제품 카탈로그 개방형 API

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

이 API를 사용하여 외부 시스템과 Now Platform. Product Catalog Open API는 ServiceNow® TM Forum Product Catalog Management API REST 사양을 구현한 것입니다. 이 구현은 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 - 삭제 /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"

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

특정 sys_id가 있는 가격 목록 라인을 비활성화하지만 삭제하지는 않습니다.

가격표 라인을 비활성 상태로 설정하기 위해 이 DELETE 메서드는 가격표 라인의 종료 날짜를 오늘 날짜로 업데이트합니다. 종료 날짜가 오늘 날짜 이전인 가격 목록 라인도 비활성 상태로 간주됩니다. 비활성 가격 목록 라인은 관련 GET 메서드에서 검색할 수 없습니다.

URL 형식

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

지원되는 요청 매개변수

표 7. 경로 매개변수

이름	설명
ID	삭제할 가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열

표 8. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
안 함

머리글

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

표 10. 요청 헤더

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

표 11. 응답 헤더

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

상태 코드

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

표 12. 상태 코드

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

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

이름	설명
메시지	가격 목록 라인의 비활성화 성공 또는 실패에 대한 메시지가 포함된 상태 코드입니다.

cURL 요청

다음 예제에서는 지정된 sys_id 994d의 가격 목록을 성공적으로 비활성화하거나 삭제하는 방법을 보여 줍니다.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request DELETE\
--user 'username':'password'

응답. 응답은 성공적인 비활성화에 대한 세부 정보가 포함된 200 상태 코드를 반환합니다.

Status: 200 OK
"The price list line (994d5d364f8b5210f899f61d20ce0b7c) is inactive successfully"

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

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

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

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

URL 형식

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

지원되는 요청 매개변수

표 13. 경로 매개변수

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

표 14. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
안 함

머리글

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

표 16. 요청 헤더

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

표 17. 응답 헤더

헤더	설명
없음

상태 코드

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

표 18. 상태 코드

상태 코드	설명
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"

Product Catalog Open API - GET /sn_tmf_api/catalogmanagement/catalog

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

URL 형식

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

지원되는 요청 매개변수

표 19. 경로 매개변수

이름	설명
없음

표 20. 쿼리 매개변수

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

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

이름	설명
안 함

머리글

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

표 22. 요청 헤더

헤더	설명
없음

표 23. 응답 헤더

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

상태 코드

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

표 24. 상태 코드

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

응답 본문 매개변수(JSON)

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

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"
    }
]

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

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

URL 형식

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

지원되는 요청 매개변수

표 25. 경로 매개변수

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

표 26. 쿼리 매개변수

이름	설명
필드	응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 데이터 유형: 문자열 기본값: 모든 필드

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

이름	설명
안 함

머리글

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

표 28. 요청 헤더

헤더	설명
안 함

표 29. 응답 헤더

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

상태 코드

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

표 30. 상태 코드

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

응답 본문 매개변수(JSON)

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

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"
}

제품 카탈로그 개방형 API - GET /sn_tmf_api/catalogmanagement/productOffering

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

URL 형식

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

지원되는 요청 매개변수

표 31. 경로 매개변수

이름	설명
없음

표 32. 쿼리 매개변수

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

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

이름	설명
안 함

머리글

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

표 34. 요청 헤더

헤더	설명
없음

표 35. 응답 헤더

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

상태 코드

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

표 36. 상태 코드

상태 코드	설명
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	채널의 Sys_id입니다. 데이터 유형: 문자열 표: 유통 채널 [sn_prd_pm_distribution_channel]
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링의 외부 ID 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_id 필드
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
ID	필수 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드
internalId	제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
내부 버전	제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
lastUpdate	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
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	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalId	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalVersion	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
productSpecification.version	제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드
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": { "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"
      }
   }
]

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

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

URL 형식

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

지원되는 요청 매개변수

표 37. 경로 매개변수

이름	설명
ID	검색할 제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드

표 38. 쿼리 매개변수

이름	설명
필드	응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: 범주 채널 설명 externalId ID internalId 내부 버전 lastUpdate 이름 제품 특성 productOfferingPrice productOfferingTerm 제품 사양 prodSpecCharValueUse 유효한대상 버전 데이터 유형: 문자열 기본값: 모든 필드가 반환됩니다.
사양	제품 사양 sys_id별로 제품 오퍼링을 필터링합니다. 지정된 제품 사양 sys_id 있는 제품 오퍼링만 응답에 반환됩니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification]
상태	상태별로 제품 오퍼링을 필터링합니다. 지정된 상태의 제품 오퍼링만 응답에 반환됩니다. 유효한 값은 다음과 같습니다. 보관됨 초안 게시됨 폐기됨 데이터 유형: 문자열

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

이름	설명
안 함

머리글

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

표 40. 요청 헤더

헤더	설명
안 함

표 41. 응답 헤더

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

상태 코드

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

표 42. 상태 코드

상태 코드	설명
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	채널의 Sys_id입니다. 데이터 유형: 문자열 표: 유통 채널 [sn_prd_pm_distribution_channel]
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링의 외부 ID 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_id 필드
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
ID	필수 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드
internalId	제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
내부 버전	제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
lastUpdate	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
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	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalId	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalVersion	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
productSpecification.version	제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드
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": { "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"
   }
}

제품 카탈로그 개방형 API - GET /sn_tmf_api/catalogmanagement/productOfferingPrice

인스턴스의 모든 가격표 라인 기록을 조회합니다.

URL 형식

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

지원되는 요청 매개변수

표 43. 경로 매개변수

이름	설명
안 함

표 44. 쿼리 매개변수

이름	설명
lastUpdate	가격 라인이 마지막으로 업데이트된 날짜를 기준으로 결과를 필터링합니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열
이름	지정된 가격 목록의 이름에 속하는 가격 목록 라인을 필터링합니다. 표: 가격 목록 [sn_csm_pricing_price_list] 데이터 유형: 문자열
가격.값	특정 목록 가격 값을 기준으로 결과를 필터링합니다. 데이터 유형: 문자열
priceList.id	지정된 sys_id 있는 가격 목록만 반환하도록 결과를 필터링합니다. 표: 가격 목록 [sn_csm_pricing_price_list] 데이터 유형: 문자열
priceType	제품 오퍼링의 가격 책정 방법을 기준으로 결과를 필터링합니다. 유효한 값은 다음과 같습니다. 반복: 기업이 지정된 빈도로 반복되는 가격 책정 금액을 청구할 수 있습니다. one_time: 제품 오퍼링에 대한 일회성 또는 반복 추가 과금 및 수수료를 지원합니다. 데이터 유형: 문자열
productOffering.id	제품 오퍼링의 sys_id 기준으로 가격 목록 라인을 필터링합니다. 테이블: 제품 오퍼링[sn_prd_pm_product_offering] 데이터 유형: 문자열
unitOfMeasure.id	측정 단위의 sys_id 기준으로 가격 목록 라인을 필터링합니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
validFor.endDateTime	지정된 종료 날짜 및 시간을 기준으로 가격 목록 라인을 필터링합니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열
validFor.startDateTime	지정된 시작 날짜 및 시간을 기준으로 가격 목록 라인을 필터링합니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열

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

이름	설명
안 함

머리글

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

표 46. 요청 헤더

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

표 47. 응답 헤더

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

상태 코드

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

표 48. 상태 코드

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

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

이름	설명
@type	가격 목록 라인의 유형입니다. 항상 ProductOfferingPrice의 값입니다. 데이터 유형: 문자열
href	인스턴스의 가격 목록 라인 기록에 대한 URL입니다. 데이터 유형: 문자열
ID	가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
isBundle	가격 목록 라인이 단일 제품의 일부인지 또는 제품 번들의 일부인지를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. True: 가격 목록 라인이 번들의 일부입니다. false: 가격 목록 라인이 번들의 일부가 아닙니다. 데이터 유형: 부울
lastUpdate	가격 목록 라인이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열
lifecycleStatus	가격 목록 라인의 현재 수명주기 상태입니다. 유효한 값은 다음과 같습니다. 활성 초안 비활성 데이터 유형: 문자열
가격	가격 목록 라인의 목록 가격 상세 정보입니다. 데이터 유형: 객체 "price": { "units": "String", "value": "String" }
가격.단위	가격의 통화 코드입니다. 예: USD 또는 EUR. 테이블: 통화 [fx_currency] 데이터 유형: 문자열
가격.값	가격의 값입니다. 데이터 유형: 문자열(숫자로 표시)
priceList	가격 목록 라인과 연결된 가격 목록 정보입니다. 데이터 유형: 객체 "priceList": { "id": "String", "name": "String", "@type": "String" }
priceList.id	가격 목록 [sn_csm_pricing_price_list] 테이블의 가격 목록 Sys_id입니다. 데이터 유형: 문자열
priceList.name	가격 목록의 이름입니다. 데이터 유형: 문자열
priceList.@type	가격 목록의 유형입니다. 하위 클래싱할 때 하위 클래스 확장 가능한 이름을 정의합니다. 항상 priceList 값을 갖습니다. 데이터 유형: 문자열
priceType	이 가격 목록 라인과 연결된 제품 오퍼링의 가격 책정 방법입니다. 가능한 값: 반복: 지정된 빈도로 반복되는 가격 책정 금액을 청구합니다. 값은 recurringChargePeriodType 과금 빈도를 나타냅니다. one_time: 제품 오퍼링에 대한 일회성 또는 반복 추가 과금 및 수수료입니다. 데이터 유형: 문자열
productOffering	가격 목록 라인과 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
productOffering.id	제품 오퍼링의 Sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
productOffering.internalVersion	제품 오퍼링의 내부 버전 번호입니다. 예를 들면 PRDOF01024. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
productOffering.name	제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
recurringChargePeriodType	이 가격 목록 라인과 연결된 제품 오퍼링의 주기 또는 빈도입니다. 반복으로 설정된 경우 priceType 빈도 유형을 반환하고, 그렇지 않으면 빈 문자열을 반환합니다. 가능한 값: 매년 월별 데이터 유형: 문자열
측정 단위	가격 목록 라인과 연결된 측정 단위에 대한 상세 정보입니다. 데이터 유형: 객체 "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
unitOfMeasure.amount	측정 단위의 금액입니다. 데이터 유형: 숫자
unitOfMeasure.id	측정 단위의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
unitOfMeasure.units	가격 목록 라인과 연결된 측정 단위의 유형입니다. 예를 들어, 연도 또는 번들입니다. 데이터 유형: 문자열
유효한대상	가격 목록 라인이 유효한 기간입니다. 데이터 유형: 객체 "validFor": { "endDate": "String", "startDate": "String" }
validFor.endDate	가격 목록 라인이 유효한 종료 날짜 및 시간입니다. 데이터 유형: 문자열(glide_date_time)
validFor.startDate	가격 목록 라인이 유효한 시작 날짜 및 시간입니다. 데이터 유형: 문자열(glide_date_time)

cURL 요청

다음 예에서는 인스턴스에 있는 두 개의 가격표 라인을 모두 반환합니다.

curl "http://instance.servicenow.com/api/sn_tmf_api/ catalogmanagement/productOfferingPrice " \
--request GET\
--user 'username':'password'

응답 본문.

[
  {
    "id": "2c4628ac7f4f9e50f8994fa63c86653c",
    "name": "new Price list",
    "lastUpdate": "2025-01-08 19:57:28",
    "isBundle": false,
    "lifecycleStatus": "Draft",
    "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/2c4628ac7f4f9e50f8994fa63c86653c",
    "validFor": {
      "startDateTime": "2027-03-22 22:15:58",
      "endDateTime": ""
    },
    "productOffering": {
      "id": "f2c92ac6a5260210f8774c9b4be6ce56",
      "name": "Managed Connectivity Services Supreme Bundle",
      "internalVersion": "1"
    },
    "priceType": "one_time",
    "recurringChargePeriodType": "",
    "unitOfMeasure": {
      "id": "9a7a119953020110286eddeeff7b1238",
      "amount": 1,
      "units": "Month"
    },
    "price": {
      "units": "USD",
      "value": "800"
    },
    "priceList": {
      "id": "d653246c7f4f9e50f8994fa63c86655a",
      "name": "new Price list",
      "@type": "priceList"
    },
    "@type": "ProductOfferingPrice"
  },
  {
    "id": "dfb7ec607f8f9e50f8994fa63c866569",
    "name": "new Price list",
    "lastUpdate": "2025-01-08 19:57:46",
    "isBundle": false,
    "lifecycleStatus": "Draft",
    "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
    "validFor": {
      "startDateTime": "2026-05-28 22:15:58",
      "endDateTime": ""
    },
    "productOffering": {
      "id": "f2c92ac6a5260210f8774c9b4be6ce56",
      "name": "Managed Connectivity Services Supreme Bundle",
      "internalVersion": "1"
    },
    "priceType": "one_time",
    "recurringChargePeriodType": "",
    "unitOfMeasure": {
      "id": "1eaa559953020110286eddeeff7b12c7",
      "amount": 1,
      "units": "Year"
    },
    "price": {
      "units": "USD",
      "value": "800"
    },
    "priceList": {
      "id": "d653246c7f4f9e50f8994fa63c86655a",
      "name": "new Price list",
      "@type": "priceList"
    },
    "@type": "ProductOfferingPrice"
  }
]

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

특정 가격 목록 라인에 대한 상세 정보를 검색합니다.

URL 형식

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

지원되는 요청 매개변수

표 49. 경로 매개변수

이름	설명
ID	필수 검색할 가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열

표 50. 쿼리 매개변수

이름	설명
lastUpdate	가격 라인이 마지막으로 업데이트된 날짜를 기준으로 결과를 필터링합니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열
이름	지정된 가격 목록의 이름에 속하는 가격 목록 라인을 필터링합니다. 표: 가격 목록 [sn_csm_pricing_price_list] 데이터 유형: 문자열
가격.값	특정 목록 가격 값을 기준으로 결과를 필터링합니다. 데이터 유형: 문자열
priceList.id	지정된 sys_id 있는 가격 목록만 반환하도록 결과를 필터링합니다. 표: 가격 목록 [sn_csm_pricing_price_list] 데이터 유형: 문자열
priceType	제품 오퍼링의 가격 책정 방법을 기준으로 결과를 필터링합니다. 유효한 값은 다음과 같습니다. 반복: 기업이 지정된 빈도로 반복되는 가격 책정 금액을 청구할 수 있습니다. one_time: 제품 오퍼링에 대한 일회성 또는 반복 추가 과금 및 수수료를 지원합니다. 데이터 유형: 문자열
productOffering.id	제품 오퍼링의 sys_id 기준으로 가격 목록 라인을 필터링합니다. 테이블: 제품 오퍼링[sn_prd_pm_product_offering] 데이터 유형: 문자열
unitOfMeasure.id	측정 단위의 sys_id 기준으로 가격 목록 라인을 필터링합니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
validFor.endDateTime	지정된 종료 날짜 및 시간을 기준으로 가격 목록 라인을 필터링합니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열
validFor.startDateTime	지정된 시작 날짜 및 시간을 기준으로 가격 목록 라인을 필터링합니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열

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

이름	설명
안 함

머리글

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

표 52. 요청 헤더

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

표 53. 응답 헤더

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

상태 코드

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

표 54. 상태 코드

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

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

이름	설명
@type	가격 목록 라인의 유형입니다. 항상 ProductOfferingPrice의 값입니다. 데이터 유형: 문자열
href	인스턴스의 가격 목록 라인 기록에 대한 URL입니다. 데이터 유형: 문자열
ID	가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
isBundle	가격 목록 라인이 단일 제품의 일부인지 또는 제품 번들의 일부인지를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. True: 가격 목록 라인이 번들의 일부입니다. false: 가격 목록 라인이 번들의 일부가 아닙니다. 데이터 유형: 부울
lastUpdate	가격 목록 라인이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열
lifecycleStatus	가격 목록 라인의 현재 수명주기 상태입니다. 유효한 값은 다음과 같습니다. 활성 초안 비활성 데이터 유형: 문자열
가격	가격 목록 라인의 목록 가격 상세 정보입니다. 데이터 유형: 객체 "price": { "units": "String", "value": "String" }
가격.단위	가격의 통화 코드입니다. 예: USD 또는 EUR. 테이블: 통화 [fx_currency] 데이터 유형: 문자열
가격.값	가격의 값입니다. 데이터 유형: 문자열(숫자로 표시)
priceList	가격 목록 라인과 연결된 가격 목록 정보입니다. 데이터 유형: 객체 "priceList": { "id": "String", "name": "String", "@type": "String" }
priceList.id	가격 목록 [sn_csm_pricing_price_list] 테이블의 가격 목록 Sys_id입니다. 데이터 유형: 문자열
priceList.name	가격 목록의 이름입니다. 데이터 유형: 문자열
priceList.@type	가격 목록의 유형입니다. 하위 클래싱할 때 하위 클래스 확장 가능한 이름을 정의합니다. 항상 priceList 값을 갖습니다. 데이터 유형: 문자열
priceType	이 가격 목록 라인과 연결된 제품 오퍼링의 가격 책정 방법입니다. 가능한 값: 반복: 지정된 빈도로 반복되는 가격 책정 금액을 청구합니다. 값은 recurringChargePeriodType 과금 빈도를 나타냅니다. one_time: 제품 오퍼링에 대한 일회성 또는 반복 추가 과금 및 수수료입니다. 데이터 유형: 문자열
productOffering	가격 목록 라인과 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
productOffering.id	제품 오퍼링의 Sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
productOffering.internalVersion	제품 오퍼링의 내부 버전 번호입니다. 예를 들면 PRDOF01024. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
productOffering.name	제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
recurringChargePeriodType	이 가격 목록 라인과 연결된 제품 오퍼링의 주기 또는 빈도입니다. 반복으로 설정된 경우 priceType 빈도 유형을 반환하고, 그렇지 않으면 빈 문자열을 반환합니다. 가능한 값: 매년 월별 데이터 유형: 문자열
측정 단위	가격 목록 라인과 연결된 측정 단위에 대한 상세 정보입니다. 데이터 유형: 객체 "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
unitOfMeasure.amount	측정 단위의 금액입니다. 데이터 유형: 숫자
unitOfMeasure.id	측정 단위의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
unitOfMeasure.units	가격 목록 라인과 연결된 측정 단위의 유형입니다. 예를 들어, 연도 또는 번들입니다. 데이터 유형: 문자열
유효한대상	가격 목록 라인이 유효한 기간입니다. 데이터 유형: 객체 "validFor": { "endDate": "String", "startDate": "String" }
validFor.endDate	가격 목록 라인이 유효한 종료 날짜 및 시간입니다. 데이터 유형: 문자열(glide_date_time)
validFor.startDate	가격 목록 라인이 유효한 시작 날짜 및 시간입니다. 데이터 유형: 문자열(glide_date_time)

cURL 요청

다음 예에서는 ID가 dfb7ec60...

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569" \
--request GET\
--user 'username':'password'

응답.

{
  "id": "dfb7ec607f8f9e50f8994fa63c866569",
  "name": "new Price list",
  "lastUpdate": "2025-01-08 19:57:46",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
  "validFor": {
    "startDateTime": "2026-05-28 22:15:58",
    "endDateTime": ""
  },
  "productOffering": {
    "id": "f2c92ac6a5260210f8774c9b4be6ce56",
    "name": "Managed Connectivity Services Supreme Bundle",
    "internalVersion": "1"
  },
  "priceType": "one_time",
  "recurringChargePeriodType": "",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "units": "USD",
    "value": "800"
  },
  "priceList": {
    "id": "d653246c7f4f9e50f8994fa63c86655a",
    "name": "new Price list",
    "@type": "priceList"
  },
  "@type": "ProductOfferingPrice"
}

제품 카탈로그 개방형 API - GET /sn_tmf_api/catalogmanagement/productSpecification

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

URL 형식

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

지원되는 요청 매개변수

표 55. 경로 매개변수

이름	설명
없음

표 56. 쿼리 매개변수

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

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

이름	설명
안 함

머리글

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

표 58. 요청 헤더

헤더	설명
없음

표 59. 응답 헤더

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

상태 코드

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

표 60. 상태 코드

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

응답 본문 매개변수(JSON)

이름	설명
설명	사양에 대한 설명입니다. 데이터 유형: 문자열
externalId	필수 제품 사양의 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 external_id 필드
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
ID	제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 또는 external_id 필드
internalId	필수 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드
내부 버전	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드
isBundle	단일 제품 또는 제품 번들을 나타내는지 여부를 productSpecification 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 제품 사양이 제품 번들이며 여러 제품을 포함합니다. false: 제품 사양에 단일 제품이 포함되어 있습니다. 데이터 유형: 부울 기본값: false
lastUpdate	사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
lifecycleStatus	제품 사양의 현재 수명주기 상태입니다. 허용되는 값: 활성 비활성 초안 데이터 유형: 문자열 기본값: 빈 문자열
이름	사양의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic	사양 특성. 데이터 유형: 객체 배열 "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	이 사양과 다른 제품 사양의 관계입니다. 데이터 유형: 객체 배열 "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	자원 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드
resourceSpecification.internalId	자원 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 initial_version 필드
resourceSpecification.internalVersion	자원 사양의 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 버전 필드
resourceSpecification.name	자원 사양의 이름입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification]
resourceSpecification.version	자원 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 external_version 필드
serviceSpecification	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 유형: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드
serviceSpecification.internalId	서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드
serviceSpecification.name	서비스 사양의 이름입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification]
serviceSpecification.version	서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드
유효한대상	사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "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"
                  }
               }
            ]
         }
      ]
   }
]

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

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

URL 형식

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

지원되는 요청 매개변수

표 61. 경로 매개변수

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

표 62. 쿼리 매개변수

이름	설명
필드	응답에서 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 유효한 필드: 설명 externalId ID internalId 내부 버전 lastUpdate 이름 productSpecCharacteristic productSpecificationRelationship resourceSpecification serviceSpecification 유효한대상 버전 데이터 유형: 문자열 기본값: 모든 필드가 반환됩니다.
상태	상태별로 제품 사양을 필터링합니다. 지정된 상태의 제품 사양만 응답에 반환됩니다. 허용되는 값: 보관됨 초안 게시됨 폐기됨 데이터 유형: 문자열

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

이름	설명
안 함

머리글

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

표 64. 요청 헤더

헤더	설명
안 함

표 65. 응답 헤더

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

상태 코드

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

표 66. 상태 코드

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

응답 본문 매개변수(JSON)

이름	설명
설명	사양에 대한 설명입니다. 데이터 유형: 문자열
externalId	필수 제품 사양의 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 external_id 필드
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
ID	제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 또는 external_id 필드
internalId	필수 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드
내부 버전	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드
isBundle	단일 제품 또는 제품 번들을 나타내는지 여부를 productSpecification 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 제품 사양이 제품 번들이며 여러 제품을 포함합니다. false: 제품 사양에 단일 제품이 포함되어 있습니다. 데이터 유형: 부울 기본값: false
lastUpdate	사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
lifecycleStatus	제품 사양의 현재 수명주기 상태입니다. 유효한 값은 다음과 같습니다. 활성 초안 비활성 데이터 유형: 문자열 기본값: 빈 문자열
이름	사양의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic	사양 특성. 데이터 유형: 객체 배열 "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	이 사양과 다른 제품 사양의 관계입니다. 데이터 유형: 객체 배열 "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	자원 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드
resourceSpecification.internalId	자원 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 initial_version 필드
resourceSpecification.internalVersion	자원 사양의 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 버전 필드
resourceSpecification.name	자원 사양의 이름입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification]
resourceSpecification.version	자원 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 external_version 필드
serviceSpecification	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 유형: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드
serviceSpecification.internalId	서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드
serviceSpecification.name	서비스 사양의 이름입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification]
serviceSpecification.version	서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드
유효한대상	사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "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"
               }
            }
         ]
      }
   ]
}

제품 카탈로그 개방형 API - PATCH /sn_tmf_api/catalogmanagement/productOffering/{id}

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

URL 형식

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

지원되는 요청 매개변수

표 67. 경로 매개변수

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

표 68. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
범주	제품이 속한 범주 목록입니다. 데이터 유형: 객체 배열 "category:" [ { "id": "String", "name": "String" } ] 테이블: 범주 [sc_category]
category.id	매개변수를 사용하는 경우 필수입니다 category . 범주의 ID입니다. 데이터 유형: 문자열 테이블: 범주 [sc_category]
category.name	범주의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열
채널	필수 제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 유형: 객체 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열 기본값: 빈 문자열
channel.id	필수 채널의 Sys_id입니다. 데이터 유형: 문자열 표: 유통 채널 [sn_prd_pm_distribution_channel]
channel.name	채널의 이름입니다. 데이터 유형: 문자열 기본값: 빈 문자열
설명	필수 제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링의 외부 ID 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_id 필드
ID	필수 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드
internalId	제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
내부 버전	제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
lastUpdate	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 형식: 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	세금이 포함된 제품 오퍼링의 가격입니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOfferingPrice.priceType	제품 오퍼링 유형의 유형입니다. 매개변수를 사용하는 경우 필수입니다 productOfferingPrice . 유효한 값은 다음과 같습니다. 비반복(일회성) 되풀이 데이터 유형: 문자열
productOfferingTerm	제품 오퍼링의 유효한 계약 기간입니다. 데이터 유형: 문자열 기본값: 빈 문자열
제품 사양	필수 제품의 제품 사양입니다. 데이터 유형: 객체 "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	필수 제품 사양의 Initial_version 또는 external_id입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification]
productSpecification.internalId	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalVersion	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
productSpecification.version	제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드
prodSpecCharValueUse	제품 오퍼링의 특성입니다. 데이터 유형: 객체 배열 "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값 목록입니다. 데이터 유형: 객체 배열 "productSpecCharacteristicValue": [ { "validFor": {Object}, "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": { "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 헤더를 참조하세요.

표 70. 요청 헤더

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

표 71. 응답 헤더

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

상태 코드

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

표 72. 상태 코드

상태 코드	설명
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	채널의 Sys_id입니다. 데이터 유형: 문자열 표: 유통 채널 [sn_prd_pm_distribution_channel]
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링의 외부 ID 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_id 필드
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
ID	필수 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드
internalId	제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
내부 버전	제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
lastUpdate	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
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	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalId	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalVersion	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
productSpecification.version	제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드
prodSpecCharValueUse	제품 오퍼링 특성입니다. 데이터 유형: 객체 배열 "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값 목록입니다. 데이터 유형: 객체 배열 "productSpecCharacteristicValue": [ { "validFor": {Object}, "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": { "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"
  }
}

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

가격 목록 라인 [sn_csm_pricing_price_list_line] 테이블에서 지정된 sys_id 사용하여 가격 목록 라인 기록을 업데이트합니다.

URL 형식

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

지원되는 요청 매개변수

표 73. 경로 매개변수

이름	설명
ID	필수 검색할 가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열

표 74. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
@type	필수 가격 목록 라인의 유형입니다. 항상 ProductOfferingPrice의 값입니다. 데이터 유형: 문자열
externalId	가격 목록 라인의 외부 ID입니다. 데이터 유형: 문자열
isBundle	가격 목록 라인이 단일 제품의 일부인지 또는 제품 번들의 일부인지를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. True: 가격 목록 라인이 번들의 일부입니다. false: 가격 목록 라인이 번들의 일부가 아닙니다. 데이터 유형: 부울 기본값: false
lastUpdate	필수 가격 라인이 마지막으로 업데이트된 날짜입니다. 형식: YYYY-MM-DD 데이터 유형: 문자열
수명 주기 상태	필수 제품 목록 라인의 현재 수명주기 상태입니다. 유효한 값은 다음과 같습니다. 활성 초안 비활성 데이터 유형: 문자열 기본값: 초안
이름	필수 가격 목록 라인을 지정할 이름입니다. 데이터 유형: 문자열
가격	필수 가격 목록 라인의 목록 가격 상세 정보입니다. 데이터 유형: 객체 "price": { "unit": "String", "value": "String" }
가격.단위	필수 가격 목록 라인의 통화 코드입니다. 예: USD 또는 EUR. 테이블: 통화 [fx_currency] 테이블 데이터 유형: 문자열
가격.값	필수 가격의 값입니다. 데이터 형식: 문자열(숫자로 표시됩니다. 예: "800")
priceList	필수 가격 목록 라인과 연결된 가격 목록 정보입니다. 데이터 유형: 객체 "priceList": { "id": "String", "name": "String", "@type": "String" }
priceList.id	필수 가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
priceList.name	가격 목록 라인의 이름입니다. 데이터 유형: 문자열
priceList.@type	가격 목록 라인의 유형입니다. 하위 클래싱할 때 하위 클래스 확장 가능한 이름을 정의합니다. 값은 항상 priceList입니다. 데이터 유형: 문자열
priceType	필수 제품 오퍼링의 가격 책정 방법을 기준으로 가격 목록 라인을 필터링합니다. 유효한 값은 다음과 같습니다. 반복: 지정된 빈도로 반복되는 가격 책정 금액을 청구합니다. 빈도는 매개변수에 recurringChargePeriodType 설정됩니다. one_time: 제품 오퍼링에 대한 일회성 또는 반복 추가 과금 및 수수료를 지원합니다. 데이터 유형: 문자열 기본값: 반복
productOffering	필수 가격 목록 라인의 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
productOffering.id	필수 제품 오퍼링의 Sys_id입니다. 테이블: 제품 오퍼링[sn_prd_pm_product_offering] 데이터 유형: 문자열
productOffering.internalVersion	제품 오퍼링의 내부 버전 번호입니다. 데이터 형식: 문자열(숫자로 표시됩니다. 예를 들어 "1"입니다.)
productOffering.name	제품 오퍼링의 이름입니다. 데이터 유형: 문자열
recurringChargePeriodType	반복되는 경우 priceType 필수입니다. 제품 오퍼링이 생성될 때 선택된 약정 기간입니다. 유효한 값은 다음과 같습니다. 매년 월별 데이터 유형: 문자열
측정 단위	필수 가격 목록 라인과 연결된 측정 단위에 대한 상세 정보입니다. 데이터 유형: 객체 "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
unitOfMeasure.amount	측정 단위의 금액입니다. 데이터 유형: 숫자
unitOfMeasure.id	필수 가격 라인 목록 테이블의 측정 단위 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
unitOfMeasure.units	가격 목록 라인과 연결된 측정 단위의 유형입니다. 예: 각각 또는 번들. 데이터 유형: 문자열
유효한대상	필수 가격 목록 라인이 유효한 기간입니다. 데이터 유형: 객체 "validFor": { "endDate": "String", "startDate": "String" }
validFor.endDate	가격 목록 라인이 유효한 종료 날짜입니다. 데이터 유형: 문자열(glide_date_time)
validFor.endDateTime	가격 목록 라인이 유효한 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열(glide_date)
validFor.startDate	가격 목록 라인이 유효한 시작 날짜입니다. 데이터 유형: 문자열(glide_date_time)
validFor.startDateTime	가격 목록 라인이 유효한 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열(glide_date)

머리글

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

표 76. 요청 헤더

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

표 77. 응답 헤더

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

상태 코드

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

표 78. 상태 코드

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

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

이름	설명
ID	가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
href	인스턴스의 가격 목록 라인 기록에 대한 URL입니다. 데이터 유형: 문자열
lastUpdate	가격 목록 라인이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열
유효한대상	가격 목록 라인이 유효한 기간입니다. 데이터 유형: 객체 "validFor": { "endDate": "String", "startDate": "String" }
validFor.endDate	가격 목록 라인이 유효한 종료 날짜 및 시간입니다. 데이터 유형: 문자열(glide_date_time)
validFor.startDate	가격 목록 라인이 유효한 시작 날짜 및 시간입니다. 데이터 유형: 문자열(glide_date_time)
isBundle	가격 목록 라인이 단일 제품의 일부인지 또는 제품 번들의 일부인지를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. True: 가격 목록 라인이 번들의 일부입니다. false: 가격 목록 라인이 번들의 일부가 아닙니다. 데이터 유형: 부울
lifecycleStatus	가격 목록 라인의 현재 수명주기 상태입니다. 유효한 값은 다음과 같습니다. 활성 초안 비활성 데이터 유형: 문자열
productOffering	가격 목록 라인과 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
productOffering.id	제품 오퍼링의 Sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
productOffering.internalVersion	제품 오퍼링의 내부 버전 번호입니다. 예를 들면 PRDOF01024. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
productOffering.name	제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
priceType	이 가격 목록 라인과 연결된 제품 오퍼링의 가격 책정 방법입니다. 가능한 값: 반복: 지정된 빈도로 반복되는 가격 책정 금액을 청구합니다. 값은 recurringChargePeriodType 과금 빈도를 나타냅니다. one_time: 제품 오퍼링에 대한 일회성 또는 반복 추가 과금 및 수수료입니다. 데이터 유형: 문자열
recurringChargePeriodType	이 가격 목록 라인과 연결된 제품 오퍼링의 주기 또는 빈도입니다. 반복으로 설정된 경우 priceType 빈도 유형을 반환하고, 그렇지 않으면 빈 문자열을 반환합니다. 가능한 값: 매년 월별 데이터 유형: 문자열
측정 단위	가격 목록 라인과 연결된 측정 단위에 대한 상세 정보입니다. 데이터 유형: 객체 "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
unitOfMeasure.amount	측정 단위의 금액입니다. 데이터 유형: 숫자
unitOfMeasure.id	측정 단위의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
unitOfMeasure.units	가격 목록 라인과 연결된 측정 단위의 유형입니다. 예를 들어, 연도 또는 번들입니다. 데이터 유형: 문자열
가격	가격 목록 라인의 목록 가격 상세 정보입니다. 데이터 유형: 객체 "price": { "units": "String", "value": "String" }
가격.단위	가격의 통화 코드입니다. 예: USD 또는 EUR. 테이블: 통화 [fx_currency] 데이터 유형: 문자열
가격.값	가격의 값입니다. 데이터 유형: 문자열(숫자로 표시)
priceList	가격 목록 라인과 연결된 가격 목록 정보입니다. 데이터 유형: 객체 "priceList": { "id": "String", "name": "String", "@type": "String" }
priceList.id	가격 목록 [sn_csm_pricing_price_list] 테이블의 가격 목록 Sys_id입니다. 데이터 유형: 문자열
priceList.name	가격 목록의 이름입니다. 데이터 유형: 문자열
priceList.@type	가격 목록의 유형입니다. 하위 클래싱할 때 하위 클래스 확장 가능한 이름을 정의합니다. 항상 priceList 값을 갖습니다. 데이터 유형: 문자열
@type	항상 ProductOfferingPrice의 값입니다. 하위 클래싱할 때 하위 클래스 확장 가능한 이름을 정의합니다. 데이터 유형: 문자열
상태	이 가격 목록 라인과 연결된 가격 목록의 상태입니다. 데이터 유형: 문자열
externalId	이 가격 목록 라인의 외부 ID입니다. 데이터 유형: 문자열

cURL 요청

다음 예에서는 ID가 3ddd0인 제품 오퍼링 가격의 날짜를 업데이트합니다. 은(는) 다음에 유효합니다.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request patch\
--user 'username':'password'
--data {
  "validFor": {
    "endDateTime": "2024-06-25 15:15:58"
  }
}

응답 본문:

{
  "validFor": {
    "endDateTime": "2024-06-25 15:15:58"
  },
  "id": "994d5d364f8b5210f899f61d20ce0b7c",
  "name": "new Price list",
  "lastUpdate": "2025-01-16 00:15:32",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c",
  "lifecycleStatus": "Draft"
}

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

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

URL 형식

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

지원되는 요청 매개변수

표 79. 경로 매개변수

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

표 80. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
설명	필수 사양에 대한 설명입니다. 데이터 유형: 문자열
externalId	필수 제품 사양의 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 external_id 필드
ID	제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 또는 external_id 필드
internalId	필수 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드
내부 버전	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드
isBundle	단일 제품 또는 제품 번들을 나타내는지 여부를 productSpecification 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 제품 사양이 제품 번들이며 여러 제품을 포함합니다. false: 제품 사양에 단일 제품이 포함되어 있습니다. 데이터 유형: 부울 기본값: false
lastUpdate	사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열
이름	필수 사양의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic	사양 특성. 데이터 유형: 객체 배열 "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	특성에 대한 설명입니다. 데이터 유형: 문자열
productSpecCharacteristic.name	필수 특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값 목록입니다. 데이터 유형: 객체 배열 "productSpecCharacteristicValue": [ { "validFor": {Object}, "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	다른 제품 사양과 사양의 관계에 대한 상세 정보입니다. 데이터 유형: 객체 배열 "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	필수 자원 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드
resourceSpecification.internalId	자원 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 initial_version 필드
resourceSpecification.internalVersion	자원 사양의 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 버전 필드
resourceSpecification.name	자원 사양의 이름입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification]
resourceSpecification.version	자원 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 external_version 필드
serviceSpecification	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 유형: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드
serviceSpecification.internalId	서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드
serviceSpecification.name	서비스 사양의 이름입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification]
serviceSpecification.version	서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드
유효한대상	필수 사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "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 헤더를 참조하세요.

표 82. 요청 헤더

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

표 83. 응답 헤더

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

상태 코드

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

표 84. 상태 코드

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

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

이름	설명
설명	사양에 대한 설명입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
ID	제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 또는 external_id 필드
internalId	필수 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드
내부 버전	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드
lastUpdate	사양이 마지막으로 업데이트된 날짜입니다. 형식: YYYY-MM-DD 00:00:00. 데이터 유형: 문자열
이름	사양의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic	사양의 특성입니다. 데이터 유형: 객체 배열 "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	특성에 대한 설명입니다. 데이터 유형: 문자열
productSpecCharacteristic.name	특성의 이름입니다. 데이터 유형: 문자열
prodSpecCharValueUse.productSpecCharacteristicValue	특성의 가능한 값 목록입니다. 데이터 유형: 객체 배열 "productSpecCharacteristicValue": [ { "validFor": {Object}, "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	이 사양과 다른 제품 사양의 관계입니다. 데이터 유형: 객체 배열 "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	자원 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드
resourceSpecification.internalId	자원 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 initial_version 필드
resourceSpecification.internalVersion	자원 사양의 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 버전 필드
resourceSpecification.name	자원 사양의 이름입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification]
resourceSpecification.version	자원 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 external_version 필드
serviceSpecification	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 유형: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드
serviceSpecification.internalId	서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드
serviceSpecification.name	서비스 사양의 이름입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification]
serviceSpecification.version	서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드
유효한대상	사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "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

지원되는 요청 매개변수

표 85. 경로 매개변수

이름	설명
없음

표 86. 쿼리 매개변수

이름	설명
안 함

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

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

머리글

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

표 88. 요청 헤더

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

표 89. 응답 헤더

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

상태 코드

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

표 90. 상태 코드

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

응답 본문 매개변수(JSON)

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

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

지원되는 요청 매개변수

표 91. 경로 매개변수

이름	설명
없음

표 92. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
범주	제품이 속한 범주 목록입니다. 데이터 유형: 객체 배열 "category:" [ { "id": "String", "name": "String" } ] 테이블: 범주 [sc_category]
category.id	매개변수를 사용하는 경우 필수입니다 category . 범주의 ID입니다. 데이터 유형: 문자열
category.name	범주의 이름입니다. 데이터 유형: 문자열
채널	필수 제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 유형: 객체 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열
channel.id	필수 채널의 Sys_id입니다. 데이터 유형: 문자열 표: 유통 채널 [sn_prd_pm_distribution_channel]
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	필수 제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	외부 시스템의 제품 오퍼링에 대한 고유 식별자입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
ID	필수 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링[sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드
internalId	제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
내부 버전	제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
lastUpdate	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
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	필수 제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 또는 externa_id 필드
productSpecification.internalId	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalVersion	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
productSpecification.version	제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드
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": { "endDateTime": "String", "startDateTime": "String" }
validFor.endDateTime	제품 오퍼링의 종료 날짜입니다. 데이터 유형: 문자열
validFor.startDateTime	제품 오퍼링의 시작 날짜입니다. 데이터 유형: 문자열
버전	제품 오퍼링의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드

머리글

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

표 94. 요청 헤더

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

표 95. 응답 헤더

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

상태 코드

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

표 96. 상태 코드

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

응답 본문 매개변수(JSON)

이름	설명
범주	제품이 속한 범주 목록입니다. 데이터 유형: 객체 배열 "category:" [ { "id": "String", "name": "String" } ]
category.id	범주의 ID입니다. 데이터 유형: 문자열
category.name	범주의 이름입니다. 데이터 유형: 문자열
채널	제품 오퍼링을 판매하는 데 사용할 채널입니다. 데이터 유형: 객체 배열 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	채널에 대한 설명입니다. 데이터 유형: 문자열
channel.id	채널의 Sys_id입니다. 데이터 유형: 문자열 표: 유통 채널 [sn_prd_pm_distribution_channel]
channel.name	채널의 이름입니다. 데이터 유형: 문자열
설명	제품 오퍼링에 대한 설명입니다. 데이터 유형: 문자열
externalId	제품 오퍼링의 외부 ID 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_id 필드
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
ID	필수 제품 오퍼링의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 또는 external_id 필드
internalId	제품 오퍼링의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
내부 버전	제품 오퍼링 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
lastUpdate	제품 오퍼링이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열
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	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalId	제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 initial_version 필드
productSpecification.internalVersion	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 버전 필드
productSpecification.version	제품 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 external_version 필드
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": { "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"
}

제품 카탈로그 개방형 API - POST /sn_tmf_api/catalogmanagement/productOfferingPrice

가격 목록 라인 [sn_csm_pricing_price_list_line] 테이블에 새 가격 목록 라인 기록을 생성합니다.

URL 형식

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

지원되는 요청 매개변수

표 97. 경로 매개변수

이름	설명
없음

표 98. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
@type	필수 가격 목록 라인의 유형입니다. 항상 ProductOfferingPrice의 값입니다. 데이터 유형: 문자열
externalId	가격 목록 라인의 외부 ID입니다. 데이터 유형: 문자열
isBundle	가격 목록 라인이 단일 제품의 일부인지 또는 제품 번들의 일부인지를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. True: 가격 목록 라인이 번들의 일부입니다. false: 가격 목록 라인이 번들의 일부가 아닙니다. 데이터 유형: 부울 기본값: false
lastUpdate	필수 가격 라인이 마지막으로 업데이트된 날짜입니다. 형식: YYYY-MM-DD 데이터 유형: 문자열
수명 주기 상태	필수 제품 목록 라인의 현재 수명주기 상태입니다. 유효한 값은 다음과 같습니다. 활성 초안 비활성 데이터 유형: 문자열 기본값: 초안
이름	필수 가격 목록 라인을 지정할 이름입니다. 데이터 유형: 문자열
가격	필수 가격 목록 라인의 목록 가격 상세 정보입니다. 데이터 유형: 객체 "price": { "unit": "String", "value": "String" }
가격.단위	필수 가격 목록 라인의 통화 코드입니다. 예: USD 또는 EUR. 테이블: 통화 [fx_currency] 테이블 데이터 유형: 문자열
가격.값	필수 가격의 값입니다. 데이터 형식: 문자열(숫자로 표시됩니다. 예: "800")
priceList	필수 가격 목록 라인과 연결된 가격 목록 정보입니다. 데이터 유형: 객체 "priceList": { "id": "String", "name": "String", "@type": "String" }
priceList.id	필수 가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
priceList.name	가격 목록 라인의 이름입니다. 데이터 유형: 문자열
priceList.@type	가격 목록 라인의 유형입니다. 하위 클래싱할 때 하위 클래스 확장 가능한 이름을 정의합니다. 값은 항상 priceList입니다. 데이터 유형: 문자열
priceType	필수 제품 오퍼링의 가격 책정 방법을 기준으로 가격 목록 라인을 필터링합니다. 유효한 값은 다음과 같습니다. 반복: 지정된 빈도로 반복되는 가격 책정 금액을 청구합니다. 빈도는 매개변수에 recurringChargePeriodType 설정됩니다. one_time: 제품 오퍼링에 대한 일회성 또는 반복 추가 과금 및 수수료를 지원합니다. 데이터 유형: 문자열 기본값: 반복
productOffering	필수 가격 목록 라인의 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
productOffering.id	필수 제품 오퍼링의 Sys_id입니다. 테이블: 제품 오퍼링[sn_prd_pm_product_offering] 데이터 유형: 문자열
productOffering.internalVersion	제품 오퍼링의 내부 버전 번호입니다. 데이터 형식: 문자열(숫자로 표시됩니다. 예를 들어 "1"입니다.)
productOffering.name	제품 오퍼링의 이름입니다. 데이터 유형: 문자열
recurringChargePeriodType	반복되는 경우 priceType 필수입니다. 제품 오퍼링이 생성될 때 선택된 약정 기간입니다. 유효한 값은 다음과 같습니다. 매년 월별 데이터 유형: 문자열
측정 단위	필수 가격 목록 라인과 연결된 측정 단위에 대한 상세 정보입니다. 데이터 유형: 객체 "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
unitOfMeasure.amount	측정 단위의 금액입니다. 데이터 유형: 숫자
unitOfMeasure.id	필수 가격 라인 목록 테이블의 측정 단위 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
unitOfMeasure.units	가격 목록 라인과 연결된 측정 단위의 유형입니다. 예: 각각 또는 번들. 데이터 유형: 문자열
유효한대상	필수 가격 목록 라인이 유효한 기간입니다. 데이터 유형: 객체 "validFor": { "endDate": "String", "startDate": "String" }
validFor.endDate	가격 목록 라인이 유효한 종료 날짜입니다. 데이터 유형: 문자열(glide_date_time)
validFor.endDateTime	가격 목록 라인이 유효한 종료 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열(glide_date)
validFor.startDate	가격 목록 라인이 유효한 시작 날짜입니다. 데이터 유형: 문자열(glide_date_time)
validFor.startDateTime	가격 목록 라인이 유효한 시작 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열(glide_date)

머리글

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

표 100. 요청 헤더

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

표 101. 응답 헤더

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

상태 코드

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

표 102. 상태 코드

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

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

이름	설명
ID	가격 목록 라인의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
href	인스턴스의 가격 목록 라인 기록에 대한 URL입니다. 데이터 유형: 문자열
lastUpdate	가격 목록 라인이 마지막으로 업데이트된 날짜 및 시간입니다. 형식: YYYY-MM-DD HH:mm:ss 데이터 유형: 문자열
유효한대상	가격 목록 라인이 유효한 기간입니다. 데이터 유형: 객체 "validFor": { "endDate": "String", "startDate": "String" }
validFor.endDate	가격 목록 라인이 유효한 종료 날짜 및 시간입니다. 데이터 유형: 문자열(glide_date_time)
validFor.startDate	가격 목록 라인이 유효한 시작 날짜 및 시간입니다. 데이터 유형: 문자열(glide_date_time)
isBundle	가격 목록 라인이 단일 제품의 일부인지 또는 제품 번들의 일부인지를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. True: 가격 목록 라인이 번들의 일부입니다. false: 가격 목록 라인이 번들의 일부가 아닙니다. 데이터 유형: 부울
lifecycleStatus	가격 목록 라인의 현재 수명주기 상태입니다. 유효한 값은 다음과 같습니다. 활성 초안 비활성 데이터 유형: 문자열
productOffering	가격 목록 라인과 연결된 제품 오퍼링입니다. 데이터 유형: 객체 "productOffering": { "id": "String", "name": "String", "internalVersion": "String" }
productOffering.id	제품 오퍼링의 Sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
productOffering.internalVersion	제품 오퍼링의 내부 버전 번호입니다. 예를 들면 PRDOF01024. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
productOffering.name	제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열
priceType	이 가격 목록 라인과 연결된 제품 오퍼링의 가격 책정 방법입니다. 가능한 값: 반복: 지정된 빈도로 반복되는 가격 책정 금액을 청구합니다. 값은 recurringChargePeriodType 과금 빈도를 나타냅니다. one_time: 제품 오퍼링에 대한 일회성 또는 반복 추가 과금 및 수수료입니다. 데이터 유형: 문자열
recurringChargePeriodType	이 가격 목록 라인과 연결된 제품 오퍼링의 주기 또는 빈도입니다. 반복으로 설정된 경우 priceType 빈도 유형을 반환하고, 그렇지 않으면 빈 문자열을 반환합니다. 가능한 값: 매년 월별 데이터 유형: 문자열
측정 단위	가격 목록 라인과 연결된 측정 단위에 대한 상세 정보입니다. 데이터 유형: 객체 "unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }
unitOfMeasure.amount	측정 단위의 금액입니다. 데이터 유형: 숫자
unitOfMeasure.id	측정 단위의 Sys_id입니다. 테이블: 가격 목록 라인 [sn_csm_pricing_price_list_line] 데이터 유형: 문자열
unitOfMeasure.units	가격 목록 라인과 연결된 측정 단위의 유형입니다. 예를 들어, 연도 또는 번들입니다. 데이터 유형: 문자열
가격	가격 목록 라인의 목록 가격 상세 정보입니다. 데이터 유형: 객체 "price": { "units": "String", "value": "String" }
가격.단위	가격의 통화 코드입니다. 예: USD 또는 EUR. 테이블: 통화 [fx_currency] 데이터 유형: 문자열
가격.값	가격의 값입니다. 데이터 유형: 문자열(숫자로 표시)
priceList	가격 목록 라인과 연결된 가격 목록 정보입니다. 데이터 유형: 객체 "priceList": { "id": "String", "name": "String", "@type": "String" }
priceList.id	가격 목록 [sn_csm_pricing_price_list] 테이블의 가격 목록 Sys_id입니다. 데이터 유형: 문자열
priceList.name	가격 목록의 이름입니다. 데이터 유형: 문자열
priceList.@type	가격 목록의 유형입니다. 하위 클래싱할 때 하위 클래스 확장 가능한 이름을 정의합니다. 항상 priceList 값을 갖습니다. 데이터 유형: 문자열
@type	항상 ProductOfferingPrice의 값입니다. 하위 클래싱할 때 하위 클래스 확장 가능한 이름을 정의합니다. 데이터 유형: 문자열
상태	이 가격 목록 라인과 연결된 가격 목록의 상태입니다. 데이터 유형: 문자열
externalId	이 가격 목록 라인의 외부 ID입니다. 데이터 유형: 문자열

cURL 요청

다음 예에서는 요청 본문에 지정된 데이터에 따라 새 가격표 라인 기록을 만들고 가격표 라인 [sn_csm_pricing_price_list_line] 테이블에 삽입합니다.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice " \
--request POST\
--user 'username':'password'
--data {
  "name": "new Price list",
  "validFor": {
    "startDateTime": "2024-05-28 15:15:58",
    "endDateTime": "2025-06-28 15:15:58"
  },
  "priceType": "recurring",
  "recurringChargePeriodType": "monthly",
  "lastUpdate": "2023-09-23 00:00:00",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "unit": "USD",
    "value": "800"
  },
  "productOffering": {
    "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
    "name": "Maintenance Fee",
    "internalVersion": "1"
  },
  "priceList": {
    "name": "new price list",
    "@type": "priceList"
  },
  "externalId": "test123",
  "@type": "ProductOfferingPrice"
}

응답 본문. 이 새 가격 목록 라인 기록에는 고유 ID가 할당됩니다. 응답 본문은 응답 매개변수를 사용하여 href 새 기록에 대한 URL과 함께 이 정보를 반환합니다.

{
  "name": "new Price list",
  "validFor": {
    "startDateTime": "2024-05-28 15:15:58",
    "endDateTime": "2025-06-28 15:15:58"
  },
  "priceType": "recurring",
  "recurringChargePeriodType": "monthly",
  "lastUpdate": "2023-09-23 00:00:00",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "unit": "USD",
    "value": "800"
  },
  "productOffering": {
    "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
    "name": "Maintenance Fee",
    "internalVersion": "1"
  },
  "priceList": {
    "id": "194d5d364f8b5210f899f61d20ce0b7a",
    "name": "new Price list",
    "@type": "priceList"
  },
  "externalId": "test123",
  "@type": "ProductOfferingPrice",
  "id": "994d5d364f8b5210f899f61d20ce0b7c",
  "state": "draft",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c"
}

제품 카탈로그 개방형 API - POST /sn_tmf_api/catalogmanagement/productSpecification

제품 사양을 작성합니다.

URL 형식

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

지원되는 요청 매개변수

표 103. 경로 매개변수

이름	설명
없음

표 104. 쿼리 매개변수

이름	설명
안 함

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

이름	설명
설명	필수 사양에 대한 설명입니다. 데이터 유형: 문자열
externalId	외부 시스템의 제품 사양에 대한 고유 식별자입니다. 데이터 유형: 문자열 기본값: 빈 문자열
ID	필수 제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 또는 external_id
internalId	필수 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드
내부 버전	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드
lastUpdate	사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:35:43. 기본값: 빈 문자열
이름	필수 사양의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic	사양 특성. 데이터 유형: 객체 배열 "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	이 사양과 다른 제품 사양의 관계입니다. 데이터 유형: 배열 "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	필수 자원 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드
resourceSpecification.internalId	자원 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 initial_version 필드
resourceSpecification.internalVersion	자원 사양의 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 버전 필드
resourceSpecification.name	자원 사양의 이름입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification]
resourceSpecification.version	자원 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 external_version 필드
serviceSpecification	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 유형: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드
serviceSpecification.internalId	서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드
serviceSpecification.name	서비스 사양의 이름입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification]
serviceSpecification.version	서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드
유효한대상	필수 사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "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 헤더를 참조하세요.

표 106. 요청 헤더

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

표 107. 응답 헤더

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

상태 코드

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

표 108. 상태 코드

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

응답 본문 매개변수(JSON)

이름	설명
설명	사양에 대한 설명입니다. 데이터 유형: 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
ID	제품 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 또는 external_id 필드
internalId	필수 제품 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 initial_version 필드
내부 버전	제품 사양의 버전입니다. 데이터 유형: 문자열 테이블: 제품 사양 [sn_prd_pm_product_specification] 테이블의 버전 필드
isBundle	단일 제품 또는 제품 번들을 나타내는지 여부를 productSpecification 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 제품 사양이 제품 번들이며 여러 제품을 포함합니다. false: 제품 사양에 단일 제품이 포함되어 있습니다. 데이터 유형: 부울 기본값: false
lastUpdate	사양이 마지막으로 업데이트된 날짜입니다. 데이터 유형: 문자열 형식: YYYY-MM-DD 00:00:00.
lifecycleStatus	제품 사양의 현재 수명주기 상태입니다. 가능한 값: 활성 초안 비활성 데이터 유형: 문자열 기본값: 빈 문자열
이름	사양의 이름입니다. 데이터 유형: 문자열
productSpecCharacteristic	사양 특성. 데이터 유형: 객체 배열 "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	이 사양과 다른 제품 사양의 관계입니다. 데이터 유형: 객체 배열 "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	자원 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 sys_id 또는 external_id 필드
resourceSpecification.internalId	자원 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 initial_version 필드
resourceSpecification.internalVersion	자원 사양의 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 버전 필드
resourceSpecification.name	자원 사양의 이름입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification]
resourceSpecification.version	자원 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 자원 사양 [sn_prd_pm_resource_specification] 테이블의 external_version 필드
serviceSpecification	이 제품 사양과 관련된 서비스 사양 목록입니다. 데이터 유형: 객체 배열 "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	서비스 사양의 초기 버전 또는 외부 ID입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 sys_id 또는 external_id 필드
serviceSpecification.internalId	서비스 사양의 초기 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 initial_version 필드
serviceSpecification.internalVersion	서비스 사양의 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 버전 필드
serviceSpecification.name	서비스 사양의 이름입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification]
serviceSpecification.version	서비스 사양의 외부 버전입니다. 데이터 유형: 문자열 테이블: 서비스 사양 [sn_prd_pm_service_specification] 테이블의 external_version 필드
유효한대상	사양이 유효한 날짜 범위입니다. 데이터 유형: 객체 "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"
      }
   ]
}