Ordlista (Azure Data Catalog REST API)

  • Artikel

Skapa

Skapar en enda ordlista.

Förfrågan

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

Anteckning

Vissa HTTP-klientimplementeringar kan automatiskt utfärda begäranden på nytt som svar på en 302 från servern, men vanligtvis ta bort auktoriseringshuvuden från begäran. Eftersom auktoriseringshuvudet krävs för att göra begäranden till ADC måste du se till att auktoriseringshuvudet fortfarande tillhandahålls när du skickar en begäran till en omdirigeringsplats som anges av ADC. Nedan visas exempelkod som visar detta med hjälp av .NET HttpWebRequest-objektet.

Uri-parametrar

Name Beskrivning Datatyp
catalog_name Namnet på katalogen eller "DefaultCatalog" för att använda standardkatalogen. Sträng
glossary_name Namnet på ordlistan, som standard är samma som catalog_name. Använd "DefaultGlossary" för att välja standardordlistan. Sträng
api-version API-versionen. Sträng

POST-exempel

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
#### Brödtextexempel
{  
  "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"  
    }  
  ]  
}

Obs!

  1. Om brödtexten inte innehåller "parentId" blir termen som skapas en rotterm och har ingen överordnad.
  2. Två termer får inte ha samma namn om de har samma överordnade term.

Svarsåtgärder

Statuskoder

Kod Description
201 Skapad. Begäran uppfylldes och en ny term skapades.
409 Konflikt. Det finns redan ett duplicerat termnamn under samma överordnade term.

Content-Type

application/json

Huvud

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

Ta bort

Tar bort en enda ordlista.

Förfrågan

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

Anteckning

Vissa HTTP-klientimplementeringar kan automatiskt utfärda begäranden på nytt som svar på en 302 från servern, men vanligtvis ta bort auktoriseringshuvuden från begäran. Eftersom auktoriseringshuvudet krävs för att göra begäranden till ADC måste du se till att auktoriseringshuvudet fortfarande tillhandahålls när du skickar en begäran till en omdirigeringsplats som anges av ADC. Nedan visas exempelkod som visar detta med hjälp av .NET HttpWebRequest-objektet.

Uri-parametrar

Name Beskrivning Datatyp
catalog_name Namnet på katalogen eller "DefaultCatalog" för att använda standardkatalogen. Sträng
glossary_name Namnet på ordlistan, som standard är samma som catalog_name. Använd "DefaultGlossary" för att välja standardordlistan. Sträng
term_id ID för en ordlista. Sträng
api-version API-versionen. Sträng

DELETE-exempel

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

Huvud

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

Svarsåtgärder

Statuskoder

Kod Description
204 NoContent. Termen finns inte eller så har borttagningen lyckats.
404 NotFound. Det går inte att hitta termen.
412 Villkoret misslyckades. Begäran avbröts på grund av ETag-matchningsfelet.

Anteckning

Semantiken Ta bort är "ta bort om den finns", så om termen inte finns returneras statuskoden 204 (NoContent).

Content-Type

application/json

Huvud

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

Numrera

Räkna upp alla termer i en ordlista.

Förfrågan

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

Anteckning

Vissa HTTP-klientimplementeringar kan automatiskt utfärda begäranden på nytt som svar på en 302 från servern, men vanligtvis ta bort auktoriseringshuvuden från begäran. Eftersom auktoriseringshuvudet krävs för att göra begäranden till ADC måste du se till att auktoriseringshuvudet fortfarande tillhandahålls när du skickar en begäran till en omdirigeringsplats som anges av ADC. Nedan visas exempelkod som visar detta med hjälp av .NET HttpWebRequest-objektet.

Uri-parametrar

Name Beskrivning Datatyp
catalog_name Namnet på katalogen eller "DefaultCatalog" för att använda standardkatalogen. Sträng
glossary_name Namnet på ordlistan, som standard är samma som catalog_name. Använd "DefaultGlossary" för att välja standardordlistan. Sträng
api-version API-versionen. Sträng

GET-exempel

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

Huvud

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

Svarsåtgärder

Statuskoder

Kod Description
200 OK. Svaret innehåller en lista över ordlistetermer.

Content-Type

application/json

Huvud

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

Brödtext

Anteckning

Varje uppräkningsåtgärd returnerar högst 1 000 termer. Om det finns fler än 1 000 termer i ordlistan inkluderas en "nextLink" i svaret för kontinuerlig uppräkning.

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

Hämta

Hämtar en enda ordlista.

Förfrågan

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

Anteckning

Vissa HTTP-klientimplementeringar kan automatiskt utfärda begäranden på nytt som svar på en 302 från servern, men tar vanligtvis bort auktoriseringshuvuden från begäran. Eftersom auktoriseringshuvudet krävs för att göra begäranden till ADC måste du se till att auktoriseringshuvudet fortfarande tillhandahålls när en begäran utfärdas på nytt till en omdirigeringsplats som anges av ADC. Nedan visas exempelkod som visar detta med hjälp av .NET HttpWebRequest-objektet.

URI-parametrar

Name Beskrivning Datatyp
catalog_name Namnet på katalogen eller "DefaultCatalog" för att använda standardkatalogen. Sträng
glossary_name Namnet på ordlistan, som standard är samma som catalog_name. Använd "DefaultGlossary" för att välja standardordlistan. Sträng
term_id ID för en ordlista. Sträng
api-version API-versionen. Sträng

GET-exempel

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

Huvud

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

Svarsåtgärder

Statuskoder

Kod Description
200 OK. Svaret innehåller den begärda ordlistan.
404 NotFound. Det gick inte att hitta termen.

Content-Type

application/json

Huvud

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

Brödtext

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

Uppdatera

Uppdateringar en enda ordlista.

Förfrågan

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

Anteckning

Vissa HTTP-klientimplementeringar kan automatiskt utfärda begäranden på nytt som svar på en 302 från servern, men tar vanligtvis bort auktoriseringshuvuden från begäran. Eftersom auktoriseringshuvudet krävs för att göra begäranden till ADC måste du se till att auktoriseringshuvudet fortfarande tillhandahålls när en begäran utfärdas på nytt till en omdirigeringsplats som anges av ADC. Nedan visas exempelkod som visar detta med hjälp av .NET HttpWebRequest-objektet.

URI-parametrar

Name Beskrivning Datatyp
catalog_name Namnet på katalogen eller "DefaultCatalog" för att använda standardkatalogen. Sträng
glossary_name Namnet på ordlistan, som standard är samma som catalog_name. Använd "DefaultGlossary" för att välja standardordlistan. Sträng
term_id ID för en ordlista. Sträng
api-version API-versionen. Sträng

PUT-exempel

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

Huvud

Innehållstyp: application/json x-ms-client-request-id: 13c45c14... 46ab469473f0 Auktorisering: Bearer eyJ0eX ... FWSXfwtQ

 #### Brödtextexempel
{  
  "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"  
    }  
  ]  
}

Svarsåtgärder

Statuskoder

Kod Description
200 Okej. En befintlig term har uppdaterats.
404 NotFound. Det gick inte att hitta termen.
409 Konflikt. Det finns redan ett duplicerat termnamn under samma överordnade term.
412 Förutsättningen misslyckades. Begäran avbröts på grund av ETag-matchningsfelet.

Content-Type

application/json

Huvud

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