제품 카탈로그 오픈 API

Product Catalog Open API는 제품 카탈로그, 제품 오퍼링 및 제품 사양을 작성하고 검색할 수 있는 엔드포인트를 제공합니다.

이 API를 사용하여 외부 시스템과 .Now Platform Product Catalog Open API는 TM Forum Product Catalog Management API REST 스펙의 구현입니다ServiceNow®. 이 구현은 TMF620 제품 카탈로그 관리 API REST 사양 버전 4, 2021년 4월을 기반으로 합니다.

이 API는 에서 사용할 수 ServiceNow Store있는 Product Catalog Advanced 애플리케이션에 포함되어 있습니다.

이 API는 sn_tmf_api 네임스페이스 내에서 제공됩니다.

호출하는 사용자에게는 sn_prd_pm_adv.catalog_integrator 역할이 있어야 합니다.

이 API는 다음 테이블의 데이터를 만들고 업데이트합니다.

• 특성 [sn_prd_pm_characteristic]
• 특성 옵션 [sn_prd_pm_characteristic_option]
• 제품 오퍼링 [sn_prd_pm_product_offering]
• 제품 오퍼링 카탈로그 [sn_prd_pm_product_offering_catalog]
• 제품 오퍼링 특성 [sn_prd_pm_product_offering_characteristic]
• 제품 사양 [sn_prd_pm_product_specification]
• 사양 관계 [sn_prd_pm_specification_relationship]

제품 카탈로그 오픈 API - DELETE /sn_tmf_api/catalogmanagement/productOffering/{id}

지정된 제품 오퍼링을 삭제합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

지원되는 요청 매개변수

표 1. 경로 매개변수

이름	설명
id	삭제할 제품 오퍼링의 Sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열

표 2. 쿼리 매개변수

이름	설명
없음

표 3. 요청 본문 매개변수(XML 또는 JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 5. 응답 헤더

헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.

응답 본문 매개변수(JSON 또는 XML)

이름	설명
메시지	제품 사양의 삭제 또는 보관에 대한 실패 또는 성공 메시지입니다.

cURL 요청

다음 예에서는 ID가 d6f8d9995b020210235d85cced81c7eb인 제품 오퍼링을 삭제합니다.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

응답 본문은 성공적인 삭제 메시지를 반환합니다.

"The product offering (d6f8d9995b020210235d85cced81c7eb) is successfully deleted"

제품 카탈로그 Open API - DELETE /sn_tmf_api/catalogmanagement/productSpecification/{id}

지정된 제품 사양을 삭제하거나 보관합니다.

이 DELETE 메서드를 호출할 때 제품 사양은 상태에 따라 삭제되거나 보관될 수 있습니다.

• 초안 상태의 제품 사양이 성공적으로 삭제되었습니다. 응답은 성공 메시지를 반환합니다.
• 보관된 상태의 제품 사양은 삭제할 수 없습니다. 응답은 사양이 이미 보관되어 있다는 메시지를 반환합니다.
• 초안 상태가 아니고 다른 제품 사양 또는 오퍼링과 연결된 제품 사양은 보관되지만 삭제되지는 않습니다. 응답은 사양이 활성 상태에서 보관된 상태로 이동되었다는 메시지를 반환합니다.
• 활성 제품 사양 또는 오퍼링과 연결된 제품 사양은 삭제할 수 없습니다. 응답은 오류 메시지를 반환합니다.

URL 형식

기본 URL: /sn_tmf_api/catalogmanagement/productSpecification/{id}

지원되는 요청 매개변수

표 7. 경로 매개변수

이름	설명
id	삭제할 제품 사양의 Sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열

표 8. 쿼리 매개변수

이름	설명
없음

표 9. 요청 본문 매개변수(XML 또는 JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 10. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 11. 응답 헤더

헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 12. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.

응답 본문 매개변수(JSON 또는 XML)

이름	설명
메시지	제품 사양의 삭제 또는 보관에 대한 실패 또는 성공 메시지입니다.

cURL 요청

다음 예제에서는 ID가 8ef57fa05b308210235d85cced81c7d8인 제품 사양을 삭제합니다.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/8ef57fa05b308210235d85cced81c7d8" \ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

응답 본문은 성공 또는 실패 메시지를 반환합니다.

"The product specification (8ef57fa05b308210235d85cced81c7d8) is successfully deleted"

제품 카탈로그 Open API - GET /sn_tmf_api/catalogmanagement/catalog

모든 제품 오퍼링 카탈로그의 목록을 조회합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/catalog

지원되는 요청 매개변수

표 13. 경로 매개변수

이름	설명
없음

표 14. 쿼리 매개변수

이름	설명
필드	응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열
제한	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 최대: 100 데이터 유형: 숫자
오프셋	기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자

표 15. 요청 본문 매개변수(JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 16. 요청 헤더

헤더	설명
없음

표 17. 응답 헤더

헤더	설명
콘텐츠 범위	페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 offset=2 및 limit=3인 경우 헤더의 Content-Range 값은 항목 3-5입니다.
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.
링크	쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. 첫 번째 마지막 다음 이전
X-Total-Count	페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 18. 상태 코드

상태 코드	설명
200	요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음).
206	응답으로 반환된 부분 자원입니다(페이지 매김 포함).
400	잘못된 요청입니다. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
설명	제품 오퍼링 카탈로그에 대한 설명입니다. 데이터 유형: 문자열
id	제품 오퍼링 카탈로그 [sn_prd_pm_product_offering_catalog] 테이블의 제품 오퍼링 카탈로그 Sys_id입니다. 데이터 유형: 문자열
이름	제품 오퍼링 카탈로그의 이름입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 모든 제품 오퍼링 카탈로그를 검색합니다.

curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--user 'username':'password'

응답 본문입니다.

[
    {
        "id": "SD-WAN1344314wrfw14345",
        "name": "New Catalog",
        "description": "New Catalog"
    },
    {
        "id": "9919291ac34c20105252716b7d40dd0f",
        "name": "Enterprise Mobile Plan",
        "description": " Product Catalog for Enterprise Mobile Plan"
    }
]

제품 카탈로그 Open API - GET /sn_tmf_api/catalogmanagement/catalog/{id}

제품 오퍼링 카탈로그를 조회합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/catalog/{id}

지원되는 요청 매개변수

표 19. 경로 매개변수

이름	설명
id	검색할 제품 오퍼링 카탈로그의 Sys_id입니다. 제품 오퍼링 카탈로그 [sn_prd_pm_product_offering_catalog] 테이블에 있습니다. 데이터 유형: 문자열

표 20. 쿼리 매개변수

이름	설명
필드	응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열

표 21. 요청 본문 매개변수(JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 22. 요청 헤더

헤더	설명
없음

표 23. 응답 헤더

헤더	설명
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 24. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. 잘못된 경로 매개변수 잘못된 URI
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
설명	제품 오퍼링 카탈로그에 대한 설명입니다. 데이터 유형: 문자열
id	제품 오퍼링 카탈로그 [sn_prd_pm_product_offering_catalog] 테이블의 제품 오퍼링 카탈로그 Sys_id입니다. 데이터 유형: 문자열
이름	제품 오퍼링 카탈로그의 이름입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 엔터프라이즈 모바일 계획에 대한 제품 오퍼링 카탈로그를 검색합니다.

curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog/9919291ac34c20105252716b7d40dd0f" \
--user 'username':'password'

응답 본문입니다.

{
   "id": "9919291ac34c20105252716b7d40dd0f",
   "name": "Enterprise Mobile Plan",
   "description": " Product Catalog for Enterprise Mobile Plan"
}

제품 카탈로그 Open API - GET /sn_tmf_api/catalogmanagement/productOffering

모든 제품 오퍼링을 검색합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productOffering

지원되는 요청 매개변수

표 25. 경로 매개변수

이름	설명
없음

표 26. 쿼리 매개변수

이름	설명
필드	응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: 범주 채널 설명 externalId id internalId internalVersion 마지막 업데이트 이름 제품특성 productOfferingPrice (영문) productOfferingTerm (영문) 제품 사양 prodSpecCharValueUse (영문) validFor 버전 기본값: 모든 필드가 반환됩니다. 데이터 유형: 문자열
제한	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 최대: 100 데이터 유형: 숫자
오프셋	기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자
사양	제품 사양 sys_id별로 제품 오퍼링을 필터링합니다. 지정된 제품 사양 sys_id이 있는 제품 오퍼링만 응답에 반환됩니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열
상태	상태별로 제품 오퍼링을 필터링합니다. 지정된 상태의 제품 오퍼링만 응답에 반환됩니다. 허용되는 값: archived 초안 게시 날짜: 폐기됨 데이터 유형: 문자열

표 27. 요청 본문 매개변수(JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 28. 요청 헤더

헤더	설명
없음

표 29. 응답 헤더

헤더	설명
콘텐츠 범위	페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 offset=2 및 limit=3인 경우 헤더의 Content-Range 값은 항목 3-5입니다.
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.
링크	쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. 첫 번째 마지막 다음 이전
X-Total-Count	페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 30. 상태 코드

상태 코드	설명
200	요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음).
206	응답으로 반환된 부분 자원입니다(페이지 매김 포함).
400	잘못된 요청입니다. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
범주	제품이 속한 범주의 목록입니다. 데이터 형식: 객체 배열 "category:" [ { "id": "String", "name": "String" } ]
category.id	범주의 ID입니다. 데이터 유형: 문자열
category.name	범주의 이름입니다. 데이터 유형: 문자열
채널	제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 형식: 객체 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열
channel.id	유통 채널 [sn_prd_pm_distribution_channel] 테이블의 채널 Sys_id입니다. 데이터 유형: 문자열
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_id입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
id	필수. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 버전입니다. 데이터 유형: 문자열
마지막 업데이트	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
lifecycleStatus	제품 오퍼링의 현재 수명주기 상태입니다. 허용되는 값: 활성 비활성 초안 데이터 유형: 문자열 기본값: 빈 문자열
이름	제품 오퍼링의 이름입니다. 데이터 유형: 문자열
제품특성	제품 특성 목록입니다. 데이터 형식: 객체 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
productCharacteristic.value (영문)	특성의 값입니다. 데이터 유형: 문자열
productOfferingPrice (영문)	제품 오퍼링에 대한 가격 정보입니다. 데이터 형식: 객체 배열 "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	제품 오퍼링 가격의 통화 코드입니다. 데이터 유형: 문자열
productOfferingPrice.price.taxIncludedAmount.value	세금을 포함한 제품 오퍼링 가격입니다. 데이터 유형: 문자열
productOfferingPrice.priceType	제품 오퍼링 가격의 유형입니다(일회성 또는 반복 지불). 유효한 값은 다음과 같습니다. 비반복(일회성) 되풀이 데이터 유형: 문자열
productOfferingTerm (영문)	제품 오퍼링의 유효한 계약 기간입니다. 데이터 유형: 문자열
제품 사양	제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	제품 사양의 initial_version입니다. 제품 사양 [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] 테이블에 있습니다. 데이터 유형: 문자열
prodSpecCharValueUse (영문)	제품 오퍼링 특성입니다. 데이터 형식: 객체 배열 "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값입니다. 데이터 형식: 객체 배열 "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
prodSpecCharValueUse.description	특성에 대한 설명입니다. 데이터 유형: 문자열
prodSpecCharValueUse.name	특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	특성의 종료 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor.startDateTime	특성의 시작 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다.
validFor	제품 오퍼링이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	제품 오퍼링의 종료 날짜입니다. 데이터 유형: 문자열
validFor.startDateTime	제품 오퍼링의 시작 날짜입니다. 데이터 유형: 문자열
버전	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_version입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 모든 제품 오퍼링을 검색합니다.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering" \
--user 'username':'password'

응답 본문:

[
   {
      "id": "24413",
      "name": "Premium SD-WAN Offering New",
      "version": "",
      "internalVersion": "1",
      "internalId": "0199f8e65b430110235d85cced81c7d2",
      "description": "Premium SD-WAN Offering",
      "lastUpdate": "2022-01-27 05:41:16",
      "validFor": {
         "startDateTime": "2021-08-05",
         "endDateTime": "2026-09-04"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
         {
            "priceType": "recurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "JPY",
                  "value": 984.0913
               }
            }
         },
         {
            "priceType": "nonRecurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "GBP",
                  "value": 2434
               }
            }
         }
      ],
      "productSpecification": {
         "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
         "name": "SD-WAN Service Package",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
         {
            "name": "Routing",
            "description": "Routing",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:08:20"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "WAN Optimization",
            "description": "WAN Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:10:28"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "CPE Model",
            "description": "CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:54"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "ISR",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "ASR",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Security Type",
            "description": "Security Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-30 12:51:13"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247"
            }
         },
         {
            "name": "CPE Type",
            "description": "CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:16"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Tenancy",
            "description": "Tenancy",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:04:24"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Advance (50 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base (10 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium (>50 sites)",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5"
            }
         }
      ],
      "channel": [
         {
            "id": "e561aae4c3e710105252716b7d40dd8f",
            "name": "Web"
         }
      ],
      "category": {
         "id": "c0ed043653b02010cd6dddeeff7b1277",
         "name": "SD-WAN"
      }
   }
]

제품 카탈로그 Open API - GET /sn_tmf_api/catalogmanagement/productOffering/{id}

제품 오퍼링을 조회합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

지원되는 요청 매개변수

표 31. 경로 매개변수

이름	설명
id	검색할 제품 오퍼링의 Initial_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열

표 32. 쿼리 매개변수

이름	설명
필드	응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: 범주 채널 설명 externalId id internalId internalVersion 마지막 업데이트 이름 제품특성 productOfferingPrice (영문) productOfferingTerm (영문) 제품 사양 prodSpecCharValueUse (영문) validFor 버전 기본값: 모든 필드가 반환됩니다. 데이터 유형: 문자열
사양	제품 사양 sys_id별로 제품 오퍼링을 필터링합니다. 지정된 제품 사양 sys_id이 있는 제품 오퍼링만 응답에 반환됩니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열
상태	상태별로 제품 오퍼링을 필터링합니다. 지정된 상태의 제품 오퍼링만 응답에 반환됩니다. 허용되는 값: archived 초안 게시 날짜: 폐기됨 데이터 유형: 문자열

표 33. 요청 본문 매개변수(JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 34. 요청 헤더

헤더	설명
없음

표 35. 응답 헤더

헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 36. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
범주	제품이 속한 범주의 목록입니다. 데이터 유형: 배열 "category:" [ { "id": "String", "name": "String" } ]
category.id	범주의 ID입니다. 데이터 유형: 문자열
category.name	범주의 이름입니다. 데이터 유형: 문자열
채널	제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 유형: 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열
channel.id	유통 채널 [sn_prd_pm_distribution_channel] 테이블의 채널 Sys_id입니다. 데이터 유형: 문자열
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_id입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
id	필수. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 버전입니다. 데이터 유형: 문자열
마지막 업데이트	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
lifecycleStatus	제품 오퍼링의 현재 수명주기 상태를 나타냅니다. 허용되는 값: 활성 비활성 초안 데이터 유형: 문자열 기본값: 빈 문자열
이름	제품 오퍼링의 이름입니다. 데이터 유형: 문자열
제품특성	제품 특성 목록입니다. 데이터 유형: 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
productCharacteristic.value (영문)	특성의 값입니다. 데이터 유형: 문자열
productOfferingPrice (영문)	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 배열 "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	제품 오퍼링 가격의 통화 코드입니다. 데이터 유형: 문자열
productOfferingPrice.price.taxIncludedAmount.value	세금을 포함한 제품 오퍼링 가격입니다. 데이터 유형: 문자열
productOfferingPrice.priceType	제품 오퍼링 가격이 일회성 지불인지 반복 지불인지 식별합니다. 유효한 값은 다음과 같습니다. 되풀이 되풀이 데이터 유형: 문자열
productOfferingTerm (영문)	제품 오퍼링의 유효한 계약 기간입니다. 데이터 유형: 문자열
제품 사양	제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	제품 사양의 initial_version입니다. 제품 사양 [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] 테이블에 있습니다. 데이터 유형: 문자열
prodSpecCharValueUse (영문)	제품 오퍼링 특성입니다. 데이터 유형: 배열 "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값을 포함하는 배열입니다. 데이터 유형: 배열 "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
prodSpecCharValueUse.description	특성에 대한 설명입니다. 데이터 유형: 문자열
prodSpecCharValueUse.name	특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	특성의 종료 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor.startDateTime	특성의 시작 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다.
validFor	제품 오퍼링이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	제품 오퍼링의 종료 날짜입니다. 데이터 유형: 문자열
validFor.startDateTime	제품 오퍼링의 시작 날짜입니다. 데이터 유형: 문자열
버전	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_version입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 제품 오퍼링을 조회합니다.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering/24413" \
--user 'username':'password'

응답 본문:

{
   "id": "24413",
   "name": "Premium SD-WAN Offering New",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2022-01-27 05:41:16",
   "version": "",
   "internalVersion": "2",
   "internalId": "69017a0f536520103b6bddeeff7b127d",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "not_applicable",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-30 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "abc",
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}

제품 카탈로그 Open API - GET /sn_tmf_api/catalogmanagement/productSpecification

모든 제품 사양을 검색합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productSpecification

지원되는 요청 매개변수

표 37. 경로 매개변수

이름	설명
없음

표 38. 쿼리 매개변수

이름	설명
필드	응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: 설명 externalId id internalId internalVersion 마지막 업데이트 이름 제품 사양 특성 제품 사양 관계 resourceSpecification 서비스 사양 validFor 버전 기본값: 모든 필드가 반환됩니다. 데이터 유형: 문자열
제한	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 최대: 100 데이터 유형: 숫자
오프셋	기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자
상태	상태별로 제품 사양을 필터링합니다. 지정된 상태의 제품 사양만 응답에 반환됩니다. 허용되는 값: archived 초안 게시 날짜: 폐기됨 데이터 유형: 문자열

표 39. 요청 본문 매개변수(JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 40. 요청 헤더

헤더	설명
없음

표 41. 응답 헤더

헤더	설명
콘텐츠 범위	페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 offset=2 및 limit=3인 경우 헤더의 Content-Range 값은 항목 3-5입니다.
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.
링크	쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. 첫 번째 마지막 다음 이전
X-Total-Count	페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 42. 상태 코드

상태 코드	설명
200	요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음).
206	응답으로 반환된 부분 자원입니다(페이지 매김 포함).
400	잘못된 요청입니다. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
설명	사양에 대한 설명입니다. 데이터 유형: 문자열
externalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_id입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
id	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 버전입니다. 데이터 유형: 문자열
is번들	단일 제품 또는 제품 번들을 나타내는지 여부를 productSpecification 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 제품 사양이 제품 번들이며 여러 제품을 포함합니다. false: 제품 사양에 단일 제품이 포함되어 있습니다. 데이터 유형: 부울 기본값: false
마지막 업데이트	사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
lifecycleStatus	제품 사양의 현재 수명주기 상태입니다. 허용되는 값: 활성 비활성 초안 데이터 유형: 문자열 기본값: 빈 문자열
이름	사양의 이름입니다. 데이터 유형: 문자열
제품 사양 특성	사양 특성. 데이터 형식: 객체 배열 "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	특성에 대한 설명입니다. 데이터 유형: 문자열
productSpecCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic.productSpecCharacteristicValue	특성의 가능한 값 목록입니다. 데이터 형식: 객체 배열 "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
productSpecCharacteristic.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	특성의 종료 날짜입니다. 데이터 유형: 문자열
productSpecCharacteristic.validFor.startDateTime	특성의 시작 날짜입니다. 데이터 유형: 문자열
productSpecCharacteristic.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열
제품 사양 관계	이 사양과 다른 제품 사양의 관계입니다. 데이터 형식: 객체 배열 "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]
productSpecificationRelationship.id	관련 사양의 ID입니다. 데이터 유형: 문자열
productSpecificationRelationship.type	관계의 유형입니다. 데이터 유형: 문자열
productSpecificationRelationship.validFor	관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	관계의 종료 날짜입니다. 데이터 유형: 문자열
productSpecificationRelationship.validFor.startDateTime	관계의 시작 날짜입니다. 데이터 유형: 문자열
resourceSpecification	이 제품 사양과 관련된 자원 사양의 목록입니다. 데이터 형식: 객체 배열 "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	자원 사양의 Initial_version 또는 external_id입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalId	자원 사양의 Initial_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalVersion	자원 사양의 버전입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.name	자원 사양의 이름입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.version	자원 사양의 External_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
서비스 사양	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 형식: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalId	서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.name	서비스 사양의 이름입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.version	서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
validFor	사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	사양의 종료 날짜입니다. 데이터 유형: 문자열
validFor.startDateTime	사양의 시작 날짜입니다. 데이터 유형: 문자열
버전	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_version. 데이터 유형: 문자열

cURL 요청

이 예에서는 모든 제품 사양을 검색합니다.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--user 'username':'password'

응답 본문:

[
   {
      "id": "0c47f2257441c110f877ca57242ff9bd",
      "name": "SD-WAN My Device",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "0c47f2257441c110f877ca57242ff9bd",
      "description": "This is my product specification ...",
      "lastUpdate": "2022-01-14 17:57:23",
      "validFor": {
         "startDateTime": "2022-01-11",
         "endDateTime": "2027-01-10"
      },
      "serviceSpecification": [
         {
            "id": "e23ae2d01bb420106ba59acf034bcb56",
            "name": "IP Sec Tunnel",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "e23ae2d01bb420106ba59acf034bcb56"
         }
      ],
      "productSpecificationRelationship": [
         {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "1",
            "type": "Service",
            "validFor": {
               "startDateTime": "2022-01-11",
               "endDateTime": "2027-02-12"
            }
         }
      ],
      "resourceSpecification": [
         {
            "id": "493fa60b536520103b6bddeeff7b12b6",
            "name": "Customer Premise SD-WAN Router",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "493fa60b536520103b6bddeeff7b12b6"
         }
      ],
      "productSpecCharacteristic": [
         {
            "name": "New characteristic",
            "description": "This product has new spec characteristic.",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-13 06:47:43"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "TestValue",
                  "validFor": {
                     "startDateTime": "2022-01-11"
                  }
               }
            ]
         }
      ]
   }
]

제품 카탈로그 Open API - GET /sn_tmf_api/catalogmanagement/productSpecification/{id}

지정된 제품 사양을 조회합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productSpecification/{id}

지원되는 요청 매개변수

표 43. 경로 매개변수

이름	설명
사양 ID	검색할 제품 사양의 initial_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열

표 44. 쿼리 매개변수

이름	설명
필드	응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: 설명 externalId id internalId internalVersion 마지막 업데이트 이름 제품 사양 특성 제품 사양 관계 resourceSpecification 서비스 사양 validFor 버전 기본값: 모든 필드가 반환됩니다. 데이터 유형: 문자열
상태	상태별로 제품 사양을 필터링합니다. 지정된 상태의 제품 사양만 응답에 반환됩니다. 허용되는 값: archived 초안 게시 날짜: 폐기됨 데이터 유형: 문자열

표 45. 요청 본문 매개변수(JSON)

이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 46. 요청 헤더

헤더	설명
없음

표 47. 응답 헤더

헤더	설명
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 48. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON)

이름	설명
설명	사양에 대한 설명입니다. 데이터 유형: 문자열
externalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_id입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
id	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 버전입니다. 데이터 유형: 문자열
is번들	단일 제품 또는 제품 번들을 나타내는지 여부를 productSpecification 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 제품 사양이 제품 번들이며 여러 제품을 포함합니다. false: 제품 사양에 단일 제품이 포함되어 있습니다. 데이터 유형: 부울 기본값: false
마지막 업데이트	사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
lifecycleStatus	제품 사양의 현재 수명주기 상태를 나타냅니다. 유효한 값은 다음과 같습니다. 활성 비활성 초안 데이터 유형: 문자열 기본값: 빈 문자열
이름	사양의 이름입니다. 데이터 유형: 문자열
제품 사양 특성	사양 특성. 데이터 형식: 객체 배열 "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	특성에 대한 설명입니다. 데이터 유형: 문자열
productSpecCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic.productSpecCharacteristicValue	특성의 가능한 값입니다. 데이터 형식: 객체 배열 "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
productSpecCharacteristic.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	특성의 종료 날짜입니다. 데이터 유형: 문자열
productSpecCharacteristic.validFor.startDateTime	특성의 시작 날짜입니다. 데이터 유형: 문자열
productSpecCharacteristic.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열
제품 사양 관계	이 사양과 다른 제품 사양의 관계입니다. 데이터 형식: 객체 배열 "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]
productSpecificationRelationship.id	관련 사양의 ID입니다. 데이터 유형: 문자열
productSpecificationRelationship.type	관계의 유형입니다. 데이터 유형: 문자열
productSpecificationRelationship.validFor	관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	관계의 종료 날짜입니다. 데이터 유형: 문자열
productSpecificationRelationship.validFor.startDateTime	관계의 시작 날짜입니다. 데이터 유형: 문자열
resourceSpecification	이 제품 사양과 관련된 자원 사양의 목록입니다. 데이터 형식: 객체 배열 "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	자원 사양의 Initial_version 또는 external_id입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalId	자원 사양의 Initial_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalVersion	자원 사양의 버전입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.name	자원 사양의 이름입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.version	자원 사양의 External_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
서비스 사양	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 형식: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalId	서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.name	서비스 사양의 이름입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.version	서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
validFor	사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	사양의 종료 날짜입니다. 데이터 유형: 문자열
validFor.startDateTime	사양의 시작 날짜입니다. 데이터 유형: 문자열
버전	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_version. 데이터 유형: 문자열

cURL 요청

이 예에서는 제품 사양을 검색합니다.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification/0c47f2257441c110f877ca57242ff9bd" \
--user 'username':'password'

응답 본문:

{
   "id": "0c47f2257441c110f877ca57242ff9bd",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalVersion": "1",
   "internalId": "0c47f2257441c110f877ca57242ff9bd",
   "description": "This is my product specification ...",
   "lastUpdate": "2022-01-14 17:57:23",
   "validFor": {
      "startDateTime": "2022-01-11",
      "endDateTime": "2027-01-10"
   },
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "version": "v1",
         "internalVersion": "1",
         "internalId": " a6514bd3534560102f18ddeeff7b1247",
         "type": "Service",
         "validFor": {
            "startDateTime": "2022-01-11",
            "endDateTime": "2027-02-12"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ],
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-13 06:47:43"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "TestValue",
               "validFor": {
                  "startDateTime": "2022-01-11"
               }
            }
         ]
      }
   ]
}

제품 카탈로그 Open API - 패치 /sn_tmf_api/catalogmanagement/productOffering/{id}

지정된 제품 오퍼링을 업데이트합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

지원되는 요청 매개변수

표 49. 경로 매개변수

이름	설명
id	업데이트할 제품 오퍼링의 Sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열

표 50. 쿼리 매개변수

이름	설명
없음

표 51. 요청 본문 매개변수(JSON)

이름	설명
범주	제품이 속한 범주의 목록입니다. 범주 [sc_category] 테이블에 있습니다. 데이터 형식: 객체 배열 "category:" [ { "id": "String", "name": "String" } ]
category.id	매개변수를 사용하는 경우 필수입니다 category . 범주의 ID입니다. 범주 [sc_category] 테이블에 있습니다. 데이터 유형: 문자열
category.name	범주의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열
채널	필수 제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 형식: 객체 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열 기본값: 빈 문자열
channel.id	필수 유통 채널 [sn_prd_pm_distribution_channel] 테이블의 채널 Sys_id입니다. 데이터 유형: 문자열
channel.name	채널의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열
설명	필수 제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_id입니다. 데이터 유형: 문자열
id	필수. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 버전입니다. 데이터 유형: 문자열
마지막 업데이트	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열 기본값: 빈 문자열
이름	필수 제품 오퍼링의 이름입니다. 데이터 유형: 문자열
제품특성	제품 특성 목록입니다. 데이터 형식: 객체 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열
productCharacteristic.value (영문)	특성의 값입니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOfferingPrice (영문)	제품 오퍼링에 대한 가격 정보입니다. 데이터 형식: 객체 배열 "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	제품 오퍼링 가격의 통화 코드입니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOfferingPrice.price.taxIncludedAmount.value	세금을 포함한 제품 오퍼링 가격입니다. 10진수 값(예: 123.45)을 사용합니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOfferingPrice.priceType	제품 오퍼링 유형의 유형입니다. 매개변수를 사용하는 경우 필수입니다 productOfferingPrice . 유효한 값은 다음과 같습니다. 비반복(일회성) 되풀이 데이터 유형: 문자열
productOfferingTerm (영문)	제품 오퍼링의 유효한 계약 기간(월)입니다. 데이터 유형: 문자열 기본값: 빈 문자열
제품 사양	필수 제품의 제품 사양입니다. 데이터 유형: 객체 "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] 테이블에 있습니다. 데이터 유형: 문자열
prodSpecCharValueUse (영문)	제품 오퍼링의 특성입니다. 데이터 형식: 객체 배열 "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 "productSpecCharacteristicValue": [ { "validFor": { "startDateTime": "String" }, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	특성이 유효한 날짜 및 시간입니다. 데이터 유형: 객체 "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	특성이 유효한 시작 날짜 및 시간입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열
prodSpecCharValueUse.description	특성에 대한 설명입니다. 데이터 유형: 문자열
prodSpecCharValueUse.name	필수 특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	특성의 종료 날짜 및 시간입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열
prodSpecCharValueUse.validFor.startDateTime	특성의 시작 날짜 및 시간입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열
prodSpecCharValueUse.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열
validFor	필수 제품 오퍼링이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	필수 제품 오퍼링의 종료 날짜 및 시간입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열
validFor.startDateTime	필수 제품 오퍼링의 시작 날짜 및 시간입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열
버전	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_version입니다. 데이터 유형: 문자열

응답 본문 매개변수(JSON)

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 52. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 53. 응답 헤더

헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/xml. 기본값: application/json

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 54. 상태 코드

상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON 또는 XML)

이름	설명
범주	제품이 속한 범주의 목록입니다. 데이터 형식: 객체 배열 "category:" [ { "id": "String", "name": "String" } ]
category.id	범주의 ID입니다. 데이터 유형: 문자열
category.name	범주의 이름입니다. 데이터 유형: 문자열
채널	제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 형식: 객체 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열
channel.id	유통 채널 [sn_prd_pm_distribution_channel] 테이블의 채널 Sys_id입니다. 데이터 유형: 문자열
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_id입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
id	필수. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 버전입니다. 데이터 유형: 문자열
마지막 업데이트	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
liftcycleStatus	현재 수명주기 상태를 나타냅니다. 허용되는 값: 활성 초안 비활성 데이터 유형: 문자열 기본값: 빈 문자열
이름	제품 오퍼링의 이름입니다. 데이터 유형: 문자열
제품특성	제품 특성 목록입니다. 데이터 형식: 객체 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
productCharacteristic.value (영문)	특성의 값입니다. 데이터 유형: 문자열
productOfferingPrice (영문)	제품 오퍼링에 대한 가격 정보입니다. 데이터 형식: 객체 배열 "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	제품 오퍼링 가격의 통화 코드입니다. 데이터 유형: 문자열
productOfferingPrice.price.taxIncludedAmount.value	세금을 포함한 제품 오퍼링 가격입니다. 데이터 유형: 문자열
productOfferingPrice.priceType	제품 오퍼링 가격 유형, 일회성 또는 반복 지불입니다. 가능한 값: 비반복(일회성) 되풀이 데이터 유형: 문자열
productOfferingTerm (영문)	제품 오퍼링의 유효한 계약 기간입니다. 데이터 유형: 문자열
제품 사양	제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	제품 사양의 initial_version입니다. 제품 사양 [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] 테이블에 있습니다. 데이터 유형: 문자열
prodSpecCharValueUse (영문)	제품 오퍼링 특성입니다. 데이터 형식: 객체 배열 "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object} "productSpecCharacteristicValue": [Array], "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 "productSpecCharacteristicValue": [ { "validFor": { "startDateTime": "String" }, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	특성이 유효한 날짜 및 시간입니다. 데이터 유형: 객체 "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	특성이 유효한 시작 날짜 및 시간입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열
prodSpecCharValueUse.description	특성에 대한 설명입니다. 데이터 유형: 문자열
prodSpecCharValueUse.name	특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	특성의 종료 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor.startDateTime	특성의 시작 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다.
validFor	제품 오퍼링이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	제품 오퍼링의 종료 날짜입니다. 데이터 유형: 문자열
validFor.startDateTime	제품 오퍼링의 시작 날짜입니다. 데이터 유형: 문자열
버전	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_version입니다. 데이터 유형: 문자열

cURL 요청

다음 예에서는 요청 본문에 제공된 정보를 사용하여 ID가 d6f8d9995b020210235d85cced81c7eb인 제품 오퍼링을 업데이트합니다.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "name": "Offering 1",
  "displayName": "Offering 1",
  "description": "Offering 1 desc",
  "lastUpdate": "2024-04-01 16:05:19",
  "version": "Offering 1 EXTV",
  "validFor": {
    "startDateTime": "2028-02-29",
    "endDateTime": "2033-03-30"
  },
  "productOfferingTerm": "12_months",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 632.1483
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 1264.2966
        }
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "internalVersion": "3"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2026-12-06 02:32:11"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "1 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "5 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "500 Mbps",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "internalVersion": "3"
      }
    }
  ],
  "channel": [
    {
      "id": "e561aae4c3e710105252716b7d40dd8f",
      "name": "Web"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ]
}'

응답 본문:

{
  "result": {
    "name": "Offering 1",
    "displayName": "Offering 1",
    "description": "Offering 1 desc",
    "lastUpdate": "2024-04-01 16:05:19",
    "version": "Offering 1 EXTV",
    "validFor": {
      "startDateTime": "2028-02-29",
      "endDateTime": "2033-03-30"
    },
    "productOfferingTerm": "12_months",
    "productOfferingPrice": [
      {
        "priceType": "recurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 632.1483
          }
        }
      },
      {
        "priceType": "nonRecurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 1264.2966
          }
        }
      }
    ],
    "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "internalVersion": "3",
      "sys_id": "79fa17da775131108e191e599a5a997b",
      "version": "",
      "status": "published",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
    },
    "prodSpecCharValueUse": [
      {
        "name": "Bandwidth",
        "description": "Bandwidth",
        "valueType": "choice",
        "validFor": {
          "startDatetime": "2026-12-06 02:32:11"
        },
        "productSpecCharacteristicValue": [
          {
            "value": "1 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "5 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "2 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "500 Mbps",
            "validFor": {
              "startDateTime": ""
            }
          }
        ],
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "internalVersion": "3",
          "version": "",
          "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
        }
      }
    ],
    "channel": [
      {
        "id": "e561aae4c3e710105252716b7d40dd8f",
        "name": "Web"
      }
    ],
    "category": [
      {
        "id": "13e305a143b631105029d1529ab8f267",
        "name": "SD-WAN_all_offers"
      }
    ],
    "href": "/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb"
  }
}

제품 카탈로그 Open API - PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}

지정된 제품 사양을 업데이트합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productSpecification/{id}

지원되는 요청 매개변수

표 55. 경로 매개변수

이름	설명
id	업데이트할 제품 오퍼링의 Sys_id입니다. 제품 사양[sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열

표 56. 쿼리 매개변수

이름	설명
없음

표 57. 요청 본문 매개변수(JSON)

이름	설명
설명	필수 사양에 대한 설명입니다. 데이터 유형: 문자열
externalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_id입니다. 데이터 유형: 문자열
id	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 버전입니다. 데이터 유형: 문자열
is번들	단일 제품 또는 제품 번들을 나타내는지 여부를 productSpecification 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 제품 사양이 제품 번들이며 여러 제품을 포함합니다. false: 제품 사양에 단일 제품이 포함되어 있습니다. 데이터 유형: 부울 기본값: false
마지막 업데이트	사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열
이름	필수 사양의 이름입니다. 데이터 유형: 문자열
제품 사양 특성	사양 특성. 데이터 형식: 객체 배열 "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	특성에 대한 설명입니다. 데이터 유형: 문자열
productSpecCharacteristic.name	필수 특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 "productSpecCharacteristicValue": [ { "validFor": { "startDateTime": "String" }, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	특성이 유효한 날짜 및 시간입니다. 데이터 유형: 객체 "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	특성이 유효한 시작 날짜 및 시간입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열
productSpecCharacteristic.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	특성의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열
productSpecCharacteristic.validFor.startDateTime	특성의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열
productSpecCharacteristic.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열
제품 사양 관계	이 사양과 다른 제품 사양의 관계입니다. 데이터 형식: 객체 배열 "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	관련 사양의 ID입니다. 데이터 유형: 문자열
productSpecificationRelationship.type	매개변수를 사용하는 경우 필수입니다 productSpecificationRelationship . 관계의 유형입니다. 유효한 값은 다음과 같습니다. 번들 composed_of 데이터 유형: 문자열
productSpecificationRelationship.validFor	관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	관계의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열
productSpecificationRelationship.validFor.startDateTime	관계의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열
resourceSpecification	필수 이 제품 사양과 관련된 자원 사양의 배열입니다. 데이터 형식: 객체 배열 "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	필수 자원 사양의 Initial_version 또는 external_id입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalId	자원 사양의 Initial_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalVersion	자원 사양의 버전입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.name	자원 사양의 이름입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.version	자원 사양의 External_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
서비스 사양	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 형식: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalId	서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.name	서비스 사양의 이름입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.version	서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
validFor	필수 사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	사양의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열
validFor.startDateTime	사양의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열
버전	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_version. 데이터 유형: 문자열

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 58. 요청 헤더

헤더	설명
컨텐츠-형식	요청 본문의 데이터 형식입니다. 지원되는 유형: application/json 또는 application/xml. 기본값: application/json

표 59. 응답 헤더

헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 60. 상태 코드

상태 코드	설명
200	요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 가능한 이유: 페이로드가 비어 있습니다. 잘못된 페이로드입니다. 필수 필드 누락: <필드 이름>
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON 또는 XML)

이름	설명
설명	사양에 대한 설명입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
id	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 버전입니다. 데이터 유형: 문자열
마지막 업데이트	사양이 마지막으로 업데이트된 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
이름	사양의 이름입니다. 데이터 유형: 문자열
제품 사양 특성	사양의 특성입니다. 데이터 형식: 객체 배열 "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	특성에 대한 설명입니다. 데이터 유형: 문자열
productSpecCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값을 포함하는 배열입니다. 데이터 형식: 개체 배열 "productSpecCharacteristicValue": [ { "validFor": { "startDateTime": "String" }, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	특성이 유효한 날짜 및 시간입니다. 데이터 유형: 객체 "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	특성이 유효한 시작 날짜 및 시간입니다. 형식: YYYY–MM–DD 00:00:00 데이터 유형: 문자열
productSpecCharacteristic.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	특성의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
productSpecCharacteristic.validFor.startDateTime	특성의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
productSpecCharacteristic.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열
제품 사양 관계	이 사양과 다른 제품 사양의 관계입니다. 데이터 형식: 객체 배열 "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	관련 사양의 Sys_id입니다. 데이터 유형: 문자열
productSpecificationRelationship.type	관계의 유형입니다. 데이터 유형: 문자열
productSpecificationRelationship.validFor	관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	종료 날짜 및 관계의 유형입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
productSpecificationRelationship.validFor.startDateTime	관계의 시작 날짜 및 유형입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
resourceSpecification	이 제품 사양과 관련된 자원 사양의 목록입니다. 데이터 형식: 객체 배열 "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	자원 사양의 Initial_version 또는 external_id입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalId	자원 사양의 Initial_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalVersion	자원 사양의 버전입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.name	자원 사양의 이름입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.version	자원 사양의 External_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
서비스 사양	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 형식: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalId	서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.name	서비스 사양의 이름입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.version	서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
validFor	사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	사양의 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
validFor.startDateTime	사양의 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
버전	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_version. 데이터 유형: 문자열

cURL 요청

다음 예제에서는 요청 본문에 제공된 정보를 사용하여 제품 사양 ID d6f8d9995b020210235d85cced81c7eb를 업데이트합니다.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/d6f8d9995b020210235d85cced81c7eb" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "id": "1001",
  "name": "SD-WAN 0322 test",
  "description": "This is my product specification ...",
  "validFor": {
    "startDateTime": "2017-06-19T00:00",
    "endDateTime": "2018-01-13T00:00"
  },
  "productSpecCharacteristic": [
    {
      "name": "New characteristic",
      "description": "This product has new spec characteristic.",
      "valueType": "label",
      "validFor": {
        "startDateTime": "2017-06-20T00:00"
      }
    }
  ],
  "serviceSpecification": [
    {
      "id": "e23ae2d01bb420106ba59acf034bcb56",
      "name": "IP Sec Tunnel",
      "internalVersion": "2"
    }
  ],
  "productSpecificationRelationship": [
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "internalVersion": "2",
      "type": "bundles",
      "validFor": {
        "startDateTime": "2017-06-16T00:00"
      }
    }
  ],
  "resourceSpecification": [
    {
      "id": "493fa60b536520103b6bddeeff7b12b6",
      "name": "Customer Premise SD-WAN Router"
    }
  ],
  "@type": "ProductSpecification"
}

응답 본문:

{
  "result": {
    "id": "1001",
    "name": "SD-WAN 0322 test",
    "description": "This is my product specification ...",
    "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
    },
    "productSpecCharacteristic": [
      {
        "name": "New characteristic",
        "description": "This product has new spec characteristic.",
        "valueType": "label",
        "validFor": {
          "startDateTime": "2017-06-20T00:00"
        }
      }
    ],
    "serviceSpecification": [
      {
        "id": "e23ae2d01bb420106ba59acf034bcb56",
        "name": "IP Sec Tunnel",
        "internalVersion": "2",
        "sys_id": "dd8354205b550210235d85cced81c7cd",
        "version": "",
        "status": "published",
        "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
    ],
    "productSpecificationRelationship": [
      {
        "id": "a6514bd3534560102f18ddeeff7b1247",
        "name": "SD-WAN Security",
        "internalVersion": "2",
        "type": "bundles",
        "validFor": {
          "startDateTime": "2017-06-16T00:00"
        },
        "sys_id": "7a491dd3776301108b2a1e599a5a99d3",
        "version": "",
        "status": "published",
        "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
    ],
    "resourceSpecification": [
      {
        "id": "493fa60b536520103b6bddeeff7b12b6",
        "name": "Customer Premise SD-WAN Router",
        "sys_id": "493fa60b536520103b6bddeeff7b12b6",
        "internalVersion": "1",
        "version": "",
        "status": "published",
        "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
    ],
    "@type": "ProductSpecification",
    "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/3d140fe85be1c210235d85cced81c73a"
  }
}

제품 카탈로그 오픈 API - POST /sn_tmf_api/catalogmanagement/catalog

제품 오퍼링 카탈로그를 만듭니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/catalog

지원되는 요청 매개변수

표 61. 경로 매개변수

이름	설명
없음

표 62. 쿼리 매개변수

이름	설명
없음

표 63. 요청 본문 매개변수(JSON)

이름	설명
설명	제품 오퍼링 카탈로그에 대한 설명입니다. 데이터 유형: 문자열 기본값: 빈 문자열
externalId	외부 시스템의 제품 오퍼링 카탈로그에 대한 고유 식별자입니다. 데이터 유형: 문자열 기본값: 빈 문자열
이름	필수 제품 오퍼링 카탈로그의 이름입니다. 데이터 유형: 문자열

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 64. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 65. 응답 헤더

헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 66. 상태 코드

상태 코드	설명
201	요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. 페이로드가 비어 있습니다. 잘못된 페이로드입니다. 필수 필드 누락: <필드 이름>

응답 본문 매개변수(JSON)

이름	설명
설명	제품 오퍼링 카탈로그에 대한 설명입니다. 데이터 유형: 문자열
id	제품 오퍼링 카탈로그 [sn_prd_pm_product_offering_catalog] 테이블의 제품 오퍼링 카탈로그 Sys_id입니다. 데이터 유형: 문자열
이름	제품 오퍼링 카탈로그의 이름입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 제품 오퍼링 카탈로그를 만듭니다.

curl --location --request POST "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--header "Content-Type: application/json" \
--data-raw '{
    "id": "testId",
    "name": "Catalog",
    "description": "Description"
}'
--user 'username':'password'

응답 본문입니다.

{
   "id": "45715d02c3510110bc0526083c40dd6b",
   "description": "Description",
   "name": "Catalog1"
}

제품 카탈로그 오픈 API - POST /sn_tmf_api/catalogmanagement/productOffering

제품 오퍼링을 생성합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productOffering

지원되는 요청 매개변수

표 67. 경로 매개변수

이름	설명
없음

표 68. 쿼리 매개변수

이름	설명
없음

표 69. 요청 본문 매개변수(JSON)

이름	설명
범주	제품이 속한 범주의 목록입니다. 범주 [sc_category] 테이블에 있습니다. 데이터 형식: 객체 배열 "category:" [ { "id": "String", "name": "String" } ]
category.id	매개변수를 사용하는 경우 필수입니다 category . 범주의 ID입니다. 데이터 유형: 문자열
category.name	범주의 이름입니다. 데이터 유형: 문자열
채널	필수 제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 유형: 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열
channel.id	필수 유통 채널 [sn_prd_pm_distribution_channel] 테이블의 채널 Sys_id입니다. 데이터 유형: 문자열
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	필수 제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	외부 시스템의 제품 오퍼링에 대한 고유 식별자입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
id	필수 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 Initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 버전입니다. 데이터 유형: 문자열
마지막 업데이트	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
lifecycleStatus	현재 수명주기 상태를 나타냅니다. 허용되는 값: 활성 비활성 초안 데이터 유형: 문자열
이름	필수 제품 오퍼링의 이름입니다. 데이터 유형: 문자열
제품특성	제품 특성 목록입니다. 데이터 형식: 객체 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
productCharacteristic.value (영문)	특성의 값입니다. 데이터 유형: 문자열
productOfferingPrice (영문)	제품 오퍼링에 대한 가격 정보입니다. 데이터 형식: 객체 배열 "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	제품 오퍼링 가격의 통화 코드 입니다. 데이터 유형: 문자열
productOfferingPrice.price.taxIncludedAmount.value	세금을 포함한 제품 오퍼링 가격입니다. 데이터 유형: 문자열
productOfferingPrice.priceType	매개변수를 사용하는 경우 필수입니다 productOfferingPrice . 제품 오퍼링 가격 유형, 일회성 또는 반복 지불입니다. 유효한 값은 다음과 같습니다. 비반복(일회성) 되풀이 데이터 유형: 문자열
productOfferingTerm (영문)	제품 오퍼링의 유효한 계약 기간입니다. 데이터 유형: 문자열
제품 사양	필수 제품의 제품 사양입니다. 데이터 유형: 객체 "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] 테이블에 있습니다. 데이터 유형: 문자열
prodSpecCharValueUse (영문)	제품 오퍼링 특성입니다. 데이터 형식: 객체 배열 "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	필수 특성의 가능한 값 목록입니다. 데이터 형식: 객체 배열 "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	필수 특성의 값입니다. 데이터 유형: 문자열
prodSpecCharValueUse.description	특성에 대한 설명입니다. 데이터 유형: 문자열
prodSpecCharValueUse.name	필수 특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	특성의 종료 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor.startDateTime	특성의 시작 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열
validFor	필수 제품 오퍼링이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	제품 오퍼링의 종료 날짜입니다. 데이터 유형: 문자열
validFor.startDateTime	제품 오퍼링의 시작 날짜입니다. 데이터 유형: 문자열
버전	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_version입니다. 데이터 유형: 문자열

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 70. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 71. 응답 헤더

헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 72. 상태 코드

상태 코드	설명
201	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 가능한 이유: 페이로드가 비어 있습니다. 잘못된 페이로드입니다. 필수 필드 누락: <필드 이름>

응답 본문 매개변수(JSON)

이름	설명
범주	제품이 속한 범주의 목록입니다. 데이터 유형: 배열 "category:" [ { "id": "String", "name": "String" } ]
category.id	범주의 ID입니다. 데이터 유형: 문자열
category.name	범주의 이름입니다. 데이터 유형: 문자열
채널	제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 형식: 객체 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열
channel.id	유통 채널 [sn_prd_pm_distribution_channel] 테이블의 채널 Sys_id입니다. 데이터 유형: 문자열
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_id입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
id	필수. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 버전입니다. 데이터 유형: 문자열
마지막 업데이트	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
lifecycleStatus	제품 오퍼링의 현재 수명주기 상태입니다. 허용되는 값: 활성 비활성 초안 데이터 유형: 문자열 기본값: 빈 문자열
이름	제품 오퍼링의 이름입니다. 데이터 유형: 문자열
제품특성	제품 특성 목록입니다. 데이터 형식: 객체 배열 "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
productCharacteristic.value (영문)	특성의 값입니다. 데이터 유형: 문자열
productOfferingPrice (영문)	제품 오퍼링에 대한 가격 정보입니다. 데이터 형식: 객체 배열 "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	제품 오퍼링에 대한 가격 정보입니다. 데이터 유형: 객체 "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	제품 오퍼링 가격의 통화 코드입니다. 데이터 유형: 문자열
productOfferingPrice.price.taxIncludedAmount.value	세금을 포함한 제품 오퍼링 가격입니다. 데이터 유형: 문자열
productOfferingPrice.priceType	제품 오퍼링 가격 유형, 일회성 또는 반복 지불입니다. 가능한 값: 비반복(일회성) 되풀이 데이터 유형: 문자열
productOfferingTerm (영문)	제품 오퍼링의 유효한 계약 기간입니다. 데이터 유형: 문자열
제품 사양	제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	제품 사양의 initial_version입니다. 제품 사양 [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] 테이블에 있습니다. 데이터 유형: 문자열
prodSpecCharValueUse (영문)	제품 오퍼링 특성입니다. 데이터 형식: 객체 배열 "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값 목록입니다. 데이터 형식: 객체 배열 "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
prodSpecCharValueUse.description	특성에 대한 설명입니다. 데이터 유형: 문자열
prodSpecCharValueUse.name	특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	특성의 종료 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.validFor.startDateTime	특성의 시작 날짜입니다. 데이터 유형: 문자열
prodSpecCharValueUse.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열
validFor	제품 오퍼링이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	제품 오퍼링의 종료 날짜입니다. 데이터 유형: 문자열
validFor.startDateTime	제품 오퍼링의 시작 날짜입니다. 데이터 유형: 문자열
버전	제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 제품 오퍼링 external_version입니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 제품 오퍼링을 생성합니다.

curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering" \
--header "Content-Type: application/json" \
--data-raw '{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": "",
   "internalVersion": "2",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " 39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}'
--user 'username':'password'

응답 본문:

{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": null,
   "internalVersion": "5",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": null,
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": null,
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": null,
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   },
   "internalId": "fbc1c0a25b030110235d85cced81c724",
   "externalId": "d52a756b5bde0110235d85cced81c7ab"
}

제품 카탈로그 Open API - POST /sn_tmf_api/catalogmanagement/productSpecification

제품 사양을 작성합니다.

URL 형식

기본 URL: /api/sn_tmf_api/catalogmanagement/productSpecification

지원되는 요청 매개변수

표 73. 경로 매개변수

이름	설명
없음

표 74. 쿼리 매개변수

이름	설명
없음

표 75. 요청 본문 매개변수(JSON)

이름	설명
설명	필수 사양에 대한 설명입니다. 데이터 유형: 문자열
externalId	외부 시스템의 제품 사양에 대한 고유 식별자입니다. 데이터 유형: 문자열 기본값: 빈 문자열
id	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 버전입니다. 데이터 유형: 문자열
마지막 업데이트	사양이 마지막으로 업데이트된 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열 기본값: 빈 문자열
이름	필수 사양의 이름입니다. 데이터 유형: 문자열
제품 사양 특성	사양 특성. 데이터 유형: 배열 "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	특성에 대한 설명입니다. 데이터 유형: 문자열 기본값: 빈 문자열
productSpecCharacteristic.name	필수 특성의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic.productSpecCharacteristicValue	필수 특성의 가능한 값을 포함하는 배열입니다. 데이터 유형: 배열 "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	필수 특성의 값입니다. 데이터 유형: 문자열
productSpecCharacteristic.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	특성의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열 기본값: 빈 문자열
productSpecCharacteristic.validFor.startDateTime	특성의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열 기본값: 빈 문자열
productSpecCharacteristic.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열 기본값: 빈 문자열
제품 사양 관계	이 사양과 다른 제품 사양의 관계입니다. 데이터 유형: 배열 "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	관련 사양의 ID입니다. 데이터 유형: 문자열 기본값: 빈 문자열
productSpecificationRelationship.type	매개변수를 사용하는 경우 필수입니다 productSpecificationRelationship . 관계의 유형입니다. 유효한 값은 다음과 같습니다. composed_of 번들 데이터 유형: 문자열
productSpecificationRelationship.validFor	관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	관계의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열 기본값: 빈 문자열
productSpecificationRelationship.validFor.startDateTime	관계의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열 기본값: 빈 문자열
resourceSpecification	필수 이 제품 사양과 관련된 자원 사양의 배열입니다. 데이터 유형: 배열 "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	필수 자원 사양의 initial_version 또는 external_id입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalId	자원 사양의 Initial_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalVersion	자원 사양의 버전입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.name	자원 사양의 이름입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.version	자원 사양의 External_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
서비스 사양	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 형식: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalId	서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.name	서비스 사양의 이름입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.version	서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
validFor	필수 사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	사양의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열 기본값: 빈 문자열
validFor.startDateTime	사양의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 데이터 유형: 문자열 기본값: 빈 문자열
버전	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_version. 데이터 유형: 문자열

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 76. 요청 헤더

헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 77. 응답 헤더

헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 78. 상태 코드

상태 코드	설명
201	요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 가능한 이유: 페이로드가 비어 있습니다. 잘못된 페이로드입니다. 필수 필드 누락: <필드 이름>

응답 본문 매개변수(JSON)

이름	설명
설명	사양에 대한 설명입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
id	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version 또는 external_id입니다. 데이터 유형: 문자열
internalId	필수 제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 Initial_version입니다. 데이터 유형: 문자열
internalVersion	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 버전입니다. 데이터 유형: 문자열
is번들	단일 제품 또는 제품 번들을 나타내는지 여부를 productSpecification 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 제품 사양이 제품 번들이며 여러 제품을 포함합니다. false: 제품 사양에 단일 제품이 포함되어 있습니다. 데이터 유형: 부울 기본값: false
마지막 업데이트	사양이 마지막으로 업데이트된 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
lifecycleStatus	제품 사양의 현재 수명주기 상태입니다. 가능한 값: 활성 비활성 초안 데이터 유형: 문자열 기본값: 빈 문자열
이름	사양의 이름입니다. 데이터 유형: 문자열
제품 사양 특성	사양 특성. 데이터 유형: 배열 "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	특성에 대한 설명입니다. 데이터 유형: 문자열
productSpecCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic.productSpecCharacteristicValue	특성의 가능한 값을 포함하는 배열입니다. 데이터 유형: 배열 "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	특성의 값입니다. 데이터 유형: 문자열
productSpecCharacteristic.validFor	특성이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	특성의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
productSpecCharacteristic.validFor.startDateTime	특성의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
productSpecCharacteristic.valueType	특성의 값 유형(예: 선택 또는 이메일)입니다. 데이터 유형: 문자열
제품 사양 관계	이 사양과 다른 제품 사양의 관계입니다. 데이터 유형: 배열 "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	관련 사양의 Sys_id입니다. 데이터 유형: 문자열
productSpecificationRelationship.type	관계의 유형입니다. 데이터 유형: 문자열
productSpecificationRelationship.validFor	관계가 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	관계의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
productSpecificationRelationship.validFor.startDateTime	관계의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
resourceSpecification	이 제품 사양과 관련된 자원 사양의 목록입니다. 데이터 형식: 객체 배열 "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	자원 사양의 Initial_version 또는 external_id입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalId	자원 사양의 Initial_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.internalVersion	자원 사양의 버전입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.name	자원 사양의 이름입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
resourceSpecification.version	자원 사양의 External_version입니다. 자원 사양 [sn_prd_pm_resource_specification] 테이블에 있습니다. 데이터 유형: 문자열
서비스 사양	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 형식: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 Initial_version 또는 external_id입니다. 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalId	서비스 사양의 Initial_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.name	서비스 사양의 이름입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
serviceSpecification.version	서비스 사양의 External_version입니다. 서비스 사양[sn_prd_pm_service_specification] 테이블에 있습니다. 데이터 유형: 문자열
validFor	사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "validFor": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	사양의 종료 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
validFor.startDateTime	사양의 시작 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
버전	제품 사양 [sn_prd_pm_product_specification] 테이블의 제품 사양 External_version. 데이터 유형: 문자열

cURL 요청

이 예에서는 제품 사양을 생성합니다.

curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--header "Content-Type: application/json" \
--data-raw '{
   "name": "SD-WAN My Device",
   "description": "This is my product specification ...",
   "internalId": "1c3c9a325bc34110235d85cced81c7d5",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "label",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router"
      }
   ]
}'
--user 'username':'password'

응답 본문입니다.

{
   "id": "exter123",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalId": "63c3d946745d8150f877ca57242ff918",
   "description": "This is my product specification ...",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         },
         "valid": true,
         "version": "v1",
         "internalVersion": "1",
         "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ]
}