Glossar (Azure Data Catalog REST-API)

  • Artikel

Erstellen

Erstellt einen einzelnen Glossarbegriff.

Anforderung

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

Hinweis

Einige HTTP-Clientimplementierungen stellen möglicherweise Anforderungen als Reaktion auf eine 302 vom Server automatisch erneut aus, entfernen jedoch in der Regel Autorisierungsheader aus der Anforderung. Da der Autorisierungsheader zum Senden von Anforderungen an ADC erforderlich ist, müssen Sie sicherstellen, dass der Autorisierungsheader beim erneuten Ausstellen einer Anforderung an einen von ADC angegebenen Umleitungsspeicherort weiterhin bereitgestellt wird. Im Folgenden finden Sie Beispielcode, der dies mithilfe des HttpWebRequest-Objekts von .NET veranschaulicht.

URI-Parameter

Name Beschreibung Datentyp
Catalog_name Name des Katalogs oder "DefaultCatalog", um den Standardkatalog zu verwenden. String
glossary_name Name des Glossars, der standardmäßig mit catalog_name identisch ist. Verwenden Sie "DefaultGlossary", um das Standardglossar auszuwählen. String
api-version Die API-Version. String

POST-Beispiel

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

Hinweis:

  1. Wenn body nicht "parentId" enthält, ist der erstellte Ausdruck ein Stammbegriff und verfügt nicht über ein übergeordnetes Element.
  2. Zwei Begriffe dürfen nicht denselben Namen haben, wenn sie denselben übergeordneten Begriff haben.

Antwort

Statuscodes

Code BESCHREIBUNG
201 Erstellt. Die Anforderung wurde erfüllt, und ein neuer Begriff wurde erstellt.
409 Konflikt. Doppelter Begriffsname ist bereits unter demselben übergeordneten Begriff vorhanden.

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

Löschen

Löscht einen einzelnen Glossarbegriff.

Anforderung

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

Hinweis

Einige HTTP-Clientimplementierungen stellen möglicherweise Anforderungen als Reaktion auf eine 302 vom Server automatisch erneut aus, entfernen jedoch in der Regel Autorisierungsheader aus der Anforderung. Da der Autorisierungsheader zum Senden von Anforderungen an ADC erforderlich ist, müssen Sie sicherstellen, dass der Autorisierungsheader beim erneuten Ausstellen einer Anforderung an einen von ADC angegebenen Umleitungsspeicherort weiterhin bereitgestellt wird. Im Folgenden finden Sie Beispielcode, der dies mithilfe des HttpWebRequest-Objekts von .NET veranschaulicht.

URI-Parameter

Name Beschreibung Datentyp
Catalog_name Name des Katalogs oder "DefaultCatalog", um den Standardkatalog zu verwenden. String
glossary_name Name des Glossars, der standardmäßig mit catalog_name identisch ist. Verwenden Sie "DefaultGlossary", um das Standardglossar auszuwählen. String
term_id ID eines Glossarbegriffs. String
api-version Die API-Version. String

DELETE-Beispiel

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...

Antwort

Statuscodes

Code BESCHREIBUNG
204 NoContent. Der Begriff ist nicht vorhanden, oder der Löschvorgang war erfolgreich.
404 Notfound. Der Begriff wurde nicht gefunden.
412 Fehler bei der Vorbedingung. Die Anforderung wurde aufgrund des ETag-Konflikts abgebrochen.

Hinweis

Die Semantik des Löschvorgangs lautet "delete if exists". Wenn der Ausdruck also nicht erfolgreich ist, wird status Code 204 (NoContent) zurückgegeben.

Content-Type

application/json

Header

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

Aufzählen

Listet alle Begriffe in einem Glossar auf.

Anforderung

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

Hinweis

Einige HTTP-Clientimplementierungen stellen möglicherweise Anforderungen als Reaktion auf eine 302 vom Server automatisch erneut aus, entfernen jedoch in der Regel Autorisierungsheader aus der Anforderung. Da der Autorisierungsheader zum Senden von Anforderungen an ADC erforderlich ist, müssen Sie sicherstellen, dass der Autorisierungsheader beim erneuten Ausstellen einer Anforderung an einen von ADC angegebenen Umleitungsspeicherort weiterhin bereitgestellt wird. Im Folgenden finden Sie Beispielcode, der dies mithilfe des HttpWebRequest-Objekts von .NET veranschaulicht.

URI-Parameter

Name Beschreibung Datentyp
Catalog_name Name des Katalogs oder "DefaultCatalog", um den Standardkatalog zu verwenden. String
glossary_name Name des Glossars, der standardmäßig mit catalog_name identisch ist. Verwenden Sie "DefaultGlossary", um das Standardglossar auszuwählen. String
api-version Die API-Version. String

GET-Beispiel

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...

Antwort

Statuscodes

Code BESCHREIBUNG
200 OK. Die Antwort enthält eine Liste mit Glossarbegriffen.

Content-Type

application/json

Header

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

Body

Hinweis

Jeder Enumerationsvorgang gibt maximal 1000 Begriffe zurück. Wenn mehr als 1.000 Begriffe im Glossar enthalten sind, wird ein "nextLink" in die Antwort für die fortlaufende Enumeration eingeschlossen.

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

Herunterladen

Ruft einen einzelnen Glossarbegriff ab.

Anforderung

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

Hinweis

Einige HTTP-Clientimplementierungen stellen Möglicherweise Anforderungen als Antwort auf eine 302 vom Server automatisch erneut aus, entfernen jedoch in der Regel Autorisierungsheader aus der Anforderung. Da der Autorisierungsheader zum Senden von Anforderungen an ADC erforderlich ist, müssen Sie sicherstellen, dass der Autorisierungsheader beim erneuten Ausstellen einer Anforderung an einen von ADC angegebenen Umleitungsspeicherort weiterhin bereitgestellt wird. Im Folgenden finden Sie Beispielcode, der dies mithilfe des .NET HttpWebRequest-Objekts veranschaulicht.

URI-Parameter

Name Beschreibung Datentyp
Catalog_name Name des Katalogs oder "DefaultCatalog", um den Standardkatalog zu verwenden. String
glossary_name Name des Glossars, der standardmäßig mit catalog_name identisch ist. Verwenden Sie "DefaultGlossary", um das Standardglossar auszuwählen. String
term_id ID eines Glossarbegriffs. String
api-version Die API-Version. String

GET-Beispiel

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...

Antwort

Statuscodes

Code BESCHREIBUNG
200 OK. Die Antwort enthält den angeforderten Glossarbegriff.
404 Notfound. Der Begriff wurde nicht gefunden.

Content-Type

application/json

Header

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

Aktualisieren

Updates einen einzelnen Glossarbegriff.

Anforderung

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

Hinweis

Einige HTTP-Clientimplementierungen stellen Möglicherweise Anforderungen als Antwort auf eine 302 vom Server automatisch erneut aus, entfernen jedoch in der Regel Autorisierungsheader aus der Anforderung. Da der Autorisierungsheader zum Senden von Anforderungen an ADC erforderlich ist, müssen Sie sicherstellen, dass der Autorisierungsheader beim erneuten Ausstellen einer Anforderung an einen von ADC angegebenen Umleitungsspeicherort weiterhin bereitgestellt wird. Im Folgenden finden Sie Beispielcode, der dies mithilfe des .NET HttpWebRequest-Objekts veranschaulicht.

URI-Parameter

Name Beschreibung Datentyp
Catalog_name Name des Katalogs oder "DefaultCatalog", um den Standardkatalog zu verwenden. String
glossary_name Name des Glossars, der standardmäßig mit catalog_name identisch ist. Verwenden Sie "DefaultGlossary", um das Standardglossar auszuwählen. String
term_id ID eines Glossarbegriffs. String
api-version Die API-Version. String

PUT-Beispiel

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 Autorisierung: Bearer eyJ0eX ... FWSXfwtQ

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

Antwort

Statuscodes

Code BESCHREIBUNG
200 OK: Ein vorhandener Begriff wurde aktualisiert.
404 Notfound. Der Begriff wurde nicht gefunden.
409 Konflikt. Doppelter Begriffsname ist bereits unter demselben übergeordneten Begriff vorhanden.
412 Vorbedingung fehlgeschlagen. Die Anforderung wurde aufgrund des ETag-Konflikts abgebrochen.

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