Condividi tramite

Glossario (API REST di Azure Data Catalog)

  • Articolo

Crea

Crea un singolo termine di glossario.

Richiesta

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

Nota

Alcune implementazioni client HTTP possono rimettere automaticamente richieste in risposta a 302 dal server, ma in genere stripare le intestazioni di autorizzazione dalla richiesta. Poiché l'intestazione di autorizzazione è necessaria per effettuare richieste ad ADC, è necessario assicurarsi che l'intestazione di autorizzazione venga ancora fornita quando si esegue nuovamente una richiesta a un percorso di reindirizzamento specificato da ADC. Di seguito è riportato il codice di esempio che illustra questa operazione usando l'oggetto .NET HttpWebRequest.

Parametri dell'URI

Nome Descrizione Tipo di dati
catalog_name Nome del catalogo o "DefaultCatalog" per usare il catalogo predefinito. string
glossary_name Nome del glossario, che è predefinito come catalog_name. Usare "Default Glossariary" per scegliere il glossario predefinito. string
api-version La versione delle API. string

Esempio di 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
Esempio di corpo ####
{  
  "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"  
    }  
  ]  
}

Nota:

  1. Se il corpo non include "parentId", il termine creato sarà un termine radice e non ha un elemento padre.
  2. Due termini non possono avere lo stesso nome se hanno lo stesso termine padre.

Risposta

Codici di stato

Codice Descrizione
201 Creazione riuscita. La richiesta è stata soddisfatta e è stato creato un nuovo termine.
409 Conflitto. Il nome del termine duplicato esiste già nello stesso termine padre.

Content-Type

application/json

Intestazione

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

Elimina

Elimina un singolo termine di glossario.

Richiesta

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

Nota

Alcune implementazioni client HTTP possono rimettere automaticamente richieste in risposta a 302 dal server, ma in genere stripare le intestazioni di autorizzazione dalla richiesta. Poiché l'intestazione di autorizzazione è necessaria per effettuare richieste ad ADC, è necessario assicurarsi che l'intestazione di autorizzazione venga ancora fornita quando si esegue nuovamente una richiesta a un percorso di reindirizzamento specificato da ADC. Di seguito è riportato il codice di esempio che illustra questa operazione usando l'oggetto .NET HttpWebRequest.

Parametri dell'URI

Nome Descrizione Tipo di dati
catalog_name Nome del catalogo o "DefaultCatalog" per usare il catalogo predefinito. string
glossary_name Nome del glossario, che è predefinito come catalog_name. Usare "Default Glossariary" per scegliere il glossario predefinito. string
term_id ID di un termine di glossario. string
api-version La versione delle API. string

Esempio di 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

Intestazione

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

Risposta

Codici di stato

Codice Descrizione
204 NoContent. Il termine non esiste o l'eliminazione ha avuto esito positivo.
404 Notfound. Il termine non viene trovato.
412 Precondizione non riuscita. La richiesta è stata annullata a causa della mancata corrispondenza ETag.

Nota

La semantica Elimina operazione è "delete if exists", quindi se il termine non esiste codice di stato riuscito 204 (NoContent) verrà restituito.

Content-Type

application/json

Intestazione

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

Enumerazione

Enumera tutti i termini in un glossario.

Richiesta

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

Nota

Alcune implementazioni client HTTP possono rimettere automaticamente richieste in risposta a 302 dal server, ma in genere stripare le intestazioni di autorizzazione dalla richiesta. Poiché l'intestazione di autorizzazione è necessaria per effettuare richieste ad ADC, è necessario assicurarsi che l'intestazione di autorizzazione venga ancora fornita quando si esegue nuovamente una richiesta a un percorso di reindirizzamento specificato da ADC. Di seguito è riportato il codice di esempio che illustra questa operazione usando l'oggetto .NET HttpWebRequest.

Parametri dell'URI

Nome Descrizione Tipo di dati
catalog_name Nome del catalogo o "DefaultCatalog" per usare il catalogo predefinito. string
glossary_name Nome del glossario, che per impostazione predefinita è uguale a catalog_name. Usare "Glossario predefinito" per scegliere il glossario predefinito. string
api-version La versione delle API. string

Esempio GET

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

Intestazione

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

Risposta

Codici di stato

Codice Descrizione
200 OK. La risposta contiene un elenco di termini di glossario.

Content-Type

application/json

Intestazione

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

Corpo

Nota

Ogni operazione di enumerazione restituisce al massimo 1000 termini. Se nel glossario sono presenti più di 1000 termini, nella risposta verrà incluso un "nextLink" per l'enumerazione continua.

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

Recupero

Ottiene un singolo termine di glossario.

Richiesta

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

Nota

Alcune implementazioni client HTTP possono inviare automaticamente richieste in risposta a 302 dal server, ma in genere rimuovere le intestazioni di autorizzazione dalla richiesta. Poiché l'intestazione Authorization è necessaria per effettuare richieste ad ADC, è necessario assicurarsi che l'intestazione authorization sia ancora specificata quando si esegue di nuovo una richiesta a un percorso di reindirizzamento specificato da ADC. Di seguito è riportato il codice di esempio che illustra questa operazione usando l'oggetto .NET HttpWebRequest.

Parametri dell'URI

Nome Descrizione Tipo di dati
catalog_name Nome del catalogo o "DefaultCatalog" per usare il catalogo predefinito. string
glossary_name Nome del glossario, che per impostazione predefinita è uguale a catalog_name. Usare "Glossario predefinito" per scegliere il glossario predefinito. string
term_id ID di un termine di glossario. string
api-version La versione delle API. string

Esempio 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

Intestazione

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

Risposta

Codici di stato

Codice Descrizione
200 OK. La risposta contiene il termine glossario richiesto.
404 Notfound. Termine non trovato.

Content-Type

application/json

Intestazione

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

Corpo

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

Aggiornamento

Aggiornamenti un singolo termine di glossario.

Richiesta

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

Nota

Alcune implementazioni client HTTP possono inviare automaticamente richieste in risposta a 302 dal server, ma in genere rimuovere le intestazioni di autorizzazione dalla richiesta. Poiché l'intestazione Authorization è necessaria per effettuare richieste ad ADC, è necessario assicurarsi che l'intestazione authorization sia ancora specificata quando si esegue di nuovo una richiesta a un percorso di reindirizzamento specificato da ADC. Di seguito è riportato il codice di esempio che illustra questa operazione usando l'oggetto .NET HttpWebRequest.

Parametri dell'URI

Nome Descrizione Tipo di dati
catalog_name Nome del catalogo o "DefaultCatalog" per usare il catalogo predefinito. string
glossary_name Nome del glossario, che per impostazione predefinita è uguale a catalog_name. Usare "Glossario predefinito" per scegliere il glossario predefinito. string
term_id ID di un termine di glossario. string
api-version La versione delle API. string

Esempio di 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

Intestazione

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

 Esempio di corpo ####
{  
  "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"  
    }  
  ]  
}

Risposta

Codici di stato

Codice Descrizione
200 OK. È stato aggiornato un termine esistente.
404 Notfound. Termine non trovato.
409 Conflitto. Il nome del termine duplicato esiste già con lo stesso termine padre.
412 Precondizione non riuscita. La richiesta è stata annullata a causa della mancata corrispondenza ETag.

Content-Type

application/json

Intestazione

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