Partager via

Glossaire (API REST Azure Data Catalog)

  • Article

Créer

Crée un seul terme de glossaire.

Requête

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

Notes

Certaines implémentations de client HTTP peuvent émettre automatiquement des demandes en réponse à une erreur 302 du serveur, mais en général supprimer les en-têtes d’autorisation de la demande. Étant donné que l’en-tête d’autorisation est nécessaire pour effectuer des demandes à ADC, vous devez vous assurer que l’en-tête d’autorisation est toujours fourni lors de la réexécriture d’une demande vers un emplacement de redirection spécifié par ADC. Voici un exemple de code illustrant cela à l’aide de l’objet HttpWebRequest .NET.

Paramètres d’URI

Nom Description Type de données
catalog_name Nom du catalogue ou « DefaultCatalog » pour utiliser le catalogue par défaut. String
glossary_name Nom du glossaire, qui est par défaut identique à catalog_name. Utilisez « DefaultGlossary » pour choisir le glossaire par défaut. String
api-version Version de l'API. String

Exemple 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
#### Exemple de corps
{  
  "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"  
    }  
  ]  
}

Remarque :

  1. Si body n’inclut pas « parentId », le terme créé sera un terme racine et n’aura pas de parent.
  2. Deux termes ne sont pas autorisés à avoir le même nom s’ils ont le même terme parent.

response

Codes d’état

Code Description
201 Créé. La demande a été satisfaite et un nouveau terme a été créé.
409 Conflit. Le nom du terme en double existe déjà sous le même terme parent.

Content-Type

application/json

En-tête

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

Supprime un seul terme de glossaire.

Requête

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

Notes

Certaines implémentations de client HTTP peuvent émettre automatiquement des demandes en réponse à une erreur 302 du serveur, mais en général supprimer les en-têtes d’autorisation de la demande. Étant donné que l’en-tête d’autorisation est nécessaire pour effectuer des demandes à ADC, vous devez vous assurer que l’en-tête d’autorisation est toujours fourni lors de la réexécriture d’une demande vers un emplacement de redirection spécifié par ADC. Voici un exemple de code illustrant cela à l’aide de l’objet HttpWebRequest .NET.

Paramètres d’URI

Nom Description Type de données
catalog_name Nom du catalogue ou « DefaultCatalog » pour utiliser le catalogue par défaut. String
glossary_name Nom du glossaire, qui est par défaut identique à catalog_name. Utilisez « DefaultGlossary » pour choisir le glossaire par défaut. String
term_id ID d’un terme de glossaire. String
api-version Version de l'API. String

Exemple 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

En-tête

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

response

Codes d’état

Code Description
204 NoContent. Le terme n’existe pas ou la suppression a réussi.
404 Notfound. Le terme est introuvable.
412 Échec de la condition préalable. La demande a été annulée en raison de l’incompatibilité ETag.

Remarque

La sémantique de l’opération Delete est « delete if exists », donc si le terme n’existe pas réussite status code 204 (NoContent) est retourné.

Content-Type

application/json

En-tête

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

Énumérer

Énumérer tous les termes d’un glossaire.

Requête

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

Notes

Certaines implémentations de client HTTP peuvent émettre automatiquement des demandes en réponse à une erreur 302 du serveur, mais en général supprimer les en-têtes d’autorisation de la demande. Étant donné que l’en-tête d’autorisation est nécessaire pour effectuer des demandes à ADC, vous devez vous assurer que l’en-tête d’autorisation est toujours fourni lors de la réexécriture d’une demande vers un emplacement de redirection spécifié par ADC. Voici un exemple de code illustrant cela à l’aide de l’objet HttpWebRequest .NET.

Paramètres d’URI

Nom Description Type de données
catalog_name Nom du catalogue ou « DefaultCatalog » pour utiliser le catalogue par défaut. String
glossary_name Nom du glossaire, qui est par défaut identique à catalog_name. Utilisez « DefaultGlossary » pour choisir le glossaire par défaut. String
api-version Version de l'API. String

Exemple GET

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

En-tête

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

response

Codes d’état

Code Description
200 OK. La réponse contient la liste des termes du glossaire.

Content-Type

application/json

En-tête

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

body

Notes

Chaque opération d’énumération retourne au plus 1 000 termes. S’il existe plus de 1 000 termes dans le glossaire, un « nextLink » est inclus dans la réponse pour l’énumération continue.

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

Obtenir

Obtient un seul terme de glossaire.

Requête

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

Notes

Certaines implémentations de client HTTP peuvent émettre automatiquement des demandes en réponse à une erreur 302 du serveur, mais en général supprimer les en-têtes d’autorisation de la demande. Étant donné que l’en-tête d’autorisation est nécessaire pour effectuer des demandes à ADC, vous devez vous assurer que l’en-tête d’autorisation est toujours fourni lors de la réexécriture d’une demande vers un emplacement de redirection spécifié par ADC. Voici un exemple de code illustrant cela à l’aide de l’objet HttpWebRequest .NET.

Paramètres d’URI

Nom Description Type de données
catalog_name Nom du catalogue ou « DefaultCatalog » pour utiliser le catalogue par défaut. String
glossary_name Nom du glossaire, qui est par défaut identique à catalog_name. Utilisez « DefaultGlossary » pour choisir le glossaire par défaut. String
term_id ID d’un terme de glossaire. String
api-version Version de l'API. String

Exemple 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

En-tête

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

response

Codes d’état

Code Description
200 OK. La réponse contient le terme de glossaire demandé.
404 Notfound. Le terme est introuvable.

Content-Type

application/json

En-tête

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

Corps

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

Mises à jour un seul terme de glossaire.

Requête

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

Notes

Certaines implémentations de client HTTP peuvent émettre automatiquement des demandes en réponse à une erreur 302 du serveur, mais en général supprimer les en-têtes d’autorisation de la demande. Étant donné que l’en-tête d’autorisation est nécessaire pour effectuer des demandes à ADC, vous devez vous assurer que l’en-tête d’autorisation est toujours fourni lors de la réexécriture d’une demande vers un emplacement de redirection spécifié par ADC. Voici un exemple de code illustrant cela à l’aide de l’objet HttpWebRequest .NET.

Paramètres d’URI

Nom Description Type de données
catalog_name Nom du catalogue ou « DefaultCatalog » pour utiliser le catalogue par défaut. String
glossary_name Nom du glossaire, qui est par défaut identique à catalog_name. Utilisez « DefaultGlossary » pour choisir le glossaire par défaut. String
term_id ID d’un terme de glossaire. String
api-version Version de l'API. String

Exemple 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

En-tête

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

 #### Exemple de corps
{  
  "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

Codes d’état

Code Description
200 OK. Un terme existant a été mis à jour.
404 Notfound. Le terme est introuvable.
409 Conflit. Le nom du terme en double existe déjà sous le même terme parent.
412 Échec de la condition préalable. La demande a été annulée en raison de l’incompatibilité ETag.

Content-Type

application/json

En-tête

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