제품 인벤토리 오픈 API
제품 인벤토리 오픈 API는 제품 인벤토리를 생성하고 검색할 수 있는 엔드포인트를 제공합니다.
이 API를 사용하여 외부 시스템과 ServiceNow AI Platform.
이 API는 다음에서 사용할 수 있는 제품 인벤토리 고급 애플리케이션에 포함되어 있습니다 ServiceNow Store.
이 API는 sn_prd_invt 네임스페이스 내에서 제공됩니다.
호출하는 사용자에게 sn_prd_invt.product_inventory_integrator 역할이 있어야 합니다.
- 제품 특성 [sn_prd_invt_product_characteristics]
- 제품 인벤토리 [sn_prd_invt_product_inventory]
- 제품 모델 [cmdb_model]
- 제품 모델 특성 [sn_prd_pm_product_model_characteristic]
제품 인벤토리 오픈 API는 ServiceNow® TM 포럼 제품 인벤토리 관리 API REST 사양을 구현한 것입니다. 이 구현은 2019년 8월 TMF637 제품 인벤토리 관리 API REST 사양 릴리스 19를 기반으로 합니다. Product Inventory Open API는 TM Forum에서 적합성 인증을 받았습니다.
제품 인벤토리 오픈 API - GET /sn_prd_invt/product
모든 제품 인벤토리 목록을 조회합니다.
URL 형식
기본 URL: api/sn_prd_invt/product
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 고객 | 고객별로 제품 인벤토리를 필터링합니다. 고객 sys_id 또는 이 매개변수의 값과 일치하는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 고객을 기준으로 필터링하지 않습니다. |
| 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 데이터 유형: 문자열 기본값: 모든 필드를 반환합니다. |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 사용하여 offset 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 20 최대: 100 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 데이터 유형: 숫자 기본값: 0 |
| 장소 | 위치별로 제품 인벤토리를 필터링합니다. 데이터 유형: 객체 |
| place.id | 제품 인벤토리 기록과 연결된 위치의 Sys_id 또는 external_id입니다. 테이블: 위치 [cmn_location] 데이터 유형: 문자열 |
| 상태 | 상태별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 상태의 제품 인벤토리만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 상태별로 필터링하지 않습니다. |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 콘텐츠 범위 | 페이지 매김된 호출에서 반환된 콘텐츠의 범위입니다. 예를 들어, |
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다.
|
| X-Total-Count | 페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환됩니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원(페이지 매김 포함). |
| 400 | 잘못된 요청. 가능한 이유:
|
| 404 | 기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| href | 제품 인벤토리 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| ID | 제품 인벤토리의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 장소 | 제품과 연결된 위치입니다. 데이터 유형: 객체 |
| place.id | 제품 인벤토리의 위치 sys_id 또는 external_id입니다. 테이블: 위치 [cmn_location] 데이터: 문자열 |
| place.name | 제품 인벤토리와 연결된 위치의 이름입니다. 테이블: 위치 [cmn_location] 데이터: 문자열 |
| 제품 특성 | 제품 특성 목록입니다. 제품 특성에 대한 자세한 내용은 다음 문서를 참조하십시오 Create a product offering category. 데이터 유형: 객체 배열 |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| productCharacteristic.valueType | 특성 값의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 |
| productOffering.id | 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드 |
| productOffering.internalId | 제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링의 internal_version 필드 [sn_prd_pm_product_offering] |
| productOffering.internalVersion | 제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드 |
| productOffering.name | 제품 오퍼링의 이름입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.version | 제품 오퍼링의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드 |
| 제품 가격 | 빈 배열을 반환합니다. 데이터 유형: 배열 |
| productRelationship | 관련 제품 목록입니다. 데이터 유형: 객체 배열 |
| productRelationship.productId | 관련 제품의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 |
| productSpecification.id | 제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 internal_version 또는 external_id 필드 |
| productSpecification.internalId | 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드 |
| productSpecification.internalVersion | 제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드 |
| productSpecification.version | 제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 external_version 필드 |
| 실현자원 | 제품을 실현하는 자원입니다. 실현 자원은 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 |
| realizingResource.id | 실현 자원의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingResource.type | 실현 자원의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 실현서비스 | 제품을 실현하는 서비스입니다. 실현 서비스는 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 |
| realizingService.id | 실현 서비스의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingService.type | 실현 서비스의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 관련당사자 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 객체 배열 |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 접촉 창구의 Sys_id입니다. 데이터 유형: 문자열 표: 계정[customer_account], 연락처[customer_contact] 또는 소비자[csm_consumer] |
| relatedParty.@referredType | 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 모든 제품 인벤토리를 조회합니다.
curl --location --request GET "https://instance.service-now.com/api/sn_prd_invt/product" \
--user 'username':'password'
응답 본문.
[
{
"id": "037fd87ec3603010abc8b5183c40ddf2",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Example Company",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "Routing and Configuration PI0000318",
"productSpecification": {
"id": "aec57e981bb420106ba59acf034bcb08",
"name": "Routing and Configuration",
"version": "",
"internalVersion": "1",
"internalId": "aec57e981bb420106ba59acf034bcb08"
},
"status": "Active",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"product": "ce0b52c7532520103b6bddeeff7b12f5",
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"name": "100 South Charles Street, Baltimore,MD"
},
"productCharacteristic": [],
"productRelationship": [],
"realizingService": [],
"realizingResource": [
{
"id": "9b2fa60b536520103b6bddeeff7b1233",
"name": "Route Target"
}
],
"productPrice": [],
"href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
"billingAccount": "Not Specified."
}
]
제품 인벤토리 오픈 API - GET /sn_prd_invt/product/{id}
지정된 제품 인벤토리 기록을 조회합니다.
URL 형식
기본 URL: /api/sn_prd_invt/product/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| ID | 검색할 제품 인벤토리의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| 이름 | 설명 |
|---|---|
| 고객 | 고객별로 제품 인벤토리를 필터링합니다. 고객 sys_id 또는 이 매개변수의 값과 일치하는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 고객에게 제출하지 마십시오. |
| 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 데이터 유형: 문자열 기본값: 모든 필드가 반환됩니다. |
| 장소 | 위치별로 제품 인벤토리를 필터링합니다. 데이터 유형: 객체 |
| place.id | 제품 인벤토리 기록과 연결된 위치의 Sys_id 또는 external_id입니다. 테이블: 위치 [cmn_location] 데이터 유형: 문자열 |
| 상태 | 상태별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 상태의 제품 인벤토리만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 상태별로 필터링하지 않습니다. |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음과 같은 이유 중 하나일 수 있습니다.
|
| 404 | 기록 없음 ID와 관련된 기록을 테이블에서 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| billingAccount | 제품 인벤토리 기록의 청구 계정입니다. 데이터 유형: 문자열 |
| href | 제품 인벤토리 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| ID | 제품 인벤토리의 Sys_id 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 장소 | 제품과 연결된 위치입니다. 데이터 유형: 객체 |
| place.id | 제품 인벤토리의 위치 sys_id 또는 external_id입니다. 테이블: 위치 [cmn_location] 데이터: 문자열 |
| place.name | 제품 인벤토리와 연결된 위치의 이름입니다. 테이블: 위치 [cmn_location] 데이터: 문자열 |
| 제품 특성 | 제품 특성 목록입니다. 제품 특성에 대한 자세한 내용은 다음 문서를 참조하십시오 Create a product offering category. 데이터 유형: 객체 배열 |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| productCharacteristic.valueType | 특성 값의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 |
| productOffering.id | 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드 |
| productOffering.internalId | 제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링의 internal_version 필드 [sn_prd_pm_product_offering] |
| productOffering.internalVersion | 제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드 |
| productOffering.name | 제품 오퍼링의 이름입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.version | 제품 오퍼링의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드 |
| 제품 가격 | 빈 배열을 반환합니다. 데이터 유형: 배열 |
| productRelationship | 관련 제품 목록입니다. 데이터 유형: 객체 배열 |
| productRelationship.productId | 관련 제품의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 |
| productSpecification.id | 제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 internal_version 또는 external_id 필드 |
| productSpecification.internalId | 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드 |
| productSpecification.internalVersion | 제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드 |
| productSpecification.version | 제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 external_version 필드 |
| 실현자원 | 제품을 실현하는 자원입니다. 실현 자원은 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 |
| realizingResource.id | 실현 자원의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingResource.type | 실현 자원의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 실현서비스 | 제품을 실현하는 서비스입니다. 실현 서비스는 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 |
| realizingService.id | 실현 서비스의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingService.type | 실현 서비스의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 관련당사자 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 객체 배열 |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 접촉 창구의 Sys_id입니다. 데이터 유형: 문자열 표: 계정[customer_account], 연락처[customer_contact] 또는 소비자[csm_consumer] |
| 관련당사자.유형 | 관련 당사자의 유형입니다. 값은 항상 관련 당사자입니다.데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 또는 고객 접촉 창구와 같은 고객 유형입니다. 데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 지정된 제품 인벤토리를 조회합니다.
curl -X GET 'https://instance.service-now.com/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2' \
--user 'username':'password'
출력:
{
"id": "037fd87ec3603010abc8b5183c40ddf2",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Example Company",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "Routing and Configuration PI0000318",
"productSpecification": {
"id": "aec57e981bb420106ba59acf034bcb08",
"name": "Routing and Configuration",
"version": "",
"internalVersion": "1",
"internalId": "aec57e981bb420106ba59acf034bcb08"
},
"status": "Active",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"product": "ce0b52c7532520103b6bddeeff7b12f5",
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"name": "100 South Charles Street, Baltimore,MD"
},
"productCharacteristic": [],
"productRelationship": [],
"realizingService": [],
"realizingResource": [
{
"id": "9b2fa60b536520103b6bddeeff7b1233",
"name": "Route Target"
}
],
"productPrice": [],
"href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
"billingAccount": "Not Specified."
}
제품 인벤토리 오픈 API - GET /sn_prd_invt/productinventory
모든 제품 인벤토리 목록을 조회합니다.
URL 형식
기본 URL: api/sn_prd_invt/productinventory
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 고객 | 고객별로 제품 인벤토리를 필터링합니다. 고객 sys_id 또는 이 매개변수의 값과 일치하는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 고객을 기준으로 필터링하지 않습니다. |
| 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 데이터 유형: 문자열 기본값: 모든 필드가 반환됩니다. |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 사용하여 offset 기록 검색을 페이지 매김합니다. 데이터 유형: 숫자 기본값: 20 최대: 100 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 데이터 유형: 숫자 기본값: 0 |
| 장소 | 위치별로 제품 인벤토리를 필터링합니다. 데이터 유형: 객체 |
| place.id | 제품 인벤토리 기록과 연결된 위치의 Sys_id 또는 external_id입니다. 테이블: 위치 [cmn_location] 데이터 유형: 문자열 |
| 상태 | 상태별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 상태의 제품 인벤토리만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 인벤토리 상태를 기준으로 필터링하지 않습니다. |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 콘텐츠 범위 | 페이지 매김된 호출에서 반환된 콘텐츠의 범위입니다. 예를 들어, |
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다.
|
| X-Total-Count | 페이지 매김된 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환됩니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원(페이지 매김 포함). |
| 400 | 잘못된 요청. 가능한 이유:
|
| 404 | 기록 없음 쿼리 매개변수와 일치하는 기록을 테이블에서 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| ID | 제품 인벤토리의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 장소 | 제품과 연결된 위치입니다. 데이터 유형: 객체 |
| place.id | 제품 인벤토리의 위치 sys_id 또는 external_id입니다. 테이블: 위치 [cmn_location] 데이터: 문자열 |
| place.name | 제품 인벤토리와 연결된 위치의 이름입니다. 테이블: 위치 [cmn_location] 데이터: 문자열 |
| 제품 특성 | 제품 특성 목록입니다. 제품 특성에 대한 자세한 내용은 다음 문서를 참조하십시오 Create a product offering category. 데이터 유형: 객체 배열 |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| productCharacteristic.valueType | 특성 값의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 |
| productOffering.id | 제품 오퍼링의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.name | 제품 오퍼링의 이름입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productRelationship | 관련 제품 목록입니다. 데이터 유형: 객체 배열 |
| productRelationship.productId | 관련 제품의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 |
| productSpecification.id | 제품 사양의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] |
| 실현자원 | 자원 실현. 데이터 유형: 객체 |
| realizingResource.id | 실현 자원의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingResource.type | 실현 자원의 유형입니다. 데이터 유형: 문자열 |
| 실현서비스 | 서비스 실현. 데이터 유형: 객체 |
| realizingService.id | 실현 서비스의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingService.type | 실현 서비스의 유형입니다. 데이터 유형: 문자열 |
| 관련당사자 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 객체 배열 |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 접촉 창구의 Sys_id입니다. 데이터 유형: 문자열 표: 계정[customer_account], 연락처[customer_contact] 또는 소비자[csm_consumer] |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 값은 항상 관련 당사자입니다.데이터 유형: 문자열 |
| 관련당사자.유형 | 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 모든 제품 인벤토리를 조회합니다.
curl "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--request GET \
--user 'username':'password'
응답 본문.
[
{
"id": "075072aec3a83010abc8b5183c40dd44",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "Firewall Administration PI0000300",
"productSpecification": {
"id": "31c5caff07266010a7955b7e0ad3006b",
"name": "Firewall Administration"
},
"status": "Active",
"productOffering": {
"id": "",
"name": ""
},
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"name": "200 South James street,Atlanta, GA"
},
"productCharacteristic": [
{
"name": "Firewall Administration CPE Type",
"valueType": "Choice",
"value": "Physical"
},
{
"name": "Configuration and Policy backup",
"valueType": "Choice",
"value": ""
},
{
"name": "Firewall Administration CPE ID",
"valueType": "Single Line Text",
"value": "CPE123456789"
},
{
"name": "Remote CLI troubleshoot support",
"valueType": "Choice",
"value": ""
},
{
"name": "Firewall Administration CPE Model",
"valueType": "Choice",
"value": "9300 series"
}
],
"productRelationship": [],
"realizingService": [],
"realizingResource": [
{
"id": "3546463307666010a7955b7e0ad3005d",
"name": "Cisco Firewall Management system"
}
]
},
{
"id": "0303a8ea74418510f877ca57242ff96d",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "SD-WAN Edge Device PI0001114",
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device"
},
"status": "Installation Pending",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"place": "",
"productCharacteristic": [],
"productRelationship": [],
"realizingService": [
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "16d79ec3532520103b6bddeeff7b12a6",
"name": "SD WAN Optimization Service"
},
{
"id": "16d79ec3532520103b6bddeeff7b12a6",
"name": "SD WAN Optimization Service"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
}
],
"realizingResource": [
{
"id": "493fa60b536520103b6bddeeff7b12b6",
"name": "Customer Premise SD-WAN Router"
}
]
}
]
제품 인벤토리 오픈 API - GET /sn_prd_invt/productinventory/{inventoryId}
제품 인벤토리를 조회합니다.
URL 형식
기본 URL: /api/sn_prd_invt/productinventory/{inventoryId}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 인벤토리 ID | 검색할 제품 인벤토리의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| 이름 | 설명 |
|---|---|
| 고객 | 고객별로 제품 인벤토리를 필터링합니다. 고객 sys_id 또는 이 매개변수의 값과 일치하는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 필드 | 응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 데이터 유형: 문자열 기본값: 모든 필드가 반환됩니다. |
| 장소 | 위치별로 제품 인벤토리를 필터링합니다. 데이터 유형: 객체 |
| place.id | 제품 인벤토리 기록과 연결된 위치의 Sys_id 또는 external_id입니다. 테이블: 위치 [cmn_location] 데이터 유형: 문자열 |
| 상태 | 상태별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 상태의 제품 인벤토리만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음과 같은 이유 중 하나일 수 있습니다.
|
| 404 | 기록 없음 ID와 관련된 기록을 테이블에서 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| ID | 제품 인벤토리의 Sys_id 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 장소 | 제품과 연결된 위치입니다. 데이터 유형: 객체 |
| place.id | 제품 인벤토리의 위치 sys_id 또는 external_id입니다. 테이블: 위치 [cmn_location] 데이터: 문자열 |
| place.name | 제품 인벤토리와 연결된 위치의 이름입니다. 테이블: 위치 [cmn_location] 데이터: 문자열 |
| 제품 특성 | 제품 특성 목록입니다. 제품 특성에 대한 자세한 내용은 다음 문서를 참조하십시오 Create a product offering category. 데이터 유형: 객체 배열 |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| productCharacteristic.valueType | 특성 값의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 |
| productOffering.id | 제품 오퍼링의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.name | 제품 오퍼링의 이름입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productRelationship | 관련 제품 목록입니다. 데이터 유형: 객체 배열 |
| productRelationship.productId | 관련 제품의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 |
| productSpecification.id | 제품 사양의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] |
| 실현자원 | 자원 실현. 데이터 유형: 객체 |
| realizingResource.id | 실현 자원의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingResource.type | 실현 자원의 유형입니다. 데이터 유형: 문자열 |
| 실현서비스 | 서비스 실현. 데이터 유형: 객체 |
| realizingService.id | 실현 서비스의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingService.type | 실현 서비스의 유형입니다. 데이터 유형: 문자열 |
| 관련당사자 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 객체 배열 |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 접촉 창구의 Sys_id입니다. 데이터 유형: 문자열 표: 계정[customer_account], 연락처[customer_contact] 또는 소비자[csm_consumer] |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 값은 항상 관련 당사자입니다.데이터 유형: 문자열 |
| 관련당사자.유형 | 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 SD-WAN 서비스 패키지에 대한 제품 인벤토리를 검색합니다.
curl --location --request GET 'https:// instance.servicenow.com/api/sn_prd_invt/productinventory/074450fc74918d10f877ca57242ff9e3' \
--user 'username':'password'
출력:
{
"id": "074450fc74918d10f877ca57242ff9e3",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "SD-WAN Service Package PI0001576",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package"
},
"status": "Installation Pending",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"place": "",
"productCharacteristic": [],
"productRelationship": [
{
"id": "a74490fc74918d10f877ca57242ff942",
"name": "SD-WAN Edge Device PI0001582",
"relationshipType": "Bundles"
},
{
"id": "b85414fc74918d10f877ca57242ff90e",
"name": "SD-WAN Controller PI0001602",
"relationshipType": "Bundles"
},
{
"id": "d74490fc74918d10f877ca57242ff907",
"name": "SD-WAN Security PI0001577",
"relationshipType": "Bundles"
}
],
"realizingService": [],
"realizingResource": []
}
제품 인벤토리 오픈 API - POST /sn_prd_invt/product
제품 인벤토리 기록을 생성합니다.
URL 형식
기본 URL: /api/sn_prd_invt/product
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| bundle | 제품 인벤토리 기록이 번들 제품의 일부인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| isBundle | 제품 인벤토리 기록이 번들 제품의 일부인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| 이름 | 필수 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| pid | 외부 시스템의 제품 인벤토리에 대한 고유 식별자입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품 특성 | 제품 특성 목록입니다. 제품 특성에 대한 자세한 내용은 다음 문서를 참조하십시오 Create a product offering category. 데이터 유형: 객체 배열 |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productCharacteristic.valueType | 특성 값의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| productOffering | 필수 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 |
| productOffering.id | 필수 제품 오퍼링의 Initial_version 또는 external_id입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.internalVersion | 제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드 |
| productOffering.name | 제품 오퍼링의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.version | 제품 오퍼링의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드 |
| productRelationship | 관련 제품 목록입니다. 데이터 유형: 객체 배열 |
| productRelationship.productId | 매개변수를 사용하는 경우 필수입니다 productRelationship . 관련 제품의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| productRelationship.relationshipType | 관계의 유형입니다. 유일하게 유효한 값은 child입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품 사양 | 필수 제품의 제품 사양입니다. 데이터 유형: 객체 |
| productSpecification.id | 필수 제품 사양의 Initial_version 또는 external_id입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] |
| productSpecification.internalVersion | 제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드 |
| productSpecification.version | 제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 external_version 필드 |
| 실현자원 | 제품을 실현하는 자원입니다. 실현 자원은 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 |
| realizingResource.id | 매개변수를 사용하는 경우 필수입니다 realizingResource . 실현 자원의 Sys_id. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 실현서비스 | 제품을 실현하는 서비스입니다. 실현 서비스는 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 |
| realizingService.id | 매개변수를 사용하는 경우 필수입니다 realizingService . 실현 서비스의 Sys_id. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 관련당사자 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 객체 배열 |
| relatedParty.@referredType | 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 기본값: 빈 문자열 |
| relatedParty.id | 매개변수를 사용하는 경우 필수입니다 relatedParty . 티켓과 연결된 계정 또는 고객 접촉 창구의 Sys_id입니다. 데이터 유형: 문자열 표: 계정[customer_account], 연락처[customer_contact] 또는 소비자[csm_consumer] |
| 상태 | 제품의 현재 상태입니다. 가능한 값:
데이터 유형: 문자열 기본값: installation_pending |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음과 같은 이유 중 하나일 수 있습니다.
|
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| bundle | 제품 인벤토리 기록이 번들 제품의 일부인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| href | 제품 인벤토리 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| ID | 제품 인벤토리의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| isBundle | 제품 인벤토리 기록이 번들 제품의 일부인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| pid | 외부 시스템의 제품 인벤토리에 대한 고유 식별자입니다. 데이터 유형: 문자열 |
| 제품 특성 | 제품 특성 목록입니다. 데이터 유형: 객체 배열 |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 |
| productOffering.id | 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드 |
| productOffering.internalId | 제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링의 internal_version 필드 [sn_prd_pm_product_offering] |
| productOffering.internalVersion | 제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드 |
| productOffering.name | 제품 오퍼링의 이름입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.version | 제품 오퍼링의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드 |
| 제품 가격 | 빈 배열을 반환합니다. 데이터 유형: 배열 |
| productRelationship | 관련 제품 목록입니다. 데이터 유형: 객체 배열 |
| productRelationship.productId | 관련 제품의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 |
| productSpecification.id | 제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 internal_version 또는 external_id 필드 |
| productSpecification.internalId | 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드 |
| productSpecification.internalVersion | 제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드 |
| productSpecification.version | 제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 external_version 필드 |
| 실현자원 | 제품을 실현하는 자원입니다. 실현 자원은 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 |
| realizingResource.id | 실현 자원의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingResource.type | 실현 자원의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 실현서비스 | 제품을 실현하는 서비스입니다. 실현 서비스는 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 |
| realizingService.id | 실현 서비스의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingService.type | 실현 서비스의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 관련당사자 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 객체 배열 |
| relatedParty.@referredType | 관련 당사자의 유형입니다. 값은 항상 관련 당사자입니다.데이터 유형: 문자열 |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 접촉 창구의 Sys_id입니다. 데이터 유형: 문자열 테이블:계정 [customer_account], 연락처 [customer_contact] 또는 소비자 [csm_consumer] |
| 관련당사자.유형 | 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 사용자를 위한 VoIP(Voice over IP) 솔루션에 대한 제품 인벤토리를 생성합니다.
curl -X POST "https://instance.service-now.com/api/sn_prd_invt/product" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data "[
{
"pid": "PO-456",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"@referredType": "ProductOffering",
"name": "Premium SD-WAN Offering",
"id": "69017a0f536520103b6bddeeff7b127d"
},
"productCharacteristic": [],
"productRelationship": [
{
"productId": "fa6d13f45b5620102dff5e92dc81c77f",
"relationshipType": "child"
}
],
"realizingService": {
"id": "fe6d13f45b5620102dff5e92dc81c786",
"relationshipType": "child"
},
"realizingResource": {
"id": "326d13f45b5620102dff5e92dc81c78c",
"relationshipType": "child"
},
"relatedParty": [
{
"@referredType": "CustomerContact",
"@type": "RelatedParty",
"name": "Sally Thomas",
"id": "eaf68911c35420105252716b7d40ddde"
},
{
"@referredType": "Customer",
"@type": "RelatedParty",
"name": "Funco Intl",
"id": "ffc68911c35420105252716b7d40dd55"
}
],
"productSpecification": {
"@referredType": "ProductSpecification",
"@type": null,
"name": null,
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"internalVersion": "1"
},
"bundle": false
}
]"
응답 본문.
{
"pid": "PO-456",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"@referredType": "ProductOffering",
"name": "Premium SD-WAN Offering",
"id": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1",
"version": null,
"status": "published",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productCharacteristic": [],
"productRelationship": [
{
"productId": "fa6d13f45b5620102dff5e92dc81c77f",
"relationshipType": "child"
}
],
"realizingService": {
"id": "fe6d13f45b5620102dff5e92dc81c786",
"relationshipType": "child"
},
"realizingResource": {
"id": "326d13f45b5620102dff5e92dc81c78c",
"relationshipType": "child"
},
"relatedParty": [
{
"@referredType": "CustomerContact",
"@type": "RelatedParty",
"name": "Sally Thomas",
"id": "eaf68911c35420105252716b7d40ddde"
},
{
"@referredType": "Customer",
"@type": "RelatedParty",
"name": "Example Company",
"id": "ffc68911c35420105252716b7d40dd55"
}
],
"productSpecification": {
"@referredType": "ProductSpecification",
"@type": null,
"name": null,
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"internalVersion": "1",
"version": null,
"status": "published",
"internalId": "3ee1fdb1c3331010d216b5183c40dd81"
},
"bundle": false,
"productPrice": [],
"id": "25b07475471789108761b955d36d439d",
"href": "/api/sn_prd_invt/product/25b07475471789108761b955d36d439d"
}
제품 인벤토리 오픈 API - POST /sn_prd_invt/productinventory
제품 인벤토리를 생성합니다.
URL 형식
기본 URL: /api/sn_prd_invt/productinventory
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| isBundle | 제품 인벤토리 기록이 번들 제품의 일부인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 기본값: false |
| 이름 | 필수 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| pid | 외부 시스템의 제품 인벤토리에 대한 고유 식별자입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품 특성 | 제품 특성 목록입니다. 제품 특성에 대한 자세한 내용은 다음 문서를 참조하십시오 Create a product offering category. 데이터 유형: 객체 배열 |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productCharacteristic.valueType | 특성 값의 유형입니다. 허용되는 값:
데이터 유형: 문자열 |
| productOffering | 필수 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 |
| productOffering.id | 필수 제품 오퍼링의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.name | 제품 오퍼링의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productRelationship | 관련 제품 목록입니다. 데이터 유형: 객체 배열 |
| productRelationship.productId | 매개변수를 사용하는 경우 필수입니다 productRelationship . 관련 제품의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| productRelationship.relationshipType | 관계의 유형입니다. 유일하게 유효한 값은 child입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품 사양 | 필수 제품의 제품 사양입니다. 데이터 유형: 객체 |
| productSpecification.id | 필수 제품 사양의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] |
| 실현자원 | 자원 실현. 데이터 유형: 객체 |
| realizingResource.id | 매개변수를 사용하는 경우 필수입니다 realizingResource . 실현 자원의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingResource.type | 실현 자원의 유형입니다. 유일하게 유효한 값은 child입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 실현서비스 | 서비스 실현. 데이터 유형: 객체 |
| realizingService.id | 매개변수를 사용하는 경우 필수입니다 realizingService . 실현 서비스의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingService.type | 실현 서비스의 유형입니다. 유일하게 유효한 값은 child입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 관련당사자 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 객체 배열 |
| relatedParty.@referredType | 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 기본값: 빈 문자열 |
| relatedParty.id | 매개변수를 사용하는 경우 필수입니다 relatedParty . 티켓과 연결된 계정 또는 고객 접촉 창구의 Sys_id입니다. 데이터 유형: 문자열 표: 계정[customer_account], 연락처[customer_contact] 또는 소비자[csm_Consumer] |
| 상태 | 제품의 현재 상태입니다. 가능한 값:
데이터 유형: 문자열 기본값: installation_pending |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. .만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음과 같은 이유 중 하나일 수 있습니다.
|
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| ID | 제품 인벤토리의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| isBundle | 제품 인벤토리 기록이 번들 제품의 일부인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| pid | 외부 시스템의 제품 인벤토리에 대한 고유 식별자입니다. 데이터 유형: 문자열 |
| 제품 특성 | 제품 특성 목록입니다. 데이터 유형: 객체 배열 |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value | 특성의 값입니다. 데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 |
| productOffering.id | 제품 오퍼링의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productOffering.name | 제품 오퍼링의 이름입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] |
| productRelationship | 관련 제품 목록입니다. 데이터 유형: 객체 배열 |
| productRelationship.productId | 관련 제품의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 |
| productSpecification.id | 제품 사양의 Sys_id입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] |
| 실현자원 | 자원 실현. 데이터 유형: 객체 |
| realizingResource.id | 실현 자원의 Sys_id 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingResource.type | 실현 자원의 유형입니다. 데이터 유형: 문자열 |
| 실현서비스 | 서비스 실현. 데이터 유형: 객체 |
| realizingService.id | 실현 서비스의 Sys_id. 데이터 유형: 문자열 테이블: 제품 인벤토리 [sn_prd_invt_product_inventory] |
| realizingService.type | 실현 서비스의 유형입니다. 데이터 유형: 문자열 |
| 관련당사자 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 객체 배열 |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 접촉 창구의 Sys_id입니다. 데이터 유형: 문자열 표: 계정[customer_account], 연락처[customer_contact] 또는 소비자[csm_consumer] |
| relatedParty.@referredType | 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 사용자를 위한 VoIP(Voice over IP) 솔루션에 대한 제품 인벤토리를 생성합니다.
curl --location --request POST "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--header "Content-Type: application/json" \
--data-raw '[
{
"pid": "demoInventory",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"@referredType": "ProductOffering"
},
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "choice",
"value": "Virtual"
},
{
"name":"Routing",
"valueType": "choice",
"value": "Premium"
}
],
"productRelationship": [
{
"productId": "7e6d13f45b5620102dff5e92dc81c787",
"relationshipType": "child"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"role": "User",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@referredType": "ProductSpecification",
"version": "1"
}
}
]'
--user 'username':'password'
응답 본문.
{
"pid": "demoInventory",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"@referredType": "ProductOffering"
},
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "choice",
"value": "Virtual"
},
{
"name": "Routing",
"valueType": "choice",
"value": "Premium"
}
],
"productRelationship": [
{
"productId": "7e6d13f45b5620102dff5e92dc81c787",
"relationshipType": "child"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"role": "User",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@referredType": "ProductSpecification",
"version": "1"
},
"id": "3ac715c6745d8150f877ca57242ff97a"
}