Udostępnij za pośrednictwem

Słownik (interfejs API REST usługi Azure Data Catalog)

  • Artykuł

Utwórz

Tworzy pojedynczy termin słownika.

Żądanie

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

Uwaga

Niektóre implementacje klienta HTTP mogą automatycznie ponownie wysyłać żądania w odpowiedzi na 302 z serwera, ale zazwyczaj usuwać nagłówki autoryzacji z żądania. Ponieważ nagłówek autoryzacji jest wymagany do wysłania żądań do usługi ADC, należy się upewnić, że nagłówek autoryzacji jest nadal udostępniany podczas ponownego wystawiania żądania do lokalizacji przekierowania określonej przez usługę ADC. Poniżej przedstawiono przykładowy kod demonstrujący to przy użyciu obiektu HttpWebRequest platformy .NET.

Parametry identyfikatora URI

Nazwa Opis Typ danych
Catalog_name Nazwa wykazu lub "DefaultCatalog", aby użyć wykazu domyślnego. Ciąg
glossary_name Nazwa słownika, który jest domyślnie taki sam jak catalog_name. Użyj opcji "DefaultGlossary", aby wybrać domyślny słownik. Ciąg
api-version Wersja interfejsu API. Ciąg

Przykład 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
Przykład treści ####
{  
  "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"  
    }  
  ]  
}

Uwaga:

  1. Jeśli treść nie zawiera "parentId", utworzony termin będzie terminem głównym i nie ma elementu nadrzędnego.
  2. Dwa terminy nie mogą mieć takiej samej nazwy, jeśli mają ten sam termin nadrzędny.

Reakcja

Kody stanu

Kod Opis
201 Utworzone. Żądanie zostało spełnione i utworzono nowy termin.
409 Konflikt. Zduplikowana nazwa terminu już istnieje w ramach tego samego terminu nadrzędnego.

Content-Type

application/json

Nagłówek

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

Usuń

Usuwa pojedynczy termin słownika.

Żądanie

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

Uwaga

Niektóre implementacje klienta HTTP mogą automatycznie ponownie wysyłać żądania w odpowiedzi na 302 z serwera, ale zazwyczaj usuwać nagłówki autoryzacji z żądania. Ponieważ nagłówek autoryzacji jest wymagany do wysłania żądań do usługi ADC, należy się upewnić, że nagłówek autoryzacji jest nadal udostępniany podczas ponownego wystawiania żądania do lokalizacji przekierowania określonej przez usługę ADC. Poniżej przedstawiono przykładowy kod demonstrujący to przy użyciu obiektu HttpWebRequest platformy .NET.

Parametry identyfikatora URI

Nazwa Opis Typ danych
Catalog_name Nazwa wykazu lub "DefaultCatalog", aby użyć wykazu domyślnego. Ciąg
glossary_name Nazwa słownika, który jest domyślnie taki sam jak catalog_name. Użyj opcji "DefaultGlossary", aby wybrać domyślny słownik. Ciąg
term_id Identyfikator terminu słownika. Ciąg
api-version Wersja interfejsu API. Ciąg

Przykład 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

Nagłówek

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

Reakcja

Kody stanu

Kod Opis
204 NoContent. Termin nie istnieje lub usunięcie zakończyło się pomyślnie.
404 Notfound. Nie można odnaleźć terminu.
412 Warunek wstępny nie powiódł się. Żądanie zostało anulowane z powodu niezgodności elementu ETag.

Uwaga

Semantyka operacji usuwania to "usuń, jeśli istnieje", więc jeśli termin nie istnieje kod stanu powodzenia 204 (NoContent) zostanie zwrócony.

Content-Type

application/json

Nagłówek

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

Wyliczyć

Wyliczanie wszystkich terminów w słowniku.

Żądanie

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

Uwaga

Niektóre implementacje klienta HTTP mogą automatycznie ponownie wysyłać żądania w odpowiedzi na 302 z serwera, ale zazwyczaj usuwać nagłówki autoryzacji z żądania. Ponieważ nagłówek autoryzacji jest wymagany do wysłania żądań do usługi ADC, należy się upewnić, że nagłówek autoryzacji jest nadal udostępniany podczas ponownego wystawiania żądania do lokalizacji przekierowania określonej przez usługę ADC. Poniżej przedstawiono przykładowy kod demonstrujący to przy użyciu obiektu HttpWebRequest platformy .NET.

Parametry identyfikatora URI

Nazwa Opis Typ danych
Catalog_name Nazwa wykazu lub "DefaultCatalog", aby użyć wykazu domyślnego. Ciąg
glossary_name Nazwa słownika, który jest domyślnie taki sam jak catalog_name. Użyj opcji "DefaultGlossary", aby wybrać domyślny słownik. Ciąg
api-version Wersja interfejsu API. Ciąg

Przykład GET

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

Nagłówek

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

Reakcja

Kody stanu

Kod Opis
200 OK. Odpowiedź zawiera listę terminów słownika.

Content-Type

application/json

Nagłówek

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

Treść

Uwaga

Każda operacja wyliczania zwraca co najwyżej 1000 terminów. Jeśli słownik zawiera więcej niż 1000 terminów, w odpowiedzi na wyliczenie ciągłe zostanie uwzględnione wyrażenie "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"  
    }  
  ]  
}

Get

Pobiera pojedynczy termin słownika.

Żądanie

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

Uwaga

Niektóre implementacje klienta HTTP mogą automatycznie ponownie wysyłać żądania w odpowiedzi na 302 z serwera, ale zazwyczaj usuwać nagłówki autoryzacji z żądania. Ponieważ nagłówek autoryzacji jest wymagany do wysłania żądań do usługi ADC, należy się upewnić, że nagłówek autoryzacji jest nadal udostępniany podczas ponownego wystawiania żądania do lokalizacji przekierowania określonej przez usługę ADC. Poniżej przedstawiono przykładowy kod demonstrujący to przy użyciu obiektu HttpWebRequest platformy .NET.

Parametry identyfikatora URI

Nazwa Opis Typ danych
Catalog_name Nazwa wykazu lub "DefaultCatalog", aby użyć wykazu domyślnego. Ciąg
glossary_name Nazwa słownika, który jest domyślnie taki sam jak catalog_name. Użyj opcji "DefaultGlossary", aby wybrać domyślny słownik. Ciąg
term_id Identyfikator terminu słownika. Ciąg
api-version Wersja interfejsu API. Ciąg

Przykład 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

Nagłówek

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

Reakcja

Kody stanu

Kod Opis
200 OK. Odpowiedź zawiera żądany termin słownika.
404 Notfound. Nie można odnaleźć terminu.

Content-Type

application/json

Nagłówek

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

Treść

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

Aktualizacja

Aktualizacje pojedynczy termin słownika.

Żądanie

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

Uwaga

Niektóre implementacje klienta HTTP mogą automatycznie ponownie wysyłać żądania w odpowiedzi na 302 z serwera, ale zazwyczaj usuwać nagłówki autoryzacji z żądania. Ponieważ nagłówek autoryzacji jest wymagany do wysłania żądań do usługi ADC, należy się upewnić, że nagłówek autoryzacji jest nadal udostępniany podczas ponownego wystawiania żądania do lokalizacji przekierowania określonej przez usługę ADC. Poniżej przedstawiono przykładowy kod demonstrujący to przy użyciu obiektu HttpWebRequest platformy .NET.

Parametry identyfikatora URI

Nazwa Opis Typ danych
Catalog_name Nazwa wykazu lub "DefaultCatalog", aby użyć wykazu domyślnego. Ciąg
glossary_name Nazwa słownika, który jest domyślnie taki sam jak catalog_name. Użyj opcji "DefaultGlossary", aby wybrać domyślny słownik. Ciąg
term_id Identyfikator terminu słownika. Ciąg
api-version Wersja interfejsu API. Ciąg

PRZYKŁAD 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

Nagłówek

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

 Przykład treści ####
{  
  "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"  
    }  
  ]  
}

Reakcja

Kody stanu

Kod Opis
200 Ok. Zaktualizowano istniejący termin.
404 Notfound. Nie można odnaleźć terminu.
409 Konflikt. Zduplikowana nazwa terminu już istnieje w ramach tego samego terminu nadrzędnego.
412 Warunek wstępny nie powiódł się. Żądanie zostało anulowane z powodu niezgodności elementu ETag.

Content-Type

application/json

Nagłówek

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