변경 관리 API
Change Management API는 타사 애플리케이션을 프로세스와 ServiceNow 변경 관리 통합할 수 있는 엔드포인트를 제공합니다.
클라이언트 측 애플리케이션을 개발할 ServiceNow 때 이 REST API를 사용하여 변경 관리 프로세스를 외부 애플리케이션과 통합할 수 있습니다.
이 REST API를 통해 통합자는 다음을 수행할 수 있습니다.
- 게시된 표준 변경 요청 템플릿에서 표준 변경 요청을 시작합니다.
- 긴급 또는 정상 유형의 변경 요청을 생성합니다.
- 변경 요청에 대한 변경 요청 테이블에 있는 필드를 업데이트합니다.
- 변경 작업 테이블에 있는 필드를 업데이트하고 생성부터 종결/취소까지 작업을 수행합니다.
- 특정 변경 요청, 표준 템플릿, 변경 요청 작업 또는 변경 모델을 검색합니다.
- 페이지 매김을 사용하여 여러 변경 요청, 표준 템플릿, 변경 요청 작업을 검색합니다.
- 위험 평가를 수행합니다.
- 영향을 받는 서비스 새로 고침
- 변경 요청과 관련된 승인 활동을 생성하고 처리합니다.
- 일정이 상충될 가능성이 있는 것을 파악하고 상충이 없는 기간을 식별합니다.
- 변경 요청, 변경 요청 작업 및 충돌 검사 프로세스를 삭제합니다.
- 변경 모델 기록을 기반으로 변경 요청 기록을 만듭니다.
- 현재 상태를 포함하여 지정된 변경 요청에 대해 사용 가능한 상태 목록을 조회합니다.
- 기존 ITIL 유형: 표준, 긴급 및 일반.
- 변경 모델 상태: 신규, 예약됨, 구현, 검토 및 종결됨.
인스턴스 내에서 추가 변경 모델을 구성한 다음 이 API의 엔드포인트를 사용하여 해당 변경 모델을 기반으로 변경 요청을 만들 수 있습니다 ServiceNow . Change Management - GET /sn_chg_rest/change/model/{sys_id} 및 Change Management - GET /sn_chg_rest/change/model 엔드포인트를 사용하여 인스턴스에서 사용 가능한 변경 모델을 가져옵니다. 그런 다음 을 Change Management - POST /sn_chg_rest/change 사용하여 지정된 변경 모델을 기반으로 변경 요청을 생성합니다.
변경 모델 구성에 대한 자세한 내용은 Change Management 구성을 참조하십시오.
- DELETE: change_manager 또는 admin
- GET: change_manager, itil, sn_change_read 또는 admin
- 패치/사후: change_manager, itil 또는 관리자
또한 관리자는 변경 속성을 설정하여 Change Management 동작을 구성할 수 있습니다. 이러한 속성 목록과 사용 가능한 기능에 대한 설명은 Change Management 속성을 참조하십시오.
Change Management - /sn_chg_rest/change/{change_sys_id}/task/{task_sys_id} 삭제
지정된 sys_ids으로 식별된 변경 요청 작업을 삭제합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/ task/{task_sys_id}
기본 URL: /api/sn_chg_rest/change/{change_sys_id}/ task/{task_sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| change_sys_id | 작업이 연결된 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 작업이 지정된 변경 요청에 실제로 연결되어 있는지 확인합니다. 데이터 유형: 문자열 |
| task_sys_id | 삭제할 변경 요청 작업의 Sys_id입니다. 변경 작업 [change_task] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 삭제하기 전에 식별된 변경 요청 작업에 연결된 값이 있는 모든 필드(키)입니다. 데이터 유형: 객체 |
| 상위 | 이 작업이 연결된 변경 요청에 대한 정보입니다. 데이터 유형: 객체 |
| parent.display_value | UI에 표시할 상위 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| 부모.값 | 상위 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id | 삭제된 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire both nodes",
display_value: "Retire both nodes"
}
}
]
}
Change Management - DELETE /sn_chg_rest/change/{sys_id}
지정된 sys_id와 연결된 변경 요청을 삭제합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}
기본 URL: / api/sn_chg_rest/change/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 삭제할 변경 요청 기록의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 삭제된 변경 요청 기록입니다. 이 객체의 각 요소는 변경 요청 [change_request] 테이블의 기록에 있는 필드에 해당합니다. 데이터 유형: 객체 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Reboot the server at 6 am",
"value": "Reboot the server at 6 am"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "b0dbda5347c12200e0ef563dbb9a718f",
"value": "b0dbda5347c12200e0ef563dbb9a718f"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}
Change Management - DELETE /sn_chg_rest/change/{sys_id}/conflict
지정된 변경 요청(sys_id)에 대해 실행 중인 상충 검사 프로세스를 취소합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}/conflict
기본 URL: / api/sn_chg_rest/change/{sys_id}/conflict
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 실행 중인 상충 검사 프로세스를 취소할 변경 요청 기록의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청. 취소 요청에 실패했습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 없음 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request DELETE \
--user "username":"password"
None
Change Management - /sn_chg_rest/change/emergency/{sys_id} 삭제
지정된 sys_id로 식별된 긴급 변경 요청을 삭제합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/emergency/{sys_id}
기본 URL: / api/sn_chg_rest/change/emergency/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 삭제할 긴급 변경 요청의 Sys_id입니다. 변경 요청 [ change_request] 테이블에 있습니다. |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 삭제 전 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "긴급"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 가치는 항상 "비상"입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "b0dbda5347c12200e0ef563dbb9a718f",
display_value: "b0dbda5347c12200e0ef563dbb9a718f"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
},
},
]
}
Change Management - DELETE /sn_chg_rest/change/normal/{sys_id}
지정된 sys_id으로 식별된 일반 변경 요청을 삭제합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/normal/{sys_id}
기본 URL: / api/sn_chg_rest/change/normal/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 삭제할 일반 변경 요청의 Sys_id 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 삭제 전 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "Normal"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 값은 항상 "정상"입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
},
},
]
}
Change Management - /sn_chg_rest/change/standard/{sys_id} 삭제
지정된 sys_id으로 식별된 표준 변경 요청을 삭제합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/standard/{sys_id}
기본 URL: / api/sn_chg_rest/change/standard/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 삭제할 표준 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 식별된 변경 요청에 연결된 값이 있는 모든 필드(키)입니다. |
| 상태 | 삭제 전 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청의 고유 식별자입니다. |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "1c87925347c12200e0ef563dbb9a7177",
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
]
}
Change Management - GET /sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule
계획된 시작 시간을 포함하는 옵션을 사용하여 구성 항목 ID 및 기간별로 사용 가능한 시간 슬롯을 검색할 수 있습니다.
필요한 역할: sn_change_writer.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/ci/{cmdb_ci_sys_id}/schedule
기본 URL: / api/sn_chg_rest/change/ci/{cmdb_ci_sys_id}/schedule
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| cmdb_ci_sys_id | 구성 항목 [cmdb_ci] 테이블의 기록 Sys_id. 이 엔드포인트에는 변경 요청이 필요하지 않습니다. |
| 이름 | 설명 |
|---|---|
| duration_in_seconds | 변경 기간(초), 즉 변경 요청 작업을 완료하는 데 필요한 시간입니다. 데이터 유형: 정수 |
| planned_start_time | 옵션입니다. 변경 요청의 구현을 UTC로 시작하기 위해 계획된 날짜 및 시간입니다. 이 시간 또는 그 이후의 사용 가능한 시간 슬롯을 검색합니다. 제공되지 않은 경우 시스템은 현재 시간을 시작 시간으로 사용합니다. 시간 형식: yyyy-mm-dd hh:mm:ss 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 202 | 시스템이 요청을 수락했습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 가능한 문제:
|
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 오류 | 엔드포인트 요청을 처리하는 동안 발생한 오류에 대한 정보입니다. 데이터 유형: 객체 |
| 오류.상세 정보 | 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| error.message | 오류를 식별하는 메시지입니다. 데이터 유형: 문자열 |
| 메시지 | 메시지 정보입니다. 데이터 유형: 객체 |
| messages.errorMessages | 요청을 처리하는 동안 발생한 오류 메시지입니다. 데이터 유형: 배열 |
| messages.info메시지 | 요청을 처리하는 동안 발생한 정보 메시지입니다. 데이터 유형: 배열 |
| messages.warning메시지 | 요청을 처리하는 동안 발생한 경고 메시지입니다. 데이터 유형: 배열 |
| 요청 | 원래 엔드포인트 요청입니다. 데이터 유형: 문자열 |
| 상태 | 작업자의 현재 상태에 대한 정보입니다. 데이터 유형: 객체 |
| state.display_value | 작업자 상태의 표시 값입니다. 이러한 값은 매개 변수와 직접 상관 관계가 있습니다 state.value . 가능한 값:
데이터 유형: 문자열 |
| 상태.값 | 작업자 상태의 숫자 값입니다. 가능한 값:
데이터 유형: 숫자 |
| 유형 | 요청의 유형을 나타냅니다. 유효한 값: schedule 데이터 유형: 문자열 |
| worker | 연결된 작업자에 대한 정보입니다. 데이터 유형: 객체 |
| worker.link | 시간 슬롯 데이터를 검색하기 위한 링크입니다.결과를 보려면 GET /sn_chg_rest/change/worker/{sys_id}의 sys_id 사용합니다. 데이터 유형: 문자열 |
| 작업자.sysId | 변경 요청과 관련된 작업자 Sys_id입니다. 데이터 유형: 문자열 |
| 상태 | 오류가 발생한 경우에만 나타납니다. 엔드포인트 처리의 상태입니다. 가능한 값: 실패 데이터 유형: 문자열 |
사용 가능한 시간 슬롯 가져오기
에 제공된 worker.link 값을 사용하여 일정 창 상세 정보를 가져옵니다. 값의 형식은 다음과 같습니다.
https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>
결과를 보려면 GET /sn_chg_rest/change/worker/{sys_id}의 worker_sys_id 사용합니다.
응답 본문에는 상태가 포함되어 있으며 처리가 완료되면 결과를 제공합니다.
- 예약된 시간 슬롯 내에서 변경 요청에 제공된 시간 슬롯을 사용할 수 있는 경우 작업자 API는 속성에 사용 가능한 시간 슬롯을 payload.spans 나열합니다. 그렇지 payload.spans 않으면 속성이 결과에 나열되지 않습니다.
- 정의된 예약 시간 슬롯 내에 변경 요청 기간에 사용할 수 있는 시간 슬롯 messages.infoMessages 이 없는 경우
D주:변경 요청 일정 시간 슬롯 기본값은 90일입니다. 이 값을 변경하려면 속성을 수정합니다 change.conflict.next_available.schedule_window . 자세한 내용은 충돌 분석 속성 구성을 참조하십시오.
다음 GET /sn_chg_rest/change/worker/{sys_id} 예제에서는 worker.link 세부 정보에 제공된 ID를 사용하여 제공된 출력을 보여 줍니다. 결과는 작업 기간에 사용할 수 있는 열린 시간 범위를 나열합니다.
{
"result": {
"worker": {
"sysId": "d7d1f2b4a444b010f87712198fe9caae",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/d7d1f2b4a444b010f87712198fe9caae"
},
"request": "{\"cmdb_ci_sys_id\":\"82967cdd0ad3370236092104ce988d76\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
},
"payload": {
"spans": [
{
"start": {
"value": "2021-05-15 08:00:00",
"display_value": "2021-05-15 01:00:00"
},
"end": {
"value": "2021-05-15 11:00:00",
"display_value": "2021-05-15 04:00:00"
}
},
{
"start": {
"value": "2021-05-22 08:00:00",
"display_value": "2021-05-22 01:00:00"
},
"end": {
"value": "2021-05-22 11:00:00",
"display_value": "2021-05-22 04:00:00"
}
},
...
]
}
}
}
cURL 요청
curl "https://instance.service-now.com/api/sn_chg_rest/change/ci/<cmdb_ci_sys_id>/schedule?duration_in_seconds=10800" \
--request GET \
--header "Accept:application/json" \
--user "username":"password" 결과에는 GET /sn_chg_rest/change/worker/ 엔드포인트에서 제공된 sys_id 실행하는 데 사용할 수 있는 worker.link 세부 정보가 포함됩니다.
{
"result": {
"worker": {
"sysId": "1049419c1b4c3010f58a6572604bcb7a",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/1049419c1b4c3010f58a6572604bcb7a"
},
"request": "{\"cmdb_ci_sys_id\":\"<cmdb_ci_sys_id>\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change Management - /sn_chg_rest/change 가져오기
지정된 기준에 따라 하나 이상의 변경 요청을 조회합니다.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change
기본 URL: / api/sn_chg_rest/change
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 결과 세트를 필터링하는 데 사용할 이름-값 쌍입니다. 이름은 지정된 값이 필터링되는 필드입니다. 이 매개 변수는 와 함께 사용할 수 없습니다 sysparm_query. 예를 들어, & sysparm_query=active=true를 사용하는 대신 &active=true를 사용하여 호출 문을 단순화할 수 있습니다. 필드가 선택 또는 참조 유형 필드인 경우(예: &state=7 대신 &state=closed) 표시 값을 사용할 수도 있습니다. 여러 키-값 쌍을 지정하려면 앰퍼샌드로 각각을 구분합니다(예: & active=true&assigned_to=john.smith). 데이터 유형: 문자열 |
| 주문 | 반환된 변경 요청을 정렬할 기준이 되는 필드입니다. 데이터 유형: 문자열 기본값: name |
| sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문은 sysparm_query=<col_name><operator><value>입니다.
모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다. 예:
인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 구문:
예: 이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
| 텍스트검색 | 모든 일반 변경 요청 기록 필드를 검색하는 데 사용하는 문자열입니다. 이 검색은 전체 텍스트 검색 플랫폼 기능을 사용합니다 ServiceNow . 검색 기능에 대한 ServiceNow 자세한 내용은 검색 관리를 참조하세요. 기본값: IR_AND_OR_QUERY |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 요소 | 설명 |
|---|---|
| 결과 | 하나 이상의 변경 요청 기록 객체가 들어 있는 목록입니다. 각 개체는 변경 요청을 설명합니다. 변경 요청 객체의 각 요소는 변경 요청 [change_request] 테이블의 연결된 기록에 있는 필드에 해당합니다. 모든 요소에는 값 및 display_value 이름-값 쌍이 포함됩니다. 날짜 필드에는 display_value_internal 이름-값 쌍도 포함됩니다. 데이터 유형: 배열 |
| action_status | 연결된 변경 요청의 현재 작업 상태입니다. 가능한 값:
데이터 유형: 숫자 |
| 활성 | 변경 요청이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: true |
| activity_due | 연결된 케이스가 완료될 것으로 예상되는 날짜 및 시간입니다. 데이터 유형: 문자열 |
| additional_assignee_list | 변경 요청에 대한 작업에 할당된 추가 사용자 sys_ids 목록입니다. 데이터 유형: 배열 |
| 승인 | 필요한 승인 프로세스 유형입니다. 데이터 유형: 문자열 기본값: 요청되지 않음 |
| approval_history | 가장 최근의 승인 이력 저널 항목입니다. 데이터 유형: 문자열 |
| approval_set | 연결된 작업이 승인된 날짜와 시간입니다. 데이터 유형: 문자열 |
| assigned_to | 변경 요청에 할당된 사용자의 Sys_id입니다. 데이터 유형: 문자열 |
| assignment_group | 변경 요청에 할당된 그룹의 Sys_id입니다. 데이터 유형: 문자열 |
| backout_plan | 변경을 취소해야 하는 경우 실행할 계획에 대한 설명입니다. 데이터 유형: 문자열 |
| business_duration | 변경을 완료하는 데 걸린 예약된 작업 시간, 작업일 및 작업 주의 길이입니다. 데이터 유형: 문자열 |
| business_service | 변경 요청과 관련된 비즈니스 서비스의 Sys_id입니다. 서비스 [cmdb_ci_service] 테이블에 있습니다. 데이터 유형: 문자열 |
| cab_date | 변경심의위원회(CAB) 회의 날짜입니다. 데이터 유형: 문자열 |
| cab_delegate | CAB 모임 중에 CAB 관리자를 대신할 수 있는 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있음 데이터 유형: 문자열 |
| cab_recommendation | 변경 요청에 대한 CAB 권장 사항에 대한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| cab_required | CAB이 필수인지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: false |
| calendar_duration | 현재 에서 사용하고 변경 관리있지 않습니다. 데이터 유형: 문자열 |
| 범주 | 변경 범주(예: 하드웨어, 네트워크 또는 소프트웨어)입니다. 데이터 유형: 문자열 기본값: 기타 |
| change_plan | 변경 요청을 관리하고 제어하기 위한 활동 및 역할입니다. 데이터 유형: 문자열 |
| chg_model | 연결된 변경 요청의 기반이 되는 변경 모델의 Sys_id입니다. 변경 모델 [chg_model] 테이블에 있습니다. 변경 모델은 변경 요청에 대해 완료해야 하는 상태 플로우, 전환 및 프로세스 활동을 정의합니다. 데이터 유형: 문자열 |
| closed_at | 연결된 변경 요청이 종결된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| closed_by | 변경 요청을 종결한 사람의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| close_code | 변경 요청을 종결할 때 할당된 코드입니다. 예를 들어 성공, 문제 발생, 실패 등이 있습니다. 데이터 유형: 문자열 |
| close_notes | 변경 요청을 종결할 때 사용자가 입력했다는 메모입니다. 데이터 유형: 문자열 |
| cmdb_ci | 변경 요청과 관련된 구성 항목의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| 설명 | 연결된 변경 요청에 입력한 고객 대면 작업 메모의 목록입니다. 데이터 유형: 배열 |
| comments_and_work_notes | 연결된 변경 요청에 대해 입력한 내부 및 고객 대면 작업 메모 목록입니다. 데이터 유형: 배열 최대 길이: 4,000 |
| 회사 | 변경 요청과 관련된 회사의 Sys_id입니다. 회사 [core_company] 테이블에 있습니다. 데이터 유형: 문자열 |
| conflict_last_run | 변경 요청에서 상충 탐지 스크립트가 마지막으로 실행된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| conflict_status | 상충 탐지 스크립트로 탐지된 현재 상충 상태(예: 상충 및 실행되지 않음)입니다. 데이터 유형: 문자열 최대 길이: 40 기본값: 실행되지 않음 |
| contact_type | 변경 요청이 처음에 요청된 방법입니다. 가능한 값:
데이터 유형: 문자열 |
| 계약 | 변경 요청과 관련된 계약의 Sys_id입니다. 계약 [ast_contract] 테이블에 있습니다. 데이터 유형: 문자열 |
| correlation_display | 에 대한 correlation_id사용자 친화적 이름입니다. 데이터 유형: 문자열 최대 길이: 100 |
| correlation_id | 외부 공급업체 시스템에서 일치하는 변경 요청 기록의 전역 고유 ID(GUID)입니다. 데이터 유형: 문자열 최대 길이: 100 |
| delivery_plan | 더 이상 사용하지 않습니다. 변경 요청과 연결된 제공 계획의 Sys_id입니다. 실행 계획 [sc_cat_item_delivery_plan] 테이블에 있습니다. 데이터 유형: 문자열 |
| delivery_task | 더 이상 사용하지 않습니다. 변경 요청과 관련된 제공 작업의 Sys_id입니다. 실행 계획 작업 [sc_cat_item_delivery_task] 테이블에 있습니다. 데이터 유형: 문자열 |
| 설명 | 변경 요청에 대한 자세한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| due_date | 작업 기한입니다. 변경 요청 프로세스에서 사용되지 않습니다. 데이터 유형: 문자열 |
| end_date | 변경 요청을 완료할 날짜 및 시간입니다. 데이터 유형: 문자열 |
| 에스컬레이션 | 현재 에스컬레이션 수준입니다. 가능한 값:
데이터 유형: 숫자(정수) 기본값: 0 |
| expected_start | 작업이 시작되는 날짜 및 시간입니다. 변경 요청 프로세스에서 사용되지 않습니다. 데이터 유형: 문자열 |
| follow_up | 사용자가 변경 요청을 요청한 사람에 대해 후속 작업을 수행한 날짜 및 시간입니다. 데이터 유형: 문자열 |
| group_list | 변경 요청과 연관된 그룹의 sys_ids 및 이름 목록입니다. 데이터 유형: 배열 최대 길이: 4,000 |
| 영향도 | 변경 요청에 대한 영향은 고객에게 미칠 것입니다. 가능한 값:
데이터 유형: 숫자(정수) 기본값: 3 |
| implementation_plan | 이 변경을 구현하기 위해 실행할 순차적 단계입니다. 또한 단계와 각 단계에 대한 담당자 정보 간의 종속성도 포함됩니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| 근거 | 이 변경을 구현할 경우의 이점과 이 변경이 구현되지 않을 경우의 영향입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| knowledge | 변경 요청과 관련된 지식베이스()KB) 문서가 있는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| 위치 | 변경 요청에 참조된 장비 위치의 Sys_id 및 이름입니다. 위치 [cmn_location] 테이블에 있는 위치에 있습니다. 데이터 유형: 문자열 |
| made_sla | 더 이상 사용되지 않습니다. 변경 요청이 관련된 서비스 수준 계약에 따라 구현되었는지 여부를 나타내는 플래그입니다. 데이터 유형: 부울 |
| needs_attention | 변경 요청에 주의가 필요한지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: false |
| 번호 | CHG0040007와 같이 시스템이 변경 요청에 할당한 변경 번호입니다. 데이터 유형: 문자열 |
| on_hold | 변경 요청이 현재 보류 중인지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: false |
| on_hold_reason | 매개변수가 on_hold "true"이면 변경 요청이 보류된 이유에 대한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| on_hold_task | 매개변수가 on_hold "true"이면 보류가 해제되기 전에 완료해야 하는 작업의 sys_ids 목록입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| opened_at | 변경 릴리스를 만든 날짜 및 시간입니다. 데이터 유형: 문자열 |
| opened_by | 변경 릴리스를 작성한 사용자의 Sys_id 및 이름입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| 주문 | 에서 변경 관리사용되지 않습니다. 데이터베이스에서 레코드를 검색할 때와 같이 레코드를 정렬하는 선택적 숫자 필드입니다. 데이터 유형: 숫자(정수) |
| outside_maintenance_schedule | 변경 요청에 대해 외부 회사의 유지관리가 예약되었는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: false |
| 상위 | 이 변경 요청의 상위 작업 Sys_id 및 이름입니다(있는 경우). 작업 [task] 테이블에 있습니다. 데이터 유형: 문자열 |
| 단계 | 변경 요청의 현재 단계입니다. 이렇게 하면 변경이 수행하는 작업이 더 자세히 정의됩니다. 가능한 값:
데이터 유형: 문자열 |
| phase_state | 변경을 위해 생성해야 하는 Change_phase 기록입니다. 변경 내용 기록마다 다른 change_phase 기록이 있을 수 있도록 범주에 따라 다릅니다. change_phase 기록은 각 change_phase 일정과 승인자 집합을 가질 수 있으므로 승인 프로세스를 제어할 수 있는 기회를 제공합니다. 가능한 값:
데이터 유형: 문자열 |
| 우선순위 | 변경 요청의 우선순위입니다. 가능한 값:
데이터 유형: 숫자(정수) 기본값: 4 |
| production_system | 변경 요청이 프로덕션 환경에 있는 인스턴스에 대한 ServiceNow 것인지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| 이유 | 변경 요청이 시작된 이유에 대한 설명입니다. 가능한 값:
데이터 유형: 문자열 최대 길이: 40 |
| reassignment_count | 변경 요청이 새 소유자에게 재할당된 횟수입니다. 데이터 유형: 숫자(정수) 기본값: 0 |
| rejection_goto | 변경 요청이 거부되는 경우 수행할 작업의 Sys_id입니다. 작업 [테이블]에 있습니다. 데이터 유형: 문자열 |
| requested_by | 변경을 요청한 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| requested_by_date | 변경을 요청하여 구현한 날짜 및 시간입니다. 데이터 유형: 문자열 |
| review_comments | 변경 요청을 검토할 때 입력한 의견입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| review_date | 변경 요청을 검토한 날짜입니다. 데이터 유형: 문자열 |
| review_status | 요청된 변경 요청 검토의 현재 상태입니다. 데이터 유형: 문자열 |
| risk | 변경 요청과 관련된 위험 수준입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 숫자 기본값: 3 |
| risk_impact_analysis | 변경 요청 구현의 위험 및 분석에 대한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| route_reason | 현재 에서 사용하고 변경 관리있지 않습니다. 변경 요청이 전송된 이유입니다. 가능한 값:
데이터 유형: 숫자 |
| scope | 변경 요청의 크기입니다. 가능한 값:
데이터 유형: 숫자 기본값: 3 |
| service_offering | 변경 요청과 연결된 서비스 오퍼링의 Sys_id입니다. 서비스 오퍼링은 가용성, 범위, 가격 및 패키징 옵션 측면에서 서비스 수준을 고유하게 정의합니다. 오퍼링 [service_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| short_description | 변경 요청에 대한 설명입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 기술 | 변경 요청을 구현하는 데 필요한 모든 기술의 sys_ids 목록입니다. 기술 [cmn_skill] 테이블에 있습니다. 데이터 유형: 배열 |
| sla_due | 더 이상 사용하지 않습니다. 연결된 서비스 수준 계약에 따라 변경 요청을 완료해야 하는 날짜 및 시간입니다. 데이터 유형: 문자열 |
| sn_esign_document | 변경 요청에 첨부된 전자 서명 문서의 Sys_id입니다. 첨부 파일 [sys_attachment] 테이블에 있습니다. 데이터 유형: 문자열 |
| sn_esign_esignature_configuration | 연결된 문서에 사용된 전자 서명 템플릿의 Sys_id입니다. 전자 서명 템플릿 [sn_esign_configuration] 테이블에 있습니다. 데이터 유형: 문자열 |
| start_date | 변경 요청의 구현을 시작하기 위해 계획된 날짜와 시간입니다. 데이터 유형: 문자열 |
| 상태 | 변경 요청의 현재 상태입니다. 가능한 값은 변경 모델에 정의됩니다. 데이터 유형: 숫자(정수) 기본값: 1 |
| std_change_producer_version | 변경 요청과 연관된 기록 생성자 및 변경 제안의 Sys_id입니다. 제안서에서 만든 성공 및 실패 변경 요청 수와 백분율도 있습니다. 표준 변경 템플릿 버전 [std_change_producer_version] 테이블에 있습니다. 데이터 유형: 문자열 |
| sys_class_name | 변경 요청이 있는 테이블의 이름입니다. 데이터 유형: 문자열 |
| sys_created_by | 처음에 변경 요청을 작성한 사용자의 이름입니다. 데이터 유형: 문자열 최대 길이: 40 |
| sys_created_on | 연결된 변경 요청 기록이 원래 만들어진 날짜 및 시간입니다. 데이터 유형: 문자열 |
| sys_domain | 인스턴스에서 도메인을 사용하는 경우 변경 모듈 기록이 연결된 도메인의 이름입니다. 데이터 유형: 문자열 |
| sys_domain_path | 인스턴스에서 도메인을 사용하는 경우 연관된 변경 모듈 기록이 있는 도메인 경로입니다. 데이터 유형: 문자열 |
| sys_id | 관련 변경 요청 기록의 고유 식별자입니다. 데이터 유형: 문자열 |
| sys_mod_count | 처음 생성된 이후 케이스에 대한 업데이트 수입니다. 데이터 유형: 숫자(정수) |
| sys_updated_by | 케이스를 마지막으로 업데이트한 사람입니다. 데이터 유형: 문자열 최대 길이: 40 |
| sys_updated_on | 케이스가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| task_effective_number | Universal Request 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| task_for | 에서 변경 관리사용되지 않습니다. 작업이 생성된 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| test_plan | 변경과 관련된 테스트 계획의 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| time_worked | 변경 요청에 대해 작업한 총 시간입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청 유형입니다. 가능한 값:
데이터 유형: 문자열 최대 길이: 40 |
| 무단 | 변경 요청이 권한 해제되었는지 여부를 나타내는 플래그 가능한 값:
데이터 유형: 부울 |
| universal_request | 이 변경 요청이 속한 상위 Universal Request의 Sys_id입니다. 작업 [task] 테이블에 있습니다. 데이터 유형: 문자열 |
| upon_approval | 변경 요청이 승인될 경우 수행할 동작입니다. 가능한 값:
데이터 유형: 문자열 최대 길이: 40 기본값: 계속 |
| upon_reject | 변경 요청이 거부될 경우 수행할 작업입니다. 가능한 값:
데이터 유형: 문자열 최대 길이: 40 기본값: 취소 |
| 긴급도 | 변경 요청의 긴급도입니다. 가능한 값:
데이터 유형: 숫자(정수) 기본값: 3 |
| user_input | 추가 사용자 입력입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| variables | 변경 요청과 연관된 변수의 이름-값 쌍입니다. 데이터 유형: 문자열 최대 길이: 40 |
| watch_list | 추가 주석이 추가되거나 변경 요청의 상태가 해결됨 또는 종결됨으로 변경될 경우 이 변경 요청에 대한 알림을 받는 사용자 sys_ids 목록입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 배열 |
| wf_activity | 변경 요청과 연관된 워크플로우 활동 기록의 Sys_id입니다. 워크플로우 활동 [wf_activity] 테이블에 있습니다. 데이터 유형: 문자열 |
| work_end | 변경 요청에서 작업이 종료된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| work_notes | 변경 요청을 해결하는 방법 또는 변경 요청을 해결하기 위해 수행한 단계에 대한 정보입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| work_notes_list | 작업 메모가 추가될 때 이 변경 요청에 대한 알림을 받는 내부 사용자 sys_ids 목록입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 배열 |
| work_start | 변경 요청에 대해 작업이 시작된 날짜 및 시간입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
간단히 하기 위해 결과에는 단일 변경 요청 기록만 포함됩니다.
{
"result": [
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Clear BGP sessions on a Cisco router",
"value": "Clear BGP sessions on a Cisco router"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "1766f1de47410200e90d87e8dee490f6",
"value": "1766f1de47410200e90d87e8dee490f6"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
]
}
Change Management - GET /sn_chg_rest/change/{change_sys_id}/nextstates
현재 상태를 포함하여 지정된 변경 요청에 대해 사용 가능한 상태 목록을 조회합니다.
사용 가능한 경우 구현된 Change Management 버전에 따라 다음 상태로 전환하는 방법도 제공합니다. 변경 내용이 변경 모델 기반인 경우 엔드포인트는 통과 여부에 대한 조건을 반환합니다. 또한 지정된 전환에 대해 모든 조건이 통과되었는지 여부에 대한 정보도 제공합니다. 유형 기반 및 레거시 변경 요청에는 이 정보를 사용할 수 없습니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{ api_version}/change/{change_sys_id}/nextstates
기본 URL: / api/sn_chg_rest/change/{change_sys_id}/nextstates
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| change_sys_id | 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| available_states | 현재 상태를 포함하여 지정된 변경 요청에 사용할 수 있는 상태의 값입니다. 데이터 유형: 배열 |
| state_label | 레이블을 사용 가능한 상태와 연결하는 키-값 쌍입니다. 데이터 유형: 객체 |
| state_transitions | 사용 가능한 각 상태로 전환하는 데 필요한 사항에 대한 정보입니다. 사용 가능한 각 고유 "상태"는 자체 Array에 있으며 자체 Object에 상태를 지정하기 위한 각 조건 집합이 다릅니다. 데이터 유형: 배열 |
| state_transitions.automatic_transition | 이 상태로 자동 전환할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| state_transitions. 조건 | 상태와 연결된 조건의 목록입니다. 데이터 유형: 객체 배열 |
| state_transitions.조건.조건 | 특정 조건의 값입니다. 데이터 유형: 객체 |
| state_transitions.조건.조건.설명 | 조건에 대한 설명입니다. 데이터 유형: 문자열 |
| state_transitions.conditions.condition.name | 조건의 이름입니다. 데이터 유형: 문자열 |
| state_transitions.conditions.condition.sys_id | 조건의 Sys_id입니다. 데이터 유형: 문자열 |
| state_transitions.조건.통과됨 | 변경 요청이 관련 조건을 충족하는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
|
| state_transitions.display_value | 상태에 대한 표시된 설명입니다. 데이터 유형: 문자열 |
| state_transitions.from_state | 변경 요청이 전환되는 상태의 값입니다. 데이터 유형: 문자열 |
| state_transitions.sys_id | 전환 상태의 Sys_id입니다. 데이터 유형: 문자열 |
| state_transitions.to_state | 변경 요청이 전환되는 상태의 값입니다. 데이터 유형: 문자열 |
| state_transitions.transition_available | 변경 요청이 현재 상태에서 이 상태로 전환될 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
|
cURL 요청
다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f"/nextstates \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
반환 결과:
{
"result": {
"available_states": [ "0", "4", "-1" ], // State values
"state_transitions": [
[
{
"sys_id": "7a0d2ccdc343101035ae3f52c1d3ae2e", // sttrm_state_transition sys id
"display_value": "Implement to Review",
"from_state": "-1",
"to_state": "0",
"transition_available": false, // If true, can move to this state
"automatic_transition": true, // If true, automatically moves to this state
"conditions": [
{
"passed": false, // If true, change request met this condition
"condition": {
"name": "No active Change Tasks",
"description": null,
"sys_id": "3c1d2ccdc343101035ae3f52c1d3aea4"
}
}
]
},
{
"sys_id": "db401481c343101035ae3f52c1d3aedd",
"display_value": "Implement to Review",
"from_state": "-1",
"to_state": "0",
"transition_available": true,
"automatic_transition": false,
"conditions": [
{
"passed": true,
"condition": {
"name": "Not On hold",
"description": null,
"sys_id": "2132deb6c303101035ae3f52c1d3ae8c"
}
}
]
}
],
[
{
"sys_id": "5327c551c343101035ae3f52c1d3aeec",
"display_value": "Implement to Canceled",
"from_state": "-1",
"to_state": "4",
"transition_available": true,
"automatic_transition": false,
"conditions": []
}
]
],
"state_label": { // state value to label pairs
"0": "Review",
"4": "Canceled",
"-1": "Implement"
}
}
}
Change Management - GET /sn_chg_rest/change/{change_sys_id}/schedule
변경 요청에 사용할 수 있는 시간 슬롯을 검색할 수 있도록 설정합니다.
필요한 역할: sn_change_writer.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{change_sys_id}/schedule
기본 URL: / api/sn_chg_rest/change/{change_sys_id}/schedule
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| change_sys_id | 다음에 사용 가능한 시간 슬롯을 찾을 변경 요청의 Sys_id입니다. [change_request] 테이블에 있습니다. 선택한 변경 요청에는 계획된 시작 및 계획된 종료 시간이 있는 구성 항목(cmdb_ci)이 있어야 합니다. |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 202 | 시스템이 요청을 수락했습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 가능한 문제:
|
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다.
가능한 문제:
|
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 오류 | 엔드포인트 요청을 처리하는 동안 발생한 오류에 대한 정보입니다. 데이터 유형: 객체 |
| 오류.상세 정보 | 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| error.message | 오류를 식별하는 메시지입니다. 데이터 유형: 문자열 |
| 메시지 | 메시지 정보입니다. 데이터 유형: 객체 |
| messages.errorMessages | 요청을 처리하는 동안 발생한 오류 메시지입니다. 데이터 유형: 배열 |
| messages.info메시지 | 요청을 처리하는 동안 발생한 정보 메시지입니다. 데이터 유형: 배열 |
| messages.warning메시지 | 요청을 처리하는 동안 발생한 경고 메시지입니다. 데이터 유형: 배열 |
| 요청 | 원래 엔드포인트 요청입니다. 데이터 유형: 문자열 |
| 상태 | 작업자의 현재 상태에 대한 정보입니다. 데이터 유형: 객체 |
| state.display_value | 작업자 상태의 표시 값입니다. 이러한 값은 매개 변수와 직접 상관 관계가 있습니다 state.value . 가능한 값:
데이터 유형: 문자열 |
| 상태.값 | 작업자 상태의 숫자 값입니다. 가능한 값:
데이터 유형: 숫자 |
| 유형 | 요청의 유형을 나타냅니다. 유효한 값: schedule 데이터 유형: 문자열 |
| worker | 연결된 작업자에 대한 정보입니다. 데이터 유형: 객체 |
| worker.link | 시간 슬롯 데이터를 검색하기 위한 링크입니다.결과를 보려면 GET /sn_chg_rest/change/worker/{sys_id}의 sys_id 사용합니다. 데이터 유형: 문자열 |
| 작업자.sysId | 변경 요청과 관련된 작업자 Sys_id입니다. 데이터 유형: 문자열 |
| 상태 | 오류가 발생한 경우에만 나타납니다. 엔드포인트 처리의 상태입니다. 가능한 값: 실패 데이터 유형: 문자열 |
사용 가능한 시간 슬롯 가져오기
에 제공된 worker.link 값을 사용하여 일정 창 상세 정보를 가져옵니다. 값의 형식은 다음과 같습니다.
https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>
결과를 보려면 GET /sn_chg_rest/change/worker/{worker_sys_id}의 worker_sys_id 사용합니다.
응답 본문에는 상태가 포함되어 있으며 처리가 완료되면 결과를 제공합니다.
- 예약된 시간 슬롯 내에서 변경 요청에 제공된 시간 슬롯을 사용할 수 있는 경우 작업자 API는 속성에 사용 가능한 시간 슬롯을 payload.spans 나열합니다. 그렇지 payload.spans 않으면 속성이 결과에 나열되지 않습니다.
- 정의된 예약 시간 슬롯 내에 변경 요청 기간에 사용할 수 있는 시간 슬롯 messages.infoMessages 이 없는 경우
D주:변경 요청 일정 시간 슬롯 기본값은 90일입니다. 이 값을 변경하려면 속성을 수정합니다 change.conflict.next_available.schedule_window . 자세한 내용은 충돌 분석 속성 구성을 참조하십시오.
다음 GET /sn_chg_rest/change/worker/{sys_id} 예제에서는 worker.link 세부 정보에 제공된 ID를 사용하여 제공된 출력을 보여 줍니다. 결과는 작업 기간에 사용할 수 있는 열린 시간 범위를 나열합니다.
{
"result": {
"worker": {
"sysId": "9b3f62e0a4c87010f87712198fe9cad1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
},
"payload": {
"spans": [
{
"start": {
"value": "2021-05-08 08:00:00",
"display_value": "2021-05-08 01:00:00"
},
"end": {
"value": "2021-05-08 11:00:00",
"display_value": "2021-05-08 04:00:00"
}
},
{
"start": {
"value": "2021-05-15 08:00:00",
"display_value": "2021-05-15 01:00:00"
},
"end": {
"value": "2021-05-15 11:00:00",
"display_value": "2021-05-15 04:00:00"
}
},
...
]
}
}
}
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/change/{change_sys_id}/schedule" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
결과에는 GET /sn_chg_rest/change/worker/ 엔드포인트에서 제공된 sys_id 실행하는 데 사용할 수 있는 worker.link 세부 정보가 포함됩니다.
{
"result": {
"worker": {
"sysId": "9b3f62e0a4c87010f87712198fe9cad1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change Management - /sn_chg_rest/change/{change_sys_id}/task 가져오기
지정된 기준에 따라 지정된 변경 요청과 연결된 하나 이상의 작업을 검색합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{change_sys_id}/task
기본 URL: / api/sn_chg_rest/change/{change_sys_id}/task
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| change_sys_id | 작업을 검색할 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 키-값 쌍 | 요청을 생성할 때 수정할 필드입니다. 키는 템플릿 내의 필드 이름이며 값은 필드에 채울 정보입니다. 수정할 수 없고 전달되면 무시되는 필드:
데이터 유형: 문자열 |
| 주문 | 반환된 변경 요청을 정렬할 기준이 되는 필드입니다. 기본값: 숫자 데이터 유형: 문자열 |
| sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 500 |
| sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문은 sysparm_query=<col_name><operator><value>입니다.
모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다. 예:
인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 구문:
예: 이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
| 텍스트검색 | 모든 변경 작업 기록 필드를 검색하는 데 사용하는 문자열입니다. 이 검색은 전체 텍스트 검색 플랫폼 기능을 사용 ServiceNow 하며 기본적으로 IR_AND_OR_QUERY으로 설정됩니다.데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 삭제하기 전에 식별된 변경 요청 작업에 연결된 값이 있는 모든 필드(키)입니다. 데이터 유형: 객체 |
| 상위 | 작업과 연결된 변경 요청에 대한 정보입니다. 데이터 유형: 객체 |
| parent.display_value | UI에 표시할 변경 요청 정보입니다. 데이터 유형: 문자열 |
| 부모.값 | 작업과 연결된 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청 작업에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청 작업의 Sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe ",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire node",
display_value: "Retire node"
}
},
{ // next record found }, ... // and so on
]
}
Change Management - GET /sn_chg_rest/change/{sys_id}
지정된 sys_id으로 식별된 변경 요청을 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}
기본 URL: / api/sn_chg_rest/change/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청 [change_request] 테이블에서 검색할 변경 요청 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 요소 | 설명 |
|---|---|
| 결과 | 하나 이상의 변경 요청 기록 객체가 들어 있는 목록입니다. 각 개체는 변경 요청을 설명합니다. 변경 요청 객체의 각 요소는 변경 요청 [change_request] 테이블의 연결된 기록에 있는 필드에 해당합니다. 모든 요소에는 값 및 display_value 이름-값 쌍이 포함됩니다. 날짜 필드에는 display_value_internal 이름-값 쌍도 포함됩니다. 데이터 유형: 배열 |
| action_status | 연결된 변경 요청의 현재 작업 상태입니다. 가능한 값:
데이터 유형: 숫자 |
| 활성 | 변경 요청이 활성 상태인지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: true |
| activity_due | 연결된 케이스가 완료될 것으로 예상되는 날짜 및 시간입니다. 데이터 유형: 문자열 |
| additional_assignee_list | 변경 요청에 대한 작업에 할당된 추가 사용자 sys_ids 목록입니다. 데이터 유형: 배열 |
| 승인 | 필요한 승인 프로세스 유형입니다. 데이터 유형: 문자열 기본값: 요청되지 않음 |
| approval_history | 가장 최근의 승인 이력 저널 항목입니다. 데이터 유형: 문자열 |
| approval_set | 연결된 작업이 승인된 날짜와 시간입니다. 데이터 유형: 문자열 |
| assigned_to | 변경 요청에 할당된 사용자의 Sys_id입니다. 데이터 유형: 문자열 |
| assignment_group | 변경 요청에 할당된 그룹의 Sys_id입니다. 데이터 유형: 문자열 |
| backout_plan | 변경을 취소해야 하는 경우 실행할 계획에 대한 설명입니다. 데이터 유형: 문자열 |
| business_duration | 변경을 완료하는 데 걸린 예약된 작업 시간, 작업일 및 작업 주의 길이입니다. 데이터 유형: 문자열 |
| business_service | 변경 요청과 관련된 비즈니스 서비스의 Sys_id입니다. 서비스 [cmdb_ci_service] 테이블에 있습니다. 데이터 유형: 문자열 |
| cab_date | 변경심의위원회(CAB) 회의 날짜입니다. 데이터 유형: 문자열 |
| cab_delegate | CAB 모임 중에 CAB 관리자를 대신할 수 있는 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있음 데이터 유형: 문자열 |
| cab_recommendation | 변경 요청에 대한 CAB 권장 사항에 대한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| cab_required | CAB이 필수인지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: false |
| calendar_duration | 현재 에서 사용하고 변경 관리있지 않습니다. 데이터 유형: 문자열 |
| 범주 | 변경 범주(예: 하드웨어, 네트워크 또는 소프트웨어)입니다. 데이터 유형: 문자열 기본값: 기타 |
| change_plan | 변경 요청을 관리하고 제어하기 위한 활동 및 역할입니다. 데이터 유형: 문자열 |
| chg_model | 연결된 변경 요청의 기반이 되는 변경 모델의 Sys_id입니다. 변경 모델 [chg_model] 테이블에 있습니다. 변경 모델은 변경 요청에 대해 완료해야 하는 상태 플로우, 전환 및 프로세스 활동을 정의합니다. 데이터 유형: 문자열 |
| closed_at | 연결된 변경 요청이 종결된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| closed_by | 변경 요청을 종결한 사람의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| close_code | 변경 요청을 종결할 때 할당된 코드입니다. 예를 들어 성공, 문제 발생, 실패 등이 있습니다. 데이터 유형: 문자열 |
| close_notes | 변경 요청을 종결할 때 사용자가 입력했다는 메모입니다. 데이터 유형: 문자열 |
| cmdb_ci | 변경 요청과 관련된 구성 항목의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| 설명 | 연결된 변경 요청에 입력한 고객 대면 작업 메모의 목록입니다. 데이터 유형: 배열 |
| comments_and_work_notes | 연결된 변경 요청에 대해 입력한 내부 및 고객 대면 작업 메모 목록입니다. 데이터 유형: 배열 최대 길이: 4,000 |
| 회사 | 변경 요청과 관련된 회사의 Sys_id입니다. 회사 [core_company] 테이블에 있습니다. 데이터 유형: 문자열 |
| conflict_last_run | 변경 요청에서 상충 탐지 스크립트가 마지막으로 실행된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| conflict_status | 상충 탐지 스크립트로 탐지된 현재 상충 상태(예: 상충 및 실행되지 않음)입니다. 데이터 유형: 문자열 최대 길이: 40 기본값: 실행되지 않음 |
| contact_type | 변경 요청이 처음에 요청된 방법입니다. 가능한 값:
데이터 유형: 문자열 |
| 계약 | 변경 요청과 관련된 계약의 Sys_id입니다. 계약 [ast_contract] 테이블에 있습니다. 데이터 유형: 문자열 |
| correlation_display | 에 대한 correlation_id사용자 친화적 이름입니다. 데이터 유형: 문자열 최대 길이: 100 |
| correlation_id | 외부 공급업체 시스템에서 일치하는 변경 요청 기록의 전역 고유 ID(GUID)입니다. 데이터 유형: 문자열 최대 길이: 100 |
| delivery_plan | 더 이상 사용하지 않습니다. 변경 요청과 연결된 제공 계획의 Sys_id입니다. 실행 계획 [sc_cat_item_delivery_plan] 테이블에 있습니다. 데이터 유형: 문자열 |
| delivery_task | 더 이상 사용하지 않습니다. 변경 요청과 관련된 제공 작업의 Sys_id입니다. 실행 계획 작업 [sc_cat_item_delivery_task] 테이블에 있습니다. 데이터 유형: 문자열 |
| 설명 | 변경 요청에 대한 자세한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| due_date | 작업 기한입니다. 변경 요청 프로세스에서 사용되지 않습니다. 데이터 유형: 문자열 |
| end_date | 변경 요청을 완료할 날짜 및 시간입니다. 데이터 유형: 문자열 |
| 에스컬레이션 | 현재 에스컬레이션 수준입니다. 가능한 값:
데이터 유형: 숫자(정수) 기본값: 0 |
| expected_start | 작업이 시작되는 날짜 및 시간입니다. 변경 요청 프로세스에서 사용되지 않습니다. 데이터 유형: 문자열 |
| follow_up | 사용자가 변경 요청을 요청한 사람에 대해 후속 작업을 수행한 날짜 및 시간입니다. 데이터 유형: 문자열 |
| group_list | 변경 요청과 연관된 그룹의 sys_ids 및 이름 목록입니다. 데이터 유형: 배열 최대 길이: 4,000 |
| 영향도 | 변경 요청에 대한 영향은 고객에게 미칠 것입니다. 가능한 값:
데이터 유형: 숫자(정수) 기본값: 3 |
| implementation_plan | 이 변경을 구현하기 위해 실행할 순차적 단계입니다. 또한 단계와 각 단계에 대한 담당자 정보 간의 종속성도 포함됩니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| 근거 | 이 변경을 구현할 경우의 이점과 이 변경이 구현되지 않을 경우의 영향입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| knowledge | 변경 요청과 관련된 지식베이스()KB) 문서가 있는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| 위치 | 변경 요청에 참조된 장비 위치의 Sys_id 및 이름입니다. 위치 [cmn_location] 테이블에 있는 위치에 있습니다. 데이터 유형: 문자열 |
| made_sla | 더 이상 사용되지 않습니다. 변경 요청이 관련된 서비스 수준 계약에 따라 구현되었는지 여부를 나타내는 플래그입니다. 데이터 유형: 부울 |
| needs_attention | 변경 요청에 주의가 필요한지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: false |
| 번호 | CHG0040007와 같이 시스템이 변경 요청에 할당한 변경 번호입니다. 데이터 유형: 문자열 |
| on_hold | 변경 요청이 현재 보류 중인지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: false |
| on_hold_reason | 매개변수가 on_hold "true"이면 변경 요청이 보류된 이유에 대한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| on_hold_task | 매개변수가 on_hold "true"이면 보류가 해제되기 전에 완료해야 하는 작업의 sys_ids 목록입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| opened_at | 변경 릴리스를 만든 날짜 및 시간입니다. 데이터 유형: 문자열 |
| opened_by | 변경 릴리스를 작성한 사용자의 Sys_id 및 이름입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| 주문 | 에서 변경 관리사용되지 않습니다. 데이터베이스에서 레코드를 검색할 때와 같이 레코드를 정렬하는 선택적 숫자 필드입니다. 데이터 유형: 숫자(정수) |
| outside_maintenance_schedule | 변경 요청에 대해 외부 회사의 유지관리가 예약되었는지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 기본값: false |
| 상위 | 이 변경 요청의 상위 작업 Sys_id 및 이름입니다(있는 경우). 작업 [task] 테이블에 있습니다. 데이터 유형: 문자열 |
| 단계 | 변경 요청의 현재 단계입니다. 이렇게 하면 변경이 수행하는 작업이 더 자세히 정의됩니다. 가능한 값:
데이터 유형: 문자열 |
| phase_state | 변경을 위해 생성해야 하는 Change_phase 기록입니다. 변경 내용 기록마다 다른 change_phase 기록이 있을 수 있도록 범주에 따라 다릅니다. change_phase 기록은 각 change_phase 일정과 승인자 집합을 가질 수 있으므로 승인 프로세스를 제어할 수 있는 기회를 제공합니다. 가능한 값:
데이터 유형: 문자열 |
| 우선순위 | 변경 요청의 우선순위입니다. 가능한 값:
데이터 유형: 숫자(정수) 기본값: 4 |
| production_system | 변경 요청이 프로덕션 환경에 있는 인스턴스에 대한 ServiceNow 것인지 여부를 나타내는 플래그입니다. 가능한 값:
데이터 유형: 부울 |
| 이유 | 변경 요청이 시작된 이유에 대한 설명입니다. 가능한 값:
데이터 유형: 문자열 최대 길이: 40 |
| reassignment_count | 변경 요청이 새 소유자에게 재할당된 횟수입니다. 데이터 유형: 숫자(정수) 기본값: 0 |
| rejection_goto | 변경 요청이 거부되는 경우 수행할 작업의 Sys_id입니다. 작업 [테이블]에 있습니다. 데이터 유형: 문자열 |
| requested_by | 변경을 요청한 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| requested_by_date | 변경을 요청하여 구현한 날짜 및 시간입니다. 데이터 유형: 문자열 |
| review_comments | 변경 요청을 검토할 때 입력한 의견입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| review_date | 변경 요청을 검토한 날짜입니다. 데이터 유형: 문자열 |
| review_status | 요청된 변경 요청 검토의 현재 상태입니다. 데이터 유형: 문자열 |
| risk | 변경 요청과 관련된 위험 수준입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 숫자 기본값: 3 |
| risk_impact_analysis | 변경 요청 구현의 위험 및 분석에 대한 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| route_reason | 현재 에서 사용하고 변경 관리있지 않습니다. 변경 요청이 전송된 이유입니다. 가능한 값:
데이터 유형: 숫자 |
| scope | 변경 요청의 크기입니다. 가능한 값:
데이터 유형: 숫자 기본값: 3 |
| service_offering | 변경 요청과 연결된 서비스 오퍼링의 Sys_id입니다. 서비스 오퍼링은 가용성, 범위, 가격 및 패키징 옵션 측면에서 서비스 수준을 고유하게 정의합니다. 오퍼링 [service_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| short_description | 변경 요청에 대한 설명입니다. 데이터 유형: 문자열 최대 길이: 40 |
| 기술 | 변경 요청을 구현하는 데 필요한 모든 기술의 sys_ids 목록입니다. 기술 [cmn_skill] 테이블에 있습니다. 데이터 유형: 배열 |
| sla_due | 더 이상 사용하지 않습니다. 연결된 서비스 수준 계약에 따라 변경 요청을 완료해야 하는 날짜 및 시간입니다. 데이터 유형: 문자열 |
| sn_esign_document | 변경 요청에 첨부된 전자 서명 문서의 Sys_id입니다. 첨부 파일 [sys_attachment] 테이블에 있습니다. 데이터 유형: 문자열 |
| sn_esign_esignature_configuration | 연결된 문서에 사용된 전자 서명 템플릿의 Sys_id입니다. 전자 서명 템플릿 [sn_esign_configuration] 테이블에 있습니다. 데이터 유형: 문자열 |
| start_date | 변경 요청의 구현을 시작하기 위해 계획된 날짜와 시간입니다. 데이터 유형: 문자열 |
| 상태 | 변경 요청의 현재 상태입니다. 가능한 값은 변경 모델에 정의됩니다. 데이터 유형: 숫자(정수) 기본값: 1 |
| std_change_producer_version | 변경 요청과 연관된 기록 생성자 및 변경 제안의 Sys_id입니다. 제안서에서 만든 성공 및 실패 변경 요청 수와 백분율도 있습니다. 표준 변경 템플릿 버전 [std_change_producer_version] 테이블에 있습니다. 데이터 유형: 문자열 |
| sys_class_name | 변경 요청이 있는 테이블의 이름입니다. 데이터 유형: 문자열 |
| sys_created_by | 처음에 변경 요청을 작성한 사용자의 이름입니다. 데이터 유형: 문자열 최대 길이: 40 |
| sys_created_on | 연결된 변경 요청 기록이 원래 만들어진 날짜 및 시간입니다. 데이터 유형: 문자열 |
| sys_domain | 인스턴스에서 도메인을 사용하는 경우 변경 모듈 기록이 연결된 도메인의 이름입니다. 데이터 유형: 문자열 |
| sys_domain_path | 인스턴스에서 도메인을 사용하는 경우 연관된 변경 모듈 기록이 있는 도메인 경로입니다. 데이터 유형: 문자열 |
| sys_id | 관련 변경 요청 기록의 고유 식별자입니다. 데이터 유형: 문자열 |
| sys_mod_count | 처음 생성된 이후 케이스에 대한 업데이트 수입니다. 데이터 유형: 숫자(정수) |
| sys_updated_by | 케이스를 마지막으로 업데이트한 사람입니다. 데이터 유형: 문자열 최대 길이: 40 |
| sys_updated_on | 케이스가 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| task_effective_number | Universal Request 번호입니다. 데이터 유형: 문자열 최대 길이: 40 |
| task_for | 에서 변경 관리사용되지 않습니다. 작업이 생성된 사용자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열 |
| test_plan | 변경과 관련된 테스트 계획의 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| time_worked | 변경 요청에 대해 작업한 총 시간입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청 유형입니다. 가능한 값:
데이터 유형: 문자열 최대 길이: 40 |
| 무단 | 변경 요청이 권한 해제되었는지 여부를 나타내는 플래그 가능한 값:
데이터 유형: 부울 |
| universal_request | 이 변경 요청이 속한 상위 Universal Request의 Sys_id입니다. 작업 [task] 테이블에 있습니다. 데이터 유형: 문자열 |
| upon_approval | 변경 요청이 승인될 경우 수행할 동작입니다. 가능한 값:
데이터 유형: 문자열 최대 길이: 40 기본값: 계속 |
| upon_reject | 변경 요청이 거부될 경우 수행할 작업입니다. 가능한 값:
데이터 유형: 문자열 최대 길이: 40 기본값: 취소 |
| 긴급도 | 변경 요청의 긴급도입니다. 가능한 값:
데이터 유형: 숫자(정수) 기본값: 3 |
| user_input | 추가 사용자 입력입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| variables | 변경 요청과 연관된 변수의 이름-값 쌍입니다. 데이터 유형: 문자열 최대 길이: 40 |
| watch_list | 추가 주석이 추가되거나 변경 요청의 상태가 해결됨 또는 종결됨으로 변경될 경우 이 변경 요청에 대한 알림을 받는 사용자 sys_ids 목록입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 배열 |
| wf_activity | 변경 요청과 연관된 워크플로우 활동 기록의 Sys_id입니다. 워크플로우 활동 [wf_activity] 테이블에 있습니다. 데이터 유형: 문자열 |
| work_end | 변경 요청에서 작업이 종료된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| work_notes | 변경 요청을 해결하는 방법 또는 변경 요청을 해결하기 위해 수행한 단계에 대한 정보입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| work_notes_list | 작업 메모가 추가될 때 이 변경 요청에 대한 알림을 받는 내부 사용자 sys_ids 목록입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 배열 |
| work_start | 변경 요청에 대해 작업이 시작된 날짜 및 시간입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Clear BGP sessions on a Cisco router",
"value": "Clear BGP sessions on a Cisco router"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "1766f1de47410200e90d87e8dee490f6",
"value": "1766f1de47410200e90d87e8dee490f6"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}
Change Management - GET /sn_chg_rest/change/{sys_id}/ci
지정된 연결 유형에 따라 지정된 변경 요청에 연결된 여러 CI(구성 항목)를 검색합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}/ci
기본 URL: / api/sn_chg_rest/change/{sys_id}/ci
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 연결된 CMDB CI를 반환할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| association_type | 필수 CMDB CI와 변경 요청 간의 연결 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 이름-값 쌍 | 결과 세트를 필터링하는 데 사용할 이름-값 쌍입니다. 이름은 지정된 값이 필터링되는 필드입니다. 이 매개 변수는 와 함께 사용할 수 없습니다 sysparm_query. 예를 들어, & sysparm_query=active=true를 사용하는 대신 &active=true를 사용하여 호출 문을 단순화할 수 있습니다. 필드가 선택 또는 참조 유형 필드인 경우(예: &state=7 대신 &state=closed) 표시 값을 사용할 수도 있습니다. 여러 키-값 쌍을 지정하려면 앰퍼샌드로 각각을 구분합니다(예: & active=true&assigned_to=john.smith). 데이터 유형: 문자열 |
| sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 500 |
| sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문은 sysparm_query=<col_name><operator><value>입니다.
모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다. 예:
인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 구문:
예: 이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 오류 응답에는 문제 해결에 도움이 되는 관련 메시지가 포함되어 있습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| ci_item|cmdb_ci_service | 연결 유형에 따라 ci_item 변수 또는 cmdb_ci_service 변수입니다. 데이터 유형: 배열 |
| ci_item|cmdb_ci_service.값 | ci_item 또는 cmdb_ci_service의 Sys_id입니다. 데이터 유형: 문자열 |
| ci_item|cmdb_ci_service.display_value | ci_item 또는 cmdb_ci_service의 표시 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청 sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| <record_fields> | ci_item 또는 cmdb_ci_service 기록의 모든 유효한 필드; 연결 유형을 기반으로 하는 테이블입니다. 데이터 유형: 객체 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci?association_type=affected" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
result: [
{
sys_id: {
value: "92b8544047810200e90d87e8dee490b0",
display_value: "92b8544047810200e90d87e8dee490b0"
},
ci_item|cmdb_ci_service : {
value: "3a27d4370a0a0bb4006316812bf45439",
display_value: "PS Apache01"
},
..., // all valid fields in record, table based on association type
},
{ // next record found }, ... // and so on
]
}
Change Management - GET /sn_chg_rest/change/{sys_id}/conflict
현재 실행 중인 변경 요청 충돌 검사 프로세스의 상태 또는 지정된 변경 요청에 대해 마지막으로 완료된 충돌 검사 프로세스의 결과를 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}/conflict
기본 URL: / api/sn_chg_rest/change/{sys_id}/conflict
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 실행 중/완료된 상충 검사 프로세스의 상태를 반환하기 위한 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 상충 확인 프로세스의 현재 상태; 충돌이 감지되면 포함합니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 상충 | 변경 요청에 대해 발견된 상충 목록입니다. 빈 개체는 충돌이 감지되지 않았음을 나타냅니다. 데이터 유형: 배열 |
| job_status | 실제 상충 검사 작업의 상태입니다. 데이터 유형: 문자열 |
| last_run | 마지막 상충 검사 프로세스가 시작된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| record_count | 확인된 기록 수입니다. 데이터 유형: 문자열 |
| 상태 | 상충 검사 프로세스의 결과입니다(예: "상충" 또는 "실행되지 않음"). 주:
변경 요청에 상충이 없는 경우에도 이 필드는 "상충"으로 설정됩니다. conflicts 그러나 개체가 비어 있습니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
성공적인 응답 - 상충 없음
{
result: {
status: "Conflict",
last_run": "2018-08-30 12:58:05",
record_count: "1",
job_status: "2",
conflicts: []
}
}
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
성공적인 응답 - 상충 있음
{
result: {
status: "Conflict",
last_run": "2018-08-30 12:58:05",
record_count: "1",
job_status: "2",
conflicts: [
{
change: {
display_value: "CHG0030001",
value: "afbffb24b758230096c3e4f6ee11a972"
},
type: {
display_value: "Not In Maintenance Window",
value: "not_in_maintenance_window"
}
..., // all valid fields in record, example below
}
]
}
}
Change Management - GET /sn_chg_rest/change/emergency
지정된 기준에 따라 하나 이상의 긴급 변경 요청을 조회합니다.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change/emergency
기본 URL: / api/sn_chg_rest/change/emergency
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 주문 | 반환된 변경 요청을 정렬할 기준이 되는 필드입니다. 기본값: 숫자 데이터 유형: 문자열 기본값: 숫자 |
| sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 500 |
| sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문은 sysparm_query=<col_name><operator><value>입니다.
모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다. 예:
인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 구문:
예: 이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
| 키-값 쌍 | 결과 세트를 필터링하는 데 사용할 이름-값 쌍입니다. 이름은 지정된 값이 필터링되는 필드입니다. 이 매개 변수는 와 함께 사용할 수 없습니다 sysparm_query. 예를 들어, & sysparm_query=active=true를 사용하는 대신 &active=true를 사용하여 호출 문을 단순화할 수 있습니다. 필드가 선택 또는 참조 유형 필드인 경우(예: &state=7 대신 &state=closed) 표시 값을 사용할 수도 있습니다. 여러 키-값 쌍을 지정하려면 앰퍼샌드로 각각을 구분합니다(예: & active=true&assigned_to=john.smith). 데이터 유형: 문자열 |
| 텍스트검색 | 모든 긴급 변경 요청 기록 필드를 검색하는 데 사용할 문자열입니다. 이 검색은 전체 텍스트 검색 플랫폼 기능을 사용 ServiceNow 하며 기본적으로 IR_AND_OR_QUERY으로 설정됩니다.데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "긴급"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 가치는 항상 "비상"입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
},
},
{ // next record found }, ... // and so on
]
}
Change Management - GET /sn_chg_rest/change/emergency/{sys_id}
지정된 sys_id로 식별되는 긴급 변경 요청을 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/emergency/{sys_id}
기본 URL: / api/sn_chg_rest/change/emergency/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청[change_request] 테이블에서 검색할 긴급 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "긴급"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 가치는 항상 "비상"입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "b0dbda5347c12200e0ef563dbb9a718f",
display_value: "b0dbda5347c12200e0ef563dbb9a718f"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
},
},
]
}
Change Management - GET /sn_chg_rest/change/model
지정된 기준에 따라 하나 이상의 변경 모델을 조회합니다.
이 엔드포인트를 사용하여 생성하려는 변경 요청에 가장 적합한 변경 모델을 찾습니다. 자세한 내용은 변경 모델을 참조하십시오.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change/model
기본 URL: / api/sn_chg_rest/change/model
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 결과 세트를 필터링하는 데 사용할 이름-값 쌍입니다. 이름은 지정된 값이 필터링되는 필드입니다. 이 매개 변수는 와 함께 사용할 수 없습니다 sysparm_query. 예를 들어, & sysparm_query=active=true를 사용하는 대신 &active=true를 사용하여 호출 문을 단순화할 수 있습니다. 필드가 선택 또는 참조 유형 필드인 경우(예: &state=7 대신 &state=closed) 표시 값을 사용할 수도 있습니다. 여러 키-값 쌍을 지정하려면 앰퍼샌드로 각각을 구분합니다(예: & active=true&assigned_to=john.smith). 데이터 유형: 문자열 |
| 주문 | 반환된 변경 모델을 정렬할 기준이 되는 필드입니다. 데이터 유형: 문자열 기본값: name |
| sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문은 sysparm_query=<col_name><operator><value>입니다.
모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다. 예:
인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 구문:
예: 이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
| 텍스트검색 | 모든 변경 모델 기록 필드를 검색하는 데 사용할 문자열입니다. 이 검색은 전체 텍스트 검색 플랫폼 기능을 사용합니다 ServiceNow . 검색 기능에 대한 ServiceNow 자세한 내용은 검색 관리를 참조하세요. 데이터 유형: 문자열 기본값: IR_AND_OR_QUERY |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 하나 이상의 변경 모델 기록 객체가 들어 있는 목록입니다. 각 개체는 변경 모델을 설명합니다. 변경 모델 개체의 각 요소는 변경 모델 [chg_model] 테이블에 있는 관련 레코드의 필드에 해당합니다. 모든 요소에는 값 및 display_value 이름-값 쌍이 포함됩니다. 일부는 display_value_internal 이름-값 쌍 을 포함합니다. 데이터 유형: 배열 |
| 결과.활성 | 연결된 변경 모델 기록이 활성 상태이며 인스턴스 내에서 사용 가능한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: true |
| result.available_in_ui | 연결된 변경 모델 기록을 사용자 인터페이스 내에서 사용할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: true |
| 결과.색상 | 변경 요청 방문 페이지의 연결된 변경 모델 색상입니다. 데이터 유형: 문자열 기본값: #cbcbcb |
| result.default_change_model | 연결된 변경 모델 기록이 기본 변경 모델인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| 결과.설명 | 변경 모델의 목적에 대한 짧은 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| result.name | 변경 모델의 이름입니다. 데이터 유형: 문자열 최대 길이: 200 |
| result.record_preset | 새 변경 요청 기록이 생성될 때 연결된 값과 함께 자동으로 채워져야 하는 필드의 이름-값 쌍입니다. 값은 캐럿 기호로 구분됩니다. 예:
데이터 유형: 문자열 |
| result.state_field | 에 제공된 table_name항목을 기준으로 선택 항목을 수집할 선택 목록 필드입니다. 변경 모델의 경우 이 값은 항상 "상태"로 설정됩니다. 데이터 유형: 문자열 |
| result.sys_클래스_이름 | 모듈 테이블 이름을 변경합니다. 항상 모델/chg_model 변경합니다. 데이터 유형: 문자열 |
| result.sys_created_by | 연결된 변경 모듈 기록을 처음 작성한 사용자의 이름입니다. 데이터 유형: 문자열 |
| result.sys_created_on | 변경 모듈 기록이 원래 만들어진 날짜 및 시간입니다. 데이터 유형: 문자열 |
| result.sys_도메인 | 인스턴스에서 도메인을 사용하는 경우 변경 모듈 기록이 연결된 도메인의 이름입니다. 데이터 유형: 문자열 |
| result.sys_도메인_경로 | 인스턴스에서 도메인을 사용하는 경우 연관된 변경 모듈 기록이 있는 도메인 경로입니다. 데이터 유형: 문자열 |
| result.sys_id | 연결된 변경 모델 기록의 고유 식별자입니다. 데이터 유형: 문자열 |
| result.sys_mod_count | 연결된 변경 모델 기록이 수정된 횟수입니다. 데이터 유형: 숫자 |
| result.sys_이름 | 변경 모델의 이름입니다. 항상 매개 변수와 name 동일합니다. 데이터 유형: 문자열 |
| result.sys_태그 | 변경 모델 기록과 연결된 시스템 태그입니다. 데이터 유형: 문자열 |
| result.sys_updated_by | 연결된 변경 모델 기록을 마지막으로 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열 최대 길이: 40 |
| result.sys_updated_on | 연결된 변경 모델 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| result.table_name | 선택 항목을 수집할 선택 목록 필드를 정의하는 테이블입니다. 변경 모델의 경우 이 값은 항상 "change_request"로 설정됩니다. 데이터 유형: 문자열 최대 길이: 80 |
cURL 요청
이 예에서는 모든 변경 모델 기록을 가져오는 요청을 표시합니다.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
간단히 하기 위해 이 응답에는 단일 변경 모델 개체만 표시됩니다.
{
"result": [
{
"record_preset": {
"display_value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ",
"value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ"
},
"color": {
"display_value": "#488df4",
"value": "#488df4"
},
"default_change_model": {
"display_value": "false",
"value": false
},
"sys_mod_count": {
"display_value": "6",
"value": 6.0
},
"description": {
"display_value": "This model is intended to capture a record of an automated change. There are no approvals associated with this change model.\r\n",
"value": "This model is intended to capture a record of an automated change. There are no approvals associated with this change model.\r\n"
},
"active": {
"display_value": "true",
"value": true
},
"sys_updated_on": {
"display_value": "2020-10-02 06:24:24",
"value": "2020-10-02 13:24:24",
"display_value_internal": "2020-10-02 06:24:24"
},
"sys_tags": {
"display_value": "",
"value": ""
},
"table_name": {
"display_value": "change_request",
"value": "change_request"
},
"sys_class_name": {
"display_value": "Change Model",
"value": "chg_model"
},
"sys_id": {
"display_value": "7840d2515323101034d1ddeeff7b12a6",
"value": "7840d2515323101034d1ddeeff7b12a6"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"available_in_ui": {
"display_value": "false",
"value": false
},
"state_field": {
"display_value": "state",
"value": "state"
},
"sys_created_on": {
"display_value": "2020-09-28 07:33:25",
"value": "2020-09-28 14:33:25",
"display_value_internal": "2020-09-28 07:33:25"
},
"name": {
"display_value": "Change Registration",
"value": "Change Registration"
},
"sys_name": {
"display_value": "Change Registration",
"value": "Change Registration"
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
}
}
]
}
Change Management - GET /sn_chg_rest/change/model/{sys_id}
지정된 sys_id으로 식별되는 변경 모델을 조회합니다.
그런 다음 이 변경 모델을 사용하여 원하는 변경 요청을 생성할 수 있습니다. 변경 모델에 대한 자세한 내용은 변경 모델을 참조하십시오.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/model/{sys_id}
기본 URL: / api/sn_chg_rest/change/model/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 변경 모델 [chg_model] 테이블에서 검색할 변경 모델 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 요청된 변경 모델 기록 객체입니다. 이 객체의 각 요소는 변경 모델 [chg_model] 테이블의 기록에 있는 필드에 해당합니다. 모든 요소에는 및 이름-값 쌍이 display_value 포함됩니다value. 일부는 이름-값 쌍을 포함합니다 display_value_internal . 데이터 유형: 객체 |
| 결과.활성 | 연결된 변경 모델 기록이 활성 상태이며 인스턴스 내에서 사용 가능한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: true |
| result.available_in_ui | 연결된 변경 모델 기록을 사용자 인터페이스 내에서 사용할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: true |
| 결과.색상 | 변경 요청 방문 페이지의 연결된 변경 모델 색상입니다. 데이터 유형: 문자열 기본값: #cbcbcb |
| result.default_change_model | 연결된 변경 모델 기록이 기본 변경 모델인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| 결과.설명 | 변경 모델의 목적에 대한 짧은 설명입니다. 데이터 유형: 문자열 최대 길이: 4,000 |
| result.name | 변경 모델의 이름입니다. 데이터 유형: 문자열 최대 길이: 200 |
| result.record_preset | 새 변경 요청 기록이 생성될 때 연결된 값과 함께 자동으로 채워져야 하는 필드의 이름-값 쌍입니다. 값은 캐럿 기호로 구분됩니다. 예:
데이터 유형: 문자열 |
| result.state_field | 에 제공된 table_name항목을 기준으로 선택 항목을 수집할 선택 목록 필드입니다. 변경 모델의 경우 이 값은 항상 "상태"로 설정됩니다. 데이터 유형: 문자열 |
| result.sys_클래스_이름 | 모듈 테이블 이름을 변경합니다. 항상 모델/chg_model 변경합니다. 데이터 유형: 문자열 |
| result.sys_created_by | 연결된 변경 모듈 기록을 처음 작성한 사용자의 이름입니다. 데이터 유형: 문자열 |
| result.sys_created_on | 변경 모듈 기록이 원래 만들어진 날짜 및 시간입니다. 데이터 유형: 문자열 |
| result.sys_도메인 | 인스턴스에서 도메인을 사용하는 경우 변경 모듈 기록이 연결된 도메인의 이름입니다. 데이터 유형: 문자열 |
| result.sys_도메인_경로 | 인스턴스에서 도메인을 사용하는 경우 연관된 변경 모듈 기록이 있는 도메인 경로입니다. 데이터 유형: 문자열 |
| result.sys_id | 연결된 변경 모델 기록의 고유 식별자입니다. 데이터 유형: 문자열 |
| result.sys_mod_count | 연결된 변경 모델 기록이 수정된 횟수입니다. 데이터 유형: 숫자 |
| result.sys_이름 | 변경 모델의 이름입니다. 항상 매개 변수와 name 동일합니다. 데이터 유형: 문자열 |
| result.sys_태그 | 변경 모델 기록과 연결된 시스템 태그입니다. 데이터 유형: 문자열 |
| result.sys_updated_by | 연결된 변경 모델 기록을 마지막으로 업데이트한 사용자의 이름입니다. 데이터 유형: 문자열 최대 길이: 40 |
| result.sys_updated_on | 연결된 변경 모델 기록이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| result.table_name | 선택 항목을 수집할 선택 목록 필드를 정의하는 테이블입니다. 변경 모델의 경우 이 값은 항상 "change_request"로 설정됩니다. 데이터 유형: 문자열 최대 길이: 80 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model/c0efda5347c12200e0ef563dbb9a81e3" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"record_preset": {
"display_value": "type=emergency^EQ",
"value": "type=emergency^EQ"
},
"color": {
"display_value": "#ea3423",
"value": "#ea3423"
},
"default_change_model": {
"display_value": "false",
"value": false
},
"sys_mod_count": {
"display_value": "2",
"value": 2.0
},
"description": {
"display_value": "ITIL Mode 1 Emergency Change",
"value": "ITIL Mode 1 Emergency Change"
},
"active": {
"display_value": "true",
"value": true
},
"sys_updated_on": {
"display_value": "2020-09-28 08:53:12",
"value": "2020-09-28 15:53:12",
"display_value_internal": "2020-09-28 08:53:12"
},
"sys_tags": {
"display_value": "",
"value": ""
},
"table_name": {
"display_value": "change_request",
"value": "change_request"
},
"sys_class_name": {
"display_value": "Change Model",
"value": "chg_model"
},
"sys_id": {
"display_value": "c0efda5347c12200e0ef563dbb9a81e3",
"value": "c0efda5347c12200e0ef563dbb9a81e3"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"available_in_ui": {
"display_value": "true",
"value": true
},
"state_field": {
"display_value": "state",
"value": "state"
},
"sys_created_on": {
"display_value": "2020-09-04 09:16:03",
"value": "2020-09-04 16:16:03",
"display_value_internal": "2020-09-04 09:16:03"
},
"name": {
"display_value": "Emergency",
"value": "Emergency"
},
"sys_name": {
"display_value": "Emergency",
"value": "Emergency"
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
}
}
}
Change Management - GET /sn_chg_rest/change/normal
지정된 기준에 따라 하나 이상의 일반 변경 요청을 검색합니다.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change/normal
기본 URL: / api/sn_chg_rest/change/normal
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 결과 세트를 필터링하는 데 사용할 이름-값 쌍입니다. 이름은 지정된 값이 필터링되는 필드입니다. 이 매개 변수는 와 함께 사용할 수 없습니다 sysparm_query. 예를 들어, & sysparm_query=active=true를 사용하는 대신 &active=true를 사용하여 호출 문을 단순화할 수 있습니다. 필드가 선택 또는 참조 유형 필드인 경우(예: &state=7 대신 &state=closed) 표시 값을 사용할 수도 있습니다. 여러 키-값 쌍을 지정하려면 앰퍼샌드로 각각을 구분합니다(예: & active=true&assigned_to=john.smith). 데이터 유형: 문자열 |
| 주문 | 반환된 변경 요청을 정렬할 기준이 되는 필드입니다. 기본값: 숫자 데이터 유형: 문자열 |
| sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 500 |
| sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문은 sysparm_query=<col_name><operator><value>입니다.
모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다. 예:
인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 구문:
예: 이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
| 텍스트검색 | 모든 일반 변경 요청 기록 필드를 검색하는 데 사용하는 문자열입니다. 이 검색은 ServiceNow 전체 텍스트 검색 플랫폼 기능을 사용하며 기본적으로 IR_AND_OR_QUERY으로 설정됩니다.데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 삭제 전 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "Normal"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 값은 항상 "정상"입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
{ // next record found }, ... // and so on
]
}
Change Management - GET /sn_chg_rest/change/normal/{sys_id}
지정된 sys_id로 식별되는 일반 변경 요청을 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/normal/{sys_id}
기본 URL: / api/sn_chg_rest/change/normal/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청 [change_request] 테이블에서 검색할 일반 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 삭제 전 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "Normal"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 값은 항상 "정상"입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
]
}
Change Management - GET /sn_chg_rest/change/standard
지정된 기준에 따라 하나 이상의 표준 변경 요청을 검색합니다.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change/standard
기본 URL: / api/sn_chg_rest/change/standard
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 결과 세트를 필터링하는 데 사용할 이름-값 쌍입니다. 이름은 지정된 값이 필터링되는 필드입니다. 이 매개 변수는 와 함께 사용할 수 없습니다 sysparm_query. 예를 들어, & sysparm_query=active=true를 사용하는 대신 &active=true를 사용하여 호출 문을 단순화할 수 있습니다. 필드가 선택 또는 참조 유형 필드인 경우(예: &state=7 대신 &state=closed) 표시 값을 사용할 수도 있습니다. 여러 키-값 쌍을 지정하려면 앰퍼샌드로 각각을 구분합니다(예: & active=true&assigned_to=john.smith). 데이터 유형: 문자열 |
| 주문 | 반환된 변경 요청을 정렬할 기준이 되는 필드입니다. 기본값: 숫자 데이터 유형: 문자열 |
| sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 문자열 기본값: 500 |
| sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문은 sysparm_query=<col_name><operator><value>입니다.
모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다. 예:
인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 구문:
예: 이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
| 텍스트검색 | 모든 표준 변경 요청 기록 필드를 검색하는 데 사용할 문자열입니다. 이 검색은 전체 텍스트 검색 플랫폼 기능을 사용 ServiceNow 하며 기본적으로 IR_AND_OR_QUERY으로 설정됩니다.데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 식별된 변경 요청에 연결된 값이 있는 모든 필드(키)입니다. 데이터 유형: 객체 |
| 상태 | 삭제 전 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "표준"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 값은 항상 "표준"입니다. 데이터 유형: 문자열 |
샘플 cURL 요청
curl "https://instance.service-now.com/api/sn_chg_rest/v1/change/standard?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "standard",
display_value: "Standard"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
{ // next record found }, ... // and so on
]
}
Change Management - GET /sn_chg_rest/change/standard/{sys_id}
지정된 sys_id으로 식별된 표준 변경 요청을 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/standard/{sys_id}
기본 URL: / api/sn_chg_rest/change/standard/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청[change_request] 테이블에서 검색할 표준 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 식별된 변경 요청에 연결된 값이 있는 모든 필드(키)입니다. 데이터 유형: 객체 |
| 상태 | 삭제 전 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
]
}
Change Management - /sn_chg_rest/change/standard/template 가져오기
지정된 기준에 따라 하나 이상의 표준 변경 템플릿을 조회합니다.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change/standard/template
기본 URL: / api/sn_chg_rest/change/standard/template
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 결과 세트를 필터링하는 데 사용할 이름-값 쌍입니다. 이름은 지정된 값이 필터링되는 필드입니다. 이 매개 변수는 와 함께 사용할 수 없습니다 sysparm_query. 예를 들어, & sysparm_query=active=true를 사용하는 대신 &active=true를 사용하여 호출 문을 단순화할 수 있습니다. 필드가 선택 또는 참조 유형 필드인 경우(예: &state=7 대신 &state=closed) 표시 값을 사용할 수도 있습니다. 여러 키-값 쌍을 지정하려면 앰퍼샌드로 각각을 구분합니다(예: & active=true&assigned_to=john.smith). 데이터 유형: 문자열 |
| 주문 | 반환된 표준 변경 템플릿을 정렬할 기준이 되는 필드입니다. 데이터 유형: 문자열 기본값: 숫자 |
| sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 500 |
| sysparm_offset | 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문은 sysparm_query=<col_name><operator><value>입니다.
모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다. 예:
인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_query의 구문:
예: 이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다. 잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다. 주: glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다. 데이터 유형: 문자열 |
| 텍스트검색 | 모든 표준 변경 요청 기록 필드를 검색하는 데 사용할 문자열입니다. 이 검색은 ServiceNow 전체 텍스트 검색 플랫폼 기능을 사용하며 기본적으로 IR_AND_OR_QUERY으로 설정됩니다.데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 식별된 표준 변경 템플릿에 연결된 값이 있는 모든 필드입니다. 데이터 유형: 객체 |
| sys_id | 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 템플릿 | 표준 변경 템플릿에 대한 정보입니다. 데이터 유형: 객체 |
| template.display_value | UI에 표시할 템플릿 정보입니다. 데이터 유형: 문자열 |
| template.value | 템플릿 sys_id. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "92b8544047810200e90d87e8dee490b0",
display_value: "92b8544047810200e90d87e8dee490b0"
},
template : {
value: "1c8e02ec47410200e90d87e8dee49057",
display_value: "Add network switch to datacenter cabinet"
},
..., // all valid fields in record, example below
short_description: {
value: "Standard change template to add network switch to cabinet",
display_value: "Standard change template to add network switch to cabinet"
},
},
{ // next record found }, ... // and so on
]
}
Change Management - GET /sn_chg_rest/change/standard/template/{sys_id}
지정된 sys_id으로 식별되는 표준 변경 템플릿을 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/standard/template/{sys_id}
기본 URL: / api/sn_chg_rest/change/standard/template/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | [std_change_record_producer] 테이블에서 검색할 표준 변경 템플릿의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 식별된 표준 변경 템플릿에 연결된 값이 있는 모든 필드입니다. 데이터 유형: 객체 |
| sys_id | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 템플릿 | 표준 변경 템플릿에 대한 정보입니다. 데이터 유형: 객체 |
| template.display_value | UI에 표시할 템플릿 정보입니다. 데이터 유형: 문자열 |
| template.value | 템플릿 sys_id. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template/92b8544047810200e90d87e8dee490b0" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "92b8544047810200e90d87e8dee490b0",
template : {
value: "1c8e02ec47410200e90d87e8dee49057",
display_value: "Add network switch to datacenter cabinet"
},
..., // all valid fields in record, example below
short_description: {
value: "Standard change template to add network switch to cabinet",
display_value: "Standard change template to add network switch to cabinet"
},
},
]
}
Change Management - GET /sn_chg_rest/change/worker/{sys_id}
지정된 비동기 작업자의 현재 상태, 정보 및 오류를 조회합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/worker/{sys_id}
기본 URL: /api/sn_chg_rest/{ change/worker/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | Change Management 비동기 작업자의 Sys_id입니다. Change Management 작업자 [chg_mgt_worker] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 메시지 | 메시지 정보입니다. 데이터 유형: 객체 |
| messages.errorMessages | 요청을 처리하는 동안 발생한 오류 메시지입니다. 예: 잘못된 CMDB_CI sys_id 제공됨 데이터 유형: 배열 |
| messages.info메시지 | 요청을 처리하는 동안 발생한 정보 메시지입니다. 예: CMDB_CI sys_id 이미 제공됨과 관련되어 있습니다. 데이터 유형: 배열 |
| messages.warning메시지 | 요청을 처리하는 동안 발생한 경고 메시지입니다. 예: 잘못된 CMDB_CI sys_id 제공되었습니다. 데이터 유형: 배열 |
| 페이로드 | 일정 엔드포인트의 성공 응답 본문에서 작업자 sys_id 사용할 때 제공되는 고유 페이로드입니다.
데이터 유형: 객체 |
| payload.spans | 일정 엔드포인트에 제공된 기간 내에 시간 범위를 사용할 수 있는 경우 작업자 API는 사용 가능한 시간 범위를 나열합니다.
데이터 유형: 배열 |
| payload.spans.start |
데이터 유형: 객체 |
| payload.spans.start.value | 변경 요청의 구현을 시작하기 위해 계획된 날짜와 시간입니다. 데이터 유형: 문자열 |
| payload.spans.start.display_value | 변경 요청 시작 시간 값을 표시합니다. 시간 형식: yyyy-mm-dd hh:mm:ss 데이터 유형: 문자열 |
| payload.spans.end |
데이터 유형: 객체 |
| payload.spans.end.value | 변경 요청의 완료가 계획된 날짜 및 시간입니다. 시간 형식: yyyy-mm-dd hh:mm:ss 데이터 유형: 문자열 |
| payload.spans.end.display_value | 변경 요청 완료 시간 값을 표시합니다. 데이터 유형: 문자열 |
| 요청 | 원래 엔드포인트 요청입니다. 데이터 유형: 문자열 |
| 상태 | 작업자의 현재 상태에 대한 정보입니다. 데이터 유형: 객체 |
| state.display_value | 작업자 상태의 표시 값입니다. 이러한 값은 매개 변수와 직접 상관 관계가 있습니다 state.value . 가능한 값:
데이터 유형: 문자열 |
| 상태.값 | 작업자 상태의 숫자 값입니다. 가능한 값:
데이터 유형: 숫자 |
| 유형 | CMDB CI와 변경 요청 간의 연결 유형입니다. 데이터 유형: 문자열 |
| worker | 연결된 작업자에 대한 정보입니다. 데이터 유형: 객체 |
| worker.link | 연결된 작업자 상태 및 기타 작업자 관련 정보를 검색하는 URL입니다. 데이터 유형: 문자열 |
| 작업자.sysId | 변경 요청과 관련된 작업자 Sys_id입니다. 데이터 유형: 문자열 |
| <other_params> | 프로세스별 기타 매개변수(예: ignored_cmdb_ci_sys_ids. |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/worker/0644cd02dbec330084f07ffdbf9619c1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"worker": {
"sysId": "0644cd02dbec330084f07ffdbf9619c1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/0644cd02dbec330084f07ffdbf9619c1"
},
"request": "{\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "impacted",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change Management - PATCH /sn_chg_rest/change/{sys_id}
지정된 sys_id으로 식별되는 변경 요청을 요청 본문 또는 URL의 키-값 쌍으로 업데이트합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}
기본 URL: / api/sn_chg_rest/change/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 수정할 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 업데이트할 필드를 나타내는 이름-값 쌍입니다. 요청 본문 매개변수는 URL 매개변수를 재정의합니다. 그러나 필수 매개변수는 URL에 지정해야 합니다. 데이터 유형: 문자열 |
| encrypted_fields | 암호화할 쉼표로 구분된 필드 목록입니다. 이러한 필드는 관련 기록에 저장되기 전에 암호화됩니다. 지정되면 엔드포인트는 setValue() 메서드를 호출하는 대신 GlideRecord setDisplayValue() 메서드를 호출합니다. 따라서 이 매개변수를 사용하면 sys_ids 또는 값을 전달하는 대신 참조 또는 선택 필드와 같은 암호화되지 않은 필드의 표시 값을 전달할 수도 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 데이터 | 연관된 변경 요청에서 업데이트할 필드를 나타내는 이름-값 쌍입니다. 예를 들어, 간단한 설명 파일을 업데이트하려면 --data "{\"short_description\": \" my short desc\" }" \와 유사한 이름-값 쌍을 입력합니다. 데이터 유형: 문자열 |
| encrypted_fields | 암호화할 쉼표로 구분된 필드 목록입니다. 이러한 필드는 관련 기록에 저장되기 전에 암호화됩니다. 지정되면 엔드포인트는 setValue() 메서드를 호출하는 대신 GlideRecord setDisplayValue() 메서드를 호출합니다. 따라서 이 매개변수를 사용하면 sys_ids 또는 값을 전달하는 대신 참조 또는 선택 필드와 같은 암호화되지 않은 필드의 표시 값을 전달할 수도 있습니다. 데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 업데이트된 변경 요청 기록입니다. 이 객체의 각 요소는 변경 요청 [change_request] 테이블의 기록에 있는 필드에 해당합니다. 모든 요소에는 및 이름-값 쌍이 display_value 포함됩니다value. 일부는 이름-값 쌍을 포함합니다 display_value_internal . 데이터 유형: 객체 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"short_desription\": \"Reboot the server at 6 am\" }" \
--user "username":"password"
{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Reboot the server at 6 am",
"value": "Reboot the server at 6 am"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "b0dbda5347c12200e0ef563dbb9a718f",
"value": "b0dbda5347c12200e0ef563dbb9a718f"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}
cURL 요청
다음 예제에서는 요청 본문에서 암호화된 필드를 전달하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"encrypted_fields\":\"short_description,description\",
\"short_description\":\"my short desc\",
\"description\":\"my desc\"
}" \
--user "username":"password"
cURL 요청
다음 예제에서는 암호화된 필드를 쿼리 매개 변수로 전달하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"
Change Management - PATCH /sn_chg_rest/change/{sys_id}/approvals
현재 사용자가 지정된 변경 요청에 대한 변경 요청 승인 기록을 승인하거나 거부할 수 있습니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}/approvals
기본 URL: / api/sn_chg_rest/change/{sys_id}/approvals
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 승인/거부가 적용되는 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 댓글 | 거부되는 경우 state 필요합니다. 변경이 거부된 이유입니다.데이터 유형: 문자열 |
| 상태 | 필수 승인 상태입니다. 예: --data "{\"state\": \" 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 400 | 잘못된 요청. 사용자가 변경 요청을 승인하거나 거부할 권한이 없는 경우와 같은 잘못된 요청 유형을 나타냅니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 변경 요청의 현재 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 승인/거부되는 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 가능한 값:
데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 가능한 값:
데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/approvals" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"approved\"}" \
--user "username":"password"
{
result: [
{
sys_id: "0f4ac6c4b750230096c3e4f6ee11a9fe",
state: {
value: "-2",
display_value: "Scheduled"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, single parameter example below
short_description: {
value: "Remove server",
display_value: "Remove server"
}
}
]
}
Change Management - PATCH /sn_chg_rest/change/{change_sys_id}/schedule/first_available
찾은 첫 번째 사용 가능한 시간 슬롯을 사용하여 변경 요청의 계획된 시작 및 종료 시간을 업데이트합니다.
필요한 역할: sn_change_writer.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{change_sys_id}/schedule/first_available
기본 URL: / api/sn_chg_rest/change/{change_sys_id}/schedule/first_available
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| change_sys_id | 다음에 사용 가능한 시간 슬롯으로 업데이트할 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 선택한 변경 요청에는 구성 항목(cmdb_ci)이 있어야 합니다. |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| duration_in_seconds | 변경 기간(초), 즉 변경 요청 작업을 완료하는 데 필요한 시간입니다. 데이터 유형: 정수 |
| planned_start_time | 옵션입니다. 변경 요청의 구현을 UTC로 시작하기 위해 계획된 날짜 및 시간입니다. 이 시간 또는 그 이후의 사용 가능한 시간 슬롯을 검색합니다. 제공되지 않은 경우 시스템은 현재 시간을 시작 시간으로 사용합니다. 시간 형식: yyyy-mm-dd hh:mm:ss 데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 202 | 시스템이 요청을 수락했습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 가능한 문제:
|
| 403 | 금지되었습니다. 사용자에게 변경 요청의 계획된 시작 및 종료 날짜 값에 대한 쓰기 권한이 없습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다.
가능한 문제:
|
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 오류 | 엔드포인트 요청을 처리하는 동안 발생한 오류에 대한 정보입니다. 데이터 유형: 객체 |
| 오류.상세 정보 | 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| error.message | 오류를 식별하는 메시지입니다. 데이터 유형: 문자열 |
| 메시지 | 메시지 정보입니다. 데이터 유형: 객체 |
| messages.errorMessages | 요청을 처리하는 동안 발생한 오류 메시지입니다. 데이터 유형: 배열 |
| messages.info메시지 | 요청을 처리하는 동안 발생한 정보 메시지입니다. 데이터 유형: 배열 |
| messages.warning메시지 | 요청을 처리하는 동안 발생한 경고 메시지입니다. 데이터 유형: 배열 |
| 요청 | 원래 엔드포인트 요청입니다. 데이터 유형: 문자열 |
| 상태 | 작업자의 현재 상태에 대한 정보입니다. 데이터 유형: 객체 |
| state.display_value | 작업자 상태의 표시 값입니다. 이러한 값은 매개 변수와 직접 상관 관계가 있습니다 state.value . 가능한 값:
데이터 유형: 문자열 |
| 상태.값 | 작업자 상태의 숫자 값입니다. 가능한 값:
데이터 유형: 숫자 |
| 유형 | 요청의 유형을 나타냅니다. 유효한 값: schedule 데이터 유형: 문자열 |
| worker | 연결된 작업자에 대한 정보입니다. 데이터 유형: 객체 |
| worker.link | 변경 요청 일정 상태를 검색하기 위한 링크입니다. 결과를 보려면 GET /sn_chg_rest/change/worker/{sys_id}의 sys_id 사용합니다. 데이터 유형: 문자열 |
| 작업자.sysId | 변경 요청과 관련된 작업자 Sys_id입니다. 데이터 유형: 문자열 |
| 상태 | 오류가 발생한 경우에만 나타납니다. 엔드포인트 처리의 상태입니다. 가능한 값: 실패 데이터 유형: 문자열 |
변경 요청 일정 상태 가져오기
제공된 값을 worker.link 사용하여 사용 가능한 첫 번째 시간 슬롯에 대해 변경 기록이 성공적으로 예약되었는지 확인합니다. 값의 형식은 다음과 같습니다.
https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>
worker.link 상세 정보를 사용하여 GET /sn_chg_rest/change/worker/{sys_id} 에서 제공된 sys_id 실행하여 결과를 확인합니다.
응답 본문에는 상태가 포함되어 있으며 처리가 완료되면 결과를 제공합니다.
사용 가능한 시간 슬롯이 발견되면 시스템은 사용 가능한 첫 번째 슬롯으로 변경 요청을 업데이트합니다. 상태가 완료되면 messages.infoMessages 사용 가능한 첫 번째 시간 슬롯이 설정되었음을 나타냅니다.
변경이 업데이트됨– 시간 슬롯에 대한 변경이 요청되었습니다.No slot for <number> days from now(지금부터 숫자일 동안 슬롯을 찾을 수 없음– 일정 기간에 정의된 일 수 내에 제공된 변경 요청 기간에 사용할 수 있는 시간 슬롯이 없습니다.주:변경 요청 일정 시간 슬롯 기본값은 90일입니다. 이 값을 변경하려면 속성을 수정합니다 change.conflict.next_available.schedule_window . 자세한 내용은 충돌 분석 속성 구성을 참조하십시오.
다음 GET /sn_chg_rest/change/worker/{sys_id} 예제에서는 worker.link 세부 정보에 제공된 ID를 사용하여 제공된 출력을 보여 줍니다. 결과는 처리가 완료되었고 변경 요청이 사용 가능한 첫 번째 시간 슬롯으로 업데이트되었음을 나타냅니다.
{
"result": {
"worker": {
"sysId": "355c62e0a4c87010f87712198fe9cacf",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": [
"Change has been updated"
]
}
}
}
cURL 요청
curl "https://instance.service-now.com/api/sn_chg_rest/change/87ae5e900a0a2c3e263e8304e727c646/schedule/first_available" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"duration_in_seconds\":\"10800\"}" \
--user "username":"password"
결과에는 GET /sn_chg_rest/change/worker/ 엔드포인트에서 제공된 sys_id 실행하는 데 사용할 수 있는 worker.link 세부 정보가 포함됩니다.
{
"result": {
"worker": {
"sysId": "355c62e0a4c87010f87712198fe9cacf",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change Management - PATCH /sn_chg_rest/change/{change_sys_id}/task/{task_sys_id}
지정된 sys_ids으로 식별되는 변경 요청 작업을 요청 본문 또는 URL의 키-값 쌍으로 업데이트합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/change/{change_sys_id}/ task/{task_sys_id}
기본 URL: /api/sn_chg_rest/change/{change_sys_id}/ task/{task_sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| change_sys_id | 작업이 연결된 변경 요청의 Sys_id입니다. 지정된 작업이 지정된 변경 요청과 연결되어 있는지 확인합니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| task_sys_id | 수정할 작업의 Sys_id입니다. 변경 작업 [change_task] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 키-값 쌍 | 업데이트할 필드를 나타내는 이름-값 쌍입니다. 요청 본문 매개변수는 URL 매개변수를 재정의합니다. 그러나 필수 매개변수는 URL에 지정해야 합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 데이터 | 연관된 변경 요청에서 업데이트할 필드를 나타내는 이름-값 쌍입니다. 예를 들어, 간단한 설명 파일을 업데이트하려면 --data "{\"short_description\": \" my short desc\" }" \와 유사한 이름-값 쌍을 입력합니다. 데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 삭제하기 전에 식별된 변경 요청 작업에 연결된 값이 있는 모든 필드(키)입니다. 데이터 유형: 객체 |
| sys_id | 변경 요청 작업에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| 상위 | 이 작업과 연결된 변경 요청에 대한 고유 식별자 정보입니다. 데이터 유형: 객체 |
| parent.display_value | UI에 표시할 작업 정보입니다. 데이터 유형: 문자열 |
| 부모.값 | 상위 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| __meta.ignoredFields | 호출에 전달되었지만 기본 기록에 없거나 필드가 읽기 전용이므로 변경 요청에 적용되지 않은 키-값 쌍입니다. 데이터 유형: 배열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5?short_description=Retire both nodes" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire both nodes",
display_value: "Retire both nodes"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change Management - PATCH /sn_chg_rest/change/emergency/{sys_id}
지정된 sys_id으로 식별되는 긴급 변경 요청을 요청 본문 또는 URL의 키-값 쌍으로 업데이트합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/emergency/{sys_id}
기본 URL: / api/sn_chg_rest/change/emergency/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 수정할 변경 요청의 Sys_id입니다. [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 업데이트할 필드를 나타내는 이름-값 쌍입니다. 요청 본문 매개변수는 URL 매개변수를 재정의합니다. 그러나 필수 매개변수는 URL에 지정해야 합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 데이터 | 연관된 변경 요청에서 업데이트할 필드를 나타내는 이름-값 쌍입니다. 예를 들어, 간단한 설명 파일을 업데이트하려면 --data "{\"short_description\": \" my short desc\" }" \와 유사한 이름-값 쌍을 입력합니다. 데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 문자열 |
| 상태 | 변경 요청의 현재 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "긴급"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 가치는 항상 "비상"입니다. 데이터 유형: 문자열 |
| __meta.ignoredFields | 호출에서 전달되었지만 기본 기록에 없거나 필드가 읽기 전용이므로 변경 요청에 적용되지 않은 이름-값 쌍입니다. 데이터 유형: 배열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"no_such_field\": \"this will be ignored\", }" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f", },
state: {
value: "-4",
display_value: "Assess"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change Management - PATCH /sn_chg_rest/change/normal/{sys_id}
지정된 sys_id으로 식별되는 일반 변경 요청을 요청 본문 또는 URL의 매개변수를 사용하여 업데이트합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/normal/{sys_id}
기본 URL: / api/sn_chg_rest/change/normal/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 수정할 변경 요청의 Sys_id입니다. [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 업데이트할 필드를 나타내는 이름-값 쌍입니다. 요청 본문 매개변수는 URL 매개변수를 재정의합니다. 그러나 필수 매개변수는 URL에 지정해야 합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 데이터 | 연관된 변경 요청에서 업데이트할 필드를 나타내는 이름-값 쌍입니다. 예를 들어, 간단한 설명 파일을 업데이트하려면 --data "{\"short_description\": \" my short desc\" }" \와 유사한 이름-값 쌍을 입력합니다. 데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 변경 요청의 현재 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "Normal"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 값은 항상 "정상"입니다. 데이터 유형: 문자열 |
| __meta.ignoredFields | 호출에서 전달되었지만 기본 기록에 없거나 필드가 읽기 전용이므로 변경 요청에 적용되지 않은 이름-값 쌍입니다. 데이터 유형: 배열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f?state=assess" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-4",
display_value: "Assess"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change Management - PATCH /sn_chg_rest/change/standard/{sys_id}
지정된 sys_id으로 식별되는 표준 변경 요청을 요청 본문 또는 URL의 매개변수를 사용하여 업데이트합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/standard/{sys_id}
기본 URL: / api/sn_chg_rest/change/standard/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 수정할 변경 요청의 Sys_id입니다. [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 업데이트할 필드를 나타내는 이름-값 쌍입니다. 요청 본문 매개변수는 URL 매개변수를 재정의합니다. 그러나 필수 매개변수는 URL에 지정해야 합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 데이터 | 연관된 변경 요청에서 업데이트할 필드를 나타내는 이름-값 쌍입니다. 예를 들어, 간단한 설명 파일을 업데이트하려면 --data "{\"short_description\": \" my short desc\" }" \와 유사한 이름-값 쌍을 입력합니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 식별된 변경 요청에 연결된 값이 있는 모든 필드(키)입니다. 데이터 유형: 객체 |
| 상태 | 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 데이터 유형: 문자열 |
| sys_id | 변경 요청에 대한 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177?description=Reboot my email server" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"short_description\": \"my short desc\" }" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot my email server",
display_value: "Reboot my email server"
},
}
]
}
Change Management - PATCH /sn_chg_rest/change/standard/{sys_id}/risk
Calculates the risk and impact of the specified standard change based on an evaluation of the risk conditions.
If the Change Risk Assessment plugin is installed, it also calculates the cumulative highest risk once the risk assessment is complete.
URL 형식
Versioned URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/risk
Default URL: /api/sn_chg_rest/change/{sys_id}/risk
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | Sys_id of the standard change to evaluate. Located in the Change Request [change_request] table. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | Risk assessment completed successfully. |
| 400 | Risk assessment failed. Details of the type of failure are included in the error data. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
Response body parameters (JSON or XML)
| 이름 | 설명 |
|---|---|
| 영향도 | Impact associated with the specified standard change. 데이터 유형: 객체 |
| impact.display_value | Impact information to display in a UI. 데이터 유형: 문자열 |
| impact.value | Internal impact value. 데이터 유형: 문자열 |
| name-value pairs | All valid fields within the standard change record. 데이터 유형: 객체 |
| risk | Risk calculated for the specified standard change. 데이터 유형: 객체 |
| risk.display_value | Risk information to display in a UI. 데이터 유형: 문자열 |
| risk.value | Internal risk value. 데이터 유형: 문자열 |
| sys_id | Sys_id information for the standard change request. 데이터 유형: 객체 |
| sys_id.display_value | Sys_id of the change request to display in a UI. 데이터 유형: 문자열 |
| sys_id.value | Sys_id of the change request. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/1c87925347c12200e0ef563dbb9a7177/risk" \
--request PATCH \
--header "Accept:application/json" \
--user "username":"password"
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
risk: {
value: "4",
display_value: "Low"
},
impact: {
value: "3",
display_value: "3 - Low"
}
..., // all valid fields in record
}
Change Management - POST /sn_chg_rest/change
변경 요청에 따라 변경 요청 기록을 만듭니다. 단일 호출에서 여러 변경 요청을 생성하는 것은 지원되지 않습니다.
또는 Change Management - GET /sn_chg_rest/change/model/{sys_id} 엔드포인트를 사용하여 Change Management - GET /sn_chg_rest/change/model 사용 가능한 변경 모델 목록을 가져올 수 있습니다.
변경 요청을 만들 때 변경 모델(chg_model) 또는 type. and type 가 둘 다 chg_model설정된 경우 유형은 단순히 변경 내용의 분류일 뿐입니다. 이러한 값 중 하나 이상을 제공하지 않으면 릴리스에 따라 변경될 수 있는 기본 설정이 생성됩니다. 이러한 값 중 하나 이상을 설정하는 것이 좋습니다.
값은 쿼리 매개변수 또는 요청 본문 매개변수로 설정할 수 있습니다.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change
기본 URL: / api/sn_chg_rest/change
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 업데이트할 필드를 나타내는 이름-값 쌍입니다. 요청 본문 매개변수는 URL 매개변수를 재정의합니다. 그러나 필수 매개변수는 URL에 지정해야 합니다. 대신 동일한 값을 요청 본문 매개 변수로 설정할 수 있습니다. 주: 변경 요청을 만들 때 변경 모델(chg_model) 또는 type. and type 가 둘 다 chg_model설정된 경우 유형은 단순히 변경 내용의 분류일 뿐입니다. 이러한 값 중 하나 이상을 제공하지 않으면 릴리스에 따라 변경될 수 있는 기본 설정이 생성됩니다. 이러한 값 중 하나 이상을 설정하는 것이 좋습니다. 데이터 유형: 문자열 |
| chg_model | 모델[chg_model] 테이블에 나열된 변경 모델의 이름입니다. 제공되는 형식은 자세한 내용은 변경 모델을 참조하세요. 주: 변경 모델(chg_model) 또는 type 값을 제공하지 않으면 릴리스에 따라 변경될 수 있는 기본 설정이 생성됩니다. 이러한 값 중 하나 이상을 설정하는 것이 좋습니다. 데이터 유형: 문자열 |
| encrypted_fields | 암호화할 쉼표로 구분된 필드 목록입니다. 이러한 필드는 관련 기록에 저장되기 전에 암호화됩니다. 지정되면 엔드포인트는 setValue() 메서드를 호출하는 대신 GlideRecord setDisplayValue() 메서드를 호출합니다. 따라서 이 매개변수를 사용하면 sys_ids 또는 값을 전달하는 대신 참조 또는 선택 필드와 같은 암호화되지 않은 필드의 표시 값을 전달할 수도 있습니다. 데이터 유형: 문자열 |
| 유형 | 선택 사항 [sys_choice] 테이블에 나열된 변경 요청 유형의 이름입니다. 도 chg_model 채워지면 이 필드는 변경 범주화로만 사용됩니다.
자세한 내용은 새 변경 요청 유형 추가를 참조하십시오. 주: 변경 모델(chg_model) 또는 type 값을 제공하지 않으면 릴리스에 따라 변경될 수 있는 기본 설정이 생성됩니다. 이러한 값 중 하나 이상을 설정하는 것이 좋습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 객체 | 연관된 변경 요청에서 업데이트할 필드를 나타내는 이름-값 쌍입니다. 예를 들어, 간단한 설명 파일을 업데이트하려면 --data "{\"short_description\": \" my short desc\" }" \와 유사한 이름-값 쌍을 입력합니다. 대신 동일한 속성을 쿼리 매개 변수로 설정할 수 있습니다.데이터 유형: 문자열 |
| Object.chg_model | 모델[chg_model] 테이블에 나열된 변경 모델의 이름입니다. { 자세한 내용은 변경 모델을 참조하세요. 주: 변경 모델(chg_model) 또는 type 값을 제공하지 않으면 릴리스에 따라 변경될 수 있는 기본 설정이 생성됩니다. 이러한 값 중 하나 이상을 설정하는 것이 좋습니다. 데이터 유형: 문자열 |
| Object.encrypted_fields | 암호화할 쉼표로 구분된 필드 목록입니다. 이러한 필드는 관련 기록에 저장되기 전에 암호화됩니다. 지정되면 엔드포인트는 setValue() 메서드를 호출하는 대신 GlideRecord setDisplayValue() 메서드를 호출합니다. 따라서 이 매개변수를 사용하면 sys_ids 또는 값을 전달하는 대신 참조 또는 선택 필드와 같은 암호화되지 않은 필드의 표시 값을 전달할 수도 있습니다. 데이터 유형: 문자열 |
| 객체.유형 | 선택 사항 [sys_choice] 테이블에 나열된 변경 요청 유형의 이름입니다. 도 chg_model 채워지면 이 필드는 변경 범주화로만 사용됩니다. 이름-값 쌍으로 제공되며 자세한 내용은 새 변경 요청 유형 추가를 참조하십시오. 주: 변경 모델(chg_model) 또는 type 값을 제공하지 않으면 릴리스에 따라 변경될 수 있는 기본 설정이 생성됩니다. 이러한 값 중 하나 이상을 설정하는 것이 좋습니다. 데이터 유형: 문자열 |
머리글
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 콘텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 새 변경 요청 기록입니다. 이 객체의 요소는 변경 요청 [change_request] 테이블의 기록 형식에 해당합니다. 요청에 지정되지 않은 모든 값은 기본값으로 설정되거나 비어 있음/null입니다. 데이터 유형: 객체 |
cURL 요청
다음 예제에서는 표준 변경 모델 및 표준 유형을 기반으로 변경 요청 기록을 만드는 방법을 보여 줍니다. 이 예에서 변경 요청은 모델에 의해 구동되고 유형 필드는 범주화로만 사용됩니다.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"chg_model\" : \"Standard\",
\"description\" : \"Describes the change request.\",
\"short_description\" : \"My change request\",
\"type\" : \"Standard\"
}" \
--user "username":"password"
결과는 값이 CHG0030022인 변경 요청 [change_request] 테이블에 기록이 성공적으로 추가되었음을 보여줍니다.
{
"result":
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"type": {
"display_value": "Standard",
"value": "standard"
}
"number": {
"display_value": "CHG0030022",
"value": "CHG0030022"
},
"is_bulk": {
"display_value": "false",
"value": false
}
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "New",
"value": -5
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"phase": {
"display_value": "Requested",
"value": "requested"
}
"impact": {
"display_value": "3 - Low",
"value": 3
},
"active": {
"display_value": "true",
"value": true
},
"priority": {
"display_value": "4 - Low",
"value": 4
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"production_system": {
"display_value": "false",
"value": false
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
}
"short_description": {
"display_value": "My change request",
"value": "My change request"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"reassignment_count": {
"display_value": "0",
"value": 0
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"escalation": {
"display_value": "Normal",
"value": 0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0030022",
"value": "CHG0030022"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"sys_created_on": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"chg_model": {
"display_value": "Standard",
"value": "e55d0bfec343101035ae3f52c1d3ae49"
},
"opened_at": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"description": {
"display_value": "Describes the change request.",
"value": "Describes the change request."
},
"sys_id": {
"display_value": "2ac52dd77c6b1510f877be3b096e64fe",
"value": "2ac52dd77c6b1510f877be3b096e64fe"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3
},
"scope": {
"display_value": "Medium",
"value": 3
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"approval": {
"display_value": "Not Yet Requested",
"value": "not requested"
},
}
}
cURL 요청
다음 예제에서는 요청 본문에서 암호화된 필드를 전달하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"encrypted_fields\":\"short_description,description\",
\"short_description\":\"my short desc\",
\"description\":\"my desc\"
}" \
--user "username":"password"
cURL 요청
다음 예제에서는 암호화된 필드를 쿼리 매개 변수로 전달하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"
Change Management - POST /sn_chg_rest/change/{sys_id}/ci
변경 요청과 구성 관리 데이터베이스(CMDB) CI(구성 항목) 간의 연결을 만듭니다.
연결 만들기는 비동기적으로 수행되므로 응답이 즉시 제공되고 작업자에 대한 세부 정보가 포함됩니다. 작업자는 응답 후 실제 작업을 수행합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}/ci
기본 URL: / api/sn_chg_rest/change/{sys_id}/ci
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | CMDB CI와 연결할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| association_type | 필수 CMDB CI와 변경 요청 간의 연결 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| cmdb_ci_sys_ids | 필수 변경 요청에 연결할 CMDB CI sys_ids 목록입니다. 데이터 유형: 배열 또는 쉼표로 구분된 문자열 |
| refresh_impacted_services | 영향을 받는 CI 목록을 기반으로 영향을 받는 서비스를 채우기 위해 association_type=affected 인 경우 사용하는 플래그입니다.유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 202 | 허용. 처리를 위해 요청이 수락되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. 오류 응답에는 문제 해결에 도움이 되는 관련 메시지가 포함되어 있습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 메시지 | 메시지 정보입니다. 데이터 유형: 객체 |
| messages.errorMessages | 요청을 처리하는 동안 발생한 오류 메시지입니다. 예: 잘못된 CMDB_CI sys_id 제공됨 데이터 유형: 배열 |
| messages.info메시지 | 요청을 처리하는 동안 발생한 정보 메시지입니다. 예: CMDB_CI sys_id 이미 제공됨과 관련되어 있습니다. 데이터 유형: 배열 |
| messages.warning메시지 | 요청을 처리하는 동안 발생한 경고 메시지입니다. 예: 잘못된 CMDB_CI sys_id 제공되었습니다. 데이터 유형: 배열 |
| 요청 | 원래 엔드포인트 요청입니다. 데이터 유형: 문자열 |
| 상태 | 작업자의 현재 상태에 대한 정보입니다. |
| state.display_value | 작업자 상태의 표시 값입니다. 이러한 값은 요소와 직접 상관 관계가 있습니다 state.value . 가능한 값:
데이터 유형: 문자열 |
| 상태.값 | 작업자 상태의 숫자 값입니다. 가능한 값:
데이터 유형: 숫자 |
| 유형 | CMDB CI와 변경 요청 간의 연결 유형입니다. 데이터 유형: 문자열 |
| worker | 연결된 작업자에 대한 정보입니다. 데이터 유형: 객체 |
| worker.link | 연결된 작업자 상태 및 기타 작업자 관련 정보를 검색하는 URL입니다. 데이터 유형: 문자열 |
| 작업자.sysId | 변경 요청과 관련된 작업자 Sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{cmdb_ci_sys_ids:'caf043a3b7fb23000999e4f6ee11a9c0,06f043a3b7fb23000999e4f6ee11a9c1', association_type:'affected'}" \
--user "username":"password"
{
"result": {
"worker": {
"sysId": "f490f4c6dbac330084f07ffdbf961952",
"link": "instance.service-now.com/api/sn_chg_rest/change/worker/f490f4c6dbac330084f07ffdbf961952"
},
"request": "{\"cmdb_ci_sys_ids\":[\"caf043a3b7fb23000999e4f6ee11a9c0\",\"06f043a3b7fb23000999e4f6ee11a9c1\"],\"association_type\":\"affected\",\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "affected",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change Management - POST /sn_chg_rest/change/{sys_id}/conflict
지정된 변경 요청(sys_id)에 대한 변경 요청 상충 검사 프로세스를 시작합니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}/conflict
기본 URL: / api/sn_chg_rest/change/{sys_id}/conflict
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 상충 검사 프로세스를 시작할 변경 관리 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 충돌 검사 프로세스에 대한 자세한 내용은 충돌 감지를 참조하십시오. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 해결할 수 없는 오류로 인해 요청을 시작할 수 없습니다. 반환된 메시지는 추가 세부 정보를 제공할 수 있습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 결과 | 변경 요청 충돌 검사 프로세스의 Sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: "c0b5afe4b710230096c3e4f6ee11a93f"
}
Change Management - POST /sn_chg_rest/change/emergency
기본 긴급 변경 요청 기록을 기반으로 하나의 긴급 변경 요청을 생성합니다. 단일 호출 내에 여러 긴급 변경 요청을 생성할 수 없습니다.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change/emergency
기본 URL: / api/sn_chg_rest/change/emergency
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 키-값 쌍 | 요청을 생성할 때 수정할 필드의 키-값 쌍입니다. 키는 템플릿 내의 필드 이름이며 값은 필드에 채울 정보입니다. 수정할 수 없고 전달되면 무시되는 필드:
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 긴급 변경 요청에서 생성된 필드의 이름-값 쌍입니다. 데이터 유형: 객체 |
| 상태 | 삭제 전 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 값은 항상 "신규"입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 값은 항상 "-5"입니다. 데이터 유형: 문자열 |
| sys_id | 새로 만든 긴급 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "긴급"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 가치는 항상 "비상"입니다. 데이터 유형: 문자열 |
| __meta.ignoredFields | 호출에 전달되었지만 기본 기록에 없거나 필드가 읽기 전용이므로 변경 요청에 적용되지 않은 키-값 쌍입니다. 데이터 유형: 배열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?no_such_field=something&description=test&short_description=Reboot server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
변경 관리 - POST /sn_chg_rest/change/normal
기본 일반 변경 요청 기록을 기반으로 하나의 일반 변경 요청을 만듭니다. 단일 호출 내에 여러 개의 일반 변경 요청을 생성할 수 없습니다.
URL 형식
버전이 지정된 URL: / api/sn_chg_rest/{api_version}/change/normal
기본 URL: / api/sn_chg_rest/change/normal
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 키-값 쌍 | 요청을 생성할 때 수정할 필드입니다. 키는 템플릿 내의 필드 이름이며 값은 필드에 채울 정보입니다. 수정할 수 없고 전달되면 무시되는 필드:
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 연관된 변경 요청의 모든 필드에 대한 값입니다. 데이터 유형: 객체 |
| 상태 | 새로 만든 변경 요청의 상태입니다. 데이터 유형: 객체 |
| state.display_value | UI에 표시할 상태입니다. 값은 항상 "신규"입니다. 데이터 유형: 문자열 |
| 상태.값 | 내부 상태 값입니다. 값은 항상 "-5"입니다. 데이터 유형: 문자열 |
| sys_id | 새로 생성된 일반 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 유형 | 변경 요청의 유형입니다. 데이터 유형: 객체 |
| type.display_value | UI에 표시할 유형을 변경합니다. 값은 항상 "Normal"입니다. 데이터 유형: 문자열 |
| 유형.값 | 내부 유형 값입니다. 값은 항상 "정상"입니다. 데이터 유형: 문자열 |
| __meta.ignoredFields | 호출에 전달되었지만 기본 기록에 없거나 필드가 읽기 전용이므로 변경 요청에 적용되지 않은 키-값 쌍입니다. 데이터 유형: 배열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?no_such_field=something&description=test&short_description=Remove server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change Management - POST /sn_chg_rest/change/{sys_id}/refresh_impacted_services
기본 CI를 기반으로 영향을 받는 서비스/CI(구성 항목) 관련 목록을 채웁니다.
기본 CI는 변경 요청 양식과 영향을 받는 CI 관련 목록에 나타납니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{sys_id}/refresh_impacted_services
기본 URL: / api/sn_chg_rest/change/{sys_id}/refresh_impacted_services
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| sys_id | 영향을 받는 서비스를 새로 고치는 데 사용할 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 메시지 | 메시지 정보입니다. 데이터 유형: 객체 |
| messages.errorMessages | 요청을 처리하는 동안 발생한 오류 메시지입니다. 예: 잘못된 CMDB_CI sys_id 제공됨 데이터 유형: 배열 |
| messages.info메시지 | 요청을 처리하는 동안 발생한 정보 메시지입니다. 예: CMDB_CI sys_id 이미 제공됨과 관련되어 있습니다. 데이터 유형: 배열 |
| messages.warning메시지 | 요청을 처리하는 동안 발생한 경고 메시지입니다. 예: 잘못된 CMDB_CI sys_id 제공되었습니다. 데이터 유형: 배열 |
| 요청 | 원래 엔드포인트 요청입니다. 데이터 유형: 문자열 |
| 상태 | 작업자의 현재 상태에 대한 정보입니다. 데이터 유형: 객체 |
| state.display_value | 작업자 상태의 표시 값입니다. 이러한 값은 요소와 직접 상관 관계가 있습니다 state.value . 가능한 값:
데이터 유형: 문자열 |
| 상태.값 | 작업자 상태의 숫자 값입니다. 가능한 값:
데이터 유형: 숫자 |
| 유형 | CMDB CI와 변경 요청 간의 연결 유형입니다. 데이터 유형: 문자열 |
| worker | 연결된 작업자에 대한 정보입니다. 데이터 유형: 객체 |
| worker.link | 연결된 작업자 상태 및 기타 작업자 관련 정보를 검색하는 URL입니다. 데이터 유형: 문자열 |
| 작업자.sysId | 변경 요청과 관련된 작업자 Sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/refresh_impacted_services" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user "username":"password"
{
result: {
worker: {
sysId: "aa31c308b75033000999e4f6ee11a9c2",
link: "http://instance.service-now.com/api/sn_chg_rest/change/worker/aa31c308b75033000999e4f6ee11a9c2"
},
request: "",
state: {
value: 1,
display_value: "Waiting"
},
type: "impacted",
messages: {
errorMessages: [],
warningMessages: [],
infoMessages: []
}
}
}
Change Management - POST /sn_chg_rest/change/standard/{standard_change_template_id}
전달된 템플릿 sys_id에서 지정한 대로 기존 표준 변경 템플릿을 기반으로 표준 변경 요청을 하나 만듭니다. 단일 호출로 여러 표준 변경 요청을 작성할 수 없습니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/standard/{standard_change_template_id}
기본 URL: / api/sn_chg_rest/change/standard/{standard_change_template_id}
지원되는 요청 매개변수
| 매개변수 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| standard_change_template_id | 새 표준 변경 요청의 기준이 되는 표준 변경 템플릿의 Sys_id입니다. 표준 변경 템플릿[std_change_record_producer] 테이블에 있습니다. 데이터 유형: 문자열 |
| 매개변수 | 설명 |
|---|---|
| 이름-값 쌍 | 요청을 생성할 때 수정할 지정된 표준 변경 템플릿 내의 필드입니다. 키는 템플릿 내의 필드 이름이며 값은 필드에 채울 정보입니다. 수정할 수 없고 전달되면 무시되는 필드:
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문
API는 응답 본문에 이러한 JSON 또는 XML 요소를 반환합니다.
| 요소 | 설명 |
|---|---|
| 이름-값 쌍 | 표준 변경 요청에서 생성된 필드의 이름-값 쌍입니다. 데이터 유형: 객체 |
| sys_id | 새로 만든 표준 변경 요청의 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 표준 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 표준 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| __meta.ignoredFields | 호출에 전달되었지만 기본 기록에 없거나 필드가 읽기 전용이므로 변경 요청에 적용되지 않은 키-값 쌍입니다. 데이터 유형: 배열 |
샘플 cURL 요청
curl "https://instance.servicenow.com" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change Management - POST /sn_chg_rest/change/{change_sys_id}/task
기본 변경 요청 작업 기록을 기반으로 하나의 변경 요청 작업을 만들고 지정된 변경 요청과 연결합니다. 단일 호출 내에 여러 변경 요청 작업을 생성할 수 없습니다.
URL 형식
버전이 지정된 URL: /api/sn_chg_rest/{api_version}/ change/{change_sys_id}/task
기본 URL: / api/sn_chg_rest/change/{change_sys_id}/task
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| change_sys_id | 이 작업을 연결할 변경 요청의 Sys_id입니다. 변경 요청 [change_request] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 키-값 쌍 | 요청을 생성할 때 수정할 필드입니다. 키는 템플릿 내의 필드 이름이며 값은 필드에 채울 정보입니다. 수정할 수 없고 전달되면 무시되는 필드:
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 헤더 | 설명 |
|---|---|
| 없음 |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 완료되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 지정된 기록을 찾을 수 없습니다. |
| 500 | 내부 서버 오류입니다. 서버 쪽 코드에서 논리 오류가 발생했습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름-값 쌍 | 변경 요청 작업에서 생성된 필드의 이름-값 쌍입니다. 데이터 유형: 객체 |
| 상위 | 작업과 연결된 변경 요청에 대한 정보입니다. 데이터 유형: 객체 |
| parent.display_value | 작업과 연관된 변경 요청에 대해 UI에 표시할 정보입니다. 데이터 유형: 문자열 |
| 부모.값 | 작업과 연결된 변경 요청의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id | 새로 만든 변경 요청 작업의 Sys_id 정보입니다. 데이터 유형: 객체 |
| sys_id.display_value | UI에 표시할 변경 요청 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id.가치 | 변경 요청 작업의 Sys_id입니다. 데이터 유형: 문자열 |
| __meta.ignoredFields | 호출에 전달되었지만 기본 기록에 없거나 필드가 읽기 전용이므로 변경 요청에 적용되지 않은 키-값 쌍입니다. 데이터 유형: 배열 |
cURL 요청
curl "https://instance.servicenow.com/api/now/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?short_description=Retire node&no_such_field=test" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe ",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire node",
display_value: "Retire node"
}
__meta.ignoredFields": ["no_such_field"]
}
]
}