데이터 분류 API

  • 릴리스 버전: Zurich
  • 업데이트 날짜 2025년 07월 31일
  • 소요 시간: 12분

    • 데이터 분류 API는 유형별로 데이터를 그룹화하기 위한 엔드포인트를 제공합니다.

    Data Classification API를 사용하여 다음을 수행할 수 있습니다.
    • 기존 딕셔너리 항목에 데이터 분류를 할당합니다.
    • 특정 딕셔너리 항목에 대한 데이터 분류를 조회합니다.
    • 특정 딕셔너리 항목과 연결된 모든 데이터 분류를 제거합니다.
    • 현재 도메인에서 사용할 수 있는 모든 데이터 분류 목록을 검색합니다.

    이 API에는 데이터 분류 [com.glide.data_classification] 플러그인이 필요합니다.

    자세한 내용은 데이터 분류를 참조하십시오.

    데이터 분류 - GET /data_classification/getAllDataClasses

    현재 도메인에서 사용할 수 있는 모든 데이터 분류의 목록을 반환합니다.

    관리자, data_classification_admin 또는 data_classification_auditor 역할이 필요합니다.

    URL 형식

    기본 URL: /api/now/data_classification/getAllDataClasses

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    없음
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 4. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 요청의 결과입니다. 사용 가능한 각 데이터 분류의 sys_id와 이름을 반환합니다. 데이터 분류가 없으면 빈 배열을 반환합니다.

    데이터 분류는 상위-하위 관계로 구성할 수 있습니다. 상위 데이터 분류가 있는 경우 결과에서 식별됩니다.

    데이터 유형: 객체 배열

    "result": [
  {
    "name": "String",
    "parent": {Object},
    "sys_id": "String"
  }
]
    result.name 데이터 분류의 이름입니다.

    데이터 유형: 문자열
    결과.부모 상위 데이터 분류에 대한 항목입니다.

    데이터 유형: 객체

    "parent": {
  "name": "String",
  "sys_id": "String"
}
    result.parent.name 상위 데이터 분류의 이름입니다.

    데이터 유형: 문자열
    result.parent.sys_id 상위 데이터 분류 기록의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 데이터 분류 [data_classification]
    result.sys_id 데이터 분류 기록의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 데이터 분류 [data_classification]

    cURL 요청

    사용 가능한 모든 데이터 분류 목록을 조회합니다.

    curl "https://instance.servicenow.com/api/now/data_classification/getAllDataClasses" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
    {
  "result": [
    {
      "parent": {
        "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
        "name": "Confidential"
      },
      "sys_id": "348107b951d71010f877f3f178e7dd0d",
      "name": "Personally identifiable information"
    },
    {
      "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
      "name": "Confidential"
    },
    {
      "sys_id": "59b7070b73fc1010ae8dd21efaf6a764",
      "name": "Restricted"
    },
    {
      "sys_id": "11d60fc773fc1010ae8dd21efaf6a744",
      "name": "Internal"
    },
    {
      "sys_id": "f5b4cf4773fc1010ae8dd21efaf6a766",
      "name": "Public"
    }
  ]
}

    데이터 분류 - POST /data_classification/classify

    사전 정의 또는 사용자 정의 데이터 분류를 기존 딕셔너리 항목에 할당합니다.

    관리자 또는 data_classification_admin 역할이 필요합니다.

    URL 형식

    기본 URL: /api/now/data_classification/classify

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    없음
    표 8. 쿼리 매개변수
    이름 설명
    없음
    표 9. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    dictionary_entries 필수
    분류하려는 기록의 Sys_ids입니다. 문자열로 묶인 쉼표로 구분된 목록으로 입력됩니다.

    테이블: 딕셔너리 [sys_dictionary] 테이블

    데이터 유형: 문자열
    data_classes 필수
    할당하려는 데이터 분류의 Sys_ids입니다. 문자열로 묶인 쉼표로 구분된 목록으로 입력됩니다.

    테이블: 데이터 분류 [data_classification]

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 10. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    콘텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 11. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 12. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 운영 결과를 설명하는 메시지입니다.

    데이터 유형: 문자열

    cURL 요청

    사전 항목에 데이터 분류를 할당합니다.

    curl "https://instance.servicenow.com/api/now/data_classification/classify" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\",
    \"data_classes\": \"40edb1f51bbcec50b92a10a61a4bcb8a\"
}" \
--user 'username':'password'

    {
  "result": "Successfully stored the data classification configurations"
}

    데이터 분류 - POST /data_classification/지우기

    지정된 딕셔너리 항목에 대한 모든 데이터 분류를 제거합니다.

    관리자 또는 data_classification_admin 역할이 필요합니다.

    URL 형식

    기본 URL: /api/now/data_classification/clear

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    없음
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    dictionary_entries 필수
    분류를 제거하려는 기록의 Sys_ids입니다. 문자열로 묶인 쉼표로 구분된 목록으로 입력됩니다.

    테이블: 딕셔너리 [sys_dictionary]

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 16. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    콘텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 18. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 운영 결과를 설명하는 메시지입니다.

    데이터 유형: 문자열

    cURL 요청

    딕셔너리 항목에 대한 데이터 분류를 지웁니다.

    curl "https://instance.servicenow.com/api/now/data_classification/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\"
}" \
--user 'username':'password'

    {
  "result": "Classifications removed for the specified dictionary entries"
}

    데이터 분류 - POST /data_classification/getClassification

    지정된 딕셔너리 항목에 대한 모든 데이터 분류를 검색합니다.

    관리자, data_classification_admin 또는 data_classification_auditor 역할이 필요합니다.

    URL 형식

    기본 URL: /api/now/data_classification/getClassification

    지원되는 요청 매개변수

    표 19. 경로 매개변수
    이름 설명
    없음
    표 20. 쿼리 매개변수
    이름 설명
    없음
    표 21. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    dictionary_entries 필수
    분류를 검색할 기록의 Sys_ids입니다. 문자열로 묶인 쉼표로 구분된 목록으로 입력됩니다.

    테이블: 딕셔너리 [sys_dictionary]

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 22. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    콘텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 23. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 24. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    결과 요청의 결과입니다. 연결된 데이터 분류의 배열과 함께 각 사전 항목의 sys_id 포함하는 JSON 객체를 반환합니다. 연결된 데이터 분류가 없는 경우 작업 결과를 설명하는 메시지를 반환합니다.

    데이터 분류는 상위-하위 관계로 구성할 수 있습니다. 상위 데이터 분류가 있는 경우 결과에서 식별됩니다.

    데이터 유형: 객체

    "result": {
  <sys_dictionary_sys_id>: [
    {
      "name": "String",
      "parent": {Object},
      "sys_id": "String"
    }
  ]
}
    result.name 데이터 분류의 이름입니다.

    데이터 유형: 문자열
    결과.부모 상위 데이터 분류에 대한 항목입니다.

    데이터 유형: 객체

    "parent": {
  "name": "String",
  "sys_id": "String"
}
    result.parent.name 상위 데이터 분류의 이름입니다.

    데이터 유형: 문자열
    result.parent.sys_id 상위 데이터 분류 기록의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 데이터 분류 [data_classification]
    result.sys_id 데이터 분류 기록의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 데이터 분류 [data_classification]

    cURL 요청

    특정 딕셔너리 항목과 연결된 데이터 분류를 가져옵니다.

    curl "https://instance.servicenow.com/api/now/data_classification/getClassification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\"
}" \
--user 'username':'password'

    {
  "result": {
    "445de0a6dba30300efc57416bf9619b0": [
      {
        "parent": {
          "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
          "name": "Confidential"
        },
        "sys_id": "348107b951d71010f877f3f178e7dd0d",
        "name": "Personally identifiable information"
      }
    ]
  }
}