Cdm정책Api

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기27분

    • CdmPoliciesApi는 CDM(배포 가능 항목 구성 데이터 관리 )의 정책 매핑을 관리할 수 있는 엔드포인트를 제공합니다. 배포 가능 항목에 올바르게 매핑된 정책은 배포 가능 항목의 스냅샷이 확인될 때 실행됩니다.

    이 API의 엔드포인트에 액세스하려면 다음 역할 중 하나가 있어야 합니다.
    • 스크립팅된 REST CDM 뷰 ACL
    • 스크립팅된 REST CDM 관리자 ACL

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

    정책 매핑에 대한 자세한 내용은 배포 가능 항목에 정책 매핑 섹션을 참조하세요.

    CdmPoliciesApi - DELETE /sn_cdm/policies/mappings

    배포 가능 항목에 지정된 정책의 매핑을 삭제합니다.

    이 엔드포인트의 호출자는 CDM 관리자 역할이 있어야 합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_cdm/{api_version}/policies/mappings

    기본 URL: /api/sn_cdm/policies/mappings

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 2. 쿼리 매개변수
    이름 설명
    appName 필수 정책에 대한 매핑을 구성 데이터 관리 제거할 (CDM) 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    'deployableName' 필수 정책에 대한 매핑을 제거할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다.

    데이터 유형: 문자열
    policyName 필수 연결된 정책의 이름입니다. 정책 [sn_pace_policy] 테이블에 있습니다.

    데이터 유형: 문자열
    표 3. 요청 본문 매개변수
    이름 설명
    없음

    헤더

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

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

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

    상태 코드

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

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

    응답 본문 매개변수

    이름 설명
    오류 처리 중에 오류가 발생한 경우 오류에 대한 상세 정보입니다.

    데이터 유형: 객체

    "error": {
  "detail": "String",
  "message": "String"
}
    오류.상세 정보 오류에 대한 추가 정보입니다.

    데이터 유형: 문자열
    오류.메시지 요청을 처리하는 동안 생성된 오류 메시지입니다.

    데이터 유형: 문자열

    cURL 요청

    다음 코드 예제에서는 정책 매핑을 제거하는 방법을 보여 줍니다.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?deployableName=Development_1&policyName=testALPolicy1&appName=testApp" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    매핑을 성공적으로 삭제하려면 HTTP 상태 코드 이외의 응답이 반환되지 않습니다.

    None - results defined by the HTTP status code

    CdmPoliciesApi - GET /sn_cdm/policies/mappings/inputs/resolved

    배포 가능 항목의 지정된 정책 매핑에 대해 해결된 입력을 반환합니다.

    정책 매핑에 대한 자세한 내용은 배포 가능 항목에 정책 매핑 및 구성 데이터 유효성 검사 및 수정을 참조하세요.

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

    URL 형식

    버전이 지정된 URL: /api/sn_cdm/{api_version}/policies/mappings/inputs/resolved

    기본 URL: /api/sn_cdm/policies/mappings/inputs/resolved

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 8. 쿼리 매개변수
    이름 설명
    appName 필수 해결된 정책 입력을 구성 데이터 관리 반환할 배포 가능 항목과 연결된 (CDM) 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    'deployableName' 필수 해결된 정책을 반환할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다.

    데이터 유형: 문자열
    policyName 필수 연결된 정책의 이름입니다. 정책 [sn_pace_policy] 테이블에 있습니다.

    데이터 유형: 문자열
    표 9. 요청 본문 매개변수
    이름 설명
    없음

    헤더

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

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

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

    상태 코드

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

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

    응답 본문 매개변수

    이름 설명
    결과 지정된 정책 매핑에 대해 확인된 모든 입력의 이름-값 쌍 목록입니다.

    예: {"input_name": "user_1", "input_password": "" }

    데이터 유형: 객체

    cURL 요청

    다음 예제에서는 이 엔드포인트를 사용하여 해결된 정책 입력을 가져오는 방법을 보여 줍니다.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/resolved?policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    반환 결과:

    { 
  "result": { 
    "key1": "someVal", 
    "additionalDeployablesInput": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]" 
  } 
}

    CdmPoliciesApi - POST /sn_cdm/policies/mappings

    지정된 정책을 배포 가능 항목에 매핑합니다.

    이 엔드포인트의 호출자는 CDM 관리자 역할이 있어야 합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_cdm/{api_version}/policies/mappings

    기본 URL: /api/sn_cdm/policies/mappings

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 14. 쿼리 매개변수
    이름 설명
    appName 필수 구성 데이터 관리 정책을 매핑할 (CDM) 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    'deployableName' 필수 정책을 매핑할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다.

    데이터 유형: 문자열
    policyName 필수 연결된 정책의 이름입니다. 정책 [sn_pace_policy] 테이블에 있습니다.

    데이터 유형: 문자열
    returnFields 응답의 일부로 반환할 필드 목록입니다. sys_id, sys_updated_by 또는 state와 같은 기록 열 이름을 전달합니다.

    데이터 유형: 배열

    기본값: 엔드포인트에 의해 결정된 모든 필드
    표 15. 요청 본문 매개변수
    이름 설명
    없음

    헤더

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

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

    상태 코드

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

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

    응답 본문 매개변수

    이름 설명
    설명 매핑에 대한 설명입니다.

    데이터 유형: 문자열
    문서 문서의 Sys_id입니다.

    데이터 유형: 문자열
    document_ref 노드와 연결된 document_ref 기록의 상세 정보입니다.

    데이터 유형: 객체

    "document_ref": {
  "link": "String",
  "value": "String"
}
    document_ref.링크 테이블 REST API를 사용하여 정책에 매핑된 배포 가능 기록을 쿼리하기 위한 호출 구문입니다.

    PaCE 에서는 이 필드를 사용하여 정책에 매핑된 배포 가능 항목에 대한 참조를 저장합니다.

    데이터 유형: 문자열
    document_ref.sys_id 정책에 매핑된 배포 가능 항목 기록의 Sys_id입니다.

    데이터 유형: 문자열
    오류 처리 중에 오류가 발생한 경우 오류에 대한 상세 정보입니다.

    데이터 유형: 객체

    "error": {
  "detail": "String",
  "message": "String"
}
    오류.상세 정보 오류에 대한 추가 정보입니다.

    데이터 유형: 문자열
    오류.메시지 요청을 처리하는 동안 생성된 오류 메시지입니다.

    데이터 유형: 문자열
    예외 매핑을 수행하는 동안 예외가 발생하면 예외 기록에 대한 링크입니다.

    데이터 유형: 문자열
    exception_allowed 정책에 대해 예외가 허용되는지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 예외가 허용됩니다.
    • false: 예외가 허용되지 않습니다.

    데이터 유형: 부울
    input_status 입력의 상태입니다.
    가능한 값:
    • 잘못됨
    • 유효함

    데이터 유형: 문자열
    last_updated_by 정책 매핑을 마지막으로 업데이트한 사용자의 상세 정보입니다.

    데이터 유형: 객체

    "last_updated_by": {
  "link": "String",
  "value": "String"
}
    last_updated_by.링크 테이블 REST API를 사용하여 사용자 기록을 쿼리하기 위한 호출 구문입니다.

    데이터 유형: 문자열
    last_updated_by.sys_id 사용자 기록의 sys_id입니다. 사용자 [sys_user] 테이블에 있습니다.

    데이터 유형: 문자열
    번호 매핑을 식별하는 고유 번호입니다. 이 값은 매핑에 대해 사용자가 읽을 수 있는 식별자를 제공합니다.

    데이터 유형: 문자열
    정책 매핑과 연결된 정책 기록의 상세 정보입니다.

    데이터 유형: 객체

    "policy": {
  "link": "String",
  "value": "String"
}
    policy.link 테이블 REST API를 사용하여 정책에 매핑된 정책 기록을 쿼리하기 위한 호출 구문입니다.

    데이터 유형: 문자열
    policy.sys_id 정책 기록의 Sys_id입니다. 정책 [sn_pace_policy] 테이블에 있습니다.

    데이터 유형: 문자열
    이유 현재 상태에 대한 이유에 대한 설명입니다.

    데이터 유형: 문자열
    상태 매핑의 현재 상태입니다.
    가능한 값:
    • active
    • 비활성

    데이터 유형: 문자열
    sys_class_name 정책 매핑의 테이블 이름입니다.

    데이터 유형: 문자열
    sys_created_by 매핑을 생성한 사용자의 이름입니다.

    데이터 유형: 문자열
    sys_created_on 매핑이 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열

    형식: yyyy-mm-dd hh:mm:ss
    sys_id 매핑의 Sys_id입니다. 정책 매핑 [sn_pace_policy_mapping] 테이블에 있습니다.

    데이터 유형: 문자열
    sys_updated_by 매핑을 업데이트한 사용자의 이름입니다.

    데이터 유형: 문자열
    sys_updated_on 매핑이 마지막으로 업데이트된 날짜 및 시간입니다.

    데이터 유형: 문자열

    형식: yyyy-mm-dd hh:mm:ss

    cURL 요청

    이 코드 예제에서는 특정 정책을 배포 가능 항목에 매핑하는 방법을 보여 줍니다.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?appName=testApp&deployableName=Development_1&policyName=testALPolicy1" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    반환 결과:

    { 
  "result": { 
    "exception": null, 
    "reason": null, 
    "exception_allowed": "--", 
    "document": "0be34a531b501110636e0fe0604bcb21", 
    "input_status": "valid", 
    "description": null, 
    "sys_updated_on": "2022-06-30 14:07:37", 
    "sys_class_name": "sn_cdm_pace_policy_mapping", 
    "sys_id": "ea24469f1b101110636e0fe0604bcbed", 
    "number": "MAP0001001", 
    "last_updated_by": { 
      "value": "48630e131b501110636e0fe0604bcb53", 
      "link": "https://instance.servicenow.com/api/now/table/sys_user/48630e131b501110636e0fe0604bcb53" 
    }, 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-30 14:07:37", 
    "document_ref": { 
      "value": "0be34a531b501110636e0fe0604bcb21", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_deployable/0be34a531b501110636e0fe0604bcb21" 
    }, 
    "state": "active", 
    "sys_created_by": "admin", 
    "policy": { 
      "value": "12a3c2531b501110636e0fe0604bcb9b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_pace_policy/12a3c2531b501110636e0fe0604bcb9b" 
    } 
  } 
}

    CdmPoliciesApi - PUT /sn_cdm/policies/mappings/inputs/additional-deployables

    (CDM) 정책 매핑의 additionalDeployablesInput 입력 변수를 업데이트합니다 구성 데이터 관리 .

    additionalDeployablesInput 입력 변수에는 기존 정책 매핑에 할당할 수 있는 추가 배포 가능 항목이 포함되어 있습니다. 매핑 입력과 유사하지만 특정 배열 구조를 갖습니다.

    정책 매핑에 대한 자세한 내용은 배포 가능 항목에 정책 매핑 섹션을 참조하세요.

    이 엔드포인트의 호출자는 CDM 관리자 역할이 있어야 합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_cdm/{api_version}/policies/mappings/inputs/additional-deployables

    기본 URL: /api/sn_cdm/policies/mappings/inputs/additional-deployables

    지원되는 요청 매개변수

    표 19. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 20. 쿼리 매개변수
    이름 설명
    additionalDeployables 필수 additionalDeployablesInput 입력 변수에 추가할 배포 가능 항목 목록입니다.

    데이터 형식: 객체 배열

    "additionalDeployables": [
  {
    "appName": "String", 
    "deployableName": "String"
  }
]
    additionalDeployables.appName 필수 배포 가능 항목이 연결된 CDM 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    additionalDeployables.deployableName 필수 additionalDeployablesInput 입력 변수에 추가할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다.

    데이터 유형: 문자열
    appName 필수 additionalDeployablesInput 입력 변수를 업데이트할 CDM 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    'deployableName' 필수 additionalDeployablesInput 입력 변수를 업데이트할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다.

    데이터 유형: 문자열
    policyName 필수 연결된 정책의 이름입니다. 정책 [sn_pace_policy] 테이블에 있습니다.

    데이터 유형: 문자열
    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 잘못된 요청입니다. 전달된 policyName 매개변수가 잘못되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수

    이름 설명
    io_definition 연결된 PaCE IO 정의 기록에 대한 상세 정보입니다.

    에 대한 PaCE자세한 내용은 다음 문서를 참조하십시오 Policy as Code Engine (PaCE).

    데이터 유형: 객체

    "io_definition": {
  "link": "String",
  "value": "String"
}
    io_definition.링크 테이블 REST API를 사용하여 이 PaCE IO 정의 기록을 쿼리하기 위한 호출 구문입니다.

    데이터 유형: 문자열
    io_definition.value IO 정의 기록의 PaCE Sys_id입니다. IO 매핑 [sn_pace_io_mapping] 테이블에 있습니다.

    데이터 유형: 문자열
    is_unused 매핑 입력 변수가 사용되지 않았는지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 연결된 매핑 입력 변수가 현재 사용되지 않습니다.
    • false: 연결된 매핑 입력 변수가 현재 사용 중입니다.

    데이터 유형: 부울
    mapped_value 매핑 입력 변수의 현재 값입니다.

    데이터 유형: 객체 또는 문자열 배열
    policy_mapping 정책 매핑 기록에 대한 PaCE 상세 정보입니다.

    에 대한 PaCE자세한 내용은 다음 문서를 참조하십시오 Policy as Code Engine (PaCE).

    데이터 유형: 객체

    "policy_mapping": {
  "link": "String",
  "value": "String"
}
    policy_mapping.링크 테이블 REST API를 사용하여 정책 매핑 기록을 쿼리하기 위한 호출 구문입니다.

    데이터 유형: 문자열
    policy_mapping.value 정책 매핑 기록의 PaCE Sys_id입니다. 정책 매핑 [sn_pace_policy_mapping] 테이블에 있습니다.

    데이터 유형: 문자열
    sys_created_by 매핑 입력 변수를 생성한 사용자의 이름입니다.

    데이터 유형: 문자열
    sys_created_on 매핑 입력 변수가 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열

    형식: yyyy-mm-dd hh:mm:ss
    sys_id 연결된 매핑 기록의 Sys_id입니다. IO 매핑 [sn_pace_io_mapping] 테이블에 있습니다.

    데이터 유형: 문자열
    sys_updated_by 매핑 입력 변수를 업데이트한 사용자의 이름입니다.

    데이터 유형: 문자열
    sys_updated_on 매핑 입력 변수가 마지막으로 업데이트된 날짜 및 시간입니다.

    데이터 유형: 문자열

    형식: yyyy-mm-dd hh:mm:ss

    cURL 요청

    다음 예제에서는 additionalDeployablesInput 입력 변수에 배포 가능 항목을 추가하는 방법을 보여줍니다.

    curl "https://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/additional-deployables?additionalDeployables=%5B%7B%22appName%22%3A%20%22testApp%22%2C%20%22deployableName%22%3A%22Development_2%22%7D%5D&policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'admin':'admin

    반환 결과:

    { 
  "result": { 
    "sys_id": "6bb746171b501110636e0fe0604bcb1c", 
    "policy_mapping": { 
      "value": "6bb746171b501110636e0fe0604bcb1b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
    }, 
    "sys_updated_by": "ameya", 
    "sys_created_on": "2022-06-30 14:23:15", 
    "io_definition": { 
      "value": "4d0b061b1b501110636e0fe0604bcb2f", 
      "link": "https://instance.servicenow.com/api/now/table/sn_pace_io_definition/4d0b061b1b501110636e0fe0604bcb2f" 
    }, 
    "mapped_value": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]", 
    "sys_updated_on": "2022-06-30 14:53:21", 
    "sys_created_by": "ameya", 
    "is_unused": false 
  } 
}

    CdmPoliciesApi - PUT /sn_cdm/policies/mappings/inputs

    (CDM) 정책 매핑에 대해 지정된 입력 변수를 업데이트합니다 구성 데이터 관리 .

    폴리시 매핑에 대한 자세한 내용은 정책을 배포 가능 항목에 매핑을 참조하세요.

    이 엔드포인트의 호출자는 CDM 관리자 역할이 있어야 합니다.

    URL 형식

    버전이 지정된 URL: /api/sn_cdm/{api_version}/policies/mappings/inputs

    기본 URL: /api/sn_cdm/policies/mappings/inputs

    지원되는 요청 매개변수

    표 25. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 26. 쿼리 매개변수
    이름 설명
    appName 필수 정책 매핑 입력을 업데이트할 CDM 애플리케이션의 이름입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    'deployableName' 필수 정책 매핑 입력을 업데이트할 CDM 배포 가능 항목의 이름입니다. CDM 배포 가능 항목 [sn_cdm_deployable] 테이블에 있습니다.

    데이터 유형: 문자열
    입력 이름 필수 업데이트할 입력 변수의 이름입니다. 사용 가능한 입력 변수는 IO 매핑 [sn_pace_io_mapping] 테이블에 정의되어 있습니다.

    데이터 유형: 문자열
    입력값 필수 입력 변수에 할당할 값입니다.

    데이터 유형: 입력 변수에 따라 다릅니다. IO 매핑 [sn_pace_io_mapping] 테이블에서 데이터 유형을 찾을 수 있습니다.
    policyName 필수 연결된 정책의 이름입니다. 정책 [sn_pace_policy] 테이블에 있습니다.

    데이터 유형: 문자열
    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 잘못된 요청입니다. 전달된 policyName 매개변수가 잘못되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수

    이름 설명
    io_definition 연결된 PaCE IO 정의 기록에 대한 상세 정보입니다.

    에 대한 PaCE자세한 내용은 다음 문서를 참조하십시오 Policy as Code Engine (PaCE).

    데이터 유형: 객체

    "io_definition": {
  "link": "String",
  "value": "String"
}
    io_definition.링크 테이블 REST API를 사용하여 이 PaCE IO 정의 기록을 쿼리하기 위한 호출 구문입니다.

    데이터 유형: 문자열
    io_definition.value IO 정의 기록의 PaCE Sys_id입니다. IO 매핑 [sn_pace_io_mapping] 테이블에 있습니다.

    데이터 유형: 문자열
    is_unused 매핑 입력 변수가 사용되지 않았는지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 연결된 매핑 입력 변수가 현재 사용되지 않습니다.
    • false: 연결된 매핑 입력 변수가 현재 사용 중입니다.

    데이터 유형: 부울
    mapped_value 매핑 입력 변수의 현재 값입니다.

    데이터 유형: 객체 또는 문자열 배열
    policy_mapping 정책 매핑 기록에 대한 PaCE 상세 정보입니다.

    에 대한 PaCE자세한 내용은 다음 문서를 참조하십시오 Policy as Code Engine (PaCE).

    데이터 유형: 객체

    "policy_mapping": {
  "link": "String",
  "value": "String"
}
    policy_mapping.링크 테이블 REST API를 사용하여 정책 매핑 기록을 쿼리하기 위한 호출 구문입니다.

    데이터 유형: 문자열
    policy_mapping.value 정책 매핑 기록의 PaCE Sys_id입니다. 정책 매핑 [sn_pace_policy_mapping] 테이블에 있습니다.

    데이터 유형: 문자열
    sys_created_by 매핑 입력 변수를 생성한 사용자의 이름입니다.

    데이터 유형: 문자열
    sys_created_on 매핑 입력 변수가 생성된 날짜 및 시간입니다.

    데이터 유형: 문자열

    형식: yyyy-mm-dd hh:mm:ss
    sys_id 연결된 매핑 기록의 Sys_id입니다. IO 매핑 [sn_pace_io_mapping] 테이블에 있습니다.

    데이터 유형: 문자열
    sys_updated_by 매핑 입력 변수를 업데이트한 사용자의 이름입니다.

    데이터 유형: 문자열
    sys_updated_on 매핑 입력 변수가 마지막으로 업데이트된 날짜 및 시간입니다.

    데이터 유형: 문자열

    형식: yyyy-mm-dd hh:mm:ss

    cURL 요청

    다음 예제에서는 testALPolicy와 연결된 key1 입력 변수를 업데이트하는 방법을 보여 줍니다.

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs?policyName=testALPolicy1&appName=testApp&inputValue=value1&inputName=key1&deployableName=Development_1" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    반환 결과:

    { 
  "result": { 
    "sys_id": "631b861b1b501110636e0fe0604bcb6f", 
    "policy_mapping": { 
      "value": "6bb746171b501110636e0fe0604bcb1b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
    }, 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-30 14:38:00", 
    "io_definition": { 
      "value": "fe1b061b1b501110636e0fe0604bcb90", 
      "link": "https://instance.servicenow.comm/api/now/table/sn_pace_io_definition/fe1b061b1b501110636e0fe0604bcb90" 
    }, 
    "mapped_value": "someVal", 
    "sys_updated_on": "2022-06-30 14:39:21", 
    "sys_created_by": "admin", 
    "is_unused": false 
  } 
}