Delen via

Woordenlijst (Azure Data Catalog REST API)

  • Artikel

Maken

Hiermee maakt u één woordenlijstterm.

Aanvraag

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

Notitie

Sommige HTTP-client-implementaties kunnen aanvragen automatisch opnieuw uitgeven als reactie op een 302 van de server, maar meestal worden autorisatieheaders uit de aanvraag verwijderd. Omdat de autorisatieheader vereist is om aanvragen naar ADC te verzenden, moet u ervoor zorgen dat de autorisatieheader nog steeds wordt opgegeven wanneer u een aanvraag opnieuw verzendt naar een omleidingslocatie die is opgegeven door ADC. Hieronder ziet u voorbeeldcode die dit aangeeft met behulp van het .NET HttpWebRequest-object.

URI-parameters

Naam Beschrijving Gegevenstype
catalog_name Naam van de catalogus of 'DefaultCatalog' om de standaardcatalogus te gebruiken. Tekenreeks
glossary_name De naam van de woordenlijst is standaard hetzelfde als catalog_name. Gebruik 'DefaultGlossary' om de standaard woordenlijst te kiezen. Tekenreeks
api-versie De API-versie. Tekenreeks

POST-voorbeeld

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
#### Voorbeeld van hoofdtekst
{  
  "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"  
    }  
  ]  
}

Opmerking:

  1. Als hoofdtekst geen 'parentId' bevat, is de gemaakte term een hoofdterm en heeft deze geen bovenliggende term.
  2. Twee termen mogen niet dezelfde naam hebben als ze dezelfde bovenliggende term hebben.

Antwoord

Statuscodes

Code Beschrijving
201 Gemaakt. De aanvraag is voltooid en er is een nieuwe term gemaakt.
409 Conflict. Dubbele termnaam bestaat al onder dezelfde bovenliggende term.

Content-Type

application/json

Header

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

Verwijderen

Hiermee verwijdert u één woordenlijstterm.

Aanvraag

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

Notitie

Sommige HTTP-client-implementaties kunnen aanvragen automatisch opnieuw uitgeven als reactie op een 302 van de server, maar meestal worden autorisatieheaders uit de aanvraag verwijderd. Omdat de autorisatieheader vereist is om aanvragen naar ADC te verzenden, moet u ervoor zorgen dat de autorisatieheader nog steeds wordt opgegeven wanneer u een aanvraag opnieuw verzendt naar een omleidingslocatie die is opgegeven door ADC. Hieronder ziet u voorbeeldcode die dit aangeeft met behulp van het .NET HttpWebRequest-object.

URI-parameters

Naam Beschrijving Gegevenstype
catalog_name Naam van de catalogus of 'DefaultCatalog' om de standaardcatalogus te gebruiken. Tekenreeks
glossary_name De naam van de woordenlijst is standaard hetzelfde als catalog_name. Gebruik 'DefaultGlossary' om de standaard woordenlijst te kiezen. Tekenreeks
term_id Id van een woordenlijstterm. Tekenreeks
api-versie De API-versie. Tekenreeks

VOORBEELD VAN VERWIJDEREN

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

Header

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

Antwoord

Statuscodes

Code Beschrijving
204 NoContent. De term bestaat niet of de verwijdering is geslaagd.
404 NotFound. De term is niet gevonden.
412 Voorwaarde is mislukt. De aanvraag is geannuleerd omdat de ETag niet overeenkomt.

Notitie

De semantische verwijderingsbewerking is 'delete if exists', dus als de term niet bestaat, wordt de statuscode 204 (NoContent) geretourneerd.

Content-Type

application/json

Header

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

Opsommen

Alle termen in een woordenlijst opsommen.

Aanvraag

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

Notitie

Sommige HTTP-client-implementaties kunnen aanvragen automatisch opnieuw uitgeven als reactie op een 302 van de server, maar meestal worden autorisatieheaders uit de aanvraag verwijderd. Omdat de autorisatieheader vereist is om aanvragen naar ADC te verzenden, moet u ervoor zorgen dat de autorisatieheader nog steeds wordt opgegeven wanneer u een aanvraag opnieuw verzendt naar een omleidingslocatie die is opgegeven door ADC. Hieronder ziet u voorbeeldcode die dit aangeeft met behulp van het .NET HttpWebRequest-object.

URI-parameters

Naam Beschrijving Gegevenstype
catalog_name Naam van de catalogus of 'DefaultCatalog' om de standaardcatalogus te gebruiken. Tekenreeks
glossary_name De naam van de woordenlijst is standaard hetzelfde als catalog_name. Gebruik 'DefaultGlossary' om de standaard woordenlijst te kiezen. Tekenreeks
api-versie De API-versie. Tekenreeks

GET-voorbeeld

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

Header

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

Antwoord

Statuscodes

Code Description
200 OK. Het antwoord bevat een lijst met woordenlijsttermen.

Content-Type

application/json

Header

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

Hoofdtekst

Notitie

Elke opsommingsbewerking retourneert maximaal 1000 termen. Als de woordenlijst meer dan 1000 termen bevat, wordt een 'nextLink' opgenomen in het antwoord voor continue inventarisatie.

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

Ophalen

Hiermee haalt u één woordenlijstterm op.

Aanvraag

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

Notitie

Sommige HTTP-client-implementaties kunnen aanvragen automatisch opnieuw uitgeven als reactie op een 302 van de server, maar meestal verwijderen autorisatieheaders uit de aanvraag. Omdat de autorisatieheader vereist is om aanvragen naar ADC te doen, moet u ervoor zorgen dat de autorisatieheader nog steeds wordt opgegeven wanneer u een aanvraag opnieuw verzendt naar een omleidingslocatie die is opgegeven door ADC. Hieronder ziet u voorbeeldcode die dit aantoont met behulp van het .NET HttpWebRequest-object.

URI-parameters

Naam Beschrijving Gegevenstype
catalog_name Naam van de catalogus of 'DefaultCatalog' om de standaardcatalogus te gebruiken. Tekenreeks
glossary_name De naam van de woordenlijst is standaard hetzelfde als catalog_name. Gebruik 'DefaultGlossary' om de standaard woordenlijst te kiezen. Tekenreeks
term_id Id van een woordenlijstterm. Tekenreeks
api-versie De API-versie. Tekenreeks

GET-voorbeeld

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

Header

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

Antwoord

Statuscodes

Code Description
200 OK. Het antwoord bevat de aangevraagde woordenlijstterm.
404 NotFound. De term is niet gevonden.

Content-Type

application/json

Header

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

Hoofdtekst

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

Bijwerken

Updates één woordenlijstterm.

Aanvraag

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

Notitie

Sommige HTTP-client-implementaties kunnen aanvragen automatisch opnieuw uitgeven als reactie op een 302 van de server, maar meestal verwijderen autorisatieheaders uit de aanvraag. Omdat de autorisatieheader vereist is om aanvragen naar ADC te doen, moet u ervoor zorgen dat de autorisatieheader nog steeds wordt opgegeven wanneer u een aanvraag opnieuw verzendt naar een omleidingslocatie die is opgegeven door ADC. Hieronder ziet u voorbeeldcode die dit aantoont met behulp van het .NET HttpWebRequest-object.

URI-parameters

Naam Beschrijving Gegevenstype
catalog_name Naam van de catalogus of 'DefaultCatalog' om de standaardcatalogus te gebruiken. Tekenreeks
glossary_name De naam van de woordenlijst is standaard hetzelfde als catalog_name. Gebruik 'DefaultGlossary' om de standaard woordenlijst te kiezen. Tekenreeks
term_id Id van een woordenlijstterm. Tekenreeks
api-versie De API-versie. Tekenreeks

PUT-voorbeeld

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

Header

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

 #### Voorbeeld van hoofdtekst
{  
  "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"  
    }  
  ]  
}

Antwoord

Statuscodes

Code Description
200 OK. Er is een bestaande term bijgewerkt.
404 NotFound. De term is niet gevonden.
409 Conflict. Dubbele termnaam bestaat al onder dezelfde bovenliggende term.
412 Voorwaarde is mislukt. De aanvraag is geannuleerd omdat de ETag niet overeenkomt.

Content-Type

application/json

Header

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