Compartir a través de

Glosario (API REST de Azure Data Catalog)

  • Artículo

Crear

Crea un único término de glosario.

Solicitud

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

Nota

Algunas implementaciones de cliente HTTP pueden volver a emitir automáticamente solicitudes en respuesta a un 302 desde el servidor, pero normalmente quitar los encabezados de autorización de la solicitud. Dado que el encabezado Authorization es necesario para realizar solicitudes a ADC, debe asegurarse de que el encabezado Authorization todavía se proporciona al volver a emitir una solicitud a una ubicación de redireccionamiento especificada por ADC. A continuación se muestra el código de ejemplo que muestra esto mediante el objeto HttpWebRequest de .NET.

Parámetros URI

Nombre Descripción Tipo de datos
catalog_name Nombre del catálogo o "DefaultCatalog" para usar el catálogo predeterminado. String
glossary_name Nombre del glosario, que es el mismo que catalog_name. Use "DefaultGlossary" para elegir el glosario predeterminado. String
api-version Versión de la API. String

Ejemplo 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
Ejemplo de #### Body
{  
  "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. Si body no incluye "parentId", el término creado será un término raíz y no tendrá un elemento primario.
  2. No se permite que dos términos tengan el mismo nombre si tienen el mismo término primario.

Response

Códigos de estado

Código Descripción
201 Creado. Se ha cumplido la solicitud y se ha creado un nuevo término.
409 Conflicto. El nombre del término duplicado ya existe bajo el mismo término primario.

Content-Type

application/json

Encabezado

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 un único término del glosario.

Solicitud

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

Nota

Algunas implementaciones de cliente HTTP pueden volver a emitir automáticamente solicitudes en respuesta a un 302 desde el servidor, pero normalmente quitar los encabezados de autorización de la solicitud. Dado que el encabezado Authorization es necesario para realizar solicitudes a ADC, debe asegurarse de que el encabezado Authorization todavía se proporciona al volver a emitir una solicitud a una ubicación de redireccionamiento especificada por ADC. A continuación se muestra el código de ejemplo que muestra esto mediante el objeto HttpWebRequest de .NET.

Parámetros URI

Nombre Descripción Tipo de datos
catalog_name Nombre del catálogo o "DefaultCatalog" para usar el catálogo predeterminado. String
glossary_name Nombre del glosario, que es el mismo que catalog_name. Use "DefaultGlossary" para elegir el glosario predeterminado. String
term_id Identificador de un término de glosario. String
api-version Versión de la API. String

Ejemplo 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

Encabezado

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

Response

Códigos de estado

Código Descripción
204 NoContent. El término no existe o la eliminación se ha realizado correctamente.
404 NotFound. No se encuentra el término.
412 Error de condición previa. La solicitud se canceló debido a la falta de coincidencia de ETag.

Nota:

La semántica de la operación delete es "delete if exists", por lo que si el término no existe, se devolverá el código de estado correcto 204 (NoContent).

Content-Type

application/json

Encabezado

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

Enumerar

Enumera todos los términos de un glosario.

Solicitud

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

Nota

Algunas implementaciones de cliente HTTP pueden volver a emitir automáticamente solicitudes en respuesta a un 302 desde el servidor, pero normalmente quitar los encabezados de autorización de la solicitud. Dado que el encabezado Authorization es necesario para realizar solicitudes a ADC, debe asegurarse de que el encabezado Authorization todavía se proporciona al volver a emitir una solicitud a una ubicación de redireccionamiento especificada por ADC. A continuación se muestra el código de ejemplo que muestra esto mediante el objeto HttpWebRequest de .NET.

Parámetros URI

Nombre Descripción Tipo de datos
catalog_name Nombre del catálogo o "DefaultCatalog" para usar el catálogo predeterminado. String
glossary_name Nombre del glosario, que es el mismo que catalog_name. Use "DefaultGlossary" para elegir el glosario predeterminado. String
api-version Versión de la API. String

Ejemplo get

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

Encabezado

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

Response

Códigos de estado

Código Descripción
200 Aceptar. La respuesta contiene una lista de términos del glosario.

Content-Type

application/json

Encabezado

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

Body

Nota:

Cada operación de enumeración devuelve como máximo 1000 términos. Si hay más de 1000 términos en el glosario, se incluirá un "nextLink" en la respuesta para la enumeración continua.

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

Obtener

Obtiene un único término del glosario.

Solicitud

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

Nota

Algunas implementaciones de cliente HTTP pueden volver a emitir automáticamente solicitudes en respuesta a 302 desde el servidor, pero normalmente quitan los encabezados de autorización de la solicitud. Dado que el encabezado Authorization es necesario para realizar solicitudes a ADC, debe asegurarse de que el encabezado Authorization todavía se proporciona al volver a emitir una solicitud a una ubicación de redireccionamiento especificada por ADC. A continuación se muestra el código de ejemplo que muestra esto mediante el objeto HttpWebRequest de .NET.

Parámetros URI

Nombre Descripción Tipo de datos
catalog_name Nombre del catálogo o "DefaultCatalog" para usar el catálogo predeterminado. String
glossary_name Nombre del glosario, que es el mismo que catalog_name. Use "DefaultGlossary" para elegir el glosario predeterminado. String
term_id Identificador de un término de glosario. String
api-version Versión de la API. String

Ejemplo 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

Encabezado

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

Response

Códigos de estado

Código Descripción
200 Aceptar. La respuesta contiene el término del glosario solicitado.
404 NotFound. No se encontró el término.

Content-Type

application/json

Encabezado

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

Cuerpo

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

Actualizar

Novedades un único término de glosario.

Solicitud

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

Nota

Algunas implementaciones de cliente HTTP pueden volver a emitir automáticamente solicitudes en respuesta a 302 desde el servidor, pero normalmente quitan los encabezados de autorización de la solicitud. Dado que el encabezado Authorization es necesario para realizar solicitudes a ADC, debe asegurarse de que el encabezado Authorization todavía se proporciona al volver a emitir una solicitud a una ubicación de redireccionamiento especificada por ADC. A continuación se muestra el código de ejemplo que muestra esto mediante el objeto HttpWebRequest de .NET.

Parámetros URI

Nombre Descripción Tipo de datos
catalog_name Nombre del catálogo o "DefaultCatalog" para usar el catálogo predeterminado. String
glossary_name Nombre del glosario, que es el mismo que catalog_name. Use "DefaultGlossary" para elegir el glosario predeterminado. String
term_id Identificador de un término de glosario. String
api-version Versión de la API. String

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

Encabezado

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

 Ejemplo de cuerpo de ####
{  
  "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"  
    }  
  ]  
}

Response

Códigos de estado

Código Descripción
200 OK. Se actualizó un término existente.
404 NotFound. No se encontró el término.
409 Conflicto. El nombre del término duplicado ya existe bajo el mismo término primario.
412 Error de condición previa. La solicitud se canceló debido a la falta de coincidencia de ETag.

Content-Type

application/json

Encabezado

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