자원 인벤토리 오픈 API
Resource Inventory Open API는 리소스를 생성, 검색 및 삭제하기 위한 엔드포인트를 제공합니다.
- 케이블 [cmdb_ci_cable]
- 장비 홀더 [cmdb_ci_equipment_holder]
- 인터페이스 카드 [cmdb_ci_interface_card]
- IP 주소 [cmdb_ci_ip_address]
- 논리적 연결 [cmdb_ci_ni_logical_path]
- 네트워크 인터페이스 [cmdb_ci_ni_interface]
- 네트워크 사이트 [cmdb_ci_ni_site]
- 물리적 연결 [cmdb_ci_ni_physical_link]
- 스트랜드 [cmdb_ci_strand]
- 토폴로지 [cmdb_ci_topology]
- sys_property에서 sn_ni_core.equipment_tables 지정한 테이블 및 지정된 테이블을 확장하는 모든 테이블입니다.
- 장비 홀더 [cmdb_ci_equipment_holder]를 확장하는 테이블.
- 다음 테이블 중 하나를 확장하는 하위 테이블:
- 케이블 [cmdb_ci_cable]
- 장비 홀더 [cmdb_ci_equipment_holder]
- 스트랜드 [cmdb_ci_strand]
이 API는 에서 사용할 수 ServiceNow Store있는 Network Inventory Core 애플리케이션에 포함되어 있습니다.
이 API는 sn_ni_core 네임스페이스 내에서 제공됩니다.
호출하는 사용자에게 sn_ni_core.inventory_integrator 역할이 있어야 합니다.
이 API를 확장하여 필수 매개변수, 요청 본문 유효성 검사 및 필드 매핑을 중심으로 사용자 지정할 수 있습니다. 자세한 내용은 Resource Inventory Open API 개발자 가이드 문서를 참조하십시오.
Resource Inventory Open API는 TM Forum Resource Inventory API REST 스펙의 구현입니다ServiceNow®. 이 구현은 TMF639 Resource Inventory API 사용자 가이드 v4.0.1, 2020년 7월을 기반으로 합니다.
자원 인벤토리 Open API - DELETE /sn_ni_core/resource/{id}
지정된 자원 기록을 삭제합니다.
URL 형식
기본 URL: /api/sn_ni_core/resource/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| id | 자원의 Sys_id입니다. 자원 유형에 따라 다음 테이블 중 하나에 배치됩니다.
주: 이 API를 사용하여 IP 주소 [cmdb_ci_ip_address] 테이블의 자원을 삭제할 수 없습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 215 | 처리를 위한 요청을 성공적으로 수신했습니다. 요청은 비동기식으로 완료됩니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 403 | 금지되었습니다. 자원을 삭제하지 못했습니다. 자원은 관련 자원에 필요할 수 있습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 없음 |
cURL 요청
이 예제에서는 리소스를 삭제합니다.
curl "https://instance.service-now.com/api/sn_ni_core/resource/54ada05e875c15109a9c0f65dabb3586" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
응답 본문입니다.
""
자원 인벤토리 오픈 API - GET /sn_ni_core/resource
모든 자원 기록의 목록을 조회합니다.
URL 형식
기본 URL: /api/sn_ni_core/resource
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| @type | 필수 검색할 자원 유형의 테이블 이름입니다. API 호출당 한 가지 유형의 자원만 검색할 수 있습니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 설명 | 자원을 필터링하는 데 사용할 설명입니다. 지정된 설명이 있는 자원만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 값은 다음과 같습니다.
기본값: 모든 필드를 반환합니다. 데이터 유형: 문자열 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 데이터 유형: 숫자 |
| 이름 | 자원을 필터링하는 데 사용할 이름입니다. 지정된 이름을 가진 자원만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자 |
| resourceSpecification.id | 자원을 필터링하는 데 사용할 자원 사양 sys_id입니다. sys_id은 다음 테이블 중 하나의 모델에서 가져온 것이어야 합니다.
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 콘텐츠 범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 |
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다.
|
| X-Total-Count | 페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다. 주: 총 기록 수가 100,000개를 초과하는 경우 이 헤더는 항상 100,000개를 반환합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 206 | 부분 콘텐츠입니다. 요청이 성공적으로 처리되었으며 페이지를 매긴 호출로 지정된 콘텐츠의 일부 범위가 반환되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| @type | 자원의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 설명 | 자원에 대한 설명입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| id | 자원의 Sys_id입니다. 자원 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| 이름 | 자원의 이름입니다. 데이터 유형: 문자열 |
| 메모 | 자원에 대한 메모 목록입니다. 데이터 유형: 배열 |
| note.text | 메모 텍스트입니다. 데이터 유형: 문자열 |
| 장소 | 자원에 대한 네트워크 사이트입니다. 이 매개변수는 네트워크 사이트, 물리적 연결 또는 논리적 연결 자원에 대해 지원되지 않습니다. 데이터 유형: 객체
|
| place.@referredType | 장소의 유형입니다. 이 값은 항상 GeographicAddress입니다.데이터 유형: 문자열 |
| place.href | 장소 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| place.id | 네트워크 사이트 [cmdb_ci_ni_site] 테이블의 장소 기록 Sys_id입니다. 데이터 유형: 문자열 |
| 관련파티 | |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 유형 필드의 그룹 [sys_user_group] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.href | 관련 당사자 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| relatedParty.id | 그룹 [sys_user_group] 테이블의 관련 당사자 기록 Sys_id입니다. 데이터 유형: 문자열 |
| relatedParty.role | 관련 당사자의 역할입니다. 그룹 유형 필드의 팀 [cmdb_rel_team] 테이블에 있습니다. 데이터 유형: 문자열 |
| resource특성 | 자원의 특성 목록입니다. 다음 자원 유형에는 특정 자원 특성이 필요합니다.
데이터 유형: 배열 |
| resourceCharacteristic.name | 매개변수로 지정된 @type 자원 테이블의 필드 이름입니다. model_id, 이름, network_site, operation_notes, operational_status, short_description, start_date 또는 sys_id와 같이 sys_ 접두사가 붙은 필드는 사용할 수 없습니다. 데이터 유형: 문자열 |
| resourceCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| resourceCharacteristic.valueType | 값의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| resourceRelationship(자원 관계) | 관련 자원 목록입니다. 다음 자원 유형에는 특정 관련 자원이 필요합니다.
데이터 유형: 배열 |
| resourceRelationship.relationshipType | [이 자원 설명자]::[관련 자원 설명자] 형식으로 된 두 자원 간의 관계 유형입니다. 예를 들어 Contains::Contained by 는 관련 리소스가 이 리소스의 자식임을 나타냅니다.설명자에 대한 유효한 값은 상위 설명자 및 하위 설명자 열의 CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| resourceRelationship.resource | 관련 자원에 대한 상세 정보입니다. 관련 자원은 다음 자원 유형 중 하나여야 합니다.
데이터 유형: 객체
|
| resourceRelationship.resource.id | 관련 자원의 Sys_id입니다. 관련 자원의 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| resourceRelationship.resource.href | 관련 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| resourceSpecification | 자원 사양입니다. 데이터 유형: 객체 |
| resourceSpecification.id | 자원에 연결된 모델의 Sys_id입니다. 모델 유형에 따라 다음 테이블 중 하나에 있습니다.
데이터 유형: 문자열 |
| startOperatingDate (영문) | 자원이 처음 작동을 시작한 날짜 및 시간입니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 처음 5개의 네트워크 사이트 리소스 레코드에 name대한 , id및 href 필드를 검색합니다.
curl "https://instance.service-now.com/api/sn_ni_core/resource?@type=cmdb_ci_ni_site&fields=name%2Cid%2Chref&limit=5" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
응답 본문입니다.
[
{
"name": "DALLAS TX CO/HUB",
"id": "c23683c54051c910f8772175cacd725c",
"href": "/api/sn_ni_core/resource/c23683c54051c910f8772175cacd725c"
},
{
"name": "PFP LOC F-800",
"id": "0ac19bc54051c910f8772175cacd724b",
"href": "/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b"
},
{
"name": "FIBER SERVICE TERMINAL 003",
"id": "d0541fcd4051c910f8772175cacd72c8",
"href": "/api/sn_ni_core/resource/d0541fcd4051c910f8772175cacd72c8"
},
{
"name": "270 RUMWOOD MAIN",
"id": "e6f6df8d4051c910f8772175cacd72b2",
"href": "/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2"
},
{
"name": "3620 CHESTER ROMI48073",
"id": "917dd8f6870e851079c40f2d0ebb353d",
"href": "/api/sn_ni_core/resource/917dd8f6870e851079c40f2d0ebb353d"
}
]
자원 인벤토리 Open API - GET /sn_ni_core/resource/{id}
지정된 자원 기록을 조회합니다.
URL 형식
기본 URL: /api/sn_ni_core/resource/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| id | 자원의 Sys_id입니다. 자원 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 값은 다음과 같습니다.
기본값: 모든 필드를 반환합니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| @type | 자원의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 설명 | 자원에 대한 설명입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| id | 자원의 Sys_id입니다. 자원 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| 이름 | 자원의 이름입니다. 데이터 유형: 문자열 |
| 메모 | 자원에 대한 메모 목록입니다. 데이터 유형: 배열 |
| note.text | 메모 텍스트입니다. 데이터 유형: 문자열 |
| 장소 | 자원에 대한 네트워크 사이트입니다. 이 매개변수는 네트워크 사이트, 물리적 연결 또는 논리적 연결 자원에 대해 지원되지 않습니다. 데이터 유형: 객체
|
| place.@referredType | 장소의 유형입니다. 이 값은 항상 GeographicAddress입니다.데이터 유형: 문자열 |
| place.href | 장소 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| place.id | 네트워크 사이트 [cmdb_ci_ni_site] 테이블의 장소 기록 Sys_id입니다. 데이터 유형: 문자열 |
| 관련파티 | |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 유형 필드의 그룹 [sys_user_group] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.href | 관련 당사자 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| relatedParty.id | 그룹 [sys_user_group] 테이블의 관련 당사자 기록 Sys_id입니다. 데이터 유형: 문자열 |
| resource특성 | 자원의 특성 목록입니다. 다음 자원 유형에는 특정 자원 특성이 필요합니다.
데이터 유형: 배열 |
| resourceCharacteristic.name | 매개변수로 지정된 @type 자원 테이블의 필드 이름입니다. model_id, 이름, network_site, operation_notes, operational_status, short_description, start_date 또는 sys_id와 같이 sys_ 접두사가 붙은 필드는 사용할 수 없습니다. 데이터 유형: 문자열 |
| resourceCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| resourceCharacteristic.valueType | 값의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| resourceRelationship(자원 관계) | 관련 자원 목록입니다. 다음 자원 유형에는 특정 관련 자원이 필요합니다.
데이터 유형: 배열 |
| resourceRelationship.relationshipType | [이 자원 설명자]::[관련 자원 설명자] 형식으로 된 두 자원 간의 관계 유형입니다. 예를 들어 Contains::Contained by 는 관련 리소스가 이 리소스의 자식임을 나타냅니다.설명자에 대한 유효한 값은 상위 설명자 및 하위 설명자 열의 CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| resourceRelationship.resource | 관련 자원에 대한 상세 정보입니다. 관련 자원은 다음 자원 유형 중 하나여야 합니다.
데이터 유형: 객체
|
| resourceRelationship.resource.id | 관련 자원의 Sys_id입니다. 관련 자원의 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| resourceRelationship.resource.href | 관련 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| resourceSpecification | 자원 사양입니다. 데이터 유형: 객체 |
| resourceSpecification.id | 자원에 연결된 모델의 Sys_id입니다. 모델 유형에 따라 다음 테이블 중 하나에 있습니다.
데이터 유형: 문자열 |
| startOperatingDate (영문) | 자원이 처음 작동을 시작한 날짜 및 시간입니다. 데이터 유형: 문자열 |
cURL 요청
이 예제에서는 지정된 자원 기록을 조회합니다.
curl "https://instance.service-now.com/api/sn_ni_core/resource/915da8e140ddc910f8772175cacd72de" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
응답 본문입니다.
{
"href": "/api/sn_ni_core/resource/915da8e140ddc910f8772175cacd72de",
"id": "915da8e140ddc910f8772175cacd72de",
"name": "DLLSTXMR/ESS7450/IOM-01/MDA-01/NI-01",
"place": {
"id": "c23683c54051c910f8772175cacd725c",
"href": "/api/now/table/cmdb_ci_ni_site/c23683c54051c910f8772175cacd725c",
"@referredType": "GeographicAddress"
},
"resourceCharacteristic": [
{
"name": "attested",
"valueType": "boolean",
"value": "false"
},
{
"name": "availability",
"valueType": "string",
"value": "used"
},
{
"name": "cabled",
"valueType": "boolean",
"value": "false"
},
{
"name": "can_print",
"valueType": "boolean",
"value": "false"
},
{
"name": "connector_type",
"valueType": "string",
"value": "sc"
},
{
"name": "cost_cc",
"valueType": "string",
"value": "USD"
},
{
"name": "equipment_clli",
"valueType": "string",
"value": "DLLSTXESS01"
},
{
"name": "fault_count",
"valueType": "integer",
"value": "0"
},
{
"name": "install_status",
"valueType": "integer",
"value": "1"
},
{
"name": "life_cycle_stage",
"valueType": "reference",
"value": "Operational"
},
{
"name": "life_cycle_stage_status",
"valueType": "reference",
"value": "In Use"
},
{
"name": "manufacturer",
"valueType": "reference",
"value": "a2f6a4914055c910f8772175cacd723a"
},
{
"name": "monitor",
"valueType": "boolean",
"value": "false"
},
{
"name": "network_domain",
"valueType": "string",
"value": "core"
},
{
"name": "ni_type",
"valueType": "reference",
"value": "646cf25fe42e0510f877e70ec9bcaca8"
},
{
"name": "port_bandwidth",
"valueType": "reference",
"value": "ff39ae92eb900110700ca73bc152286d"
},
{
"name": "replaceable",
"valueType": "boolean",
"value": "false"
},
{
"name": "skip_sync",
"valueType": "boolean",
"value": "false"
},
{
"name": "telco_equipment",
"valueType": "reference",
"value": "583e7b95405dc910f8772175cacd7292"
},
{
"name": "unverified",
"valueType": "boolean",
"value": "false"
},
{
"name": "virtual",
"valueType": "boolean",
"value": "false"
}
],
"resourceRelationship": [
{
"relationshipType": "Contained by::Contains",
"resource": {
"id": "81baac6140ddc910f8772175cacd728e",
"href": "/api/sn_ni_core/resource/81baac6140ddc910f8772175cacd728e"
}
},
{
"relationshipType": "Contained by::Contains",
"resource": {
"id": "bf624bc640194d10f8772175cacd7225",
"href": "/api/sn_ni_core/resource/bf624bc640194d10f8772175cacd7225"
}
}
],
"resourceSpecification": {
"id": "980416b0874e8110d28eb259dabb356b",
"href": "/api/now/table/sn_ni_core_network_inventory_product_model/980416b0874e8110d28eb259dabb356b",
"@referredType": "NetworkInterfaceModel"
},
"@type": "cmdb_ci_ni_interface"
}
자원 인벤토리 Open API - PATCH /sn_ni_core/resource/{id}
지정된 자원 기록을 업데이트합니다.
URL 형식
기본 URL: /api/sn_ni_core/resource/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| id | 자원의 Sys_id입니다. 자원 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| @type | 자원의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 설명 | 자원에 대한 설명입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| 이름 | 자원의 이름입니다. 데이터 유형: 문자열 |
| 메모 | 자원에 대한 메모 목록입니다. 데이터 유형: 배열 |
| note.text | 매개변수를 note 사용하는 경우 필수입니다. 메모 텍스트입니다. 데이터 유형: 문자열 |
| 장소 | 자원에 대한 네트워크 사이트입니다. 이 매개변수는 네트워크 사이트, 물리적 연결 또는 논리적 연결 자원에 대해 지원되지 않습니다. 데이터 유형: 객체
|
| place.@referredType | 장소의 유형입니다. 이 값은 항상 GeographicAddress입니다.데이터 유형: 문자열 |
| place.href | 장소 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| place.id | 매개변수를 place 사용하는 경우 필수입니다. 네트워크 사이트 [cmdb_ci_ni_site] 테이블의 장소 기록 Sys_id입니다. 데이터 유형: 문자열 |
| 관련파티 | 자원의 접촉 창구에 대한 상세 정보입니다.
데이터 유형: 배열 주: 리소스에서 relatedParty 레코드를 제거하는 것은 이 엔드포인트에서 지원되지 않습니다. Teams [cmdb_rel_team] 테이블에서 기록을 수동으로 삭제할 수 있습니다. |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 유형 필드의 그룹 [sys_user_group] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.href | 관련 당사자 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| relatedParty.id | 매개변수를 relatedParty 사용하는 경우 필수입니다. |
| relatedParty.role | 관련 당사자의 역할입니다. 그룹 유형 필드의 팀 [cmdb_rel_team] 테이블에 있습니다. 데이터 유형: 문자열 |
| resource특성 | 자원의 특성 목록입니다. 다음 자원 유형에는 특정 자원 특성이 필요합니다.
데이터 유형: 배열 |
| resourceCharacteristic.name | 매개변수를 resourceCharacteristic 사용하는 경우 필수입니다. 매개변수로 지정된 @type 자원 테이블의 필드 이름입니다. model_id, 이름, network_site, operation_notes, operational_status, short_description, start_date 또는 sys_id와 같이 sys_ 접두사가 붙은 필드는 사용할 수 없습니다. 데이터 유형: 문자열 |
| resourceCharacteristic.value | 매개변수를 resourceCharacteristic 사용하는 경우 필수입니다. 특성의 값입니다. 데이터 유형: 문자열 |
| resourceCharacteristic.valueType | 값의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| resourceRelationship(자원 관계) | 관련 자원 목록입니다. 다음 자원 유형에는 특정 관련 자원이 필요합니다.
데이터 유형: 배열 |
| resourceRelationship.relationshipType | 매개변수를 resourceRelationship 사용하는 경우 필수입니다.[이 자원 설명자]::[관련 자원 설명자] 형식으로 된 두 자원 간의 관계 유형입니다. 예를 들어 Contains::Contained by 는 관련 리소스가 이 리소스의 자식임을 나타냅니다.설명자에 대한 유효한 값은 상위 설명자 및 하위 설명자 열의 CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| resourceRelationship.resource | 매개변수를 resourceRelationship 사용하는 경우 필수입니다. 관련 자원에 대한 상세 정보입니다. 관련 자원은 다음 자원 유형 중 하나여야 합니다.
데이터 유형: 객체
|
| resourceRelationship.resource.id | 매개변수를 resourceRelationship 사용하는 경우 필수입니다. 관련 자원의 Sys_id입니다. 관련 자원의 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| resourceRelationship.resource.href | 관련 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| resourceSpecification | 자원 사양입니다. 데이터 유형: 객체 |
| resourceSpecification.id | 매개변수를 resourceSpecification 사용하는 경우 필수입니다. 자원에 연결된 모델의 Sys_id입니다. 모델 유형에 따라 다음 테이블 중 하나에 있습니다.
데이터 유형: 문자열 |
| startOperatingDate (영문) | 자원이 처음 작동을 시작한 날짜 및 시간입니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. 는 만 지원합니다 application/merge-patch+json. |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
| 415 | 요청 본문이 지원되지 않는 형식이거나 Content-Type 요청 헤더가 잘못 설정되었습니다. |
응답 본문 매개변수(JSON 또는 XML)
| 이름 | 설명 |
|---|---|
| @type | 자원의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 설명 | 자원에 대한 설명입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| id | 자원의 Sys_id입니다. 자원 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| 이름 | 자원의 이름입니다. 데이터 유형: 문자열 |
| 메모 | 자원에 대한 메모 목록입니다. 데이터 유형: 배열 |
| note.text | 메모 텍스트입니다. 데이터 유형: 문자열 |
| 장소 | 자원에 대한 네트워크 사이트입니다. 이 매개변수는 네트워크 사이트, 물리적 연결 또는 논리적 연결 자원에 대해 지원되지 않습니다. 데이터 유형: 객체
|
| place.@referredType | 장소의 유형입니다. 이 값은 항상 GeographicAddress입니다.데이터 유형: 문자열 |
| place.href | 장소 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| place.id | 네트워크 사이트 [cmdb_ci_ni_site] 테이블의 장소 기록 Sys_id입니다. 데이터 유형: 문자열 |
| 관련파티 | |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 유형 필드의 그룹 [sys_user_group] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.href | 관련 당사자 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| relatedParty.id | 그룹 [sys_user_group] 테이블의 관련 당사자 기록 Sys_id입니다. 데이터 유형: 문자열 |
| relatedParty.role | 관련 당사자의 역할입니다. 그룹 유형 필드의 팀 [cmdb_rel_team] 테이블에 있습니다. 데이터 유형: 문자열 |
| resource특성 | 자원의 특성 목록입니다. 다음 자원 유형에는 특정 자원 특성이 필요합니다.
데이터 유형: 배열 |
| resourceCharacteristic.name | 매개변수로 지정된 @type 자원 테이블의 필드 이름입니다. model_id, 이름, network_site, operation_notes, operational_status, short_description, start_date 또는 sys_id와 같이 sys_ 접두사가 붙은 필드는 사용할 수 없습니다. 데이터 유형: 문자열 |
| resourceCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| resourceCharacteristic.valueType | 값의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| resourceRelationship(자원 관계) | 관련 자원 목록입니다. 다음 자원 유형에는 특정 관련 자원이 필요합니다.
데이터 유형: 배열 |
| resourceRelationship.relationshipType | [이 자원 설명자]::[관련 자원 설명자] 형식으로 된 두 자원 간의 관계 유형입니다. 예를 들어 Contains::Contained by 는 관련 리소스가 이 리소스의 자식임을 나타냅니다.설명자에 대한 유효한 값은 상위 설명자 및 하위 설명자 열의 CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| resourceRelationship.resource | 관련 자원에 대한 상세 정보입니다. 관련 자원은 다음 자원 유형 중 하나여야 합니다.
데이터 유형: 객체
|
| resourceRelationship.resource.id | 관련 자원의 Sys_id입니다. 관련 자원의 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| resourceRelationship.resource.href | 관련 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| resourceSpecification | 자원 사양입니다. 데이터 유형: 객체 |
| resourceSpecification.id | 자원에 연결된 모델의 Sys_id입니다. 모델 유형에 따라 다음 테이블 중 하나에 있습니다.
데이터 유형: 문자열 |
| startOperatingDate (영문) | 자원이 처음 작동을 시작한 날짜 및 시간입니다. 데이터 유형: 문자열 |
cURL 요청
이 예제에서는 리소스의 이름을 업데이트합니다.
curl "http://instance.servicenow.com/api/sn_ni_core/resource/583e7b95405dc910f8772175cacd7292" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/merge-patch+json" \
--user 'username':'password' \
--data '{"name": "new name"}'
응답 본문입니다.
{
"href": "/api/sn_ni_core/resource/583e7b95405dc910f8772175cacd7292",
"id": "583e7b95405dc910f8772175cacd7292",
"name": "new name",
"note": [
{
"text": "TECHNICIAN SCHECULED TO BE ONSITE THE WEEK OF APRIL 4, 2022."
}
],
"place": {
"id": "c23683c54051c910f8772175cacd725c",
"href": "/api/now/table/cmdb_ci_ni_site/c23683c54051c910f8772175cacd725c",
"@referredType": "GeographicAddress"
},
"resourceCharacteristic": [
{
"name": "alarmable",
"valueType": "boolean",
"value": "true"
},
{
"name": "attested",
"valueType": "boolean",
"value": "false"
},
{
"name": "can_hub",
"valueType": "boolean",
"value": "false"
},
{
"name": "can_partitionvlans",
"valueType": "boolean",
"value": "false"
},
{
"name": "can_print",
"valueType": "boolean",
"value": "false"
},
{
"name": "can_route",
"valueType": "boolean",
"value": "false"
},
{
"name": "can_switch",
"valueType": "boolean",
"value": "false"
},
{
"name": "comments",
"valueType": "string",
"value": "ETHERNET SWITCH"
},
{
"name": "cost_cc",
"valueType": "string",
"value": "USD"
},
{
"name": "cpu_count",
"valueType": "integer",
"value": "1"
},
{
"name": "equipment_clli",
"valueType": "string",
"value": "DLLSTXESS01"
},
{
"name": "fault_count",
"valueType": "integer",
"value": "0"
},
{
"name": "firmware_manufacturer",
"valueType": "reference",
"value": "0c441abbc6112275000025157c651c89"
},
{
"name": "firmware_version",
"valueType": "string",
"value": "A09DX887"
},
{
"name": "hardware_status",
"valueType": "string",
"value": "installed"
},
{
"name": "install_status",
"valueType": "integer",
"value": "1"
},
{
"name": "internet_facing",
"valueType": "boolean",
"value": "true"
},
{
"name": "inventory_category",
"valueType": "string",
"value": "equipment"
},
{
"name": "last_service_date",
"valueType": "datetime",
"value": "2022-02-18T16:36:54.000Z"
},
{
"name": "life_cycle_stage",
"valueType": "reference",
"value": "Deploy"
},
{
"name": "life_cycle_stage_status",
"valueType": "reference",
"value": "Reserved"
},
{
"name": "managed_by",
"valueType": "reference",
"value": "46c9e158a9fe198101d44d0d22cb640d"
},
{
"name": "manufacturer",
"valueType": "reference",
"value": "b7e831bdc0a80169015ae101f3c4d6cd"
},
{
"name": "model_number",
"valueType": "string",
"value": "7450ESS-1"
},
{
"name": "monitor",
"valueType": "boolean",
"value": "false"
},
{
"name": "network_domain",
"valueType": "string",
"value": "core"
},
{
"name": "ni_function",
"valueType": "reference",
"value": "2d22153940990d10f8772175cacd728b"
},
{
"name": "ni_role",
"valueType": "reference",
"value": "c68e3f15405dc910f8772175cacd72f1"
},
{
"name": "ni_type",
"valueType": "reference",
"value": "3772e8d54015c910f8772175cacd721c"
},
{
"name": "ram",
"valueType": "integer",
"value": "3000"
},
{
"name": "replaceable",
"valueType": "boolean",
"value": "true"
},
{
"name": "serial_number",
"valueType": "string",
"value": "7894564568225"
},
{
"name": "skip_sync",
"valueType": "boolean",
"value": "false"
},
{
"name": "spare",
"valueType": "boolean",
"value": "true"
},
{
"name": "template_id",
"valueType": "reference",
"value": "49433535e5d28110f877657a33339131"
},
{
"name": "unit_position",
"valueType": "integer",
"value": "2"
},
{
"name": "unverified",
"valueType": "boolean",
"value": "false"
}
],
"resourceRelationship": [
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "f5d1c429405dc910f8772175cacd723f",
"href": "/api/sn_ni_core/resource/f5d1c429405dc910f8772175cacd723f"
}
},
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "d6e100e5405dc910f8772175cacd72e9",
"href": "/api/sn_ni_core/resource/d6e100e5405dc910f8772175cacd72e9"
}
},
{
"relationshipType": "Contained by::Contains",
"resource": {
"id": "5b10e8154015c910f8772175cacd724d",
"href": "/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d"
}
}
],
"resourceSpecification": {
"id": "0ae34df1e5528110f877657a33339119",
"href": "/api/now/table/cmdb_model/0ae34df1e5528110f877657a33339119",
"@referredType": "EquipmentModel"
},
"@type": "cmdb_ci_ni_telco_equipment"
}
자원 인벤토리 오픈 API - POST /sn_ni_core/resource
자원 기록을 작성합니다.
URL 형식
기본 URL: /api/sn_ni_core/resource
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| @type | 자원의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 설명 | 자원에 대한 설명입니다. 데이터 유형: 문자열 |
| 이름 | 필수 자원의 이름입니다. 데이터 유형: 문자열 |
| 메모 | 자원에 대한 메모 목록입니다. 데이터 유형: 배열 |
| note.text | 매개변수를 note 사용하는 경우 필수입니다. 메모 텍스트입니다. 데이터 유형: 문자열 |
| 장소 | 컨테이너 유형이 케이지, 베이, 캐비닛, 랙, 라인업 또는 인벤토리 모델 번들인 장비 홀더 자원에 필요합니다. 모든 장비 자원에 필요합니다. 자원에 대한 네트워크 사이트입니다. 이 매개변수는 네트워크 사이트, 물리적 연결 또는 논리적 연결 자원에 대해 지원되지 않습니다. 데이터 유형: 객체
|
| place.@referredType | 장소의 유형입니다. 이 값은 항상 GeographicAddress입니다.데이터 유형: 문자열 |
| place.href | 장소 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| place.id | 매개변수를 place 사용하는 경우 필수입니다. 네트워크 사이트 [cmdb_ci_ni_site] 테이블의 장소 기록 Sys_id입니다. 데이터 유형: 문자열 |
| 관련파티 | |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 유형 필드의 그룹 [sys_user_group] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.href | 관련 당사자 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| relatedParty.id | 매개변수를 relatedParty 사용하는 경우 필수입니다. |
| resource특성 | 자원의 특성 목록입니다. 다음 자원 유형에는 특정 자원 특성이 필요합니다.
데이터 유형: 배열 |
| resourceCharacteristic.name | 매개변수를 resourceCharacteristic 사용하는 경우 필수입니다. 매개변수로 지정된 @type 자원 테이블의 필드 이름입니다. model_id, 이름, network_site, operation_notes, operational_status, short_description, start_date 또는 sys_id와 같이 sys_ 접두사가 붙은 필드는 사용할 수 없습니다. 데이터 유형: 문자열 |
| resourceCharacteristic.value | 매개변수를 resourceCharacteristic 사용하는 경우 필수입니다. 특성의 값입니다. 데이터 유형: 문자열 |
| resourceCharacteristic.valueType | 값의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| resourceRelationship(자원 관계) | 관련 자원 목록입니다. 다음 자원 유형에는 특정 관련 자원이 필요합니다.
데이터 유형: 배열 |
| resourceRelationship.relationshipType | 매개변수를 resourceRelationship 사용하는 경우 필수입니다.[이 자원 설명자]::[관련 자원 설명자] 형식으로 된 두 자원 간의 관계 유형입니다. 예를 들어 Contains::Contained by 는 관련 리소스가 이 리소스의 자식임을 나타냅니다.설명자에 대한 유효한 값은 상위 설명자 및 하위 설명자 열의 CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| resourceRelationship.resource | 매개변수를 resourceRelationship 사용하는 경우 필수입니다. 관련 자원에 대한 상세 정보입니다. 관련 자원은 다음 자원 유형 중 하나여야 합니다.
데이터 유형: 객체
|
| resourceRelationship.resource.id | 매개변수를 resourceRelationship 사용하는 경우 필수입니다. 관련 자원의 Sys_id입니다. 관련 자원의 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| resourceRelationship.resource.href | 관련 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| resourceSpecification | 자원 사양입니다. 데이터 유형: 객체 |
| resourceSpecification.id | 매개변수를 resourceSpecification 사용하는 경우 필수입니다. 자원에 연결된 모델의 Sys_id입니다. 모델 유형에 따라 다음 테이블 중 하나에 있습니다.
데이터 유형: 문자열 |
| startOperatingDate (영문) | 자원이 처음 작동을 시작한 날짜 및 시간입니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
| 위치 | 생성된 자원의 URL입니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 215 | 처리를 위한 요청을 성공적으로 수신했습니다. 요청은 비동기식으로 완료됩니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| @type | 자원의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| 설명 | 자원에 대한 설명입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| id | 자원의 Sys_id입니다. 자원 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| 이름 | 자원의 이름입니다. 데이터 유형: 문자열 |
| 메모 | 자원에 대한 메모 목록입니다. 데이터 유형: 배열 |
| note.text | 메모 텍스트입니다. 데이터 유형: 문자열 |
| 장소 | 자원에 대한 네트워크 사이트입니다. 이 매개변수는 네트워크 사이트, 물리적 연결 또는 논리적 연결 자원에 대해 지원되지 않습니다. 데이터 유형: 객체
|
| place.@referredType | 장소의 유형입니다. 이 값은 항상 GeographicAddress입니다.데이터 유형: 문자열 |
| place.href | 장소 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| place.id | 네트워크 사이트 [cmdb_ci_ni_site] 테이블의 장소 기록 Sys_id입니다. 데이터 유형: 문자열 |
| 관련파티 | 자원의 접촉 창구에 대한 상세 정보입니다. 데이터 유형: 배열 |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 유형 필드의 그룹 [sys_user_group] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.href | 관련 당사자 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| relatedParty.id | 그룹 [sys_user_group] 테이블의 관련 당사자 기록 Sys_id입니다. 데이터 유형: 문자열 |
| resource특성 | 자원의 특성 목록입니다. 다음 자원 유형에는 특정 자원 특성이 필요합니다.
데이터 유형: 배열 |
| resourceCharacteristic.name | 매개변수로 지정된 @type 자원 테이블의 필드 이름입니다. model_id, 이름, network_site, operation_notes, operational_status, short_description, start_date 또는 sys_id와 같이 sys_ 접두사가 붙은 필드는 사용할 수 없습니다. 데이터 유형: 문자열 |
| resourceCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| resourceCharacteristic.valueType | 값의 유형입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 문자열 |
| resourceRelationship(자원 관계) | 관련 자원 목록입니다. 다음 자원 유형에는 특정 관련 자원이 필요합니다.
데이터 유형: 배열 |
| resourceRelationship.relationshipType | [이 자원 설명자]::[관련 자원 설명자] 형식으로 된 두 자원 간의 관계 유형입니다. 예를 들어 Contains::Contained by 는 관련 리소스가 이 리소스의 자식임을 나타냅니다.설명자에 대한 유효한 값은 상위 설명자 및 하위 설명자 열의 CI 관계 유형 [cmdb_rel_type] 테이블에 있습니다. 데이터 유형: 문자열 |
| resourceRelationship.resource | 관련 자원에 대한 상세 정보입니다. 관련 자원은 다음 자원 유형 중 하나여야 합니다.
데이터 유형: 객체
|
| resourceRelationship.resource.id | 관련 자원의 Sys_id입니다. 관련 자원의 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| resourceRelationship.resource.href | 관련 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| resourceSpecification | 자원 사양입니다. 데이터 유형: 객체 |
| resourceSpecification.id | 자원에 연결된 모델의 Sys_id입니다. 모델 유형에 따라 다음 테이블 중 하나에 있습니다.
데이터 유형: 문자열 |
| startOperatingDate (영문) | 자원이 처음 작동을 시작한 날짜 및 시간입니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 콜로라도주 덴버에 네트워크 사이트를 만듭니다.
curl "https://instance.service-now.com/api/sn_ni_core/resource" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"DENVER CO CO/HUB\",
\"note\": [
{
\"text\": \"Cisco maintenance team onsite June 22, 2022.\"
}
],
\"resourceCharacteristic\": [
{
\"name\": \"attested\",
\"valueType\": \"boolean\",
\"value\": \"false\"
},
{
\"name\": \"can_print\",
\"valueType\": \"boolean\",
\"value\": \"false\"
},
{
\"name\": \"clli_code\",
\"valueType\": \"string\",
\"value\": \"DNVRCOMR02T\"
},
{
\"name\": \"comments\",
\"valueType\": \"string\",
\"value\": \"Site is scheduled for diesel generator test July 13, 2022 at 9am CST.\"
},
{
\"name\": \"cost_cc\",
\"valueType\": \"string\",
\"value\": \"USD\"
},
{
\"name\": \"county\",
\"valueType\": \"string\",
\"value\": \"DENVER\"
},
{
\"name\": \"data_center_code\",
\"valueType\": \"string\",
\"value\": \"DNVR00564\"
},
{
\"name\": \"fault_count\",
\"valueType\": \"integer\",
\"value\": \"0\"
},
{
\"name\": \"install_status\",
\"valueType\": \"integer\",
\"value\": \"1\"
},
{
\"name\": \"life_cycle_stage\",
\"valueType\": \"reference\",
\"value\": \"Operational\"
},
{
\"name\": \"life_cycle_stage_status\",
\"valueType\": \"reference\",
\"value\": \"In Use\"
},
{
\"name\": \"location\",
\"valueType\": \"reference\",
\"value\": \"25ab8f300a0a0bb300d99f69c3ac24cd\"
},
{
\"name\": \"managed_by\",
\"valueType\": \"reference\",
\"value\": \"b0f31e5673500010c2e7660c4cf6a711\"
},
{
\"name\": \"monitor\",
\"valueType\": \"boolean\",
\"value\": \"false\"
},
{
\"name\": \"network_domain\",
\"valueType\": \"string\",
\"value\": \"core\"
},
{
\"name\": \"ni_type\",
\"valueType\": \"reference\",
\"value\": \"8e8f3770404d0110f8772175cacd7204\"
},
{
\"name\": \"pots_number\",
\"valueType\": \"ph_number\",
\"value\": \"(214) 555-1234\"
},
{
\"name\": \"skip_sync\",
\"valueType\": \"boolean\",
\"value\": \"false\"
},
{
\"name\": \"third_party_ownership\",
\"valueType\": \"boolean\",
\"value\": \"false\"
},
{
\"name\": \"unverified\",
\"valueType\": \"boolean\",
\"value\": \"false\"
}
],
\"resourceRelationship\": [
{
\"relationshipType\": \"Connects to::Connected by\",
\"resource\": {
\"id\": \"e6f6df8d4051c910f8772175cacd72b2\",
\"href\": \"/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2\"
}
},
{
\"relationshipType\": \"Connects to::Connected by\",
\"resource\": {
\"id\": \"0ac19bc54051c910f8772175cacd724b\",
\"href\": \"/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b\"
}
},
{
\"relationshipType\": \"Connects to::Connected by\",
\"resource\": {
\"id\": \"997e5c11875851109a9c0f65dabb35ac\",
\"href\": \"/api/sn_ni_core/resource/997e5c11875851109a9c0f65dabb35ac\"
}
},
{
\"relationshipType\": \"Contains::Contained by\",
\"resource\": {
\"id\": \"5b10e8154015c910f8772175cacd724d\",
\"href\": \"/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d\"
}
},
{
\"relationshipType\": \"Contains::Contained by\",
\"resource\": {
\"id\": \"57e73b51405dc910f8772175cacd726e\",
\"href\": \"/api/sn_ni_core/resource/57e73b51405dc910f8772175cacd726e\"
}
},
{
\"relationshipType\": \"Contains::Contained by\",
\"resource\": {
\"id\": \"bf58f751405dc910f8772175cacd72e8\",
\"href\": \"/api/sn_ni_core/resource/bf58f751405dc910f8772175cacd72e8\"
}
},
{
\"relationshipType\": \"Contains::Contained by\",
\"resource\": {
\"id\": \"b5711e31405d0d10f8772175cacd7232\",
\"href\": \"/api/sn_ni_core/resource/b5711e31405d0d10f8772175cacd7232\"
}
},
{
\"relationshipType\": \"Contains::Contained by\",
\"resource\": {
\"id\": \"ed811e31405d0d10f8772175cacd72d3\",
\"href\": \"/api/sn_ni_core/resource/ed811e31405d0d10f8772175cacd72d3\"
}
},
{
\"relationshipType\": \"Contains::Contained by\",
\"resource\": {
\"id\": \"d74937d1405dc910f8772175cacd7288\",
\"href\": \"/api/sn_ni_core/resource/d74937d1405dc910f8772175cacd7288\"
}
},
{
\"relationshipType\": \"Contains::Contained by\",
\"resource\": {
\"id\": \"da0df2e3e4e64510f877e70ec9bcacc6\",
\"href\": \"/api/sn_ni_core/resource/da0df2e3e4e64510f877e70ec9bcacc6\"
}
}
],
\"@type\": \"cmdb_ci_ni_site\"
}" \
--user 'username':'password'
응답 본문입니다.
{
"href": "/api/sn_ni_core/resource/00399f0aed349150f877305f29f832b2",
"id": "00399f0aed349150f877305f29f832b2",
"name": "DENVER CO CO/HUB",
"note": [
{
"text": "Cisco maintenance team onsite June 22, 2022."
}
],
"resourceCharacteristic": [
{
"name": "altitude_units",
"valueType": "string",
"value": "feet"
},
{
"name": "attestation_status",
"valueType": "string",
"value": "Not Yet Reviewed"
},
{
"name": "attested",
"valueType": "boolean",
"value": "false"
},
{
"name": "can_print",
"valueType": "boolean",
"value": "false"
},
{
"name": "clli_code",
"valueType": "string",
"value": "DNVRCOMR02T"
},
{
"name": "comments",
"valueType": "string",
"value": "Site is scheduled for diesel generator test July 13, 2022 at 9am CST."
},
{
"name": "cost_cc",
"valueType": "string",
"value": "USD"
},
{
"name": "county",
"valueType": "string",
"value": "DENVER"
},
{
"name": "data_center_code",
"valueType": "string",
"value": "DNVR00564"
},
{
"name": "discovery_source",
"valueType": "string",
"value": "Resource Inventory Open API"
},
{
"name": "fault_count",
"valueType": "integer",
"value": "0"
},
{
"name": "first_discovered",
"valueType": "datetime",
"value": "2022-07-21T19:38:04.000Z"
},
{
"name": "install_status",
"valueType": "integer",
"value": "1"
},
{
"name": "last_discovered",
"valueType": "datetime",
"value": "2022-07-21T19:38:04.000Z"
},
{
"name": "life_cycle_stage",
"valueType": "reference",
"value": "Operational"
},
{
"name": "life_cycle_stage_status",
"valueType": "reference",
"value": "In Use"
},
{
"name": "location",
"valueType": "reference",
"value": "25ab8f300a0a0bb300d99f69c3ac24cd"
},
{
"name": "managed_by",
"valueType": "reference",
"value": "b0f31e5673500010c2e7660c4cf6a711"
},
{
"name": "monitor",
"valueType": "boolean",
"value": "false"
},
{
"name": "network_domain",
"valueType": "string",
"value": "core"
},
{
"name": "ni_type",
"valueType": "reference",
"value": "8e8f3770404d0110f8772175cacd7204"
},
{
"name": "pots_number",
"valueType": "ph_number",
"value": "(214) 555-1234"
},
{
"name": "skip_sync",
"valueType": "boolean",
"value": "false"
},
{
"name": "third_party_ownership",
"valueType": "boolean",
"value": "false"
},
{
"name": "unverified",
"valueType": "boolean",
"value": "false"
}
],
"resourceRelationship": [
{
"relationshipType": "Connects to::Connected by",
"resource": {
"id": "e6f6df8d4051c910f8772175cacd72b2",
"href": "/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2"
}
},
{
"relationshipType": "Connects to::Connected by",
"resource": {
"id": "0ac19bc54051c910f8772175cacd724b",
"href": "/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b"
}
},
{
"relationshipType": "Connects to::Connected by",
"resource": {
"id": "997e5c11875851109a9c0f65dabb35ac",
"href": "/api/sn_ni_core/resource/997e5c11875851109a9c0f65dabb35ac"
}
},
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "5b10e8154015c910f8772175cacd724d",
"href": "/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d"
}
},
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "57e73b51405dc910f8772175cacd726e",
"href": "/api/sn_ni_core/resource/57e73b51405dc910f8772175cacd726e"
}
},
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "bf58f751405dc910f8772175cacd72e8",
"href": "/api/sn_ni_core/resource/bf58f751405dc910f8772175cacd72e8"
}
},
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "b5711e31405d0d10f8772175cacd7232",
"href": "/api/sn_ni_core/resource/b5711e31405d0d10f8772175cacd7232"
}
},
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "ed811e31405d0d10f8772175cacd72d3",
"href": "/api/sn_ni_core/resource/ed811e31405d0d10f8772175cacd72d3"
}
},
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "d74937d1405dc910f8772175cacd7288",
"href": "/api/sn_ni_core/resource/d74937d1405dc910f8772175cacd7288"
}
},
{
"relationshipType": "Contains::Contained by",
"resource": {
"id": "da0df2e3e4e64510f877e70ec9bcacc6",
"href": "/api/sn_ni_core/resource/da0df2e3e4e64510f877e70ec9bcacc6"
}
}
],
"@type": "cmdb_ci_ni_site"
}
자원 인벤토리 Open API - POST /sn_ni_core/resourceinventoryviatemplate
템플릿을 기반으로 자원 CI(구성 항목) 및 관련 CI 계층 구조를 만듭니다.
이 엔드포인트를 호출하기 전에 인벤토리 템플릿 [sn_ni_core_inventory_template] 테이블에 인벤토리 템플릿을 생성해야 합니다. 인벤토리 템플릿에서 관련 CI의 전체 계층 구조를 정의할 수 있습니다. 그런 다음 단일 API 요청을 통해 모든 CI와 관계를 만들 수 있습니다.
URL 형식
기본 URL: /api/sn_ni_core/resourceinventoryviatemplate
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 재정의 | 재정의할 열과 사용할 값의 목록입니다. 데이터 유형: 객체 |
| overrides.column_name | 매개변수를 overrides 사용하는 경우 필수입니다. 열 이름 및 값입니다. 데이터 유형: 문자열 |
| parentId | 필수 상위 CI의 Sys_id입니다. 상위 CI의 유형에 따라 다음 테이블 중 하나에 배치됩니다.
데이터 유형: 문자열 |
| templateId | 필수 템플릿의 Sys_id입니다. 인벤토리 템플릿 [sn_ni_core_inventory_template] 테이블에 있습니다. 데이터 유형: 문자열 |
| templateOverrides | 템플릿 재정의 목록입니다. 데이터 유형: 배열 |
| templateOverrides.overrideTemplateId | 매개변수를 templateOverrides 사용하는 경우 필수입니다. 사용 가능한 템플릿 sys_id. 데이터 유형: 문자열 |
| templateOverrides.templateId | 매개변수를 templateOverrides 사용하는 경우 필수입니다. 관련 템플릿 sys_id. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
| 위치 | 계층 구조의 맨 위에 작성된 CI의 URL입니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 자원이 작성되었습니다. |
| 400 | 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다. |
| 401 | 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다. |
| 500 | 오류. 요청에 오류가 발생했습니다. 예를 들어 요청이 유효성 검사에 실패했습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 결과 | 생성된 CI에 대한 정보가 포함된 결과 객체입니다. 데이터 유형: 객체 |
| result.sys_id | 계층 구조의 맨 위에 있는 작성된 CI의 Sys_id입니다. 데이터 유형: 문자열 |
cURL 요청
이 예시에서는 템플릿을 사용하여 CI 계층 구조를 만듭니다.
curl "https://instance.service-now.com/api/sn_ni_core/resourceinventoryviatemplate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"templateId": "90475711ed6ec110f877d2f57b8accda",
"parentId": "917dd8f6870e851079c40f2d0ebb353d",
"overrides": {
"equipment_clli": "test"
},
"templateOverrides": [
{
"templateId": "ac3b679ded6ec110f877d2f57b8acc29",
"overrideTemplateId": "f9604efb54e18110f87749bbc4ad38d8"
},
{
"templateId": "171c23dded6ec110f877d2f57b8acc33",
"overrideTemplateId": "0f38e59187424110e14f64e73cbb35b4"
}
]
}" \
--user 'username':'password'
응답 본문입니다.
"result": {
"sys_id": "00598f0aed346259f388105f29f892c4"
}