---
sourceDocument: Xanadu API 참조
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- ko-KR
ft:publication_title :
- Xanadu API 참조
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# 제품 인벤토리 오픈 API
# 제품 인벤토리 오픈 API {#ariaid-title1}
* 릴리스 버전: Xanadu
*
* 업데이트 날짜 2024년 08월 01일
*
*  소요 시간: 67분
Product Inventory Open API는 제품 인벤토리를 만들고 검색하기 위한 엔드포인트를 제공합니다.
이 API를 사용하여 외부 시스템과 .Now Platform
이 API는 에서 사용할 수 ServiceNow Store있는 Product Inventory Advanced 애플리케이션에 포함되어 있습니다.
이 API는 `sn_prd_invt ` 네임스페이스 내에서 제공됩니다.
호출하는 사용자에게 sn_prd_invt.product_inventory_integrator 역할이 있어야 합니다.
이 API는 다음 테이블의 데이터를 만들고 업데이트합니다.
* 제품 특성 \[sn_prd_invt_product_characteristics\]
* 제품 인벤토리 \[sn_prd_invt_product_inventory\]
* 제품 모델 \[cmdb_model\]
* 제품 모델 특성 \[sn_prd_pm_product_model_characteristic\]
{#product-inventory-open-api__ul_fhn_pjj_hsb}
Product Inventory Open API는 TM Forum Product Inventory Management API REST 스펙의 구현입니다ServiceNow®. 이 구현은 [TMF637 제품 인벤토리 관리 API REST 사양 릴리스 19](https://www.tmforum.org/resources/standard/tmf637-product-inventory-management-api-rest-specification-r19-0-0/), 2019년 8월을 기반으로 합니다. Product Inventory Open API는 TM Forum에서 적합성 인증을 받았습니다.
## 제품 인벤토리 오픈 API - GET /sn_prd_invt/product {#ariaid-title2}
모든 제품 인벤토리의 목록을 조회합니다.
### URL 형식
기본 URL: api/sn_prd_invt/product
### 지원되는 요청 매개변수
{#tmf_prod_inv-GET-product__table_ofr_vgy_fsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 1. 경로 매개변수]
{#tmf_prod_inv-GET-product__table_ofr_vgy_fsb} {#tmf_prod_inv-GET-product__table_pfr_vgy_fsb__entry__2}
| 이름 | 설명 |
|-|-|
| 고객 | 고객별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 고객 sys_id 또는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 최대: 100 데이터 유형: 숫자 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자 |
| 장소 | 장소별로 제품 인벤토리를 필터링합니다 . 이 매개변수의 값과 일치하는 장소 sys_id 또는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 상태 | 상태별로 제품 inventories를 필터링합니다. 이 매개변수의 값과 상태가 일치하는 제품 인벤토리만 응답에 반환됩니다. 데이터 유형: 문자열 |
[표 2. 쿼리 매개변수]
{#tmf_prod_inv-GET-product__table_pfr_vgy_fsb} {#tmf_prod_inv-GET-product__table_gld_vkz_gsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 3. 요청 본문 매개변수(JSON)]
{#tmf_prod_inv-GET-product__table_gld_vkz_gsb}
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-GET-product__table_kqy_wgy_fsb__entry__2}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 4. 요청 헤더]
{#tmf_prod_inv-GET-product__table_kqy_wgy_fsb} {#tmf_prod_inv-GET-product__table_idy_qgm_lsb__entry__2}{#tmf_prod_inv-GET-product__content-range-row}{#tmf_prod_inv-GET-product__content-type-row}{#tmf_prod_inv-GET-product__links-pagination-row}{#tmf_prod_inv-GET-product__x-total-count-descr}
| 헤더 | 설명 |
|-|-|
| 콘텐츠 범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 `offset=2` 및 `limit=3`인 경우 헤더의 Content-Range 값은 `항목 3-5`입니다. |
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. * 첫 번째 * 마지막 * 다음 * 이전 {#tmf_prod_inv-GET-product__ul_zzk_sdm_lsb} |
| X-Total-Count | 페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다. |
[표 5. 응답 헤더]
{#tmf_prod_inv-GET-product__table_idy_qgm_lsb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-GET-product__table_hl1_rcm_lsb__entry__2}{#tmf_prod_inv-GET-product__tmf-get-status-200-p}{#tmf_prod_inv-GET-product__tmf-get-status-206-entry}{#tmf_prod_inv-GET-product__tmf-get-status-400-entry}{#tmf_prod_inv-GET-product__tmf-get-status-404-entry}
| 상태 코드 | 설명 |
|-|-|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청입니다. 가능한 이유: * 잘못된 경로 매개변수 * 잘못된 URI {#tmf_prod_inv-GET-product__ul_rys_1gy_fsb} |
| 404 | 기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다. |
[표 6. 상태 코드]
{#tmf_prod_inv-GET-product__table_hl1_rcm_lsb}
### 응답 본문 매개변수(JSON) {#tmf_prod_inv-GET-product__section_rhr_nvy_3sb}
{#tmf_prod_inv-GET-product__table_shr_nvy_3sb__entry__2}{#tmf_prod_inv-GET-product__realRes-id-entry}{#tmf_prod_inv-GET-product__realServ-id-entry}
| 이름 | 설명 |
|-|-|
| href | 제품 인벤토리 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 제품 인벤토리 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 장소 | 제품과 연결된 장소입니다. 데이터 유형: 문자열 |
| 제품특성 | 제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value (영문) | 특성의 값입니다. 데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } |
| productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.internalId | 제품 오퍼링의 Initial_version입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.버전 | 제품 오퍼링의 External_version입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productPrice | 빈 배열을 반환합니다. 데이터 유형: 배열 |
| 제품 관계 | 관련 제품 목록입니다. 데이터 유형: 배열 "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 관련 제품 Sys_id입니다. 데이터 유형: 문자열 |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" } |
| productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 제품 사양.내부 ID | 제품 사양의 Initial_version입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productSpecification.version (영문) | 제품 사양의 External_version입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource | 제품을 실현하는 자원입니다. 실현 자원은 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | 실현 자원의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 리얼라이징서비스 | 제품을 실현하는 서비스. 실현 서비스는 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | 실현 서비스의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 관련파티 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 연락처의 Sys_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * 고객 연락처 * 소비자 {#tmf_prod_inv-GET-product__ul_jqs_vbh_fwb} 데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
[ ]
{#tmf_prod_inv-GET-product__table_shr_nvy_3sb}
### cURL 요청 {#tmf_prod_inv-GET-product__example_ld5_lnz_3sb}
이 예에서는 모든 제품 인벤토리를 검색합니다.
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."
}
]
## 제품 인벤토리 Open API - GET /sn_prd_invt/product/{id} {#ariaid-title3}
지정된 제품 인벤토리 기록을 조회합니다.
### URL 형식
기본 URL: /api/sn_prd_invt/product/{id}
### 지원되는 요청 매개변수 {#tmf_prod_inv-GET-product-id__section_esr_w5y_3sb}
{#tmf_prod_inv-GET-product-id__table_apt_nkz_gsb__entry__2}
| 이름 | 설명 |
|-|-|
| id | 검색할 제품 인벤토리의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
[표 7. 경로 매개변수]
{#tmf_prod_inv-GET-product-id__table_apt_nkz_gsb} {#tmf_prod_inv-GET-product-id__table_pfr_vgy_fsb__entry__2}
| 이름 | 설명 |
|-|-|
| 고객 | 고객별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 고객 sys_id 또는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열 |
| 장소 | 장소별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 장소 sys_id 또는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 상태 | 상태별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 상태가 일치하는 제품 인벤토리만 응답에 반환됩니다. 데이터 유형: 문자열 |
[표 8. 쿼리 매개변수]
{#tmf_prod_inv-GET-product-id__table_pfr_vgy_fsb} {#tmf_prod_inv-GET-product-id__table_gld_vkz_gsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 9. 요청 본문 매개변수(JSON)]
{#tmf_prod_inv-GET-product-id__table_gld_vkz_gsb}
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-GET-product-id__table_kqy_wgy_fsb__entry__2}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 10. 요청 헤더]
{#tmf_prod_inv-GET-product-id__table_kqy_wgy_fsb} {#tmf_prod_inv-GET-product-id__table_tzy_thy_ksb__entry__2}
| 헤더 | 설명 |
|-|-|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
[표 11. 응답 헤더]
{#tmf_prod_inv-GET-product-id__table_tzy_thy_ksb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-GET-product-id__table_nxj_ykz_gsb__entry__2}
| 상태 코드 | 설명 |
|-|-|
| 200 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. * 잘못된 경로 매개변수 * 잘못된 URI {#tmf_prod_inv-GET-product-id__ul_rys_1gy_fsb} |
| 404 | 기록 없음 ID와 관련된 기록을 테이블에서 찾을 수 없습니다. |
[표 12. 상태 코드]
{#tmf_prod_inv-GET-product-id__table_nxj_ykz_gsb}
### 응답 본문 매개변수(JSON) {#tmf_prod_inv-GET-product-id__section_rhr_nvy_3sb}
{#tmf_prod_inv-GET-product-id__table_shr_nvy_3sb__entry__2}{#tmf_prod_inv-GET-product-id__realRes-id-entry}{#tmf_prod_inv-GET-product-id__realServ-id-entry}
| 이름 | 설명 |
|-|-|
| href | 제품 인벤토리 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| id | 제품인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 제품 인벤토리 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 장소 | 제품과 연결된 장소입니다. 데이터 유형: 문자열 |
| 제품특성 | 제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value (영문) | 특성의 값입니다. 데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } |
| productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.internalId | 제품 오퍼링의 Initial_version입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.버전 | 제품 오퍼링의 External_version입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productPrice | 빈 배열을 반환합니다. 데이터 유형: 배열 |
| 제품 관계 | 관련 제품 목록입니다. 데이터 유형: 배열 "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 관련 제품 Sys_id입니다. 데이터 유형: 문자열 |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" } |
| productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 제품 사양.내부 ID | 제품 사양의 Initial_version입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productSpecification.version (영문) | 제품 사양의 External_version입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource | 제품을 실현하는 자원입니다. 실현 자원은 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | 실현 자원의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 리얼라이징서비스 | 제품을 실현하는 서비스. 실현 서비스는 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | 실현 서비스의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 관련파티 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 연락처의 Sys_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
[ ]
{#tmf_prod_inv-GET-product-id__table_shr_nvy_3sb}
### 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."
}
## 제품 인벤토리 Open API - GET /sn_prd_invt/productinventory {#ariaid-title4}
모든 제품 인벤토리의 목록을 조회합니다.
중요사항:
릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트 [제품 인벤토리 오픈 API - GET /sn_prd_invt/product](https://servicenow-prod.fluidtopics.net/304uDRtt~qqmsHLSqcCTpg#tmf_prod_inv-GET-product "모든 제품 인벤토리의 목록을 조회합니다.")의 새 버전은 입니다.
### URL 형식
기본 URL: api/sn_prd_invt/productinventory
### 지원되는 요청 매개변수
{#tmf_prod_inv-GET-prodinv__table_ofr_vgy_fsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 13. 경로 매개변수]
{#tmf_prod_inv-GET-prodinv__table_ofr_vgy_fsb} {#tmf_prod_inv-GET-prodinv__table_pfr_vgy_fsb__entry__2}
| 이름 | 설명 |
|-|-|
| 고객 | 고객별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 고객 sys_id 또는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 최대: 100 데이터 유형: 숫자 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자 |
| 장소 | 장소별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 장소 sys_id 또는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 상태 | 상태별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 상태가 일치하는 제품 인벤토리만 응답에 반환됩니다. 데이터 유형: 문자열 |
[표 14. 쿼리 매개변수]
{#tmf_prod_inv-GET-prodinv__table_pfr_vgy_fsb} {#tmf_prod_inv-GET-prodinv__table_gld_vkz_gsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 15. 요청 본문 매개변수(JSON)]
{#tmf_prod_inv-GET-prodinv__table_gld_vkz_gsb}
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-GET-prodinv__table_kqy_wgy_fsb__entry__2}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 16. 요청 헤더]
{#tmf_prod_inv-GET-prodinv__table_kqy_wgy_fsb} {#tmf_prod_inv-GET-prodinv__table_idy_qgm_lsb__entry__2}{#tmf_prod_inv-GET-prodinv__content-range-row}{#tmf_prod_inv-GET-prodinv__content-type-row}{#tmf_prod_inv-GET-prodinv__links-pagination-row}{#tmf_prod_inv-GET-prodinv__x-total-count-descr}
| 헤더 | 설명 |
|-|-|
| 콘텐츠 범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 `offset=2` 및 `limit=3`인 경우 헤더의 Content-Range 값은 `항목 3-5`입니다. |
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. * 첫 번째 * 마지막 * 다음 * 이전 {#tmf_prod_inv-GET-prodinv__ul_zzk_sdm_lsb} |
| X-Total-Count | 페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다. |
[표 17. 응답 헤더]
{#tmf_prod_inv-GET-prodinv__table_idy_qgm_lsb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-GET-prodinv__table_hl1_rcm_lsb__entry__2}{#tmf_prod_inv-GET-prodinv__tmf-get-status-200-p}{#tmf_prod_inv-GET-prodinv__tmf-get-status-206-entry}{#tmf_prod_inv-GET-prodinv__tmf-get-status-400-entry}{#tmf_prod_inv-GET-prodinv__tmf-get-status-404-entry}
| 상태 코드 | 설명 |
|-|-|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청입니다. 가능한 이유: * 잘못된 경로 매개변수 * 잘못된 URI {#tmf_prod_inv-GET-prodinv__ul_rys_1gy_fsb} |
| 404 | 기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다. |
[표 18. 상태 코드]
{#tmf_prod_inv-GET-prodinv__table_hl1_rcm_lsb}
### 응답 본문 매개변수(JSON) {#tmf_prod_inv-GET-prodinv__section_rhr_nvy_3sb}
{#tmf_prod_inv-GET-prodinv__table_shr_nvy_3sb__entry__2}
| 이름 | 설명 |
|-|-|
| id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 제품 인벤토리 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 장소 | 제품과 연결된 장소입니다. 데이터 유형: 문자열 |
| 제품특성 | 제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value (영문) | 특성의 값입니다. 데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String" } |
| productOffering.id | 제품 오퍼링의 Sys_id입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 제품 관계 | 관련 제품 목록입니다. 데이터 유형: 배열 "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 관련 제품 Sys_id입니다. 데이터 유형: 문자열 |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String" } |
| productSpecification.id | 제품 사양의 Sys_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource | 자원 실현. 데이터 유형: 객체 "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 실현 자원 Sys_id입니다. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 데이터 유형: 문자열 |
| 리얼라이징서비스 | 서비스 실현. 데이터 유형: 객체 "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 실현 서비스 Sys_id입니다. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 데이터 유형: 문자열 |
| 관련파티 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 연락처의 Sys_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * customerContact * 소비자 {#tmf_prod_inv-GET-prodinv__ul_jqs_vbh_fwb} 데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
[ ]
{#tmf_prod_inv-GET-prodinv__table_shr_nvy_3sb}
### cURL 요청 {#tmf_prod_inv-GET-prodinv__example_ld5_lnz_3sb}
이 예에서는 모든 제품 인벤토리를 검색합니다.
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} {#ariaid-title5}
제품 인벤토리를 조회합니다.
중요사항:
릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트 [제품 인벤토리 Open API - GET /sn_prd_invt/product/{id}](https://servicenow-prod.fluidtopics.net/304uDRtt~qqmsHLSqcCTpg#tmf_prod_inv-GET-product-id "지정된 제품 인벤토리 기록을 조회합니다.")의 새 버전은 입니다.
### URL 형식
기본 URL: /api/sn_prd_invt/productinventory/{inventoryId}
### 지원되는 요청 매개변수 {#tmf_prod_inv-GET-prodinv-id__section_esr_w5y_3sb}
{#tmf_prod_inv-GET-prodinv-id__table_apt_nkz_gsb__entry__2}
| 이름 | 설명 |
|-|-|
| 인벤토리 ID | 검색할 제품 인벤토리의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
[표 19. 경로 매개변수]
{#tmf_prod_inv-GET-prodinv-id__table_apt_nkz_gsb} {#tmf_prod_inv-GET-prodinv-id__table_pfr_vgy_fsb__entry__2}
| 이름 | 설명 |
|-|-|
| 고객 | 고객별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 고객 sys_id 또는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열 |
| 장소 | 장소별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 일치하는 장소 sys_id 또는 외부 ID가 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 상태 | 상태별로 제품 인벤토리를 필터링합니다. 이 매개변수의 값과 상태가 일치하는 제품 인벤토리만 응답에 반환됩니다. 데이터 유형: 문자열 |
[표 20. 쿼리 매개변수]
{#tmf_prod_inv-GET-prodinv-id__table_pfr_vgy_fsb} {#tmf_prod_inv-GET-prodinv-id__table_gld_vkz_gsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 21. 요청 본문 매개변수(JSON)]
{#tmf_prod_inv-GET-prodinv-id__table_gld_vkz_gsb}
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-GET-prodinv-id__table_kqy_wgy_fsb__entry__2}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 22. 요청 헤더]
{#tmf_prod_inv-GET-prodinv-id__table_kqy_wgy_fsb} {#tmf_prod_inv-GET-prodinv-id__table_tzy_thy_ksb__entry__2}
| 헤더 | 설명 |
|-|-|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
[표 23. 응답 헤더]
{#tmf_prod_inv-GET-prodinv-id__table_tzy_thy_ksb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-GET-prodinv-id__table_nxj_ykz_gsb__entry__2}
| 상태 코드 | 설명 |
|-|-|
| 200 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. * 잘못된 경로 매개변수 * 잘못된 URI {#tmf_prod_inv-GET-prodinv-id__ul_rys_1gy_fsb} |
| 404 | 기록 없음 ID와 관련된 기록을 테이블에서 찾을 수 없습니다. |
[표 24. 상태 코드]
{#tmf_prod_inv-GET-prodinv-id__table_nxj_ykz_gsb}
### 응답 본문 매개변수(JSON) {#tmf_prod_inv-GET-prodinv-id__section_rhr_nvy_3sb}
{#tmf_prod_inv-GET-prodinv-id__table_shr_nvy_3sb__entry__2}
| 이름 | 설명 |
|-|-|
| id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 제품 인벤토리 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| 장소 | 제품과 연결된 장소입니다. 데이터 유형: 문자열 |
| 제품특성 | 제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value (영문) | 특성의 값입니다. 데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String" } |
| productOffering.id | 제품 오퍼링의 Sys_id입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 제품 관계 | 관련 제품 목록입니다. 데이터 유형: 배열 "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 관련 제품 Sys_id입니다. 데이터 유형: 문자열 |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String" } |
| productSpecification.id | 제품 사양의 Sys_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource | 자원 실현. 데이터 유형: 객체 "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 실현 자원 Sys_id입니다. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 데이터 유형: 문자열 |
| 리얼라이징서비스 | 서비스 실현. 데이터 유형: 객체 "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 실현 서비스 Sys_id입니다. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 데이터 유형: 문자열 |
| 관련파티 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 연락처의 Sys_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * 고객 연락처 * 소비자 {#tmf_prod_inv-GET-prodinv-id__ul_jqs_vbh_fwb} 데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
[ ]
{#tmf_prod_inv-GET-prodinv-id__table_shr_nvy_3sb}
### 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 {#ariaid-title6}
제품 인벤토리 기록을 생성합니다.
### URL 형식
기본 URL: /api/sn_prd_invt/product
### 지원되는 요청 매개변수
{#tmf_prod_inv-POST-product__table_o3n_mvf_hsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 25. 경로 매개변수]
{#tmf_prod_inv-POST-product__table_o3n_mvf_hsb} {#tmf_prod_inv-POST-product__table_nbq_zds_3sb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 26. 쿼리 매개변수]
{#tmf_prod_inv-POST-product__table_nbq_zds_3sb} {#tmf_prod_inv-POST-product__entry__10}
| 이름 | 설명 |
|-|-|
| 이름 | 필수 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| pid | 외부 시스템의 제품 인벤토리에 대한 고유 식별자입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품특성 | 제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productCharacteristic.value (영문) | 특성의 값입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productOffering | 필수 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } |
| 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.버전 | 제품 오퍼링의 External_version입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 제품 관계 | 관련 제품 목록입니다. 데이터 유형: 배열 "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | 매개변수를 사용하는 경우 필수입니다 productRelationship . 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 관련 제품 Sys_id입니다. 데이터 유형: 문자열 |
| productRelationship.relationshipType | 관계의 유형입니다. 유일하게 유효한 값은 child입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품 사양 | 필수 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalVersion": "String", "version": "String" } |
| productSpecification.id | 필수 제품 사양의 Initial_version 또는 external_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productSpecification.version (영문) | 제품 사양의 External_version입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource | 제품을 실현하는 자원입니다. 실현 자원은 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | 매개변수를 사용하는 경우 필수입니다 realizingResource . 실현 자원의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 리얼라이징서비스 | 제품을 실현하는 서비스. 실현 서비스는 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | 매개변수를 사용하는 경우 필수입니다 realizingService . 실현 서비스의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 관련파티 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | 매개변수를 사용하는 경우 필수입니다 relatedParty . 티켓과 연결된 계정 또는 고객 연락처의 Sys_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * customer_contact * 소비자 {#tmf_prod_inv-POST-product__ul_dhg_ngs_3sb} 데이터 유형: 문자열 기본값: 빈 문자열 |
| 상태 | 제품의 현재 상태입니다. 가능한 값: * active * change_pending * inactivation_pending * 비활성 * installation_pending {#tmf_prod_inv-POST-product__ul_blq_yw5_4sb} 데이터 유형: 문자열 기본값: installation_pending |
[표 27. 요청 본문 매개변수(JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-POST-product__table_ett_h3z_gsb__entry__2}{#tmf_prod_inv-POST-product__accept-JSON-only-entry-RESTAPI}{#tmf_prod_inv-POST-product__content_type-JSON-only-entry-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
[표 28. 요청 헤더]
{#tmf_prod_inv-POST-product__table_ett_h3z_gsb} {#tmf_prod_inv-POST-product__table_tzy_thy_ksb__entry__2}
| 헤더 | 설명 |
|-|-|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
[표 29. 응답 헤더]
{#tmf_prod_inv-POST-product__table_tzy_thy_ksb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-POST-product__table_fbw_k3z_gsb__entry__2}
| 상태 코드 | 설명 |
|-|-|
| 201 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. * 페이로드가 비어 있습니다. * 잘못된 페이로드입니다. 필수 필드 누락: \<필드 이름\> {#tmf_prod_inv-POST-product__ul_nc5_myx_fsb} |
[표 30. 상태 코드]
{#tmf_prod_inv-POST-product__table_fbw_k3z_gsb}
### 응답 본문 매개변수(JSON)
{#tmf_prod_inv-POST-product__entry__82}{#tmf_prod_inv-POST-product__realRes-id-entry}{#tmf_prod_inv-POST-product__realServ-id-entry}
| 이름 | 설명 |
|-|-|
| href | 제품 인벤토리 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 제품 인벤토리 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| pid | 외부 시스템의 제품 인벤토리에 대한 고유 식별자입니다. 데이터 유형: 문자열 |
| 제품특성 | 제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value (영문) | 특성의 값입니다. 데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } |
| productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.internalId | 제품 오퍼링의 Initial_version입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.버전 | 제품 오퍼링의 External_version입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productPrice | 빈 배열을 반환합니다. 데이터 유형: 배열 |
| 제품 관계 | 관련 제품 목록입니다. 데이터 유형: 배열 "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 관련 제품 Sys_id입니다. 데이터 유형: 문자열 |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" } |
| productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 제품 사양.내부 ID | 제품 사양의 Initial_version입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productSpecification.version (영문) | 제품 사양의 External_version입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource | 제품을 실현하는 자원입니다. 실현 자원은 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | 실현 자원의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 리얼라이징서비스 | 제품을 실현하는 서비스. 실현 서비스는 이 제품 인벤토리의 하위 제품 인벤토리입니다. 데이터 유형: 객체 "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | 실현 서비스의 Sys_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 유효한 값: child 데이터 유형: 문자열 |
| 관련파티 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 연락처의 Sys_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * 고객 연락처 * 소비자 {#tmf_prod_inv-POST-product__ul_jqs_vbh_fwb} 데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
[ ]
### 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 {#ariaid-title7}
제품 인벤토리를 작성합니다.
중요사항:
릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트 [제품 인벤토리 오픈 API - POST /sn_prd_invt/product](https://servicenow-prod.fluidtopics.net/304uDRtt~qqmsHLSqcCTpg#tmf_prod_inv-POST-product "제품 인벤토리 기록을 생성합니다.")의 새 버전은 입니다.
### URL 형식
기본 URL: /api/sn_prd_invt/productinventory
### 지원되는 요청 매개변수
{#tmf_prod_inv-POST-prodinv__table_o3n_mvf_hsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 31. 경로 매개변수]
{#tmf_prod_inv-POST-prodinv__table_o3n_mvf_hsb} {#tmf_prod_inv-POST-prodinv__table_nbq_zds_3sb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 32. 쿼리 매개변수]
{#tmf_prod_inv-POST-prodinv__table_nbq_zds_3sb} {#tmf_prod_inv-POST-prodinv__entry__10}
| 이름 | 설명 |
|-|-|
| 이름 | 필수 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| pid | 외부 시스템의 제품 인벤토리에 대한 고유 식별자입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품특성 | 제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productCharacteristic.value (영문) | 특성의 값입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productOffering | 필수 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String" } |
| productOffering.id | 필수 제품 오퍼링의 Sys_id입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품 관계 | 관련 제품 목록입니다. 데이터 유형: 배열 "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | 매개변수를 사용하는 경우 필수입니다 productRelationship . 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 관련 제품 Sys_id입니다. 데이터 유형: 문자열 |
| productRelationship.relationshipType | 관계의 유형입니다. 유일하게 유효한 값은 child입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품 사양 | 필수 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String" } |
| productSpecification.id | 필수 제품 사양의 Sys_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource | 자원 실현. 데이터 유형: 객체 "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | 매개변수를 사용하는 경우 필수입니다 realizingResource . 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 실현 자원 Sys_id입니다. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 유일하게 유효한 값은 child입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 리얼라이징서비스 | 서비스 실현. 데이터 유형: 객체 "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | 매개변수를 사용하는 경우 필수입니다 realizingService . 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 실현 서비스 Sys_id입니다. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 유일하게 유효한 값은 child입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 관련파티 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | 매개변수를 사용하는 경우 필수입니다 relatedParty . 티켓과 연결된 계정 또는 고객 연락처의 Sys_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_Consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * customer_contact * 소비자 {#tmf_prod_inv-POST-prodinv__ul_dhg_ngs_3sb} 데이터 유형: 문자열 기본값: 빈 문자열 |
| 상태 | 제품의 현재 상태입니다. 가능한 값: * active * change_pending * inactivation_pending * 비활성 * installation_pending {#tmf_prod_inv-POST-prodinv__ul_blq_yw5_4sb} 데이터 유형: 문자열 기본값: installation_pending |
[표 33. 요청 본문 매개변수(JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-POST-prodinv__table_ett_h3z_gsb__entry__2}{#tmf_prod_inv-POST-prodinv__accept-JSON-only-entry-RESTAPI}{#tmf_prod_inv-POST-prodinv__content_type-JSON-only-entry-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
[표 34. 요청 헤더]
{#tmf_prod_inv-POST-prodinv__table_ett_h3z_gsb} {#tmf_prod_inv-POST-prodinv__table_tzy_thy_ksb__entry__2}
| 헤더 | 설명 |
|-|-|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
[표 35. 응답 헤더]
{#tmf_prod_inv-POST-prodinv__table_tzy_thy_ksb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#tmf_prod_inv-POST-prodinv__table_fbw_k3z_gsb__entry__2}
| 상태 코드 | 설명 |
|-|-|
| 201 | 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. * 페이로드가 비어 있습니다. * 잘못된 페이로드입니다. 필수 필드 누락: \<필드 이름\> {#tmf_prod_inv-POST-prodinv__ul_nc5_myx_fsb} |
[표 36. 상태 코드]
{#tmf_prod_inv-POST-prodinv__table_fbw_k3z_gsb}
### 응답 본문 매개변수(JSON)
{#tmf_prod_inv-POST-prodinv__entry__74}
| 이름 | 설명 |
|-|-|
| id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 제품 인벤토리 Sys_id입니다. 데이터 유형: 문자열 |
| 이름 | 제품 인벤토리의 이름입니다. 데이터 유형: 문자열 |
| pid | 외부 시스템의 제품 인벤토리에 대한 고유 식별자입니다. 데이터 유형: 문자열 |
| 제품특성 | 제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | 특성의 이름입니다. 데이터 유형: 문자열 |
| productCharacteristic.value (영문) | 특성의 값입니다. 데이터 유형: 문자열 |
| productOffering | 제품 인벤토리와 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String" } |
| productOffering.id | 제품 오퍼링의 Sys_id입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 있습니다. 데이터 유형: 문자열 |
| 제품 관계 | 관련 제품 목록입니다. 데이터 유형: 배열 "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 관련 제품 Sys_id입니다. 데이터 유형: 문자열 |
| productRelationship.relationshipType | 관계의 유형입니다. 데이터 유형: 문자열 |
| 제품 사양 | 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String" } |
| productSpecification.id | 제품 사양의 Sys_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| realizingResource | 자원 실현. 데이터 유형: 객체 "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 실현 자원 Sys_id입니다. 데이터 유형: 문자열 |
| realizingResource.type | 실현 자원의 유형입니다. 데이터 유형: 문자열 |
| 리얼라이징서비스 | 서비스 실현. 데이터 유형: 객체 "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 실현 서비스 Sys_id입니다. 데이터 유형: 문자열 |
| realizingService.type | 실현 서비스의 유형입니다. 데이터 유형: 문자열 |
| 관련파티 | 티켓과 연결된 당사자 목록입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | 티켓과 연결된 계정 또는 고객 연락처의 Sys_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * 고객 연락처 * 소비자 {#tmf_prod_inv-POST-prodinv__ul_jqs_vbh_fwb} 데이터 유형: 문자열 |
| 상태 | 제품의 현재 상태입니다. 데이터 유형: 문자열 |
[ ]
### 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"
}