Cdm스냅샷API

CdmSnapshotApi는 CDM(스냅샷)에서 스냅샷을 게시, 게시 취소 및 다시 검증할 수 있는 엔드포인트를 구성 데이터 관리 제공합니다.

익스포트할 수 있도록 스냅샷을 게시하면 파이프라인이 Continuous Integration and Continuous Delivery(CICD) 연결된 구성 데이터에 액세스하고 사용할 수 있습니다. 익스포터는 게시된 스냅샷에서만 실행할 수 있습니다. 스냅샷이 더 이상 필요하지 않은 경우 스냅샷의 게시를 취소하여 스냅샷이 더 이상 실행 가능한지 여부에 대한 혼란을 줄일 수 있습니다.

이 API에 액세스하려면 다음 역할 중 하나가 있어야 합니다.

• 스크립팅된 REST CDM 뷰 ACL(sn_cdm.cdm.viewer)
• 스크립팅된 REST CDM 편집기 ACL(sn_cdm.cdm_editor)

또한 인스턴스에서 구성 데이터 관리 이 API를 사용하려면 (CDM) 플러그인이 활성화되어 있어야 합니다.

스냅샷에 대한 자세한 내용은 스냅샷 보기 섹션을 참조하세요.

CdmSnapshotAPI - POST /sn_cdm/snapshots/{snapshot_id}/publish

지정된 게시되지 않은 스냅샷을 게시합니다.

스냅샷을 게시하려면 먼저 유효성을 검사해야 합니다. 엔드포인트를 CdmSnapshotAPI - POST /sn_cdm/snapshots/{snapshot_id}/validate 사용하여 스냅샷의 유효성을 검사하거나 커밋을 수행할 때 자동으로 유효성을 검사하도록 할 수 있습니다. 스냅샷을 게시하려면 배포 가능 항목을 서비스에 연결해야 합니다. 또한 스냅샷이 이미 게시된 경우 요청이 실패합니다.

URL 형식

버전이 지정된 URL: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/publish

기본 URL: /api/sn_cdm/snapshots/{snapshot_id}/publish

지원되는 요청 매개변수

표 1. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
snapshot_id	처리할 스냅샷 기록의 Sys_id입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열

표 2. 쿼리 매개변수

이름	설명
없음

표 3. 요청 본문 매개변수(XML 또는 JSON)

이름	설명
없음

헤더

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

표 4. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 5. 응답 헤더

헤더	설명
없음

상태 코드

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

표 6. 상태 코드

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

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

이름	설명
오류	처리 중에 오류가 발생한 경우 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" }
오류.상세 정보	오류에 대한 추가 정보입니다. 데이터 유형: 문자열
오류.메시지	요청을 처리하는 동안 생성된 오류 메시지입니다. 데이터 유형: 문자열
상태	요청의 오류 상태입니다. 가능한 값: 실패 데이터 유형: 문자열

cURL 요청

다음 예제에서는 sys_id 3a168d9dc342301054c1582e1340dd68을 사용하여 스냅샷을 게시하는 방법을 보여 줍니다.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/publish"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

다음은 게시 요청에 대한 성공 및 실패 응답을 모두 보여 줍니다.

// Example of a successful response
{ 
  "" 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in publish request.Error:Snapshot not found",
    "detail": ""
  },
  "status": "failure"
}

CdmSnapshotAPI - POST /sn_cdm/snapshots/{snapshot_id}/unpublish

이전에 게시된 스냅샷의 게시를 취소합니다.

URL 형식

버전이 지정된 URL: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/unpublish

기본 URL: /api/sn_cdm/snapshots/{snapshot_id}/unpublish

지원되는 요청 매개변수

표 7. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
snapshot_id	처리할 스냅샷 기록의 Sys_id입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열

표 8. 쿼리 매개변수

이름	설명
없음

표 9. 요청 본문 매개변수(XML 또는 JSON)

이름	설명
없음

헤더

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

표 10. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 11. 응답 헤더

헤더	설명
없음

상태 코드

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

표 12. 상태 코드

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

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

이름	설명
오류	처리 중에 오류가 발생한 경우 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" }
오류.상세 정보	오류에 대한 추가 정보입니다. 데이터 유형: 문자열
오류.메시지	요청을 처리하는 동안 생성된 오류 메시지입니다. 데이터 유형: 문자열
상태	요청의 오류 상태입니다. 가능한 값: 실패 데이터 유형: 문자열

cURL 요청

다음 예제에서는 sys_id가 3a168d9dc342301054c1582e1340dd68인 스냅샷의 게시를 취소하는 방법을 보여 줍니다.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/unpublish"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

다음은 게시 취소 요청에 대한 성공 및 실패 응답을 모두 보여 줍니다.

// Example of a successful response
{ 
  "" 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in publish request.Error:Snapshot not found",
    "detail": ""
  },
  "status": "failure"
}

CdmSnapshotAPI - POST /sn_cdm/snapshots/{snapshot_id}/validate

지정된 게시되지 않은 스냅샷을 확인합니다.

유효성 검사는 비동기 프로세스로 수행됩니다. 이 엔드포인트를 호출하면 유효성 검사 프로세스만 시작됩니다. 이 호출의 반환 결과는 유효성 검사 자체의 결과가 아니라 유효성 검사 프로세스가 시작되었는지 여부만 나타냅니다. 스냅샷이 검증되었는지 확인하려면 Table API를 사용하여 스냅샷을 찾고 검증 상태를 확인합니다.

주:

게시된 스냅샷의 유효성을 확인할 수 없습니다.

URL 형식

버전이 지정된 URL: /api/sn_cdm/{api_version}/snapshots/{snapshot_id}/validate

기본 URL: /api/sn_cdm/snapshots/{snapshot_id}/validate

지원되는 요청 매개변수

표 13. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
snapshot_id	처리할 스냅샷 기록의 Sys_id입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열

표 14. 쿼리 매개변수

이름	설명
없음

표 15. 요청 본문 매개변수(XML 또는 JSON)

이름	설명
없음

헤더

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

표 16. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 17. 응답 헤더

헤더	설명
없음

상태 코드

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

표 18. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 지정한 스냅샷이 이미 게시되었거나 스냅샷을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

이름	설명
오류	처리 중에 오류가 발생한 경우 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" }
오류.상세 정보	오류에 대한 추가 정보입니다. 데이터 유형: 문자열
오류.메시지	요청을 처리하는 동안 생성된 오류 메시지입니다. 데이터 유형: 문자열
상태	요청의 오류 상태입니다. 가능한 값: 실패 데이터 유형: 문자열

cURL 요청

다음 예제에서는 sys_id가 3a168d9dc342301054c1582e1340dd68인 스냅샷의 유효성을 검사하는 방법을 보여 줍니다.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/validate"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password' 

다음은 유효성 검사 요청에 대한 성공 및 실패 응답을 모두 보여 줍니다.

// Example of a successful response
{ 
  "" 
}

// Example of an error response
{
  "error": {
    "message": "Invalid Snapshot id:test",
    "detail": ""
  },
  "status": "failure"
}

CdmSnapshotApi - PUT /sn_cdm/snapshots/publish

지정된 게시되지 않은 스냅샷을 게시합니다.

스냅샷을 게시하려면 먼저 유효성을 검사해야 합니다. 엔드포인트를 CdmSnapshotApi - PUT /sn_cdm/snapshots/validate 사용하여 스냅샷의 유효성을 검사하거나 커밋을 수행할 때 자동으로 유효성을 검사하도록 할 수 있습니다. 스냅샷을 게시하려면 배포 가능 항목을 서비스에 연결해야 합니다. 또한 스냅샷이 이미 게시된 경우 요청이 실패합니다.

이 엔드포인트의 호출자는 CDM 편집자 역할을 가지고 있어야 합니다.

URL 형식

버전이 지정된 URL: /api/sn_cdm/{api_version}/snapshots/publish

기본 URL: /api/sn_cdm/snapshots/publish

지원되는 요청 매개변수

표 19. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 20. 쿼리 매개변수

이름	설명
appName	필수 스냅샷을 구성 데이터 관리 생성할 (CDM) 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다. 데이터 유형: 문자열
'deployableName'	필수 스냅샷을 생성할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다. 데이터 유형: 문자열
이름	필수 스냅샷의 이름입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열
returnFields	응답의 일부로 반환할 필드 목록입니다. sys_id, sys_updated_by 또는 state와 같은 기록 열 이름을 전달합니다. 데이터 유형: 배열 기본값: 엔드포인트에 의해 결정된 모든 필드

표 21. 요청 본문 매개변수

이름	설명
없음

헤더

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

표 22. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 23. 응답 헤더

헤더	설명
없음

상태 코드

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

표 24. 상태 코드

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

응답 본문 매개변수

이름	설명
cdm_application_id	스냅샷과 연결된 CDM 애플리케이션에 대한 상세 정보입니다. 데이터 유형: 객체 "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.링크	REST 테이블 API를 사용하여 CDM 애플리케이션 기록에 접근하는 데 사용할 호출입니다. 데이터 유형: 문자열
cdm_application_id.값	연결된 CDM 애플리케이션 기록의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다. 데이터 유형: 문자열
cdm_deployable_id	스냅샷과 연결된 CDM 배포 가능 항목에 대한 상세 정보입니다. 데이터 유형: 객체 "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.링크	테이블 REST API를 사용하여 이 배포 가능 기록을 쿼리하기 위한 호출 구문입니다. 데이터 유형: 문자열
cdm_deployable_id.value	배포 가능 기록의 Sys_id입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다. 데이터 유형: 문자열
changeset_id	스냅샷과 연결된 변경 세트에 대한 상세 정보입니다. 데이터 유형: 객체 "changeset_id": { "link": "String", "value": "String" }
changeset_id.링크	테이블 REST API를 사용하여 이 변경 세트 기록을 쿼리하기 위한 호출 구문입니다. 데이터 유형: 문자열
changeset_id.value	변경 세트 기록의 고유 식별자입니다. CDM 변경 세트 [sn_cdm_changeset] 테이블에 있습니다. 데이터 유형: 문자열
설명	스냅샷에 대한 간략한 설명입니다. 데이터 유형: 문자열
오류	처리 중에 오류가 발생한 경우 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" }
오류.상세 정보	오류에 대한 추가 정보입니다. 데이터 유형: 문자열
오류.메시지	요청을 처리하는 동안 생성된 오류 메시지입니다. 데이터 유형: 문자열
last_published	스냅샷이 마지막으로 게시된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
last_validated	스냅샷의 유효성이 마지막으로 검사된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
이름	스냅샷의 이름입니다. 데이터 유형: 문자열
번호	스냅샷을 식별하는 고유 번호입니다. 이 값은 매핑에 대해 사용자가 읽을 수 있는 식별자를 제공합니다. 데이터 유형: 문자열
게시 날짜:	스냅샷이 게시되었는지 여부를 나타내는 플래그입니다. 가능한 값: true: 스냅샷이 게시되었습니다. false: 스냅샷이 게시되지 않았습니다. 데이터 유형: 부울
sys_created_by	스냅샷을 생성한 사용자의 이름입니다. 데이터 유형: 문자열
sys_created_on	스냅샷이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
sys_id	스냅샷의 Sys_id입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열
sys_updated_by	스냅샷을 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열
sys_updated_on	스냅샷이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
확인	스냅샷의 현재 확인 상태입니다. 가능한 값: execution_error 실패 in_progress not_validated 전달 passed_with_exception requested 데이터 유형: 문자열

cURL 요청

이 코드 예제에서는 스냅숏을 게시하는 방법을 보여 줍니다.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/publish?deployableName=Development_1&name=Development_1-v1.dpl&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

반환 결과:

 
{ 
  "result": { 
    "changeset_id": { 
      "value": "d4b9446e53001110a1d3ddeeff7b126c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
    }, 
    "cdm_deployable_id": { 
      "value": "6dc517a953b70110a1d3ddeeff7b129b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
    }, 
    "description": null, 
    "cdm_application_id": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "published": true, 
    "sys_updated_on": "2022-06-30 12:57:02", 
    "last_published": "2022-06-30 12:57:02", 
    "number": "SNAP0001002", 
    "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-15 14:19:38", 
    "name": "Development_1-v2.dpl", 
    "last_validated": "2022-06-30 12:56:07", 
    "validation": "passed", 
    "sys_created_by": "admin" 
  } 
}

CdmSnapshotApi - PUT /sn_cdm/snapshots/unpublish

이전에 게시된 스냅샷의 게시를 취소합니다.

URL 형식

버전이 지정된 URL: /api/sn_cdm/{api_version}/snapshots/unpublish

기본 URL: /api/sn_cdm/snapshots/unpublish

지원되는 요청 매개변수

표 25. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 26. 쿼리 매개변수

이름	설명
appName	필수 스냅샷을 구성 데이터 관리 생성할 (CDM) 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다. 데이터 유형: 문자열
'deployableName'	필수 스냅샷을 생성할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다. 데이터 유형: 문자열
이름	필수 스냅샷의 이름입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열
returnFields	응답의 일부로 반환할 필드 목록입니다. sys_id, sys_updated_by 또는 state와 같은 기록 열 이름을 전달합니다. 데이터 유형: 배열 기본값: 엔드포인트에 의해 결정된 모든 필드

표 27. 요청 본문 매개변수

이름	설명
없음

헤더

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

표 28. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 29. 응답 헤더

헤더	설명
없음

상태 코드

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

표 30. 상태 코드

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

응답 본문 매개변수

이름	설명
cdm_application_id	스냅샷과 연결된 CDM 애플리케이션에 대한 상세 정보입니다. 데이터 유형: 객체 "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.링크	REST 테이블 API를 사용하여 CDM 애플리케이션 기록에 접근하는 데 사용할 호출입니다. 데이터 유형: 문자열
cdm_application_id.값	연결된 CDM 애플리케이션 기록의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다. 데이터 유형: 문자열
cdm_deployable_id	스냅샷과 연결된 CDM 배포 가능 항목에 대한 상세 정보입니다. 데이터 유형: 객체 "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.링크	테이블 REST API를 사용하여 이 배포 가능 기록을 쿼리하기 위한 호출 구문입니다. 데이터 유형: 문자열
cdm_deployable_id.value	배포 가능 기록의 Sys_id입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다. 데이터 유형: 문자열
changeset_id	스냅샷과 연결된 변경 세트에 대한 상세 정보입니다. 데이터 유형: 객체 "changeset_id": { "link": "String", "value": "String" }
changeset_id.링크	테이블 REST API를 사용하여 이 변경 세트 기록을 쿼리하기 위한 호출 구문입니다. 데이터 유형: 문자열
changeset_id.value	변경 세트 기록의 고유 식별자입니다. CDM 변경 세트 [sn_cdm_changeset] 테이블에 있습니다. 데이터 유형: 문자열
설명	스냅샷에 대한 간략한 설명입니다. 데이터 유형: 문자열
오류	처리 중에 오류가 발생한 경우 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" }
오류.상세 정보	오류에 대한 추가 정보입니다. 데이터 유형: 문자열
오류.메시지	요청을 처리하는 동안 생성된 오류 메시지입니다. 데이터 유형: 문자열
last_published	스냅샷이 마지막으로 게시된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
last_validated	스냅샷의 유효성이 마지막으로 검사된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
이름	스냅샷의 이름입니다. 데이터 유형: 문자열
번호	스냅샷을 식별하는 고유 번호입니다. 이 값은 매핑에 대해 사용자가 읽을 수 있는 식별자를 제공합니다. 데이터 유형: 문자열
게시 날짜:	스냅샷이 게시되었는지 여부를 나타내는 플래그입니다. 가능한 값: true: 스냅샷이 게시되었습니다. false: 스냅샷이 게시되지 않았습니다. 데이터 유형: 부울
sys_created_by	스냅샷을 생성한 사용자의 이름입니다. 데이터 유형: 문자열
sys_created_on	스냅샷이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
sys_id	스냅샷의 Sys_id입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열
sys_updated_by	스냅샷을 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열
sys_updated_on	스냅샷이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
확인	스냅샷의 현재 확인 상태입니다. 가능한 값: execution_error 실패 in_progress not_validated 전달 passed_with_exception requested 데이터 유형: 문자열

cURL 요청

이 코드 예제에서는 스냅숏 게시를 취소하는 방법을 보여 줍니다.

반환 결과:

CdmSnapshotApi - PUT /sn_cdm/snapshots/validate

매핑된 정책에 대해 지정된 게시되지 않은 스냅샷을 확인합니다.

유효성 검사는 비동기 프로세스로 수행됩니다. 이 엔드포인트를 호출하면 유효성 검사 프로세스만 시작됩니다. 이 호출의 반환 결과는 유효성 검사 자체의 결과가 아니라 유효성 검사 프로세스가 시작되었는지 여부만 나타냅니다. 스냅샷이 검증되었는지 확인하려면 Table API를 사용하여 스냅샷을 찾고 검증 상태를 확인합니다.

주:

게시된 스냅샷의 유효성을 확인할 수 없습니다.

이 엔드포인트의 호출자는 CDM 편집자 역할을 가지고 있어야 합니다.

URL 형식

버전이 지정된 URL: /api/sn_cdm/{api_version}/snapshots/validate

기본 URL: /api/sn_cdm/snapshots/validate

지원되는 요청 매개변수

표 31. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 32. 쿼리 매개변수

이름	설명
appName	필수 스냅샷을 구성 데이터 관리 생성할 (CDM) 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다. 데이터 유형: 문자열
'deployableName'	필수 스냅샷을 생성할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다. 데이터 유형: 문자열
이름	필수 스냅샷의 이름입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열
returnFields	응답의 일부로 반환할 필드 목록입니다. sys_id, sys_updated_by 또는 state와 같은 기록 열 이름을 전달합니다. 데이터 유형: 배열 기본값: 엔드포인트에 의해 결정된 모든 필드

표 33. 요청 본문 매개변수

이름	설명
없음

헤더

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

표 34. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 35. 응답 헤더

헤더	설명
없음

상태 코드

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

표 36. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 지정한 스냅샷이 이미 게시되었거나 스냅샷을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수

이름	설명
cdm_application_id	스냅샷과 연결된 CDM 애플리케이션에 대한 상세 정보입니다. 데이터 유형: 객체 "cdm_application_id": { "link": "String", "value": "String" }
cdm_application_id.링크	REST 테이블 API를 사용하여 CDM 애플리케이션 기록에 접근하는 데 사용할 호출입니다. 데이터 유형: 문자열
cdm_application_id.값	연결된 CDM 애플리케이션 기록의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다. 데이터 유형: 문자열
cdm_deployable_id	스냅샷과 연결된 CDM 배포 가능 항목에 대한 상세 정보입니다. 데이터 유형: 객체 "cdm_deployable_id": { "link": "String", "value": "String" }
cdm_deployable_id.링크	테이블 REST API를 사용하여 이 배포 가능 기록을 쿼리하기 위한 호출 구문입니다. 데이터 유형: 문자열
cdm_deployable_id.value	배포 가능 기록의 Sys_id입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다. 데이터 유형: 문자열
changeset_id	스냅샷과 연결된 변경 세트에 대한 상세 정보입니다. 데이터 유형: 객체 "changeset_id": { "link": "String", "value": "String" }
changeset_id.링크	테이블 REST API를 사용하여 이 변경 세트 기록을 쿼리하기 위한 호출 구문입니다. 데이터 유형: 문자열
changeset_id.value	변경 세트 기록의 고유 식별자입니다. CDM 변경 세트 [sn_cdm_changeset] 테이블에 있습니다. 데이터 유형: 문자열
설명	스냅샷에 대한 간략한 설명입니다. 데이터 유형: 문자열
오류	처리 중에 오류가 발생한 경우 오류에 대한 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" }
오류.상세 정보	오류에 대한 추가 정보입니다. 데이터 유형: 문자열
오류.메시지	요청을 처리하는 동안 생성된 오류 메시지입니다. 데이터 유형: 문자열
last_published	스냅샷이 마지막으로 게시된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
last_validated	스냅샷의 유효성이 마지막으로 검사된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
이름	스냅샷의 이름입니다. 데이터 유형: 문자열
번호	스냅샷을 식별하는 고유 번호입니다. 이 값은 매핑에 대해 사용자가 읽을 수 있는 식별자를 제공합니다. 데이터 유형: 문자열
게시 날짜:	스냅샷이 게시되었는지 여부를 나타내는 플래그입니다. 가능한 값: true: 스냅샷이 게시되었습니다. false: 스냅샷이 게시되지 않았습니다. 데이터 유형: 부울
sys_created_by	스냅샷을 생성한 사용자의 이름입니다. 데이터 유형: 문자열
sys_created_on	스냅샷이 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
sys_id	스냅샷의 Sys_id입니다. CDM 스냅샷 [sn_cdm_snapshot] 테이블에 있습니다. 데이터 유형: 문자열
sys_updated_by	스냅샷을 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열
sys_updated_on	스냅샷이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 형식: yyyy-mm-dd hh:mm:ss
확인	스냅샷의 현재 확인 상태입니다. 가능한 값: execution_error 실패 in_progress not_validated 전달 passed_with_exception requested 데이터 유형: 문자열

cURL 요청

이 코드 예제에서는 스냅숏의 유효성을 검사하는 방법을 보여 줍니다.

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/validate?name=Development_1-v2.dpl&deployableName=Development_1&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password' 

반환 결과:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d4b9446e53001110a1d3ddeeff7b126c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
    }, 
    "cdm_deployable_id": { 
      "value": "6dc517a953b70110a1d3ddeeff7b129b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
    }, 
    "description": null, 
    "cdm_application_id": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "published": false, 
    "sys_updated_on": "2022-06-30 12:57:02", 
    "last_published": "2022-06-30 12:57:02", 
    "number": "SNAP0001002", 
    "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-15 14:19:38", 
    "name": "Development_1-v2.dpl", 
    "last_validated": "2022-06-30 12:56:07", 
    "validation": "passed", 
    "sys_created_by": "admin" 
  } 
}