Sdílet prostřednictvím

Glosář (Azure Data Catalog REST API)

  • Článek

Vytvořit

Vytvoří jeden termín glosáře.

Žádost

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

Poznámka

Některé implementace klienta HTTP můžou ze serveru automaticky znovu vydávat požadavky v reakci na kód 302, ale obvykle z požadavku odstraňují hlavičky autorizace . Vzhledem k tomu, že autorizační hlavička se vyžaduje k odesílání požadavků na ADC, musíte zajistit, aby hlavička Autorizace byla stále poskytnuta při opětovném vystavení požadavku do umístění pro přesměrování určeného službou ADC. Níže je ukázkový kód, který to demonstruje pomocí objektu HttpWebRequest .NET.

Parametry identifikátoru URI

Název Description Typ dat
catalog_name Název katalogu nebo "DefaultCatalog" pro použití výchozího katalogu. Řetězec
glossary_name Název glosáře, který je ve výchozím nastavení stejný jako catalog_name. K výběru výchozího glosáře použijte DefaultGlossary. Řetězec
verze-api Verze rozhraní API. Řetězec

Příklad 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
#### Příklad textu
{  
  "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"  
    }  
  ]  
}

Poznámka:

  1. Pokud text neobsahuje parentId, bude vytvořený termín kořenovým termínem a nebude mít nadřazený výraz.
  2. Dva termíny nesmí mít stejný název, pokud mají stejný nadřazený termín.

Odpověď

Stavové kódy

Kód Description
201 Vytvořen. Požadavek byl splněn a byl vytvořen nový termín.
409 Konflikt. Duplicitní název termínu již existuje pod stejným nadřazený termínem.

Typ obsahu

application/json

Hlavička

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

Odstranit

Odstraní jeden termín glosáře.

Žádost

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

Poznámka

Některé implementace klienta HTTP můžou ze serveru automaticky znovu vydávat požadavky v reakci na kód 302, ale obvykle z požadavku odstraňují hlavičky autorizace . Vzhledem k tomu, že autorizační hlavička se vyžaduje k odesílání požadavků na ADC, musíte zajistit, aby hlavička Autorizace byla stále poskytnuta při opětovném vystavení požadavku do umístění pro přesměrování určeného službou ADC. Níže je ukázkový kód, který to demonstruje pomocí objektu HttpWebRequest .NET.

Parametry identifikátoru URI

Název Description Typ dat
catalog_name Název katalogu nebo "DefaultCatalog" pro použití výchozího katalogu. Řetězec
glossary_name Název glosáře, který je ve výchozím nastavení stejný jako catalog_name. K výběru výchozího glosáře použijte DefaultGlossary. Řetězec
term_id ID termínu glosáře. Řetězec
verze-api Verze rozhraní API. Řetězec

Příklad odstranění

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

Hlavička

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

Odpověď

Stavové kódy

Kód Description
204 Bez obsahu. Termín neexistuje nebo bylo odstranění úspěšné.
404 Nenalezeno. Termín nebyl nalezen.
412 Předběžná podmínka se nezdařila. Žádost byla zrušena kvůli neshodě značky ETag.

Poznámka

Sémantika operace odstranění je "delete if exists", takže pokud termín neexistuje, vrátí se stavový kód 204 (NoContent).

Typ obsahu

application/json

Hlavička

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

Výčet

Vytvoření výčtu všech termínů v glosáři

Žádost

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

Poznámka

Některé implementace klienta HTTP můžou ze serveru automaticky znovu vydávat požadavky v reakci na kód 302, ale obvykle z požadavku odstraňují hlavičky autorizace . Vzhledem k tomu, že autorizační hlavička se vyžaduje k odesílání požadavků na ADC, musíte zajistit, aby hlavička Autorizace byla stále poskytnuta při opětovném vystavení požadavku do umístění pro přesměrování určeného službou ADC. Níže je ukázkový kód, který to demonstruje pomocí objektu HttpWebRequest .NET.

Parametry identifikátoru URI

Název Description Typ dat
catalog_name Název katalogu nebo "DefaultCatalog" pro použití výchozího katalogu. Řetězec
glossary_name Název glosáře, který je ve výchozím nastavení stejný jako catalog_name. K výběru výchozího glosáře použijte DefaultGlossary. Řetězec
verze-api Verze rozhraní API. Řetězec

Příklad get

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

Hlavička

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

Odpověď

Stavové kódy

Kód Description
200 OK. Odpověď obsahuje seznam termínů glosáře.

Typ obsahu

application/json

Hlavička

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

Text

Poznámka

Každá operace výčtu vrátí maximálně 1000 termínů. Pokud je v glosáři více než 1000 termínů, bude do odpovědi pro průběžný výčet zahrnut "nextLink".

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

Získat

Získá jeden termín glosáře.

Žádost

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

Poznámka

Některé implementace klienta HTTP můžou ze serveru automaticky znovu vydávat požadavky v reakci na kód 302, ale obvykle z požadavku odstraňují hlavičky autorizace . Vzhledem k tomu, že autorizační hlavička se vyžaduje k odesílání požadavků na ADC, musíte zajistit, aby hlavička Autorizace byla stále poskytnuta při opětovném vystavení požadavku do umístění pro přesměrování určeného službou ADC. Níže je ukázkový kód, který to demonstruje pomocí objektu HttpWebRequest .NET.

Parametry identifikátoru URI

Název Description Typ dat
catalog_name Název katalogu nebo "DefaultCatalog" pro použití výchozího katalogu. Řetězec
glossary_name Název glosáře, který je ve výchozím nastavení stejný jako catalog_name. K výběru výchozího glosáře použijte DefaultGlossary. Řetězec
term_id ID termínu glosáře. Řetězec
verze-api Verze rozhraní API. Řetězec

Příklad 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

Hlavička

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

Odpověď

Stavové kódy

Kód Description
200 OK. Odpověď obsahuje požadovaný termín glosáře.
404 Nenalezeno. Termín nebyl nalezen.

Typ obsahu

application/json

Hlavička

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

Text

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

Aktualizace

Aktualizace jeden termín glosáře.

Žádost

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

Poznámka

Některé implementace klienta HTTP můžou ze serveru automaticky znovu vydávat požadavky v reakci na kód 302, ale obvykle z požadavku odstraňují hlavičky autorizace . Vzhledem k tomu, že autorizační hlavička se vyžaduje k odesílání požadavků na ADC, musíte zajistit, aby hlavička Autorizace byla stále poskytnuta při opětovném vystavení požadavku do umístění pro přesměrování určeného službou ADC. Níže je ukázkový kód, který to demonstruje pomocí objektu HttpWebRequest .NET.

Parametry identifikátoru URI

Název Description Typ dat
catalog_name Název katalogu nebo "DefaultCatalog" pro použití výchozího katalogu. Řetězec
glossary_name Název glosáře, který je ve výchozím nastavení stejný jako catalog_name. K výběru výchozího glosáře použijte DefaultGlossary. Řetězec
term_id ID termínu glosáře. Řetězec
verze-api Verze rozhraní API. Řetězec

Příklad 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

Hlavička

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

 #### Příklad textu
{  
  "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"  
    }  
  ]  
}

Odpověď

Stavové kódy

Kód Description
200 Ok. Existující termín byl aktualizován.
404 Nenalezeno. Termín nebyl nalezen.
409 Konflikt. Duplicitní název termínu již existuje pod stejným nadřazený termínem.
412 Předběžná podmínka se nezdařila. Žádost byla zrušena kvůli neshodě značky ETag.

Typ obsahu

application/json

Hlavička

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