Поделиться через

Collections - List Child Collection Names

  • Ссылка
Служба:
Purview
Версия API:
2019-11-01-preview

Перечисляет имена дочерних коллекций в коллекции.

GET {endpoint}/collections/{collectionName}/getChildCollectionNames?api-version=2019-11-01-preview
С использованием необязательных параметров: 
GET {endpoint}/collections/{collectionName}/getChildCollectionNames?api-version=2019-11-01-preview&$skipToken={$skipToken}

Параметры URI

Имя В Обязательно Тип Описание
collectionName
 path True

string

endpoint
 path True

string

Конечная точка учетной записи Purview. Пример: https://{accountName}.purview.azure.com/account/
api-version
 query True

string

Используемая версия API.
$skipToken
 query

string

Ответы

Имя Тип Описание
200 OK

CollectionNameResponseList

Успех
Other Status Codes

ErrorResponseModel

Ответ об ошибке, полученный от поставщика.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Collections_ListChildCollectionNames

Образец запроса

GET {endpoint}/collections/myCollection1/getChildCollectionNames?api-version=2019-11-01-preview

Пример ответа

Код состояния:
200 
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
{
  "value": [
    {
      "name": "mycollection1",
      "friendlyName": "The first collection"
    },
    {
      "name": "mycollection2",
      "friendlyName": "Some collection"
    },
    {
      "name": "parent2",
      "friendlyName": "parent2"
    }
  ],
  "count": 3
}

Определения

Имя Описание
CollectionNameResponse

Ресурс коллекции.
CollectionNameResponseList

Список страничных коллекций.
Error

Возвращает или задает ошибку.
ErrorModel

Модель ошибок по умолчанию
ErrorResponseModel

Модель ответа об ошибках по умолчанию

CollectionNameResponse

Object

Ресурс коллекции.

Имя Тип Описание
friendlyName

string

Возвращает или задает понятное имя коллекции.
name

string

Возвращает имя.

CollectionNameResponseList

Object

Список страничных коллекций.

Имя Тип Описание
count

integer (int64)

Общее число элементов.
nextLink

string

URL-адрес следующей страницы результатов.
value

CollectionNameResponse[]

Коллекция элементов результатов типа.

Error

Object

Возвращает или задает ошибку.

Имя Тип Описание
code

string

Возвращает или задает код.
details

ErrorModel[]

Возвращает или задает сведения.
message

string

Возвращает или задает сообщения.
target

string

Возвращает или задает целевой объект.

ErrorModel

Object

Модель ошибок по умолчанию

Имя Тип Описание
code

string

Возвращает или задает код.
details

ErrorModel[]

Возвращает или задает сведения.
message

string

Возвращает или задает сообщения.
target

string

Возвращает или задает целевой объект.

ErrorResponseModel

Object

Модель ответа об ошибках по умолчанию

Имя Тип Описание
error

Error

Возвращает или задает ошибку.