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

Глоссарий (REST API Azure Каталог данных)

  • Статья

Создать

Создает один термин глоссария.

Запрос

POST https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms?api-version={api-version}

Примечание

Некоторые реализации HTTP-клиента могут автоматически повторно выдавать запросы в ответ на запрос 302 с сервера, но обычно удаляют заголовки авторизации из запроса. Так как заголовок Authorization необходим для выполнения запросов к ADC, необходимо убедиться, что заголовок Authorization по-прежнему указан при повторной отправке запроса в расположение перенаправления, указанное ADC. Ниже приведен пример кода, демонстрирующий это с помощью объекта .NET HttpWebRequest.

Параметры универсального кода ресурса (URI)

Имя Описание Тип данных
catalog_name Имя каталога или DefaultCatalog для использования каталога по умолчанию. Строка
glossary_name Имя глоссария, которое по умолчанию совпадает с именем catalog_name. Используйте "DefaultGlossary", чтобы выбрать глоссарий по умолчанию. Строка
api-version Версия API. Строка

Пример POST:

POST https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms?api-version=2016-03-30  

Content-Type: application/json x-ms-client-request-id: 13c45c14…46ab469473f0 Authorization: Bearer eyJ0eX ... FWSXfwtQ
Пример текста ####
{  
  "parentId" : "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199"  
  "name" : "Child",  
  "definition" : "termDefinition",  
  "stakeholders" : [  
    {  
      "objectId" : "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
      "upn" : "test@example.com"  
    }  
  ]  
}

Примечание.

  1. Если текст не содержит "parentId", созданный термин будет корневым и не будет родительским.
  2. Два термина не могут иметь одно и то же имя, если они имеют один и тот же родительский термин.

Ответ

Коды состояния

Код Описание
201 Создан. Запрос был выполнен и создан новый термин.
409 Конфликт. Повторяющееся имя термина уже существует в том же родительском термине.

Content-Type

application/json

Заголовок

x-ms-request-id: 1095e88c…caffabd6dabd  
Location:  https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/b04e39a9-b457-4ab3-9da9-58b42be29577

Удалить

Удаляет один термин глоссария.

Запрос

DELETE https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms/{term_id}?api-version={api-version}

Примечание

Некоторые реализации HTTP-клиента могут автоматически повторно выдавать запросы в ответ на запрос 302 с сервера, но обычно удаляют заголовки авторизации из запроса. Так как заголовок Authorization необходим для выполнения запросов к ADC, необходимо убедиться, что заголовок Authorization по-прежнему указан при повторной отправке запроса в расположение перенаправления, указанное ADC. Ниже приведен пример кода, демонстрирующий это с помощью объекта .NET HttpWebRequest.

Параметры универсального кода ресурса (URI)

Имя Описание Тип данных
catalog_name Имя каталога или DefaultCatalog для использования каталога по умолчанию. Строка
glossary_name Имя глоссария, которое по умолчанию совпадает с именем catalog_name. Используйте "DefaultGlossary", чтобы выбрать глоссарий по умолчанию. Строка
term_id Идентификатор термина глоссария. Строка
api-version Версия API. Строка

Пример DELETE

DELETE https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199?api-version=2016-03-30

Заголовок

x-ms-client-request-id: 8091955f…8f5b4c0acede Authorization: Bearer eXJ0eyAiOiJKV1QiLCJhbGciOi...

Ответ

Коды состояния

Код Описание
204 НетContent. Термин не существует или удаление выполнено успешно.
404 Не найден. Термин не найден.
412 Сбой предварительного условия. Запрос был отменен из-за несоответствия ETag.

Примечание

Семантикой операции Удаления является "удалить, если существует", поэтому если термин не существует, будет возвращен код состояния успешного выполнения 204 (NoContent).

Content-Type

application/json

Заголовок

x-ms-request-id: 1095e88c…caffabd6dabd

Перечисление

Перечисление всех терминов в глоссарии.

Запрос

GET https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms?api-version={api-version}

Примечание

Некоторые реализации HTTP-клиента могут автоматически повторно выдавать запросы в ответ на запрос 302 с сервера, но обычно удаляют заголовки авторизации из запроса. Так как заголовок Authorization необходим для выполнения запросов к ADC, необходимо убедиться, что заголовок Authorization по-прежнему указан при повторной отправке запроса в расположение перенаправления, указанное ADC. Ниже приведен пример кода, демонстрирующий это с помощью объекта .NET HttpWebRequest.

Параметры универсального кода ресурса (URI)

Имя Описание Тип данных
catalog_name Имя каталога или DefaultCatalog для использования каталога по умолчанию. Строка
glossary_name Имя глоссария, которое по умолчанию совпадает с именем catalog_name. Используйте "DefaultGlossary", чтобы выбрать глоссарий по умолчанию. Строка
api-version Версия API. Строка

Пример GET

GET https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms?api-version=2016-03-30

Заголовок

x-ms-client-request-id: 8091955f…8f5b4c0acede Authorization: Bearer eXJ0eyAiOiJKV1QiLCJhbGciOi...

Ответ

Коды состояния

Код Описание
200 Все в порядке. Ответ содержит список терминов глоссария.

Content-Type

application/json

Заголовок

x-ms-request-id: 1095e88c…caffabd6dabd  
Content-Type: application/json; charset=utf-8

Текст

Примечание

Каждая операция перечисления возвращает не более 1000 терминов. Если в глоссарии содержится более 1000 терминов, в ответ будет включена функция nextLink для непрерывного перечисления.

{  
  "value": [  
    {  
      "parentId": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199",  
      "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/0cb37c31-6743-4d9d-bb4a-35716984fc57",  
      "name": "child2",  
      "definition": "termDefinition",  
      "stakeholders": [  
        {  
          "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
          "upn": "test@sample.com"  
        }  
      ],  
      "createdBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "createdTime": "2016-03-03T17:18:09.6089982-08:00",  
      "modifiedBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "modifiedTime": "2016-03-03T17:18:09.6089982-08:00"  
    },  
    {  
      "parentId": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199",  
      "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/60d51213-84cb-42ec-a331-98e283612c6a",  
      "name": "child1",  
      "definition": "termDefinition",  
      "stakeholders": [  
        {  
          "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
          "upn": "test@sample.com"  
        }  
      ],  
      "createdBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "createdTime": "2016-03-03T17:18:00.3793795-08:00",  
      "modifiedBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "modifiedTime": "2016-03-03T17:18:00.3793795-08:00"  
    },  
    {  
      "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/19ce15d9-b25e-4f80-8dee-cfa9bdb57f1c",  
      "name": "root2",  
      "definition": "termDefinition",  
      "stakeholders": [  
        {  
          "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
          "upn": "test@sample.com"  
        }  
      ],  
      "createdBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "createdTime": "2016-03-03T17:17:00.5490763-08:00",  
      "modifiedBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "modifiedTime": "2016-03-03T17:17:00.5490763-08:00"  
    },  
    {  
      "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199",  
      "name": "root1",  
      "definition": "termDefinition",  
      "stakeholders": [  
        {  
          "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
          "upn": "test@sample.com"  
        }  
      ],  
      "createdBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "createdTime": "2016-03-03T17:15:25.6453233-08:00",  
      "modifiedBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "modifiedTime": "2016-03-03T17:15:25.6453233-08:00"  
    }  
  ]  
}

Получить

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

Запрос

GET https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms/{term_id}?api-version={api-version}

Примечание

Некоторые реализации HTTP-клиента могут автоматически повторно отправлять запросы в ответ на запрос 302 с сервера, но обычно удаляют заголовки авторизации из запроса. Так как заголовок Authorization необходим для отправки запросов к ADC, необходимо убедиться, что заголовок Authorization по-прежнему предоставляется при повторной отправке запроса в расположение перенаправления, указанное ADC. Ниже приведен пример кода, демонстрирующий это с помощью объекта .NET HttpWebRequest.

Параметры универсального кода ресурса (URI)

Имя Описание Тип данных
catalog_name Имя каталога или DefaultCatalog для использования каталога по умолчанию. Строка
glossary_name Имя глоссария, которое по умолчанию совпадает с именем catalog_name. Используйте "DefaultGlossary", чтобы выбрать глоссарий по умолчанию. Строка
term_id Идентификатор термина глоссария. Строка
api-version Версия API. Строка

Пример GET

GET https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199?api-version=2016-03-30

Заголовок

x-ms-client-request-id: 8091955f…8f5b4c0acede Authorization: Bearer eXJ0eyAiOiJKV1QiLCJhbGciOi...

Ответ

Коды состояния

Код Описание
200 Все в порядке. Ответ содержит запрошенный термин глоссария.
404 Не найму. Термин не найден.

Content-Type

application/json

Заголовок

x-ms-request-id: 1095e88c…caffabd6dabd  
Content-Type: application/json; charset=utf-8

Текст

{  
  "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199",  
  "name": "root1",  
  "definition": "termDefinition",  
  "description" : "some description",  
  "stakeholders": [  
    {  
      "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
      "upn": "holder@example.com"  
    }  
  ],  
  "createdBy": {  
    "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
    "upn": "admin@billtest255158live.ccsctp.net"  
  },  
  "createdTime": "2016-03-03T17:15:25.6453233-08:00",  
  "modifiedBy": {  
    "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
    "upn": "admin@billtest255158live.ccsctp.net"  
  },  
  "modifiedTime": "2016-03-03T17:15:25.6453233-08:00"  
}

Update

Обновления один термин глоссария.

Запрос

PUT https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms/{term_id}?api-version={api-version}

Примечание

Некоторые реализации HTTP-клиента могут автоматически повторно отправлять запросы в ответ на запрос 302 с сервера, но обычно удаляют заголовки авторизации из запроса. Так как заголовок Authorization необходим для отправки запросов к ADC, необходимо убедиться, что заголовок Authorization по-прежнему предоставляется при повторной отправке запроса в расположение перенаправления, указанное ADC. Ниже приведен пример кода, демонстрирующий это с помощью объекта .NET HttpWebRequest.

Параметры универсального кода ресурса (URI)

Имя Описание Тип данных
catalog_name Имя каталога или DefaultCatalog для использования каталога по умолчанию. Строка
glossary_name Имя глоссария, которое по умолчанию совпадает с именем catalog_name. Используйте "DefaultGlossary", чтобы выбрать глоссарий по умолчанию. Строка
term_id Идентификатор термина глоссария. Строка
api-version Версия API. Строка

Пример PUT:

PUT https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms/b04e39a9-b457-4ab3-9da9-58b42be29577?api-version=2016-03-30

Заголовок

Content-Type: application/json x-ms-client-request-id: 13c45c14... 46ab469473f0 Authorization: Bearer eyJ0eX ... FWSXfwtQ

 #### Пример текста
{  
  "parentId" : "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199"  
  "name" : "Child",  
  "definition" : "termDefinition",  
  "stakeholders" : [  
    {  
      "objectId" : "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
      "upn" : "test@example.com"  
    }  
  ]  
}

Ответ

Коды состояния

Код Описание
200 Все в порядке. Обновлен существующий термин.
404 Не найму. Термин не найден.
409 Конфликт. Повторяющееся имя термина уже существует в том же родительском термине.
412 Сбой предварительного условия. Запрос был отменен из-за несоответствия ETag.

Content-Type

application/json

Заголовок

x-ms-request-id: 1095e88c…caffabd6dabd  
Location:  https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/b04e39a9-b457-4ab3-9da9-58b42be29577