CMDB 인스턴스 API
CMDB 인스턴스 API는 기존 구성 관리 데이터베이스(CMDB) 테이블에서 작업을 생성, 읽기, 업데이트 및 삭제할 수 있는 엔드포인트를 제공합니다. 한 번에 하나의 기록만 삽입, 업데이트 또는 삭제할 수 있습니다.
이 API를 사용하려면 사용자에게 ITIL 역할이 필요합니다.
CMDB 인스턴스 - DELETE /now/cmdb/instance/{classname}/{sys_id}/relation/{rel_sys_id}
지정된 CI(구성 항목)에 대한 관계를 삭제합니다.
URL 형식
버전이 지정된 URL: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}
기본 URL: /api/now/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| className | CMDB 클래스 이름입니다. 원하는 CI 기록(예: cmdb_ci_linux_server 또는 cmdb_ci_apache_web_server)이 포함된 테이블의 이름입니다. 데이터 유형: 문자열 |
| rel_sys_id | 제거할 관계의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_id | CI의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 없음 |
| 머리글 | 설명 |
|---|---|
| 안 함 |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 405 | 잘못된 메서드입니다. 기능이 비활성화되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 없음 |
샘플 cURL 요청
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/0f4ac6c4b750230096c3e4f6ee11a9fe/relation/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--user 'username':'password'
CMDB 인스턴스 - GET /now/cmdb/instance/{classname}
지정된 구성 관리 데이터베이스(CMDB) 클래스(테이블)에 사용 가능한 CI(구성 항목)를 반환합니다.
URL 형식
버전이 지정된 URL: /api/now/{api_version}/cmdb/instance/{className}
기본 URL: /api/now/cmdb/instance/{className}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| className | CMDB 클래스 이름입니다. 원하는 CI 기록(예: cmdb_ci_linux_server 또는 cmdb_ci_apache_web_server)이 포함된 테이블의 이름입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| sysparm_limit | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 sysparm_offset 사용하여 기록 검색을 페이지 매김합니다. 이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함해 기록이 반환되지 않으면 액세스 권한이 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다. 주:
이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 줄 수 있습니다. 데이터 유형: 숫자 기본값: 10000 |
| sysparm_offset | 기록 검색을 시작할 기록 인덱스를 시작하는 중입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수에 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 예를 들어 이 엔드포인트 sysparm_offset 를 처음 호출할 때 '0'으로 설정됩니다. 사용 가능한 모든 기록을 간단히 페이지화하려면 모든 기록의 끝에 도달할 때까지 데이터 유형: 숫자 기본값: 0 |
| sysparm_query | 결과 세트를 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하면 올바르게 인코딩된 쿼리를 얻을 수 있습니다. 구문: sysparm_query=<col_name><operator><value>. 열 이름, 연산자 및 값은 대/소문자를 구분합니다.
쿼리에는 여러 조건이 포함될 수 있습니다. 예를 들어, 다음 쿼리는 호출자가 현재 사용자이고 기록이 활성 상태인 기록을 반환합니다.
인코딩된 쿼리는 오름차순 및 내림차순 기능으로 순서 정렬도 지원합니다. 특정 필드를 기준으로 응답을 정렬하려면 통사론:
예를 들어, 다음 쿼리는 모든 활성 기록을 가져오고 결과를 번호 순으로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다.
기본적으로 잘못된 필드 이름과 같은 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. 잘못된 쿼리에 행을 반환하지 않으려면 속성을 glide.invalid_query.returns_no_rows예 로 설정합니다. 주: 이 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 | 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 405 | 잘못된 메서드입니다. 기능이 비활성화되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 이름 | 지정된 클래스 내의 CI 이름입니다. 데이터 유형: 문자열 |
| sys_id | CI의 Sys_id입니다. 데이터 유형: 문자열 |
샘플 cURL 요청
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
"result": [
{
"sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
"name": "PS LinuxApp01"
},
{
"sys_id": "3a5dd3dbc0a8ce0100655f1ec66ed42c",
"name": "PS LinuxApp02"
}
]
CMDB 인스턴스 - GET /now/cmdb/instance/{classname}/{sys_id}
지정된 CI(구성 항목) 기록에 대한 속성 및 관계 정보를 반환합니다.
URL 형식
버전이 지정된 URL: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}
기본 URL: /api/now/cmdb/instance/{className}/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하도록 이 값만 지정하십시오. 데이터 유형: 문자열 |
| className | CMDB 클래스 이름입니다. 원하는 CI 기록(예: cmdb_ci_linux_server 또는 cmdb_ci_apache_web_server)이 포함된 테이블의 이름입니다. 데이터 유형: 문자열 |
| sys_id | 검색할 CI 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 안 함 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하십시오.
| 머리글 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
| 머리글 | 설명 |
|---|---|
| 안 함 |
상태 코드
이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하십시오.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 권한이 해제되었습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 405 | 잘못된 메서드입니다. 기능이 비활성화되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 속성 | 현재 CI 기록에 있는 데이터 속성입니다. 사용 가능한 속성은 지정된 CMDB 클래스에 따라 다릅니다. cmdb_ci_linux_server 또는 cmdb_ci_mfp_printer와 같이 일반적으로 "cmdb_ci"로 시작하는 연결된 CMDB 테이블에서 사용 가능한 속성을 찾을 수 있습니다. 데이터 유형: 객체 |
| 오류 | 엔드포인트 요청을 처리하는 동안 발생한 오류에 대한 정보입니다. 데이터 유형: 객체 |
| 오류.상세 정보 | 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| 오류.메시지 | 오류를 식별하는 메시지입니다. 데이터 유형: 문자열 |
| inbound_relations | CI와 연관된 인바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| inbound_relations.sys_id | 인바운드 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.target | 대상 인바운드 관계를 설명하는 정보입니다. 데이터 유형: 객체 |
| inbound_relations.target.display_value | 사용자 인터페이스에 표시할 인바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 인바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.target.value | 인바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.type | 인바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| inbound_relations.type.display_value | 사용자 인터페이스에 표시할 인바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 인바운드 관계 유형을 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.유형.값 | 인바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations | CI와 연결된 아웃바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| outbound_relations.sys_id | 아웃바운트 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.target | 필수 대상 아웃바운드 관계에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.target.display_value | 사용자 인터페이스에 표시할 아웃바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.target.value | 아웃바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.type | 아웃바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.type.display_value | 사용자 인터페이스에 표시할 아웃바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.유형.값 | 아웃바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| 상태 | 오류가 발생한 경우에만 나타납니다. 엔드포인트 처리의 상태입니다. 가능한 값: 실패 데이터 유형: 문자열 |
샘플 cURL 요청
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"outbound_relations": [
{
"sys_id": "3a62e64ac0a8ce0100aead1e3fd5439f",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "3a67513fc0a8ce0100914a76cea11b02",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Intranet",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-08 11:16:51",
"discovery_source": "",
"first_discovered": "",
"due_in": "",
"used_for": "Production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "glide.maint",
"warranty_expiration": "",
"ram": "2048",
"cpu_name": "",
"cpu_speed": "2800",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "40",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "2020-01-04 07:00:00",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": {
"display_value": "Lynda Caraway",
"link": "https://instance.service-now.com/api/now/table/sys_user/8a826bf03710200044e0bfc8bcbe5d72",
"value": "8a826bf03710200044e0bfc8bcbe5d72"
},
"os_domain": "",
"last_discovered": "",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": {
"display_value": "Iris",
"link": "https://instance.servicenow.com/api/now/table/core_company/c115c2f737e3100044e0bfc8bcbe5d46",
"value": "c115c2f737e3100044e0bfc8bcbe5d46"
},
"cpu_count": "1",
"vendor": {
"display_value": "Cloudward Inc",
"link": "https://instance.servicenow.com/api/now/table/core_company/3efe8c4c37423000158bbfc8bcbe5d7d",
"value": "3efe8c4c37423000158bbfc8bcbe5d7d"
},
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "2.6.9-22.0.1.ELsmp",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": {
"display_value": "P1000091 - Iris 5875",
"link": "https://instance.servicenow.com/api/now/table/alm_asset/0bc1ba8837f3100044e0bfc8bcbe5dbb",
"value": "0bc1ba8837f3100044e0bfc8bcbe5dbb"
},
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "system",
"sys_created_on": "2008-10-26 17:17:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "Intel",
"install_date": "2019-08-18 08:00:00",
"asset_tag": "P1000091",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "false",
"delivery_date": "",
"hardware_status": "",
"install_status": "1",
"supported_by": "",
"name": "PS LinuxApp01",
"subcategory": "",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": {
"display_value": "ACME Corporation",
"link": "https://instance.servicenow.com/api/now/table/core_company/e7c1f3d53790200044e0bfc8bcbe5deb",
"value": "e7c1f3d53790200044e0bfc8bcbe5deb"
},
"justification": "",
"department": "",
"cost": "45557.5",
"comments": "",
"os": "Linux Red Hat",
"sys_mod_count": "24",
"monitor": "false",
"model_id": {
"display_value": "Iris 5875",
"link": "https://instance.servicenow.com/api/now/table/cmdb_model/5f5fbcc3c0a8010e00f3b27814f3b96b",
"value": "5f5fbcc3c0a8010e00f3b27814f3b96b"
},
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": {
"display_value": "322 West 52nd Street, New York,NY",
"link": "https://instance.servicenow.com/api/now/table/cmn_location/25ab9f690a0a0bb3001c5fec1d0d7bcb",
"value": "25ab9f690a0a0bb3001c5fec1d0d7bcb"
},
"category": "Do not migrate to asset",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "3a5e4d8ac0a8ce010005145afb730818",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
},
{
"sys_id": "3a5e4d9cc0a8ce010097f2f5c2f65fd8",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache02",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27f1520a0a0bb400ecd6ff7afcf036",
"value": "3a27f1520a0a0bb400ecd6ff7afcf036"
}
},
{
"sys_id": "3a5e4d9fc0a8ce0100a3754fac26fe56",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache03",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a2810c20a0a0bb400268337d6e942ca",
"value": "3a2810c20a0a0bb400268337d6e942ca"
}
}
]
}
}
CMDB 인스턴스 - POST /now/cmdb/instance/{classname}
지정된 구성 관리 데이터베이스(CMDB) 테이블 내에 지정된 아웃바운드 및 인바운드 관계를 가진 단일 CI(구성 항목)를 작성합니다.
"depends_on": {
"outbound_relations":
{
"target": "b4fd7c8437201000deeabfc8bcbe5dc1",
"type": "60bc4e22c0a8010e01f074cbe6bd73c3"
}
}URL 형식
버전이 지정된 URL: /api/now/{api_version}/cmdb/instance/{className}
기본 URL: /api/now/cmdb/instance/{className}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| className | CMDB 클래스 이름입니다. 원하는 CI 기록(예: cmdb_ci_linux_server 또는 cmdb_ci_apache_web_server)이 포함된 테이블의 이름입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 속성 | CI 기록에서 정의할 데이터 속성입니다. 사용 가능한 속성은 지정된 CMDB 클래스에 따라 다릅니다. cmdb_ci_linux_server 또는 cmdb_ci_mfp_printer와 같이 일반적으로 "cmdb_ci"로 시작하는 연결된 CMDB 테이블에서 사용 가능한 속성을 찾을 수 있습니다. 데이터 유형: 객체 |
| inbound_relations | CI와 연결할 인바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| inbound_relations.target | 지정된 경우 inbound_relations 필요합니다. 지정된 CI와 연결할 대상 인바운드 관계의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.type | 지정된 경우 inbound_relations 필요합니다. 인바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations | CI와 연결할 아웃바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| outbound_relations.target | 지정된 경우 outbound_relations 필요합니다. 대상 아웃바운드 관계의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.type | 지정된 경우 outbound_relations 필요합니다. 아웃바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| 소스 | 필수 정보를 업데이트한 엔터티입니다. 이 값은 구성 항목 [cmdb_ci] 테이블의 discovery_source 필드에 지정된 선택 값 중 하나여야 합니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 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 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 405 | 잘못된 메서드입니다. 기능이 비활성화되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 속성 | 현재 CI 기록에 있는 데이터 속성입니다. 사용 가능한 속성은 지정된 CMDB 클래스에 따라 다릅니다. cmdb_ci_linux_server 또는 cmdb_ci_mfp_printer와 같이 일반적으로 "cmdb_ci"로 시작하는 연결된 CMDB 테이블에서 사용 가능한 속성을 찾을 수 있습니다. 데이터 유형: 객체 |
| 오류 | 엔드포인트 요청을 처리하는 동안 발생한 오류에 대한 정보입니다. 데이터 유형: 객체 |
| 오류.상세 정보 | 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| 오류.메시지 | 오류를 식별하는 메시지입니다. 데이터 유형: 문자열 |
| inbound_relations | CI와 연관된 인바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| inbound_relations.sys_id | 인바운드 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.target | 대상 인바운드 관계를 설명하는 정보입니다. 데이터 유형: 객체 |
| inbound_relations.target.display_value | 사용자 인터페이스에 표시할 인바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 인바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.target.value | 인바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.type | 인바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| inbound_relations.type.display_value | 사용자 인터페이스에 표시할 인바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 인바운드 관계 유형을 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.유형.값 | 인바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations | CI와 연결된 아웃바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| outbound_relations.sys_id | 아웃바운트 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.target | 필수 대상 아웃바운드 관계에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.target.display_value | 사용자 인터페이스에 표시할 아웃바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.target.value | 아웃바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.type | 아웃바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.type.display_value | 사용자 인터페이스에 표시할 아웃바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.유형.값 | 아웃바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| 상태 | 오류가 발생한 경우에만 나타납니다. 엔드포인트 처리의 상태입니다. 가능한 값: 실패 데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 이 엔드포인트를 호출하는 방법을 보여 줍니다.
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
"outbound_relations": [
{
"type" : "1a9cb166f1571100a92eb60da2bce5c5",
"target" : "3a307c930a0a0bb400353965d0b8861f"
},
{
"type" : "607ad1b2c0a8010e01941856b365af90",
"target" : "3a307c930a0a0bb400353965d0b8861f"
}
],
"attributes": {
"name" : "lnux999",
"firewall_status": "Intranet"
},
"source": "ServiceNow",
"inbound_relations": [
{
"type" : "1a9cb166f1571100a92eb60da2bce5c5",
"target" : "3a27d4370a0a0bb4006316812bf45439"
}
]
}
{
"result": {
"outbound_relations": [
{
"sys_id": "403ff2641b425010593876a61a4bcb4b",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "443ff2641b425010593876a61a4bcb4c",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Intranet",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-13 20:27:28",
"discovery_source": "ServiceNow",
"first_discovered": "2020-07-13 20:27:28",
"due_in": "",
"used_for": "Production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "dora.gray",
"warranty_expiration": "",
"ram": "",
"cpu_name": "",
"cpu_speed": "",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": "",
"os_domain": "",
"last_discovered": "2020-07-13 20:27:28",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": "",
"cpu_count": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": "",
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "dora.gray",
"sys_created_on": "2020-07-13 20:27:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "",
"install_date": "",
"asset_tag": "",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "true",
"delivery_date": "",
"hardware_status": "installed",
"install_status": "1",
"supported_by": "",
"name": "lnux299",
"subcategory": "Computer",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "0c3ff2641b425010593876a61a4bcb39",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"os": "",
"sys_mod_count": "0",
"monitor": "false",
"model_id": "",
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Hardware",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "c03ff2641b425010593876a61a4bcb49",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
}
]
}
}
cURL 요청
다음 코드 예제에서는 종속 식별 규칙이 정의된 클래스에 대해 이 엔드포인트를 호출하는 방법을 보여 줍니다. outbound_relations.target 페이로드에 포함되어야 하며 기존 CI의 sys_id 포함해야 합니다.
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
"attributes": {
"name": "test",
"sys_class_name":"cmdb_ci_db_mssql_instance",
"instance_name":"Iname"
},
"source": "ServiceNow",
"depends_on": {
"outbound_relations":
{
"target": "b4fd7c8437201000deeabfc8bcbe5dc1",
"type": "60bc4e22c0a8010e01f074cbe6bd73c3"
}
}
}
}
{
"result": {
"outbound_relations": [
{
"sys_id": "505cfa3a53662110af64ddeeff7b1217",
"type": {
"display_value": "Runs on::Runs",
"link": http://instance.servicenow.com/api/now/table/cmdb_rel_type/60bc4e22c0a8010e01f074cbe6bd73c3,
"value": "60bc4e22c0a8010e01f074cbe6bd73c3"
},
"target": {
"display_value": "*ANNIE-IBM",
"link": http://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/b4fd7c8437201000deeabfc8bcbe5dc1,
"value": "b4fd7c8437201000deeabfc8bcbe5dc1"
}
}
],
"attributes": {
"attested_date": "",
"operational_status": "1",
"running_process_command": "",
"sys_updated_on": "2023-05-05 21:28:24",
"type": "",
"running_process_key_parameters": "",
"rp_command_hash": "",
"discovery_source": "ServiceNow",
"first_discovered": "2023-05-05 21:28:24",
"due_in": "",
"service_pack": "",
"used_for": "Production",
"is_clustered": "false",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "admin",
"warranty_expiration": "",
"owned_by": "",
"checked_out": "",
"rp_key_parameters_hash": "",
"sys_domain_path": "/",
"business_unit": "",
"version": "",
"cpu_sockets": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"managed_by": "",
"port_dynamic": "false",
"last_discovered": "2023-05-05 21:28:24",
"can_print": "false",
"sys_class_name": "cmdb_ci_db_mssql_instance",
"manufacturer": "",
"cl_port": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"config_file": "",
"assigned_to": "",
"start_date": "",
"instance_name": "Iname",
"serial_number": "",
"engine_edition": "",
"support_group": "",
"version_name": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": "",
"config_directory": "",
"tcp_port": "",
"listener_name": "",
"skip_sync": "false",
"pid": "",
"attestation_score": "",
"sys_updated_by": "admin",
"install_directory": "",
"sys_created_on": "2023-05-05 21:28:24",
"sys_domain": {
"display_value": "global",
"link": http://instance.servicenow.com/api/now/table/sys_user_group/global,
"value": "global"
},
"install_date": "",
"asset_tag": "",
"fqdn": "",
"change_control": "",
"delivery_date": "",
"install_status": "1",
"supported_by": "",
"name": "test",
"subcategory": "Database",
"assignment_group": "",
"edition": "",
"managed_by_group": "",
"sys_id": "185cba3a53662110af64ddeeff7b12af",
"po_number": "",
"database": "",
"checked_in": "",
"sys_class_path": "/!!/!(/!2/!,",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"attestation_status": "Not Yet Reviewed",
"sys_mod_count": "0",
"monitor": "false",
"model_id": "",
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Resource",
"fault_count": "0",
"lease_id": ""
},
"inbound_relations": []
}
}
cURL 요청
다음 코드 예제에서는 종속 식별 규칙이 정의된 클래스에 대해 sys_id이 전달되지 않을 때 반환되는 내용을 보여 줍니다. sys_id이 잘못된 경우에도 동일한 결과가 발생합니다.
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data "{
"attributes": {
"name": "test",
"sys_class_name":"cmdb_ci_db_mssql_instance",
"instance_name":"Iname"
},
"source": "ServiceNow",
"depends_on": {
"outbound_relations": {
"type": "60bc4e22c0a8010e01f074cbe6bd73c3"
}
}
}
{
"error": {
"detail": "Exception while executing request: null Check logs for error trace or enable glide.rest.debug property to verify REST request processing",
"message": "Exception while executing request: null"
},
"status": "failure"
}
CMDB 인스턴스 - PUT /now/cmdb/instance/{classname}/{sys_id}
지정된 속성 이름-값 쌍으로 지정된 CI(구성 항목) 기록을 업데이트합니다. 이 엔드포인트는 연결된 관계를 생성, 업데이트 또는 삭제하지 않습니다.
URL 형식
버전이 지정된 URL: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}
기본 URL: /api/now/cmdb/instance/{className}/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| className | CMDB 클래스 이름입니다. 원하는 CI 기록(예: cmdb_ci_linux_server 또는 cmdb_ci_apache_web_server)이 포함된 테이블의 이름입니다. 데이터 유형: 문자열 |
| sys_id | 업데이트할 CI 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 속성 | CI 기록에서 대체할 데이터 속성입니다. 사용 가능한 속성은 지정된 CMDB 클래스에 따라 다릅니다. cmdb_ci_linux_server 또는 cmdb_ci_mfp_printer와 같이 일반적으로 "cmdb_ci"로 시작하는 연결된 CMDB 테이블에서 사용 가능한 속성을 찾을 수 있습니다. 증명에 대한 자세한 내용은 다음 문서를 참조하십시오 CIs attestation. 데이터 유형: 객체 |
| 소스 | 필수 정보를 업데이트한 엔터티입니다. 이 값은 구성 항목 [cmdb_ci] 테이블의 discovery_source 필드에 지정된 선택 값 중 하나여야 합니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 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 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 405 | 잘못된 메서드입니다. 기능이 비활성화되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 속성 | 현재 CI 기록에 있는 데이터 속성입니다. 사용 가능한 속성은 지정된 CMDB 클래스에 따라 다릅니다. cmdb_ci_linux_server 또는 cmdb_ci_mfp_printer와 같이 일반적으로 "cmdb_ci"로 시작하는 연결된 CMDB 테이블에서 사용 가능한 속성을 찾을 수 있습니다. 데이터 유형: 객체 |
| 오류 | 엔드포인트 요청을 처리하는 동안 발생한 오류에 대한 정보입니다. 데이터 유형: 객체 |
| 오류.상세 정보 | 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| 오류.메시지 | 오류를 식별하는 메시지입니다. 데이터 유형: 문자열 |
| inbound_relations | CI와 연관된 인바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| inbound_relations.sys_id | 인바운드 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.target | 대상 인바운드 관계를 설명하는 정보입니다. 데이터 유형: 객체 |
| inbound_relations.target.display_value | 사용자 인터페이스에 표시할 인바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 인바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.target.value | 인바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.type | 인바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| inbound_relations.type.display_value | 사용자 인터페이스에 표시할 인바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 인바운드 관계 유형을 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.유형.값 | 인바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations | CI와 연결된 아웃바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| outbound_relations.sys_id | 아웃바운트 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.target | 필수 대상 아웃바운드 관계에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.target.display_value | 사용자 인터페이스에 표시할 아웃바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.target.value | 아웃바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.type | 아웃바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.type.display_value | 사용자 인터페이스에 표시할 아웃바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.유형.값 | 아웃바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| 상태 | 오류가 발생한 경우에만 나타납니다. 엔드포인트 처리의 상태입니다. 가능한 값: 실패 데이터 유형: 문자열 |
샘플 cURL 요청
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
"attributes": {
"firewall_status": "Extranet",
"discovery_source": "ServiceNows",
"name": "Linux299",
"used_for": "Pre-production",
"container": "Box"
},
"source": "ServiceNow"
}
{
"result": {
"outbound_relations": [
{
"sys_id": "403ff2641b425010593876a61a4bcb4b",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "443ff2641b425010593876a61a4bcb4c",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Extranet",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-13 20:59:40",
"discovery_source": "ServiceNow",
"first_discovered": "2020-07-13 20:27:28",
"due_in": "",
"used_for": "Pre-production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "dora.gray",
"warranty_expiration": "",
"ram": "",
"cpu_name": "",
"cpu_speed": "",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": "",
"os_domain": "",
"last_discovered": "2020-07-13 20:59:40",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": "",
"cpu_count": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": {
"display_value": "Unknown",
"link": "https://instance.service-now.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
"value": "21cfba641b425010593876a61a4bcb52"
},
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "dora.gray",
"sys_created_on": "2020-07-13 20:27:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.service-now.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "",
"install_date": "",
"asset_tag": "",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "true",
"delivery_date": "",
"hardware_status": "installed",
"install_status": "1",
"supported_by": "",
"name": "Linux299",
"subcategory": "Computer",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "0c3ff2641b425010593876a61a4bcb39",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"os": "",
"sys_mod_count": "3",
"monitor": "false",
"model_id": {
"display_value": "Unknown",
"link": "https://instance.service-now.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
"value": "0ce0a2681b4e1010593876a61a4bcba6"
},
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Hardware",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "c03ff2641b425010593876a61a4bcb49",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
}
]
}
}
CMDB 인스턴스 - POST /now/cmdb/instance/{classname}/{sys_id}/relation
지정된 CI(구성 항목)에 인바운드 및/또는 아웃바운드 관계를 추가합니다. 지정된 CI가 상위 CI입니다.
URL 형식
버전이 지정된 URL: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}/relation
기본 URL: /api/now/cmdb/instance/{className}/{sys_id}/relation
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| className | CMDB 클래스 이름입니다. 원하는 CI 기록(예: cmdb_ci_linux_server 또는 cmdb_ci_apache_web_server)이 포함된 테이블의 이름입니다. 데이터 유형: 문자열 |
| sys_id | 업데이트할 CI 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| inbound_relations | CI와 연결할 인바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| inbound_relations.target | 지정된 경우 inbound_relations 필요합니다. 지정된 CI와 연결할 대상 인바운드 관계의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.type | 지정된 경우 inbound_relations 필요합니다. 인바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations | CI와 연결할 아웃바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| outbound_relations.target | 지정된 경우 outbound_relations 필요합니다. 대상 아웃바운드 관계의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.type | 지정된 경우 outbound_relations 필요합니다. 아웃바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| 소스 | 필수 정보를 업데이트한 엔터티입니다. 이 값은 구성 항목 [cmdb_ci] 테이블의 discovery_source 필드에 지정된 선택 값 중 하나여야 합니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 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 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 405 | 잘못된 메서드입니다. 기능이 비활성화되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 속성 | 현재 CI 기록에 있는 데이터 속성입니다. 사용 가능한 속성은 지정된 CMDB 클래스에 따라 다릅니다. cmdb_ci_linux_server 또는 cmdb_ci_mfp_printer와 같이 일반적으로 "cmdb_ci"로 시작하는 연결된 CMDB 테이블에서 사용 가능한 속성을 찾을 수 있습니다. 데이터 유형: 객체 |
| 오류 | 엔드포인트 요청을 처리하는 동안 발생한 오류에 대한 정보입니다. 데이터 유형: 객체 |
| 오류.상세 정보 | 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| 오류.메시지 | 오류를 식별하는 메시지입니다. 데이터 유형: 문자열 |
| inbound_relations | CI와 연관된 인바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| inbound_relations.sys_id | 인바운드 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.target | 대상 인바운드 관계를 설명하는 정보입니다. 데이터 유형: 객체 |
| inbound_relations.target.display_value | 사용자 인터페이스에 표시할 인바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 인바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.target.value | 인바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.type | 인바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| inbound_relations.type.display_value | 사용자 인터페이스에 표시할 인바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 인바운드 관계 유형을 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.유형.값 | 인바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations | CI와 연결된 아웃바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| outbound_relations.sys_id | 아웃바운트 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.target | 필수 대상 아웃바운드 관계에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.target.display_value | 사용자 인터페이스에 표시할 아웃바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.target.value | 아웃바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.type | 아웃바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.type.display_value | 사용자 인터페이스에 표시할 아웃바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.유형.값 | 아웃바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| 상태 | 오류가 발생한 경우에만 나타납니다. 엔드포인트 처리의 상태입니다. 가능한 값: 실패 데이터 유형: 문자열 |
샘플 cURL 요청
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/3a290cc60a0a0bb400000bdb386af1cf/relation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
"outbound_relations": [
{
"type" : "1a9cb166f1571100a92eb60da2bce5c5",
"target" : "3a307c930a0a0bb400353965d0b8861f"
},
{
"type" : "607ad1b2c0a8010e01941856b365af90",
"target" : "3a307c930a0a0bb400353965d0b8861f"
}
],
"source": "ServiceNow",
"inbound_relations": [
{
"type" : "1a9cb166f1571100a92eb60da2bce5c5",
"target" : "3a27d4370a0a0bb4006316812bf45439"
}
]
}
{
"result": {
"outbound_relations": [
{
"sys_id": "403ff2641b425010593876a61a4bcb4b",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "443ff2641b425010593876a61a4bcb4c",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Active",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-13 21:24:05",
"discovery_source": "ServiceNow",
"first_discovered": "2020-07-13 20:27:28",
"due_in": "",
"used_for": "Production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "dora.gray",
"warranty_expiration": "",
"ram": "",
"cpu_name": "",
"cpu_speed": "",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": "",
"os_domain": "",
"last_discovered": "2020-07-13 21:24:05",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": "",
"cpu_count": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": {
"display_value": "Unknown",
"link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
"value": "21cfba641b425010593876a61a4bcb52"
},
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "dora.gray",
"sys_created_on": "2020-07-13 20:27:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "",
"install_date": "",
"asset_tag": "",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "true",
"delivery_date": "",
"hardware_status": "installed",
"install_status": "1",
"supported_by": "",
"name": "Linux299",
"subcategory": "Computer",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "0c3ff2641b425010593876a61a4bcb39",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"os": "",
"sys_mod_count": "4",
"monitor": "false",
"model_id": {
"display_value": "Unknown",
"link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
"value": "0ce0a2681b4e1010593876a61a4bcba6"
},
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Hardware",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "c03ff2641b425010593876a61a4bcb49",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
}
]
}
}
CMDB 인스턴스 - PATCH /now/cmdb/instance/{classname}/{sys_id}
지정된 CI(구성 항목) 기록의 속성을 지정된 이름-값 쌍으로 바꿉니다. 이 엔드포인트는 연결된 관계를 생성, 업데이트 또는 삭제하지 않습니다.
URL 형식
버전이 지정된 URL: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}
기본 URL: /api/now/cmdb/instance/{className}/{sys_id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| className | CMDB 클래스 이름입니다. 원하는 CI 기록(예: cmdb_ci_linux_server 또는 cmdb_ci_apache_web_server)이 포함된 테이블의 이름입니다. 데이터 유형: 문자열 |
| sys_id | 업데이트할 CI 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 안 함 |
| 이름 | 설명 |
|---|---|
| 속성 | CI 기록에서 대체할 데이터 속성입니다. 사용 가능한 속성은 지정된 CMDB 클래스에 따라 다릅니다. cmdb_ci_linux_server 또는 cmdb_ci_mfp_printer와 같이 일반적으로 "cmdb_ci"로 시작하는 연결된 CMDB 테이블에서 사용 가능한 속성을 찾을 수 있습니다. 증명에 대한 자세한 내용은 다음 문서를 참조하십시오 CIs attestation. 데이터 유형: 객체 |
| 소스 | 필수 정보를 업데이트한 엔터티입니다. 이 값은 구성 항목 [cmdb_ci] 테이블의 discovery_source 필드에 지정된 선택 값 중 하나여야 합니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 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 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 405 | 잘못된 메서드입니다. 기능이 비활성화되었습니다. |
| 500 | 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| 속성 | 현재 CI 기록에 있는 데이터 속성입니다. 사용 가능한 속성은 지정된 CMDB 클래스에 따라 다릅니다. cmdb_ci_linux_server 또는 cmdb_ci_mfp_printer와 같이 일반적으로 "cmdb_ci"로 시작하는 연결된 CMDB 테이블에서 사용 가능한 속성을 찾을 수 있습니다. 데이터 유형: 객체 |
| 오류 | 엔드포인트 요청을 처리하는 동안 발생한 오류에 대한 정보입니다. 데이터 유형: 객체 |
| 오류.상세 정보 | 오류에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| 오류.메시지 | 오류를 식별하는 메시지입니다. 데이터 유형: 문자열 |
| inbound_relations | CI와 연관된 인바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| inbound_relations.sys_id | 인바운드 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.target | 대상 인바운드 관계를 설명하는 정보입니다. 데이터 유형: 객체 |
| inbound_relations.target.display_value | 사용자 인터페이스에 표시할 인바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 인바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.target.value | 인바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| inbound_relations.type | 인바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| inbound_relations.type.display_value | 사용자 인터페이스에 표시할 인바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| inbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 인바운드 관계 유형을 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| inbound_relations.유형.값 | 인바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations | CI와 연결된 아웃바운드 관계를 정의하는 객체의 목록입니다. 데이터 유형: 배열 |
| outbound_relations.sys_id | 아웃바운트 CI 관계의 Sys_id입니다. CI 관계 [cmdb_rel_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.target | 필수 대상 아웃바운드 관계에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.target.display_value | 사용자 인터페이스에 표시할 아웃바운드 관계의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.target.link | CMDB 구성 항목 [cmdb_ci] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.target.value | 아웃바운드 CI의 Sys_id입니다. 구성 항목 [cmdb_ci] 테이블에 있습니다. 데이터 유형: 문자열 |
| outbound_relations.type | 아웃바운드 관계의 유형에 대한 정보입니다. 데이터 유형: 객체 |
| outbound_relations.type.display_value | 사용자 인터페이스에 표시할 아웃바운드 유형의 이름입니다. 데이터 유형: 문자열 |
| outbound_relations.type.link | 테이블 CI 관계 유형 [cmdb_rel_type] 테이블에서 아웃바운드 관계를 검색하는 데 사용할 REST 엔드포인트 URL입니다. 데이터 유형: 문자열 |
| outbound_relations.유형.값 | 아웃바운드 관계 유형의 Sys_id입니다. CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| 상태 | 오류가 발생한 경우에만 나타납니다. 엔드포인트 처리의 상태입니다. 가능한 값: 실패 데이터 유형: 문자열 |
샘플 cURL 요청
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_class_sw/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password"\
--data {
"attributes": {
"firewall_status": "Active",
"name": "Linux299",
"used_for": "Production"
},
"source": "ServiceNow"
}
{
"result": {
"outbound_relations": [
{
"sys_id": "403ff2641b425010593876a61a4bcb4b",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "443ff2641b425010593876a61a4bcb4c",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Active",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-13 21:24:05",
"discovery_source": "ServiceNow",
"first_discovered": "2020-07-13 20:27:28",
"due_in": "",
"used_for": "Production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "dora.gray",
"warranty_expiration": "",
"ram": "",
"cpu_name": "",
"cpu_speed": "",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": "",
"os_domain": "",
"last_discovered": "2020-07-13 21:24:05",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": "",
"cpu_count": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": {
"display_value": "Unknown",
"link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
"value": "21cfba641b425010593876a61a4bcb52"
},
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "dora.gray",
"sys_created_on": "2020-07-13 20:27:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "",
"install_date": "",
"asset_tag": "",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "true",
"delivery_date": "",
"hardware_status": "installed",
"install_status": "1",
"supported_by": "",
"name": "Linux299",
"subcategory": "Computer",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "0c3ff2641b425010593876a61a4bcb39",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"os": "",
"sys_mod_count": "4",
"monitor": "false",
"model_id": {
"display_value": "Unknown",
"link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
"value": "0ce0a2681b4e1010593876a61a4bcba6"
},
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Hardware",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "c03ff2641b425010593876a61a4bcb49",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
}
]
}
}