Compartilhar via

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

  • Artigo

Criar

Cria um único termo de glossário.

Solicitação

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

Observação

Algumas implementações de cliente HTTP podem reemitir solicitações automaticamente em resposta a um 302 do servidor, mas normalmente removem cabeçalhos de autorização da solicitação. Como o cabeçalho De autorização é necessário para fazer solicitações ao ADC, você deve garantir que o cabeçalho autorização ainda seja fornecido ao emitir novamente uma solicitação para um local de redirecionamento especificado pelo ADC. Veja abaixo o código de exemplo que demonstra isso usando o objeto HttpWebRequest do .NET.

Parâmetros do URI

Nome Descrição Tipo de Dados
Catalog_name Nome do catálogo ou "DefaultCatalog" para usar o catálogo padrão. String
glossary_name Nome do glossário, que é padrão para ser o mesmo que catalog_name. Use "DefaultGlossary" para escolher o glossário padrão. String
api-version A versão da API. String

Exemplo 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"  
    }  
  ]  
}

Observação:

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

Resposta

Códigos de status

Código Descrição
201 Criado. A solicitação foi atendida e um novo termo foi criado.
409 Conflito. O nome do termo duplicado já existe no mesmo termo pai.

Tipo de conteúdo

application/json

parâmetro

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

Excluir

Exclui um único termo de glossário.

Solicitação

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

Observação

Algumas implementações de cliente HTTP podem reemitir solicitações automaticamente em resposta a um 302 do servidor, mas normalmente removem cabeçalhos de autorização da solicitação. Como o cabeçalho De autorização é necessário para fazer solicitações ao ADC, você deve garantir que o cabeçalho autorização ainda seja fornecido ao emitir novamente uma solicitação para um local de redirecionamento especificado pelo ADC. Veja abaixo o código de exemplo que demonstra isso usando o objeto HttpWebRequest do .NET.

Parâmetros do URI

Nome Descrição Tipo de Dados
Catalog_name Nome do catálogo ou "DefaultCatalog" para usar o catálogo padrão. String
glossary_name Nome do glossário, que é padrão para ser o mesmo que catalog_name. Use "DefaultGlossary" para escolher o glossário padrão. String
term_id ID de um termo glossário. String
api-version A versão da API. String

Exemplo 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

parâmetro

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

Resposta

Códigos de status

Código Descrição
204 NoContent. O termo não existe ou a exclusão foi bem-sucedida.
404 Notfound. Termo não encontrado.
412 Falha na pré-condição. A solicitação foi cancelada devido à incompatibilidade de ETag.

Observação

A semântica da operação Delete é "delete if exists", portanto, se o termo não existir êxito status código 204 (NoContent) será retornado.

Tipo de conteúdo

application/json

parâmetro

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

Enumerar

Enumerar todos os termos em um glossário.

Solicitação

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

Observação

Algumas implementações de cliente HTTP podem reemitir solicitações automaticamente em resposta a um 302 do servidor, mas normalmente removem cabeçalhos de autorização da solicitação. Como o cabeçalho De autorização é necessário para fazer solicitações ao ADC, você deve garantir que o cabeçalho autorização ainda seja fornecido ao emitir novamente uma solicitação para um local de redirecionamento especificado pelo ADC. Veja abaixo o código de exemplo que demonstra isso usando o objeto HttpWebRequest do .NET.

Parâmetros do URI

Nome Descrição Tipo de Dados
Catalog_name Nome do catálogo ou "DefaultCatalog" para usar o catálogo padrão. String
glossary_name Nome do glossário, que é o padrão para ser o mesmo que catalog_name. Use "DefaultGlossary" para escolher o glossário padrão. 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

parâmetro

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

Resposta

Códigos de status

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

Tipo de conteúdo

application/json

parâmetro

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

Corpo

Observação

Cada operação de enumeração retorna no máximo 1000 termos. Se houver mais de 1000 termos no glossário, um "nextLink" será incluído 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"  
    }  
  ]  
}

Obter

Obtém um único termo de glossário.

Solicitação

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

Observação

Algumas implementações de cliente HTTP podem emitir solicitações automaticamente em resposta a um 302 do servidor, mas normalmente removem cabeçalhos de autorização da solicitação. Como o cabeçalho Authorization é necessário para fazer solicitações ao ADC, você deve garantir que o cabeçalho De autorização ainda seja fornecido ao emitir novamente uma solicitação para um local de redirecionamento especificado pelo ADC. Veja abaixo o código de exemplo que demonstra isso usando o objeto HttpWebRequest do .NET.

Parâmetros do URI

Nome Descrição Tipo de Dados
Catalog_name Nome do catálogo ou "DefaultCatalog" para usar o catálogo padrão. String
glossary_name Nome do glossário, que é o padrão para ser o mesmo que catalog_name. Use "DefaultGlossary" para escolher o glossário padrão. String
term_id ID de um termo de 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

parâmetro

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

Resposta

Códigos de status

Código Descrição
200 OK. A resposta contém o termo do glossário solicitado.
404 Notfound. Termo não encontrado.

Tipo de conteúdo

application/json

parâmetro

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 de glossário.

Solicitação

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

Observação

Algumas implementações de cliente HTTP podem emitir solicitações automaticamente em resposta a um 302 do servidor, mas normalmente removem cabeçalhos de autorização da solicitação. Como o cabeçalho Authorization é necessário para fazer solicitações ao ADC, você deve garantir que o cabeçalho De autorização ainda seja fornecido ao emitir novamente uma solicitação para um local de redirecionamento especificado pelo ADC. Veja abaixo o código de exemplo que demonstra isso usando o objeto HttpWebRequest do .NET.

Parâmetros do URI

Nome Descrição Tipo de Dados
Catalog_name Nome do catálogo ou "DefaultCatalog" para usar o catálogo padrão. String
glossary_name Nome do glossário, que é o padrão para ser o mesmo que catalog_name. Use "DefaultGlossary" para escolher o glossário padrão. String
term_id ID de um termo de 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

parâmetro

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 status

Código Descrição
200 OK. Um termo existente foi atualizado.
404 Notfound. Termo não encontrado.
409 Conflito. O nome do termo duplicado já existe no mesmo termo pai.
412 Falha na pré-condição. A solicitação foi cancelada devido à incompatibilidade de ETag.

Tipo de conteúdo

application/json

parâmetro

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