Partilhar via

Glossário (API REST do Azure Catálogo de Dados)

  • Artigo

Criar

Cria um único termo glossário.

Pedir

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

Nota

Algumas implementações de cliente HTTP podem emitir automaticamente pedidos em resposta a um 302 a partir do servidor, mas normalmente retiram os cabeçalhos de Autorização do pedido. Uma vez que o cabeçalho Autorização é necessário para fazer pedidos ao ADC, tem de garantir que o cabeçalho Autorização ainda é fornecido ao emitir novamente um pedido para uma localização de redirecionamento especificada pelo ADC. Segue-se um código de exemplo que demonstra isto com o objeto .NET HttpWebRequest.

Parâmetros URI

Nome Descrição Tipo de Dados
catalog_name Nome do catálogo ou "DefaultCatalog" para utilizar o catálogo predefinido. String
glossary_name Nome do glossário, que é predefinido como sendo o mesmo que catalog_name. Utilize "DefaultGlossary" para escolher o glossário predefinido. String
api-version A versão da API. String

Exemplo de 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
#### Exemplo de corpo
{  
  "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"  
    }  
  ]  
}

Nota:

  1. Se o corpo não incluir "parentId", o termo criado será um termo raiz e não terá um elemento principal.
  2. Dois termos não podem ter o mesmo nome se tiverem o mesmo termo principal.

Resposta

Códigos de estado

Código Descrição
201 Criado. O pedido foi cumprido e foi criado um novo termo.
409 Conflito. O nome do termo duplicado já existe no mesmo termo principal.

Content-Type

application/json

Cabeçalho

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

Eliminar

Elimina um único termo glossário.

Pedir

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

Nota

Algumas implementações de cliente HTTP podem emitir automaticamente pedidos em resposta a um 302 a partir do servidor, mas normalmente retiram os cabeçalhos de Autorização do pedido. Uma vez que o cabeçalho Autorização é necessário para fazer pedidos ao ADC, tem de garantir que o cabeçalho Autorização ainda é fornecido ao emitir novamente um pedido para uma localização de redirecionamento especificada pelo ADC. Segue-se um código de exemplo que demonstra isto com o objeto .NET HttpWebRequest.

Parâmetros URI

Nome Descrição Tipo de Dados
catalog_name Nome do catálogo ou "DefaultCatalog" para utilizar o catálogo predefinido. String
glossary_name Nome do glossário, que é predefinido como sendo o mesmo que catalog_name. Utilize "DefaultGlossary" para escolher o glossário predefinido. String
term_id ID de um termo glossário. String
api-version A versão da API. String

Exemplo de 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

Cabeçalho

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

Resposta

Códigos de estado

Código Descrição
204 NoContent. O termo não existe ou a eliminação foi bem-sucedida.
404 NotFound. O termo não foi encontrado.
412 Falha na Pré-condição. O pedido foi cancelado devido ao erro de correspondência da ETag.

Nota

A semântica da operação Eliminar é "eliminar se existir", pelo que, se o termo não existir, será devolvido o código de estado de êxito 204 (NoContent).

Content-Type

application/json

Cabeçalho

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

Enumerar

Enumerar todos os termos num glossário.

Pedir

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

Nota

Algumas implementações de cliente HTTP podem emitir automaticamente pedidos em resposta a um 302 a partir do servidor, mas normalmente retiram os cabeçalhos de Autorização do pedido. Uma vez que o cabeçalho Autorização é necessário para fazer pedidos ao ADC, tem de garantir que o cabeçalho Autorização ainda é fornecido ao emitir novamente um pedido para uma localização de redirecionamento especificada pelo ADC. Segue-se um código de exemplo que demonstra isto com o objeto .NET HttpWebRequest.

Parâmetros URI

Nome Descrição Tipo de Dados
catalog_name Nome do catálogo ou "DefaultCatalog" para utilizar o catálogo predefinido. String
glossary_name Nome do glossário, que é predefinido como sendo o mesmo que catalog_name. Utilize "DefaultGlossary" para escolher o glossário predefinido. String
api-version A versão da API. String

Exemplo GET

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

Cabeçalho

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

Resposta

Códigos de estado

Código Descrição
200 OK. A resposta contém uma lista de termos do glossário.

Content-Type

application/json

Cabeçalho

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

Corpo

Nota

Cada operação de enumeração devolve, no máximo, 1000 termos. Se existirem mais de 1000 termos no glossário, será incluída uma "nextLink" na resposta para enumeração contínua.

{  
  "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

Obtém um único termo glossário.

Pedir

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

Nota

Algumas implementações de cliente HTTP podem emitir automaticamente pedidos em resposta a um 302 a partir do servidor, mas normalmente retiram os cabeçalhos de Autorização do pedido. Uma vez que o cabeçalho Autorização é necessário para fazer pedidos ao ADC, tem de garantir que o cabeçalho Autorização ainda é fornecido ao emitir novamente um pedido para uma localização de redirecionamento especificada pelo ADC. Segue-se um código de exemplo que demonstra isto com o objeto .NET HttpWebRequest.

Parâmetros URI

Nome Descrição Tipo de Dados
catalog_name Nome do catálogo ou "DefaultCatalog" para utilizar o catálogo predefinido. String
glossary_name Nome do glossário, que é predefinido como sendo o mesmo que catalog_name. Utilize "DefaultGlossary" para escolher o glossário predefinido. String
term_id ID de um termo glossário. String
api-version A versão da API. String

Exemplo 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

Cabeçalho

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

Resposta

Códigos de estado

Código Descrição
200 OK. A resposta contém o termo glossário pedido.
404 NotFound. O termo não foi encontrado.

Content-Type

application/json

Cabeçalho

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

Corpo

{  
  "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"  
}

Atualizar

Atualizações um único termo glossário.

Pedir

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

Nota

Algumas implementações de cliente HTTP podem emitir automaticamente pedidos em resposta a um 302 a partir do servidor, mas normalmente retiram os cabeçalhos de Autorização do pedido. Uma vez que o cabeçalho Autorização é necessário para fazer pedidos ao ADC, tem de garantir que o cabeçalho Autorização ainda é fornecido ao emitir novamente um pedido para uma localização de redirecionamento especificada pelo ADC. Segue-se um código de exemplo que demonstra isto com o objeto .NET HttpWebRequest.

Parâmetros URI

Nome Descrição Tipo de Dados
catalog_name Nome do catálogo ou "DefaultCatalog" para utilizar o catálogo predefinido. String
glossary_name Nome do glossário, que é predefinido como sendo o mesmo que catalog_name. Utilize "DefaultGlossary" para escolher o glossário predefinido. String
term_id ID de um termo glossário. String
api-version A versão da API. String

EXEMPLO 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

Cabeçalho

Content-Type: application/json x-ms-client-request-id: 13c45c14... 46ab469473f0 Autorização: Portador eyJ0eX... FWSXfwtQ

 #### Exemplo de corpo
{  
  "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"  
    }  
  ]  
}

Resposta

Códigos de estado

Código Descrição
200 Ok, ok. Foi atualizado um termo existente.
404 NotFound. O termo não foi encontrado.
409 Conflito. O nome do termo duplicado já existe no mesmo termo principal.
412 Falha na Pré-condição. O pedido foi cancelado devido ao erro de correspondência do ETag.

Content-Type

application/json

Cabeçalho

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