Megosztás a következőn keresztül:

Szószedet (Azure Data Catalog REST API)

  • Cikk

Létrehozás

Egyetlen szószedetkifejezést hoz létre.

Kérés

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

Megjegyzés

Egyes HTTP-ügyfél-implementációk automatikusan újra kibocsáthatják a kéréseket a kiszolgáló 302-re válaszul, de általában eltávolítják az engedélyezési fejléceket a kérelemből. Mivel az Engedélyezési fejléc szükséges az ADC-hez irányuló kérések teljesítéséhez, meg kell győződnie arról, hogy az Engedélyezési fejléc továbbra is meg van adva az ADC által megadott átirányítási helyre irányuló kérés ismételt kiadásakor. Az alábbiakban egy mintakód mutatja be ezt a .NET HttpWebRequest objektummal.

Uri-paraméterek

Név Leírás Adattípus
catalog_name A katalógus neve vagy "DefaultCatalog" az alapértelmezett katalógus használatához. Sztring
glossary_name A szószedet neve, amely alapértelmezés szerint megegyezik a catalog_name. Az alapértelmezett szószedetet a "DefaultGlossary" használatával választhatja ki. Sztring
api-verzió Az API-verzió. Sztring

POST példa

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élda törzsre
{  
  "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"  
    }  
  ]  
}

Megjegyzés:

  1. Ha a törzs nem tartalmazza a "parentId" kifejezést, a létrehozott kifejezés gyökérkifejezés lesz, és nem rendelkezik szülővel.
  2. Két kifejezés nem rendelkezhet ugyanazzal a névvel, ha ugyanaz a szülőkifejezésük van.

Reagálás

Állapotkódok

Code Description
201 Létrehozott. A kérés teljesült, és létrejött egy új kifejezés.
409 Konfliktus. Az ismétlődő kifejezésnév már létezik ugyanabban a szülőkifejezésben.

Content-Type

application/json

Fejléc

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

Törlés

Egyetlen szószedetkifejezést töröl.

Kérés

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

Megjegyzés

Egyes HTTP-ügyfél-implementációk automatikusan újra kibocsáthatják a kéréseket a kiszolgáló 302-re válaszul, de általában eltávolítják az engedélyezési fejléceket a kérelemből. Mivel az Engedélyezési fejléc szükséges az ADC-hez irányuló kérések teljesítéséhez, meg kell győződnie arról, hogy az Engedélyezési fejléc továbbra is meg van adva az ADC által megadott átirányítási helyre irányuló kérés ismételt kiadásakor. Az alábbiakban egy mintakód mutatja be ezt a .NET HttpWebRequest objektummal.

Uri-paraméterek

Név Leírás Adattípus
catalog_name A katalógus neve vagy "DefaultCatalog" az alapértelmezett katalógus használatához. Sztring
glossary_name A szószedet neve, amely alapértelmezés szerint megegyezik a catalog_name. Az alapértelmezett szószedetet a "DefaultGlossary" használatával választhatja ki. Sztring
term_id Szószedetkifejezés azonosítója. Sztring
api-verzió Az API-verzió. Sztring

DELETE példa

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

Fejléc

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

Reagálás

Állapotkódok

Code Description
204 NoContent. A kifejezés nem létezik, vagy a törlés sikeres volt.
404 NotFound. A kifejezés nem található.
412 Az előfeltétel nem sikerült. A kérést az ETag eltérése miatt törölték.

Megjegyzés

A Törlés művelet szemantikai értéke "törlés, ha létezik", ezért ha a kifejezés nem létezik, akkor a rendszer a 204 -os (NoContent) sikeres állapotkódot adja vissza.

Content-Type

application/json

Fejléc

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

Felsorolni

Egy szószedet összes kifejezésének számbavétele.

Kérés

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

Megjegyzés

Egyes HTTP-ügyfél-implementációk automatikusan újra kibocsáthatják a kéréseket a kiszolgáló 302-re válaszul, de általában eltávolítják az engedélyezési fejléceket a kérelemből. Mivel az Engedélyezési fejléc szükséges az ADC-hez irányuló kérések teljesítéséhez, meg kell győződnie arról, hogy az Engedélyezési fejléc továbbra is meg van adva az ADC által megadott átirányítási helyre irányuló kérés ismételt kiadásakor. Az alábbiakban egy mintakód mutatja be ezt a .NET HttpWebRequest objektummal.

Uri-paraméterek

Név Leírás Adattípus
catalog_name A katalógus neve vagy "DefaultCatalog" az alapértelmezett katalógus használatához. Sztring
glossary_name A szószedet neve, amely alapértelmezés szerint megegyezik a catalog_name. Az alapértelmezett szószedetet a "DefaultGlossary" használatával választhatja ki. Sztring
api-verzió Az API-verzió. Sztring

GET példa

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

Fejléc

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

Reagálás

Állapotkódok

Code Description
200 OK gombra. A válasz a szószedeti kifejezések listáját tartalmazza.

Content-Type

application/json

Fejléc

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

Törzs

Megjegyzés

Minden enumerálási művelet legfeljebb 1000 feltételt ad vissza. Ha több mint 1000 kifejezés szerepel a szószedetben, a rendszer a "nextLink" kifejezést fogja tartalmazni a folyamatos enumerálásra adott válaszban.

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

Lekérés

Egyetlen szószedetkifejezést kap.

Kérés

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

Megjegyzés

Egyes HTTP-ügyfél-implementációk automatikusan újra kibocsáthatják a kéréseket a kiszolgáló 302-re válaszul, de általában eltávolítják az engedélyezési fejléceket a kérelemből. Mivel az Engedélyezési fejléc szükséges az ADC-hez irányuló kérések teljesítéséhez, meg kell győződnie arról, hogy az Engedélyezési fejléc továbbra is meg van adva az ADC által megadott átirányítási helyre irányuló kérés ismételt kiadásakor. Az alábbiakban egy mintakód mutatja be ezt a .NET HttpWebRequest objektummal.

Uri-paraméterek

Név Leírás Adattípus
catalog_name A katalógus neve vagy "DefaultCatalog" az alapértelmezett katalógus használatához. Sztring
glossary_name A szószedet neve, amely alapértelmezés szerint megegyezik a catalog_name. Az alapértelmezett szószedetet a "DefaultGlossary" használatával választhatja ki. Sztring
term_id Szószedetkifejezés azonosítója. Sztring
api-verzió Az API-verzió. Sztring

GET példa

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

Fejléc

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

Reagálás

Állapotkódok

Code Description
200 OK gombra. A válasz a kért szószedet-kifejezést tartalmazza.
404 NotFound. A kifejezés nem található.

Content-Type

application/json

Fejléc

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

Törzs

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

Frissítés

Frissítések egyetlen szószedetkifejezést.

Kérés

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

Megjegyzés

Egyes HTTP-ügyfél-implementációk automatikusan újra kibocsáthatják a kéréseket a kiszolgáló 302-re válaszul, de általában eltávolítják az engedélyezési fejléceket a kérelemből. Mivel az Engedélyezési fejléc szükséges az ADC-hez irányuló kérések teljesítéséhez, meg kell győződnie arról, hogy az Engedélyezési fejléc továbbra is meg van adva az ADC által megadott átirányítási helyre irányuló kérés ismételt kiadásakor. Az alábbiakban egy mintakód mutatja be ezt a .NET HttpWebRequest objektummal.

Uri-paraméterek

Név Leírás Adattípus
catalog_name A katalógus neve vagy "DefaultCatalog" az alapértelmezett katalógus használatához. Sztring
glossary_name A szószedet neve, amely alapértelmezés szerint megegyezik a catalog_name. Az alapértelmezett szószedetet a "DefaultGlossary" használatával választhatja ki. Sztring
term_id Szószedetkifejezés azonosítója. Sztring
api-verzió Az API-verzió. Sztring

PUT példa

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

Fejléc

Content-Type: application/json x-ms-client-request-id: 13c45c14... 46ab469473f0 Engedélyezés: Tulajdonos eyJ0eX ... FWSXfwtQ

 #### Példa törzsre
{  
  "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"  
    }  
  ]  
}

Reagálás

Állapotkódok

Code Description
200 Oké. Egy meglévő kifejezés frissült.
404 NotFound. A kifejezés nem található.
409 Konfliktus. Az ismétlődő kifejezésnév már létezik ugyanabban a szülőkifejezésben.
412 Az előfeltétel nem sikerült. A kérés az ETag eltérése miatt megszakadt.

Content-Type

application/json

Fejléc

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