CICD(지속적 통합 및 지속적 제공) 업데이트 세트 API

CICD 업데이트 세트 API는 업데이트 세트를 만들고, 검색하고, 미리 보고, 커밋하고, 원상 복구하는 메서드를 제공합니다.

이 API는 시스템 업데이트 세트 에서 수행할 수 있는 작업과 연결되며 액세스하려면 sn_cicd.sys_ci_automation 역할과 CICD(지속적 통합 및 지속적 제공) REST API (com.glide.continuousdelivery) 플러그인이 필요합니다.

CICD 업데이트 세트 - POST /api/sn_cicd/update_set/retrieve

지정된 sys_id로 업데이트 세트를 검색하고 인스턴스에서 검색된 기존 업데이트 세트를 제거할 수 있습니다.

URL 형식

버전이 지정된 URL: /api/sn_cicd/{api_version}/update_set/retrieve

기본 URL: /api/sn_cicd/update_set/retrieve

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 1. 경로 매개변수

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

표 2. 쿼리 매개변수

이름	설명
update_set_id	필수 업데이트 세트가 검색된 소스 인스턴스에 있는 업데이트 세트의 Sys_id입니다. 테이블: 업데이트 세트 [sys_update_set] 데이터 유형: 문자열
update_source_id	원격 인스턴스 기록의 Sys_id입니다. 테이블: 원격 인스턴스 [sys_update_set_source] 데이터 유형: 문자열
update_source_instance_id	원격 인스턴스의 인스턴스 ID입니다. 테이블: 원격 인스턴스 [sys_update_set_source] 데이터 유형: 문자열
auto_preview	검색 후 업데이트 세트를 자동으로 미리 볼지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 검색 시 업데이트 세트를 미리 봅니다. false: 검색 시 업데이트 세트를 미리 않습니다. 데이터 유형: 부울 기본값: false
cleanup_retrieved	검색된 기존 업데이트 세트를 인스턴스에서 제거할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 업데이트 세트를 제거합니다. false: 업데이트 세트를 제거하지 않음 데이터 유형: 부울 기본값: false

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

이름	설명
안 함

머리글

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

표 4. 요청 헤더

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

상태 코드

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

표 5. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
403	금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

이름	설명
오류	오류에 대한 상세 정보가 포함된 오류 메시지입니다. 데이터 유형: 문자열
링크	업데이트 세트와 연관된 링크 및 sys_ids 대한 정보입니다. 데이터 유형: 객체 "links": { "progress": {Object} }
링크.진행률	업데이트 세트에서 수행된 작업에 대한 진행률 정보입니다. 데이터 유형: 객체 "progress": { "id": "String", "url": "String" }
links.progress.id	작업의 진행률 상세 정보를 포함하는 Sys_id. 끝점 CI/CD - GET /sn_cicd/progress/{progress_id}을 호출할 때 이 값을 사용할 수 있습니다. 데이터 유형: 문자열
링크.진행률.url	업데이트 세트에서 수행된 운영에 대한 진행률 상세 정보를 검색하는 데 사용할 URL입니다. 데이터 유형: 문자열
percent_complete	요청의 완료율입니다. 데이터 유형: 숫자
상태	업데이트 세트에서 수행된 작업의 실행 상태를 나타내는 번호입니다. 설명자에 status_label 해당합니다. 가능한 값: 0: 보류 중 1: 달리기 2: 성공 3: 실패 4: 취소됨 데이터 유형: 문자열
status_detail	실행 상태에 대한 자세한 메시지입니다(사용 가능한 경우). 실행 추적기 [sys_execution_tracker] 테이블의 detailed_message 필드에 해당합니다. 데이터 유형: 문자열
status_label	업데이트 세트 작업의 실행 상태입니다. 숫자에 status 해당 합니다. 가능한 값: 취소됨 실패함 보류 중 실행 중 성공 데이터 유형: 문자열
status_message	작업의 현재 상태에 대한 추가 설명입니다(사용 가능한 경우). 데이터 유형: 문자열

cURL 요청

다음 예에서는 지정된 sys_id 및 인스턴스 ID로 특정 업데이트 세트를 검색합니다.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/retrieve?update_set_id=2ce715950d619e10f87785462179bd67&update_source_id=e66613a49d011210f877036c70ae59f7" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

응답 본문. 업데이트 세트의 현재 상태 및 실행 진행률에 대한 상세 정보를 표시합니다.

{
  "result": {
    "links": {
      "progress": {
        "id": "e2ea3eedc92dde10f877184664aecd90",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/e2ea3eedc92dde10f877184664aecd90"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}   

CICD 업데이트 세트 - POST /api/sn_cicd/update_set/commitMultiple

제공된 순서에 따라 단일 요청에서 여러 업데이트 세트를 커밋합니다.

URL 형식

버전이 지정된 URL: /api/sn_cicd/{api_version}/update_set/commitMultiple

기본 URL: /api/sn_cicd/update_set/commitMultiple

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 6. 경로 매개변수

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

표 7. 쿼리 매개변수

이름	설명
remote_update_set_ids	필수 커밋할 업데이트 세트와 연결된 sys_ids 목록입니다. Sys_ids 요청에 지정된 순서대로 커밋됩니다. 주: 엔드포인트를 사용하여 CI/CD - GET /sn_cicd/progress/{progress_id} 원격 업데이트 세트 ID를 가져올 수 있습니다. 데이터 유형: 문자열 표: 검색된 업데이트 세트 [sys_remote_update_set]

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

이름	설명
force_commit	업데이트 세트를 강제로 커밋할지 여부를 나타내는 플래그입니다. 이 기능은 입력에 지정된 일부 원격 업데이트 세트가 이전 작업에서 이미 커밋된 경우에 유용합니다. 또한 이 기능은 업데이트 세트가 제공된 순서대로 커밋 순서가 준수되도록 합니다. 유효한 값은 다음과 같습니다. true: 업데이트 세트를 강제로 커밋합니다. false: 업데이트 세트를 강제로 커밋하지 않습니다. 커밋이 강제되지 않으면 커밋 순서가 준수되지 않으면 커밋이 실패합니다. 데이터 유형: 문자열 기본값: false

머리글

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

표 9. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 10. 응답 헤더

헤더	설명
콘텐츠-형식	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

상태 코드

표 11. 상태 코드

이름	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
401	사용자 자격 증명이 올바르지 않은 경우.
403	금지되었습니다. 사용자가 관리자가 아니거나 sn_cicd.sys_ci_automation 역할이 없습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
409	상충됩니다. 요청 항목이 고유하지 않습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다.

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

이름	설명
오류	오류에 대한 상세 정보가 포함된 오류 메시지입니다. 데이터 유형: 문자열
링크	업데이트 세트와 연관된 링크 및 sys_ids 대한 정보입니다. 데이터 유형: 객체 "links": { "progress": {Object} }
링크.진행률	업데이트 세트에서 수행된 작업에 대한 진행률 정보입니다. 데이터 유형: 객체 "progress": { "id": "String", "url": "String" }
links.progress.id	작업의 진행률 상세 정보를 포함하는 Sys_id. 끝점 CI/CD - GET /sn_cicd/progress/{progress_id}을 호출할 때 이 값을 사용할 수 있습니다. 데이터 유형: 문자열
링크.진행률.url	업데이트 세트에서 수행된 운영에 대한 진행률 상세 정보를 검색하는 데 사용할 URL입니다. 데이터 유형: 문자열
percent_complete	요청의 완료율입니다. 데이터 유형: 숫자
상태	업데이트 세트에서 수행된 작업의 실행 상태를 나타내는 번호입니다. 설명자에 status_label 해당합니다. 가능한 값: 0: 보류 중 1: 달리기 2: 성공 3: 실패 4: 취소됨 데이터 유형: 문자열
status_detail	실행 상태에 대한 자세한 메시지입니다(사용 가능한 경우). 실행 추적기 [sys_execution_tracker] 테이블의 detailed_message 필드에 해당합니다. 데이터 유형: 문자열
status_label	업데이트 세트 작업의 실행 상태입니다. 숫자에 status 해당 합니다. 가능한 값: 취소됨 실패함 보류 중 실행 중 성공 데이터 유형: 문자열
status_message	작업의 현재 상태에 대한 추가 설명입니다(사용 가능한 경우). 데이터 유형: 문자열

cURL 요청

다음 예제에서는 지정된 sys_id 사용하여 업데이트를 커밋하는 방법을 보여 줍니다.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/commitMultiple?remote_update_set_ids=0a9f45ab9d415e10f877036c70ae5968%2Cc2e89999c9e19e10f877184664aecd40" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"force_commit\":\"true\"}" \
--user 'username':'password'

응답 본문.

{
  "result": {
    "links": {
      "progress": {
        "id": "3d174aa1c969de10f877184664aecdc0",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/3d174aa1c969de10f877184664aecdc0"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

CICD 업데이트 세트 - POST /api/sn_cicd/update_set/preview/{remote_update_set_id}

업데이트 세트를 미리 보고 상충이 있는지 확인하고 업데이트 세트 운영에 대한 진행률 정보를 검색합니다.

주:

미리 보려는 업데이트 세트가 인스턴스에 없는 경우, 먼저 엔드포인트를 사용하여 CICD 업데이트 세트 - POST /api/sn_cicd/update_set/retrieve 업데이트 세트를 검색하거나 UI에서 수동으로 검색해야 합니다.

URL 형식

버전이 지정된 URL: /api/sn_cicd/{api_version}/update_set/preview/{remote_update_set_id}

기본 URL: /api/sn_cicd/update_set/preview/{remote_update_set_id}

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 12. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
remote_update_set_id	미리 볼 업데이트 세트의 Sys_id입니다. 표: 검색된 업데이트 세트 [sys_remote_update_set] 데이터 유형: 문자열

표 13. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
안 함

머리글

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

표 15. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 16. 응답 헤더

헤더	설명
콘텐츠-형식	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

상태 코드

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

표 17. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
403	금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

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

이름	설명
오류	오류에 대한 상세 정보가 포함된 오류 메시지입니다. 데이터 유형: 문자열
링크	업데이트 세트와 연관된 링크 및 sys_ids 대한 정보입니다. 데이터 유형: 객체 "links": { "progress": {Object} }
링크.진행률	업데이트 세트에서 수행된 작업에 대한 진행률 정보입니다. 데이터 유형: 객체 "progress": { "id": "String", "url": "String" }
links.progress.id	작업의 진행률 상세 정보를 포함하는 Sys_id. 끝점 CI/CD - GET /sn_cicd/progress/{progress_id}을 호출할 때 이 값을 사용할 수 있습니다. 데이터 유형: 문자열
링크.진행률.url	업데이트 세트에서 수행된 운영에 대한 진행률 상세 정보를 검색하는 데 사용할 URL입니다. 데이터 유형: 문자열
percent_complete	요청의 완료율입니다. 데이터 유형: 숫자
상태	업데이트 세트에서 수행된 작업의 실행 상태를 나타내는 번호입니다. 설명자에 status_label 해당합니다. 가능한 값: 0: 보류 중 1: 달리기 2: 성공 3: 실패 4: 취소됨 데이터 유형: 문자열
status_detail	실행 상태에 대한 자세한 메시지입니다(사용 가능한 경우). 실행 추적기 [sys_execution_tracker] 테이블의 detailed_message 필드에 해당합니다. 데이터 유형: 문자열
status_label	업데이트 세트 작업의 실행 상태입니다. 숫자에 status 해당 합니다. 가능한 값: 취소됨 실패함 보류 중 실행 중 성공 데이터 유형: 문자열
status_message	작업의 현재 상태에 대한 추가 설명입니다(사용 가능한 경우). 데이터 유형: 문자열

cURL 요청

다음 예시에서는 지정된 ID를 사용하여 원격 업데이트 세트를 미리 보는 방법을 보여줍니다.

curl 
curl "https://instance.servicenow.com/api/sn_cicd/update_set/preview/8f4608d39d89da10f877036c70ae5998" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

응답 본문.

{
  "result": {
    "links": {
      "progress": {
        "id": "54e9c665c969de10f877184664aecd72",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/54e9c665c969de10f877184664aecd72"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

CICD 업데이트 세트 - POST /api/sn_cicd/update_set/back_out

업데이트 세트에서 지정된 sys_id로 수행된 설치 작업을 원상 복구합니다.

원상 복구 작업이 업데이트 세트에 미치는 영향에 대한 자세한 내용은 다음 문서를 참조하십시오 Back out an update set.

URL 형식

버전이 지정된 URL: /api/sn_cicd/{api_version}/update_set/back_out

기본 URL: /api/sn_cicd/update_set/back_out

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 18. 경로 매개변수

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

표 19. 쿼리 매개변수

이름	설명
rollback_installs	업데이트 세트 커밋 중에 수행된 배치 설치를 롤백할지 여부를 나타내는 플래그입니다. 가능한 값: true: 설치를 롤백합니다. false: 설치를 롤백하지 않습니다. 데이터 유형: 부울 기본값: true
update_set_id	필수 업데이트 세트의 Sys_id입니다. 테이블: 업데이트 세트 [sys_update_set] 데이터 유형: 문자열

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

이름	설명
안 함

머리글

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

표 21. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 22. 응답 헤더

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

상태 코드

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

표 23. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
401	사용자 자격 증명이 올바르지 않은 경우.
403	금지되었습니다. 사용자가 관리자가 아니거나 sn_cicd.sys_ci_automation 역할이 없습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
405	잘못된 메서드입니다. 기능이 비활성화되어 있습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다.

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

이름	설명
오류	오류에 대한 상세 정보가 포함된 오류 메시지입니다. 데이터 유형: 문자열
링크	업데이트 세트와 연관된 링크 및 sys_ids 대한 정보입니다. 데이터 유형: 객체 "links": { "progress": {Object} }
링크.진행률	업데이트 세트에서 수행된 작업에 대한 진행률 정보입니다. 데이터 유형: 객체 "progress": { "id": "String", "url": "String" }
links.progress.id	작업의 진행률 상세 정보를 포함하는 Sys_id. 끝점 CI/CD - GET /sn_cicd/progress/{progress_id}을 호출할 때 이 값을 사용할 수 있습니다. 데이터 유형: 문자열
링크.진행률.url	업데이트 세트에서 수행된 운영에 대한 진행률 상세 정보를 검색하는 데 사용할 URL입니다. 데이터 유형: 문자열
percent_complete	요청의 완료율입니다. 데이터 유형: 숫자
상태	업데이트 세트에서 수행된 작업의 실행 상태를 나타내는 번호입니다. 설명자에 status_label 해당합니다. 가능한 값: 0: 보류 중 1: 달리기 2: 성공 3: 실패 4: 취소됨 데이터 유형: 문자열
status_detail	실행 상태에 대한 자세한 메시지입니다(사용 가능한 경우). 실행 추적기 [sys_execution_tracker] 테이블의 detailed_message 필드에 해당합니다. 데이터 유형: 문자열
status_label	업데이트 세트 작업의 실행 상태입니다. 숫자에 status 해당 합니다. 가능한 값: 취소됨 실패함 보류 중 실행 중 성공 데이터 유형: 문자열
status_message	작업의 현재 상태에 대한 추가 설명입니다(사용 가능한 경우). 데이터 유형: 문자열

cURL 요청

다음 예제에서는 특정 업데이트 sys_id에서 설치 작업을 롤백하는 방법을 보여 줍니다.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/back_out?update_set_id=73dd24e39dcd1e10f877036c70ae59ae&rollback_installs=false" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

응답:

{
  "result": {
    "links": {
      "progress": {
        "id": "036bf811c9619e10f877184664aecdcb",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/036bf811c9619e10f877184664aecdcb"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
} 

CICD 업데이트 세트 - POST /api/sn_cicd/update_set/commit/{remote_update_set_id}

지정된 sys_id로 업데이트 세트를 커밋합니다.

업데이트 세트를 미리 보고 문제를 해결한 경우 이 엔드포인트를 사용하여 업데이트 세트를 커밋할 수 있습니다. 업데이트 세트를 커밋하면 인스턴스에 대한 모든 변경이 적용되고, 각 변경에 대한 업데이트 기록을 포함하는 업데이트 세트 로컬 복사본이 생성됩니다. 업데이트 세트 커밋에 대한 자세한 내용은 다음 문서를 Commit an update set참조하십시오.

URL 형식

버전이 지정된 URL: /api/sn_cicd/{api_version}/update_set/commit/{remote_update_set_id}

기본 URL: /api/sn_cicd/update_set/ commit/{remote_update_set_id}

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 24. 경로 매개변수

이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
remote_update_set_id	커밋할 업데이트 세트의 Sys_id입니다. 주: 엔드포인트를 사용하여 CI/CD - GET /sn_cicd/progress/{progress_id} 원격 업데이트 세트 ID를 가져올 수 있습니다. 표: 검색된 업데이트 세트 [sys_remote_update_set] 데이터 유형: 문자열

표 25. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
force_commit	업데이트 세트를 강제로 커밋할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 아직 미리 않았더라도 업데이트 세트를 강제로 커밋하여 상충 여부를 확인합니다. false: 업데이트 세트를 강제로 커밋하지 않습니다. 커밋을 진행하기 전에 업데이트 세트를 미리 확인해야 합니다. 데이터 유형: 문자열 기본값: false

머리글

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

표 27. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 28. 응답 헤더

헤더	설명
콘텐츠-형식	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

상태 코드

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

표 29. 상태 코드

이름	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
401	사용자 자격 증명이 올바르지 않은 경우.
403	금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
409	상충됩니다. 요청 항목이 고유하지 않습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다.

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

이름	설명
오류	오류에 대한 상세 정보가 포함된 오류 메시지입니다. 데이터 유형: 문자열
링크	업데이트 세트와 연관된 링크 및 sys_ids 대한 정보입니다. 데이터 유형: 객체 "links": { "progress": {Object} }
링크.진행률	업데이트 세트에서 수행된 작업에 대한 진행률 정보입니다. 데이터 유형: 객체 "progress": { "id": "String", "url": "String" }
links.progress.id	작업의 진행률 상세 정보를 포함하는 Sys_id. 끝점 CI/CD - GET /sn_cicd/progress/{progress_id}을 호출할 때 이 값을 사용할 수 있습니다. 데이터 유형: 문자열
링크.진행률.url	업데이트 세트에서 수행된 운영에 대한 진행률 상세 정보를 검색하는 데 사용할 URL입니다. 데이터 유형: 문자열
percent_complete	요청의 완료율입니다. 데이터 유형: 숫자
상태	업데이트 세트에서 수행된 작업의 실행 상태를 나타내는 번호입니다. 설명자에 status_label 해당합니다. 가능한 값: 0: 보류 중 1: 달리기 2: 성공 3: 실패 4: 취소됨 데이터 유형: 문자열
status_detail	실행 상태에 대한 자세한 메시지입니다(사용 가능한 경우). 실행 추적기 [sys_execution_tracker] 테이블의 detailed_message 필드에 해당합니다. 데이터 유형: 문자열
status_label	업데이트 세트 작업의 실행 상태입니다. 숫자에 status 해당 합니다. 가능한 값: 취소됨 실패함 보류 중 실행 중 성공 데이터 유형: 문자열
status_message	작업의 현재 상태에 대한 추가 설명입니다(사용 가능한 경우). 데이터 유형: 문자열

cURL 요청

다음 예에서는 sys_id 연결된 업데이트 세트를 커밋합니다.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/commit/4ee89999c9e19e10f877184664aecd42" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

응답 본문.

{
  "result": {
    "links": {
      "progress": {
        "id": "bf380a11c9e59e10f877184664aecd0e",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/bf380a11c9e59e10f877184664aecd0e"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

CICD 업데이트 세트 - POST /api/sn_cicd/update_set/create

새 업데이트 세트를 만들고 새 기록을 업데이트 세트 [sys_update_set] 테이블에 삽입합니다.

URL 형식

버전이 지정된 URL: /api/sn_cicd/{api_version}/update_set/create

기본 URL: /api/sn_cicd/update_set/create

주:

사용 가능한 버전은 REST API 탐색기에 지정됩니다. 스크립트 기반 REST API의 경우 스크립트 기반 REST 서비스 양식에 추가 버전 정보가 있습니다.

지원되는 요청 매개변수

표 30. 경로 매개변수

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

표 31. 쿼리 매개변수

이름	설명
설명	업데이트 세트에 대한 설명입니다. 데이터 유형: 문자열 기본값: null
scope	매개변수가 sys_id 전달되지 않은 경우 필요합니다. 새 업데이트 세트를 생성할 애플리케이션의 범위 이름입니다. 테이블: 애플리케이션 [sys_scope] 데이터 유형: 문자열
sys_id	매개변수가 scope 전달되지 않은 경우 필요합니다. 새 업데이트 세트를 생성할 애플리케이션의 Sys_id입니다. 테이블: 애플리케이션 [sys_scope] 데이터 유형: 문자열
update_set_name	필수 업데이트 세트를 제공할 이름입니다. 데이터 유형: 문자열

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

이름	설명
안 함

머리글

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

표 33. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 34. 응답 헤더

헤더	설명
콘텐츠-형식	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

상태 코드

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

201	업데이트 세트가 성공적으로 작성되었습니다.
400	잘못된 요청. 업데이트 세트 이름이 null이거나 비어 있거나 입력 sys_id와 범위가 모두 null이거나 비어 있습니다.
403	금지되었습니다. 사용자가 관리자가 아니거나 sn_cicd.sys_ci_automation 역할이 없습니다.
409	상충됩니다. 요청 항목이 고유하지 않습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다.

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

이름	설명
오류	오류에 대한 상세 정보가 포함된 오류 메시지입니다. 데이터 유형: 문자열
상태	업데이트 세트에서 수행된 작업의 실행 상태를 나타내는 번호입니다. 설명자에 status_label 해당합니다. 가능한 값: 0: 보류 중 1: 달리기 2: 성공 3: 실패 4: 취소됨 데이터 유형: 문자열
status_detail	실행 상태에 대한 자세한 메시지입니다(사용 가능한 경우). 실행 추적기 [sys_execution_tracker] 테이블의 detailed_message 필드에 해당합니다. 데이터 유형: 문자열
status_label	업데이트 세트 작업의 실행 상태입니다. 숫자에 status 해당 합니다. 가능한 값: 취소됨 실패함 보류 중 실행 중 성공 데이터 유형: 문자열
status_message	작업의 현재 상태에 대한 추가 설명입니다(사용 가능한 경우). 데이터 유형: 문자열
update_set_id	생성된 업데이트 세트의 Sys_id입니다. 테이블: 업데이트 세트 [sys_update_set] 데이터 유형: 문자열

cURL 요청

다음 예시에서는 Testupdateset 라는 이름과 범위 세트를 sn_test로 하여 새 업데이트 세트를 생성하는 방법을 보여줍니다.

curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/create?update_set_name=Testupdateset&scope=sn_test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

응답 본문.

{
  "result": {
    "status": "2",
    "status_label": "",
    "status_message": "Successfully created update set: Test update set 1",
    "status_detail": "",
    "error": "",
    "update_set_id": "a9a485d1c9a19e10f877184664aecd11"
  }
}