다음을 통해 공유

용어집(Azure Data Catalog REST API)

  • 아티클

만들기

단일 용어집 용어를 만듭니다.

요청

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

참고

일부 HTTP 클라이언트 구현은 서버의 302에 대한 응답으로 요청을 자동으로 다시 실행할 수 있지만 일반적으로 요청에서 권한 부여 헤더를 제거할 수 있습니다. ADC에 대한 요청을 수행하려면 권한 부여 헤더가 필요하므로 ADC에서 지정한 리디렉션 위치로 요청을 다시 발급할 때 권한 부여 헤더가 계속 제공되는지 확인해야 합니다. 다음은 .NET HttpWebRequest 개체를 사용하여 이를 보여주는 샘플 코드입니다.

URI 매개 변수

속성 Description 데이터 형식
catalog_name 카탈로그의 이름 또는 기본 카탈로그를 사용하는 "DefaultCatalog"입니다. 문자열
glossary_name 용어집의 이름이며, 기본값은 catalog_name. "DefaultGlossary"를 사용하여 기본 용어집을 선택합니다. String
api-version API 버전입니다. 문자열

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
#### 본문 예제
{  
  "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"  
    }  
  ]  
}

고:

  1. 본문에 "parentId"가 포함되지 않은 경우 만든 용어는 루트 용어이며 부모가 없습니다.
  2. 두 용어는 동일한 부모 용어가 있는 경우 동일한 이름을 가질 수 없습니다.

응답

상태 코드

코드 설명
201 만들어졌습니다. 요청이 처리되고 새 용어가 만들어졌습니다.
409 충돌. 동일한 부모 용어에 중복 용어 이름이 이미 있습니다.

콘텐츠 형식

application/json

헤더

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

삭제

단일 용어집 용어를 삭제합니다.

요청

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

참고

일부 HTTP 클라이언트 구현은 서버의 302에 대한 응답으로 요청을 자동으로 다시 실행할 수 있지만 일반적으로 요청에서 권한 부여 헤더를 제거할 수 있습니다. ADC에 대한 요청을 수행하려면 권한 부여 헤더가 필요하므로 ADC에서 지정한 리디렉션 위치로 요청을 다시 발급할 때 권한 부여 헤더가 계속 제공되는지 확인해야 합니다. 다음은 .NET HttpWebRequest 개체를 사용하여 이를 보여주는 샘플 코드입니다.

URI 매개 변수

속성 Description 데이터 형식
catalog_name 카탈로그의 이름 또는 기본 카탈로그를 사용하는 "DefaultCatalog"입니다. 문자열
glossary_name 용어집의 이름이며, 기본값은 catalog_name. "DefaultGlossary"를 사용하여 기본 용어집을 선택합니다. 문자열
term_id 용어집 용어의 ID입니다. String
api-version API 버전입니다. 문자열

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

헤더

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

응답

상태 코드

코드 Description
204 NoContent. 용어가 없거나 삭제에 성공했습니다.
404 NotFound. 용어를 찾을 수 없습니다.
412 사전 조건이 실패했습니다. ETag 불일치로 인해 요청이 취소되었습니다.

참고

삭제 작업 의미 체계는 "있는 경우 삭제"이므로 용어가 없는 경우 성공 상태 코드 204(NoContent)가 반환됩니다.

콘텐츠 형식

application/json

헤더

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

열거

용어집의 모든 용어를 열거합니다.

요청

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

참고

일부 HTTP 클라이언트 구현은 서버의 302에 대한 응답으로 요청을 자동으로 다시 실행할 수 있지만 일반적으로 요청에서 권한 부여 헤더를 제거할 수 있습니다. ADC에 대한 요청을 수행하려면 권한 부여 헤더가 필요하므로 ADC에서 지정한 리디렉션 위치로 요청을 다시 발급할 때 권한 부여 헤더가 계속 제공되는지 확인해야 합니다. 다음은 .NET HttpWebRequest 개체를 사용하여 이를 보여주는 샘플 코드입니다.

URI 매개 변수

속성 Description 데이터 형식
catalog_name 카탈로그의 이름 또는 기본 카탈로그를 사용하는 "DefaultCatalog"입니다. 문자열
glossary_name 용어집의 이름이며, 기본값은 catalog_name. "DefaultGlossary"를 사용하여 기본 용어집을 선택합니다. String
api-version API 버전입니다. 문자열

GET 예제

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

헤더

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

응답

상태 코드

코드 Description
200 OK. 응답에는 용어집 용어 목록이 포함됩니다.

콘텐츠 형식

application/json

헤더

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

본문

참고

각 열거형 작업은 최대 1000개의 용어를 반환합니다. 용어집에 1000개 이상의 용어가 있는 경우 연속 열거형에 대한 응답에 "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 https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms/{term_id}?api-version={api-version}

참고

일부 HTTP 클라이언트 구현은 서버의 302에 대한 응답으로 요청을 자동으로 다시 실행할 수 있지만 일반적으로 요청에서 권한 부여 헤더를 제거할 수 있습니다. ADC에 대한 요청을 수행하려면 권한 부여 헤더가 필요하므로 ADC에서 지정한 리디렉션 위치에 요청을 다시 발급할 때 권한 부여 헤더가 계속 제공되는지 확인해야 합니다. 다음은 .NET HttpWebRequest 개체를 사용하여 이를 보여주는 샘플 코드입니다.

URI 매개 변수

속성 Description 데이터 형식
catalog_name 카탈로그의 이름 또는 기본 카탈로그를 사용할 "DefaultCatalog"입니다. 문자열
glossary_name 용어집의 이름이며, 기본값은 catalog_name. "DefaultGlossary"를 사용하여 기본 용어집을 선택합니다. 문자열
term_id 용어집 용어의 ID입니다. String
api-version API 버전입니다. 문자열

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

헤더

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

응답

상태 코드

코드 Description
200 OK. 응답에는 요청된 용어집 용어가 포함됩니다.
404 NotFound. 용어를 찾을 수 없습니다.

콘텐츠 형식

application/json

헤더

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

본문

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

업데이트

단일 용어집 용어를 업데이트.

요청

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

참고

일부 HTTP 클라이언트 구현은 서버의 302에 대한 응답으로 요청을 자동으로 다시 실행할 수 있지만 일반적으로 요청에서 권한 부여 헤더를 제거할 수 있습니다. ADC에 대한 요청을 수행하려면 권한 부여 헤더가 필요하므로 ADC에서 지정한 리디렉션 위치에 요청을 다시 발급할 때 권한 부여 헤더가 계속 제공되는지 확인해야 합니다. 다음은 .NET HttpWebRequest 개체를 사용하여 이를 보여주는 샘플 코드입니다.

URI 매개 변수

속성 Description 데이터 형식
catalog_name 카탈로그의 이름 또는 기본 카탈로그를 사용할 "DefaultCatalog"입니다. 문자열
glossary_name 용어집의 이름이며, 기본값은 catalog_name. "DefaultGlossary"를 사용하여 기본 용어집을 선택합니다. 문자열
term_id 용어집 용어의 ID입니다. String
api-version API 버전입니다. 문자열

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

헤더

Content-Type: application/json x-ms-client-request-id: 13c45c14... 46ab469473f0 권한 부여: 전달자 eyJ0eX ... FWSXfwtQ

 #### 본문 예제
{  
  "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"  
    }  
  ]  
}

응답

상태 코드

코드 Description
200 정상. 기존 용어가 업데이트되었습니다.
404 NotFound. 용어를 찾을 수 없습니다.
409 충돌. 동일한 부모 용어에 중복 용어 이름이 이미 있습니다.
412 사전 조건이 실패했습니다. ETag 불일치로 인해 요청이 취소되었습니다.

콘텐츠 형식

application/json

헤더

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