---
sourceDocument: Xanadu API 참조
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- ko-KR
ft:publication_title :
- Xanadu API 참조
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# 서비스 주문 오픈 API
# 서비스 주문 오픈 API {#ariaid-title1}
* 릴리스 버전: Xanadu
*
* 업데이트 날짜 2024년 08월 01일
*
*  소요 시간: 132분
Service Order Open API는 서비스 주문을 위한 표준화된 메커니즘을 사용할 수 있는 엔드포인트를 제공합니다.
이 API는 Open API TMForum TMF641 Service Ordering Management API 사양의 구현입니다 ServiceNow® .
이 API에 액세스하려면 (sn_ind_tmt_orm) 플러그인을 Order Management for Telecommunications 활성화해야 합니다. 자세한 내용은 문서를 참조하십시오. 테이블, 엔터티 및 관계에 대한 주문 관리 자세한 내용은 다음 문서를 참조하십시오 [Order Management data model](https://www.servicenow.com/docs/access?context=order-mgt-order-data-model&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US).
이 API는 `sn_tmf_api` 네임스페이스 내에서 제공됩니다.
호출하는 사용자에게 sn_ind_tmt_orm.order_integrator 역할이 있어야 합니다.
이 API를 확장하여 필수 매개변수, 요청 본문 확인, 추가 REST 작업 및 필드 매핑을 중심으로 사용자 지정할 수 있습니다. 자세한 내용은 [Service Order Open API 개발자 가이드](https://servicenow-prod.fluidtopics.net/DtBw3XAmXCmr1qwOlHKk5g#service-order_dev-guide "Service Order Open API를 사용하여 서비스 주문 정보를 생성, 업데이트 및 검색합니다.").
## 서비스 주문 오픈 API -- GET /sn_tmf_api/order/serviceOrder {#ariaid-title2}
모든 서비스 주문을 검색합니다.
이 API는 다음 관련 테이블에서 서비스 주문 정보를 검색합니다.
* 주문 \[sn_ind_tmt_orm_order\]
* 주문 특성 값 \[sn_ind_tmt_orm_order_characteristic_value\]
* 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\]
* 주문 라인 항목 연락처 \[sn_ind_tmt_orm_order_line_item_contact\]
* 주문 라인 관련 항목 \[sn_ind_tmt_orm_order_line_related_items\]
{#serviceorder-GET__ul_lxc_kxm_t4b}
### URL 형식
/api/sn_tmf_api/order/serviceOrder
### 지원되는 요청 매개변수
{#serviceorder-GET__table_ofr_vgy_fsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 1. 경로 매개변수]
{#serviceorder-GET__table_ofr_vgy_fsb} {#serviceorder-GET__table_pfr_vgy_fsb__entry__2}
| 이름 | 설명 |
|-|-|
| 필드 | 응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 데이터 유형: 문자열 기본값: 모든 필드가 반환됩니다. |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 최대: 100 데이터 유형: 숫자 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자 |
| 상태 | 상태별로 주문을 필터링합니다. 이 매개변수의 값과 일치하는 상태를 가진 주문만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 모든 상태가 반환됩니다. |
[표 2. 쿼리 매개변수]
{#serviceorder-GET__table_pfr_vgy_fsb} {#serviceorder-GET__table_xcm_cvr_nsb__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 3. 요청 본문 매개변수(JSON)]
{#serviceorder-GET__table_xcm_cvr_nsb}
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-GET__table_kqy_wgy_fsb__entry__2}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 4. 요청 헤더]
{#serviceorder-GET__table_kqy_wgy_fsb} {#serviceorder-GET__table_h4r_fxr_nsb__entry__2}{#serviceorder-GET__content-range-row}{#serviceorder-GET__content-type-row}{#serviceorder-GET__links-pagination-row}{#serviceorder-GET__x-total-count-descr}
| 헤더 | 설명 |
|-|-|
| 콘텐츠 범위 | 페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 `offset=2` 및 `limit=3`인 경우 헤더의 Content-Range 값은 `항목 3-5`입니다. |
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. * 첫 번째 * 마지막 * 다음 * 이전 {#serviceorder-GET__ul_zzk_sdm_lsb} |
| X-Total-Count | 페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다. |
[표 5. 응답 헤더]
{#serviceorder-GET__table_h4r_fxr_nsb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-GET__table_abf_sn5_4sb__entry__2}{#serviceorder-GET__tmf-get-status-200-p}{#serviceorder-GET__tmf-get-status-206-entry}{#serviceorder-GET__tmf-get-status-400-entry}{#serviceorder-GET__tmf-get-status-404-entry}
| 상태 코드 | 설명 |
|-|-|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청입니다. 가능한 이유: * 잘못된 경로 매개변수 * 잘못된 URI {#serviceorder-GET__ul_rys_1gy_fsb} |
| 404 | 기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다. |
[표 6. 상태 코드]
{#serviceorder-GET__table_abf_sn5_4sb}
### 응답 본문 매개변수(JSON) {#serviceorder-GET__section_ilb_1qx_kqb}
{#serviceorder-GET__table_jlb_1qx_kqb__entry__2}{#serviceorder-GET__type-entry-tmf641}
| 이름 | 설명 |
|-|-|
| committedDueDate | 주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 |
| 예상 완료 날짜 | 주문을 완료할 날짜입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| id | 요청된 서비스 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 메모 | 고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "note": [ { "author": "String", "date": "String", "text": "String" } ] |
| note.author | 관련 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열 |
| note.date | 메모가 생성된 날짜입니다. 데이터 유형: 문자열 |
| note.text | 고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열 |
| orderDate | 주문의 날짜 및 타임스탬프입니다. 형식: YYYY--MM--DD HH:MM:SS 데이터 유형: 문자열 기본값: 빈 문자열 |
| 폰(ponr) | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 주문에 대한 반품 불가 지점에 도달했습니다. 이행이 진행되는 동안에는 주문을 수정하거나 취소할 수 없습니다. * false: 주문에 대한 반품 불가 지점에 도달하지 못했습니다. 주문을 수정하거나 취소할 수 있습니다. {#serviceorder-GET__d7857e218}데이터 유형: 부울 |
| 관련파티 | 주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] |
| relatedParty.id | 주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 테이블 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 소비자 * 고객 * 고객 연락처 {#serviceorder-GET__ul_oc5_dc2_hqb} 데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 |
| requestedStartDate | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 |
| serviceOrderItem | 서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. "serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ] 데이터 유형: 배열 |
| serviceOrderItem.action | 서비스 주문 항목에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 입력 필드에 있는 선택 목록 탭에서 정의합니다. 자세한 내용은 [Action types for customer and service orders](https://www.servicenow.com/docs/access?context=order-mgt-customer-order-types&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US) 문서를 참조하십시오. 데이터 유형: 문자열 |
| serviceOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| serviceOrderItem.committedDueDate | 주문 라인 항목에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 데이터 유형: 문자열 |
| serviceOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑된 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 "externalProductInventory": [ { "externalProductInventoryId": "String" } ] |
| serviceOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열 |
| serviceOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.orderRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "orderRelationship:" [ { "id": "String", "relationshipType": "String" } ] |
| serviceOrderItem.orderRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.orderRelationship.relationshipType | 두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: * 하일드 * 부모 존재 여부 * 필수 {#serviceorder-GET__ul_yqf_2ty_54b} `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열 |
| serviceOrderItem.quantity | 주문된 라인 항목 수입니다. 데이터 유형: 숫자 |
| serviceOrderItem.place | 서비스를 설치할 위치의 맵입니다. 데이터 유형: 객체 "place:" { "id": "String", "@type": "String" } |
| serviceOrderItem.place.id | 위치\[cmn_location\] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| serviceOrderItem.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.ponr | 주문 라인 항목에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 주문 라인 항목이 반품 불가 지점에 도달했습니다. 이행이 진행되는 동안에는 주문 라인 항목을 수정하거나 취소할 수 없습니다. * false: 주문 라인 항목에 대한 반품 불가 지점에 도달하지 못했습니다. 주문 라인 항목을 수정하거나 취소할 수 있습니다. {#serviceorder-GET__ul_asm_252_gqb}데이터 유형: 부울 |
| serviceOrderItem.relatedParty | 광고 항목의 연락처 목록입니다. 데이터 유형: 배열 "relatedParty:" [ { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ] |
| serviceOrderItem.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.firstName | 연락처의 이름입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 연락처의 Sys_id입니다. 주문 라인 항목 접촉 창구 \[sn_ind_tmt_orm_order_line_item_contact\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.lastName | 연락처의 성입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.phone | 연락처의 직장 전화 번호입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@referredType | 필수 고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service | 고객이 구매한 서비스의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 "service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" } |
| serviceOrderItem.service.serviceCharacteristic | 연결된 서비스의 특성을 설명하는 목록입니다. 현재와 다른 previousValue 서비스를 value 제공하는 서비스 특성만 반환됩니다. 데이터 형식: 객체 배열 "serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] |
| serviceOrderItem.service.serviceCharacteristic.value | 서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.valueType | 특성 값의 유형입니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceRelationship | 서비스와 관련된 제품 인벤토리 목록입니다. 데이터 유형: 배열 "serviceRelationship": [ { "id": "String", "relationshipType": "String" } ] |
| serviceOrderItem.service.serviceRelationship.id | 제품 인벤토리의 Sys_id 또는 sn_prd_invt_external_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 sys_id 또는 sn_prd_invt_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceRelationship.relationshipType | 서비스와 제품 인벤토리 간의 관계 유형입니다. 가능한 값: 필요 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification | 서비스와 연관된 서비스 사양에 대한 설명입니다. 데이터 유형: 객체 "serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } |
| serviceOrderItem.service.serviceSpecification.id | 서비스 사양의 Initial_version 또는 external_id입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양 \[sn_prd_pm_service_specification\] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.internalId | 서비스 사양의 Initial_version입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.internalVersion | 서비스 사양의 버전입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.name | 서비스 사양의 이름입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.version | 서비스 사양의 External_version입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceType | 서비스 유형입니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.state | 판매된 제품의 상태입니다. 예를 들어 new입니다. 데이터 유형: 문자열 |
| serviceOrderItem.state | 서비스 주문 항목의 상태입니다. 예를 들어 new입니다. 데이터 유형: 문자열 |
| serviceOrderItem.version | 서비스 주문 라인 항목 버전입니다. 데이터 유형: 문자열 |
| serviceOrderItem.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 상태 | 서비스 주문의 상태입니다. 자세한 내용은 문서를 참조하십시오. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
[ ]
{#serviceorder-GET__table_jlb_1qx_kqb}
### cURL 요청
이 예에서는 모든 서비스 주문을 검색합니다.
curl --location --request GET 'http://instance.service-now.com/api/sn_tmf_api/order/serviceOrder' \
--user 'username':'password'
응답 본문입니다.
[
{
"id": "bd30366ec3a83010abc8b5183c40dd92",
"ponr": "true",
"href": "/api/sn_tmf_api/order/serviceOrder/bd30366ec3a83010abc8b5183c40dd92",
"completionDate": "2021-06-07T21:52:12.000Z",
"expectedCompletionDate": "2018-01-14T20:07:40.000Z",
"orderDate": "2021-06-08T05:34:59.000Z",
"requestedCompletionDate": "2018-01-14T20:07:40.000Z",
"requestedStartDate": "2018-01-14T20:07:40.000Z",
"serviceOrderItem": [
{
"id": "100",
"ponr": "true",
"quantity": 1,
"action": "add",
"service": {
"@type": "Service",
"id": "4b5072aec3a83010abc8b5183c40dd42",
"state": "active",
"serviceType": "cfs",
"serviceCharacteristic": [
{
"name": "Firewall coverage",
"valueType": "choice",
"value": "Premium(Up to 50 sites)\n\t\t",
"previousValue": ""
},
{
"name": "Firewall Security",
"valueType": "choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Type",
"valueType": "choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "Administration Support",
"valueType": "choice",
"value": "Basic( Customer Managed)\n\t\t",
"previousValue": ""
}
],
"serviceSpecification": {
"id": "f99546ff07266010a7955b7e0ad300a8",
"name": "Managed Firewall Service",
"version": "",
"internalVersion": "1",
"internalId": "f99546ff07266010a7955b7e0ad300a8",
"@type": "ServiceSpecificationRef"
}
},
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"@type": "Place"
},
"state": "completed",
"version": "2",
"@type": "ServiceOrderItem"
}
],
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"state": "completed",
"version": "2",
"@type": "ServiceOrder"
}
]
## 서비스 주문 Open API -- GET /sn_tmf_api/order/serviceOrder/{id} {#ariaid-title3}
지정된 서비스 주문을 검색합니다.
이 API는 다음 관련 테이블에서 서비스 주문 정보를 검색합니다.
* 주문 \[sn_ind_tmt_orm_order\]
* 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\]
* 주문 특성 값 \[sn_ind_tmt_orm_order_characteristic_value\]
* 주문 라인 항목 연락처 \[sn_ind_tmt_orm_order_line_item_contact\]
* 주문 라인 관련 항목 \[sn_ind_tmt_orm_order_line_related_items\]
{#serviceorder-GET-id__ul_lxc_kxm_t4b}
### URL 형식
/api/sn_tmf_api/order/serviceOrder/{id}
### 지원되는 요청 매개변수
{#serviceorder-GET-id__entry__2}
| 이름 | 설명 |
|-|-|
| id | 검색할 서비스 주문의 Sys_id입니다. 주문 \[sn_ind_tmt_orm_order\] 테이블에 있습니다. 데이터 유형: 문자열 |
[표 7. 경로 매개변수]
{#serviceorder-GET-id__entry__6}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 8. 쿼리 매개변수]
{#serviceorder-GET-id__entry__10}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 9. 요청 본문 매개변수(JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-GET-id__table_ed2_jl5_4sb__entry__2}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 10. 요청 헤더]
{#serviceorder-GET-id__table_ed2_jl5_4sb} {#serviceorder-GET-id__table_tzy_thy_ksb__entry__2}
| 헤더 | 설명 |
|-|-|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
[표 11. 응답 헤더]
{#serviceorder-GET-id__table_tzy_thy_ksb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-GET-id__table_n5s_hjm_gqb__entry__2}{#serviceorder-GET-id__entry-404-status-code}
| 상태 코드 | 설명 |
|-|-|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음). 선택한 주문에 처리 문제가 있는 경우 응답이 오류 메시지와 함께 성공적으로 반환됩니다. * 스케줄러가 처리할 기록을 선택하기를 기다리는 인바운드 큐 \[sn_tmt_core_inbound_queue\] 테이블에 주문이 있는 경우 200 OK 응답이 발생합니다. 오류 메시지 필드에는 기록에 대한 세부 정보가 포함됩니다. 예: { "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] } * 주문 생성이 실패하고 인바운드 큐 \[sn_tmt_core_inbound_queue\] 테이블의 기록이 오류 상태인 경우 200 OK 응답이 발생합니다. 오류 메시지 필드에는 인바운드 큐 테이블 기록에 대한 세부 정보가 포함됩니다. 예: { "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] } {#serviceorder-GET-id__ul_kdw_y4w_fwb} |
| 400 | 잘못된 요청입니다. 가능한 이유: * 쿼리 매개변수 누락 * 잘못된 URI {#serviceorder-GET-id__ul_o5s_hjm_gqb} |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
[표 12. 상태 코드]
{#serviceorder-GET-id__table_n5s_hjm_gqb}
### 응답 본문 매개변수(JSON) {#serviceorder-GET-id__section_ilb_1qx_kqb}
{#serviceorder-GET-id__table_jlb_1qx_kqb__entry__2}{#serviceorder-GET-id__type-entry-tmf641}
| 이름 | 설명 |
|-|-|
| committedDueDate | 주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 |
| 예상 완료 날짜 | 주문을 완료할 날짜입니다. 데이터 유형: 문자열 |
| id | 요청된 서비스 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 메모 | 고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "note": [ { "author": "String", "date": "String", "text": "String" } ] |
| note.author | 관련 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열 |
| note.date | 메모가 생성된 날짜입니다. 데이터 유형: 문자열 |
| note.text | 고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열 |
| orderDate | 주문의 날짜 및 타임스탬프입니다. 형식: YYYY--MM--DD HH:MM:SS 데이터 유형: 문자열 기본값: 빈 문자열 |
| 폰(ponr) | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 주문에 대한 반품 불가 지점에 도달했습니다. 이행이 진행되는 동안에는 주문을 수정하거나 취소할 수 없습니다. * false: 주문에 대한 반품 불가 지점에 도달하지 못했습니다. 주문을 수정하거나 취소할 수 있습니다. {#serviceorder-GET-id__d7857e218}데이터 유형: 부울 |
| 관련파티 | 주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] |
| relatedParty.id | 주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 테이블 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 소비자 * 고객 * 고객 연락처 {#serviceorder-GET-id__ul_oc5_dc2_hqb} 데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 |
| requestedStartDate | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 |
| serviceOrderItem | 서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 "serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ] |
| serviceOrderItem.action | 서비스 주문 항목에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 입력 필드에 있는 선택 목록 탭에서 정의합니다. 자세한 내용은 다음을 참조하십시오. [Action types for customer and service orders](https://www.servicenow.com/docs/access?context=order-mgt-customer-order-types&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US) 데이터 유형: 문자열 |
| serviceOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| serviceOrderItem.committedDueDate | 주문 라인 항목에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 데이터 유형: 문자열 |
| serviceOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑된 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 "externalProductInventory": [ { "externalProductInventoryId": "String" } ] |
| serviceOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열 |
| serviceOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.orderRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "orderRelationship:" [ { "id": "String", "relationshipType": "String" } ] |
| serviceOrderItem.orderRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.orderRelationship.relationshipType | 두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: * 하일드 * 부모 존재 여부 * 필수 {#serviceorder-GET-id__ul_yqf_2ty_54b} `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열 |
| serviceOrderItem.quantity | 주문된 라인 항목 수입니다. 데이터 유형: 숫자 |
| serviceOrderItem.place | 서비스를 설치할 위치의 맵입니다. 데이터 유형: 객체 "place:" { "id": "String", "@type": "String" } |
| serviceOrderItem.place.id | 위치\[cmn_location\] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| serviceOrderItem.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.ponr | 주문 라인 항목에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 주문 라인 항목이 반품 불가 지점에 도달했습니다. 이행이 진행되는 동안에는 주문 라인 항목을 수정하거나 취소할 수 없습니다. * false: 주문 라인 항목에 대한 반품 불가 지점에 도달하지 못했습니다. 주문 라인 항목을 수정하거나 취소할 수 있습니다. {#serviceorder-GET-id__ul_asm_252_gqb}데이터 유형: 부울 |
| serviceOrderItem.relatedParty | 광고 항목의 연락처 목록입니다. 데이터 유형: 배열 "relatedParty:" { "email": "String", "firstName": "String" "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } |
| serviceOrderItem.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.firstName | 연락처의 이름입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 연락처의 Sys_id입니다. 주문 라인 항목 접촉 창구 \[sn_ind_tmt_orm_order_line_item_contact\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.lastName | 연락처의 성입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.phone | 연락처의 직장 전화 번호입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@referredType | 필수 고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service | 고객이 구매한 서비스의 인스턴스 상세 정보에 대한 설명입니다. "service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" } 데이터 유형: 객체 |
| serviceOrderItem.service.serviceCharacteristic | 연결된 서비스의 특성을 설명하는 목록입니다. 현재와 다른 previousValue 서비스를 value 제공하는 서비스 특성만 반환됩니다. 데이터 유형: 배열 "serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ] |
| serviceOrderItem.service.serviceCharacteristic.value | 서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.valueType | 특성 값의 유형입니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceRelationship | 서비스와 관련된 제품 인벤토리 목록입니다. 데이터 유형: 배열 "serviceRelationship": [ { "id": "String", "relationshipType": "String" } ] |
| serviceOrderItem.service.serviceRelationship.id | 제품 인벤토리의 Sys_id 또는 sn_prd_invt_external_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 sys_id 또는 sn_prd_invt_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceRelationship.relationshipType | 서비스와 제품 인벤토리 간의 관계 유형입니다. 가능한 값: 필요 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification | 서비스와 연관된 서비스 사양에 대한 설명입니다. 데이터 유형: 객체 "serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } |
| serviceOrderItem.service.serviceSpecification.id | 서비스 사양의 Initial_version 또는 external_id입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양 \[sn_prd_pm_service_specification\] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.internalId | 서비스 사양의 Initial_version입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.internalVersion | 서비스 사양의 버전입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.name | 서비스 사양의 이름입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.version | 서비스 사양의 External_version입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceType | 서비스 유형입니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.state | 판매된 제품의 상태입니다. 예를 들어 new입니다. 데이터 유형: 문자열 |
| serviceOrderItem.state | 서비스 주문 항목의 상태입니다. 예를 들어 new입니다. 데이터 유형: 문자열 |
| serviceOrderItem.version | 서비스 주문 라인 항목 버전입니다. 데이터 유형: 문자열 |
| serviceOrderItem.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 상태 | 서비스 주문의 상태입니다. 자세한 내용은 문서를 참조하십시오. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
[ ]
{#serviceorder-GET-id__table_jlb_1qx_kqb}
### cURL 요청
다음 예에서는 지정된 서비스 주문을 검색합니다.
curl "https://instance.service-now.com/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf" \
--request GET \
--user 'username':'password'
응답 본문입니다.
{
"id": "4f2af65ac3a030106e2473ce3640ddcf",
"ponr": "false",
"expectedCompletionDate": "2018-01-15T09:37:40.000Z",
"requestedCompletionDate": "2018-01-15T09:37:40.000Z",
"requestedStartDate": "2018-01-15T09:37:40.000Z",
"note": [
{
"author": "System Administrator",
"date": "2021-06-07T14:53:04.000Z",
"text": "This is a TMF service order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-06-07T14:53:03.000Z",
"text": "This is a TMF service order illustration"
}
],
"serviceOrderItem": [
{
"id": "100",
"ponr": "false",
"action": "add",
"actionReason": "adding service package OLI",
"quantity": 1,
"service": {
"@type": "Service",
"state": "",
"serviceType": "cfs",
"serviceCharacteristic": [
{
"name": "Firewall coverage",
"valueType": "choice",
"value": "Premium (Up to 50 sites)",
"previousValue": ""
},
{
"name": "Firewall Security",
"valueType": "choice",
"value": "Standard",
"previousValue": ""
},
{
"name": "Administration Support",
"valueType": "choice",
"value": "Basic (Customer Managed)",
"previousValue": ""
}
],
"serviceRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"serviceSpecification": {
"id": "f99546ff07266010a7955b7e0ad300a8",
"name": "Managed Firewall Service",
"version": "v2",
"internalVersion": "2",
"internalId": "f99546ff07266010a7955b7e0ad300a8",
"@type": "ServiceSpecificationRef"
}
},
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"@type": "Place"
},
"relatedParty": [
{
"id": "972af65ac3a030106e2473ce3640ddda",
"firstName": "Mike",
"lastName": "Hudson",
"email": "mike@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"state": "new",
"version": "1",
"@type": "ServiceOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "new",
"version": "1",
"@type": "ServiceOrder"
"href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcfç",
"orderDate": "2021-06-08T05:34:59.000Z",
}
## 서비스 주문 오픈 API - PATCH /sn_tmf_api/order/serviceOrder/{id} {#ariaid-title4}
지정된 서비스 주문을 업데이트합니다.
### URL 형식
기본 URL: /api/sn_tmf_api/order/serviceOrder/{id}
### 지원되는 요청 매개변수
{#serviceorder-PATCH-serviceOrder-id__entry__2}
| 이름 | 설명 |
|-|-|
| id | 업데이트할 고객 주문의 Sys_id입니다. 고객 주문 \[sn_ind_tmt_orm_order\] 테이블에 있습니다. 데이터 유형: 문자열 |
[표 13. 경로 매개변수]
{#serviceorder-PATCH-serviceOrder-id__entry__6}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 14. 쿼리 매개변수]
{#serviceorder-PATCH-serviceOrder-id__table_m32_1l1_hwb__entry__2}{#serviceorder-PATCH-serviceOrder-id__svcOrdItem-ph-tmf641-externalid}{#serviceorder-PATCH-serviceOrder-id__note-ph-tmf622}{#serviceorder-PATCH-serviceOrder-id__note_text-ph-tmf622}{#serviceorder-PATCH-serviceOrder-id__requestedCompletionDate-ph-tmf622}{#serviceorder-PATCH-serviceOrder-id__reqStartDate-ph-tmf622}{#serviceorder-PATCH-serviceOrder-id__svcOrdItem-ph-tmf641}{#serviceorder-PATCH-serviceOrder-id__service_id-ph-tmf641}{#serviceorder-PATCH-serviceOrder-id__svcOrderItemRel_id-ph-tmf641}{#serviceorder-PATCH-serviceOrder-id__productOrderItemRelationship_relType-row-tmf622}{#serviceorder-PATCH-serviceOrder-id__service-s-tmf641}
| 이름 | 설명 |
|-|-|
| committedDueDate | 주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 주문 라인 항목에 대한 작업이 일시 중단 또는 재개인 경우 이 매개변수를 업데이트할 수 없습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/committed_due_date |
| externalId | 외부 서비스 주문의 고유한 주문 번호입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order |
| 메모 | 고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열{#serviceorder-PATCH-serviceOrder-id__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#serviceorder-PATCH-serviceOrder-id__note-codeblock-tmf622} 업데이트된 테이블/필드: sn_ind_tmt_orm_order |
| note.text | 고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열{#serviceorder-PATCH-serviceOrder-id__note_text_data_type-p-tmf622} 업데이트된 테이블/필드: sn_ind_tmt_orm_order/의견 기본값: 빈 문자열 |
| 관련파티 | 주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 요청에는 고객 계정 또는 소비자 계정 정보가 포함된 항목이 하나 이상 나열되어야 합니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] |
| relatedParty.id | 필수 주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 \[customer_account\] 테이블, 연락처 \[customer_contact\] 테이블 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 업데이트된 테이블: sn_ind_tmt_orm_order |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 소비자 * 고객 * 고객 연락처 {#serviceorder-PATCH-serviceOrder-id__ul_cdn_ddp_kqb} 데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열{#serviceorder-PATCH-serviceOrder-id__reqCompDate_data_type-p-tmf622} 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_end_date 기본값: 빈 문자열 |
| requestedStartDate | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열{#serviceorder-PATCH-serviceOrder-id__reqStartDate_data_type-p-tmf622} 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_start_date 기본값: 빈 문자열 |
| serviceOrderItem | 필수 서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열{#serviceorder-PATCH-serviceOrder-id__svcOrdItem_data_type-p-tmf641} "serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ] {#serviceorder-PATCH-serviceOrder-id__svcOrdItem-codeblock-tmf641} 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item |
| serviceOrderItem.action | 필수 서비스 주문 항목에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 입력 필드에 있는 선택 목록 탭에서 정의합니다. 가능한 값: * add * 변경 * 삭제 * 변경 없음 * resume * 매달다 {#serviceorder-PATCH-serviceOrder-id__ul_grg_vgl_gqb}자세한 내용은 [Action types for customer and service orders](https://www.servicenow.com/docs/access?context=order-mgt-customer-order-types&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US) 문서를 참조하십시오. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item/작업 |
| serviceOrderItem.actionReason | 옵션입니다. 라인 항목의 이유에 대한 설명입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] table/action_reason. |
| serviceOrderItem.committedDueDate | 주문 라인 항목에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 항목에 대한 작업이 일시 중단 또는 다시 시작인 경우 이 매개 변수를 업데이트할 수 없습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/committed_due_date |
| serviceOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑할 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 "externalProductInventory": [ { "externalProductInventoryId": "String" } ] 주: 이전에는 이미 존재했던 외부 제품 인벤토리 ID를 사용하여 PATCH 주문을 생성할 때 작업이 중단되고 오류가 반환되었습니다. 릴리스에서는 Xanadu 기존 외부 제품 인벤토리 ID가 제공되고 오류가 발생하지 않을 때 이 매개변수가 무시됩니다. |
| serviceOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑할 외부 ID입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item/external_inventory_id 및 sn_prd_invt_product_inventory/sn_prd_invt_external_id |
| serviceOrderItem.id | 필수 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/external_id |
| serviceOrderItem.orderRelationship | 필수 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "orderRelationship:" [ { "id": "String", "relationshipType": "String" } ] {#serviceorder-PATCH-serviceOrder-id__svcOrderItemRel-codeblock} 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item |
| serviceOrderItem.orderRelationship.id | 필수 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item/parent_line_item 또는 sn_ind_tmt_orm_order_line_related_items/related_order_line_item |
| serviceOrderItem.orderRelationship.relationshipType | 필수 두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: * 하일드 * 부모 존재 여부 * 필수 {#serviceorder-PATCH-serviceOrder-id__ul_yqf_2ty_54b} `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열 |
| serviceOrderItem.place | 서비스를 설치할 위치의 맵입니다. 데이터 유형: 객체 "place:" { "id": "String", "@type": "String" } |
| serviceOrderItem.place.id | 필수 위치\[cmn_location\] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item/위치 |
| serviceOrderItem.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 장소에 대한 주석입니다. 데이터 유형: 문자열 |
| serviceOrderItem.quantity | 주문할 라인 항목 수를 설정합니다. 이 속성은 서비스 주문을 추가할 때만 적용할 수 있습니다. 즉, 속성 값은 action`add`입니다. 데이터 유형: 숫자 기본값: 빈 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order/수량 |
| serviceOrderItem.relatedParty | 광고 항목의 연락처 목록입니다. 데이터 유형: 배열 "relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } |
| serviceOrderItem.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.firstName | 연락처의 이름입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.lastName | 연락처의 성입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.phone | 연락처의 직장 전화 번호입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@referredType | 필수 고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service | 필수 고객이 구매한 서비스의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 "service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" } {#serviceorder-PATCH-serviceOrder-id__service-codeblock-tmf641} 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item |
| serviceOrderItem.service.id | 판매된 서비스의 고유 식별자입니다. 이 값은 제품 인벤토리 \[sn_ind_tmt_orm_product_inventory\] 테이블의 sys_id 또는 외부 ID일 수 있습니다. 이 값은 변경/연결 해제 주문에만 사용됩니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic | 연결된 서비스의 특성을 설명하는 목록입니다. 현재와 다른 previousValue 서비스를 value 제공하는 서비스 특성만 반환됩니다. 데이터 유형: 배열 "serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ] |
| serviceOrderItem.service.serviceCharacteristic.name | 서비스와 연결된 특성 기록의 이름입니다. 특성 \[sn_prd_pm_characteristic\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.previousValue | 업데이트가 주문 변경용인 경우의 이전 특성 옵션 값입니다. 매개변수가 serviceOrderItem.actionadd가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.value | 서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification | 필수 서비스와 연관된 서비스 사양에 대한 설명입니다. 주: 변경 주문(serviceOrderItem.action`변경 여부)`은 시스템 속성 값에 따라 다르게 처리됩니다sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. * 속성이 true(기본값)로 설정되어 있을 때 서비스가 주문에 표시된 버전과 다른 버전인 경우 참조된 서비스 사양을 변경하여 서비스가 순서에 있는 버전으로 자동 업그레이드됩니다. 이렇게 하면 주문을 성공적으로 처리할 수 있습니다. * 속성이 false로 설정되어 있을 때 서비스가 주문에 표시된 버전과 다른 버전이면 버전 불일치로 인해 순서가 실패합니다. {#serviceorder-PATCH-serviceOrder-id__ul_zbw_sdz_dbc} 데이터 유형: 객체 "serviceSpecification:" { "id": "String", "name": "String", "@type": "String" } 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 service_specification 필드를 업데이트합니다. |
| serviceOrderItem.service.serviceSpecification.id | 필수 서비스 사양의 Initial_version 또는 external_id입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양 \[sn_prd_pm_service_specification\] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.name | 필수 서비스 사양의 이름입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
[표 15. 요청 본문 매개변수(JSON)]
{#serviceorder-PATCH-serviceOrder-id__table_m32_1l1_hwb}
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-PATCH-serviceOrder-id__table_omb_dvk_5rb__entry__2}{#serviceorder-PATCH-serviceOrder-id__accept-JSON-only-entry-RESTAPI}{#serviceorder-PATCH-serviceOrder-id__content_type-JSON-only-entry-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
[표 16. 요청 헤더]
{#serviceorder-PATCH-serviceOrder-id__table_omb_dvk_5rb} {#serviceorder-PATCH-serviceOrder-id__table_tzy_thy_ksb__entry__2}
| 헤더 | 설명 |
|-|-|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
[표 17. 응답 헤더]
{#serviceorder-PATCH-serviceOrder-id__table_tzy_thy_ksb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-PATCH-serviceOrder-id__table_xfv_2vk_5rb__entry__2}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 201 | 성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다. * 다음 주문 항목 특성이 없습니다. 사양을 검토\ 주문을 승인하기 전에 주문 라인 항목의 특성 및 특성 옵션을 수정합니다. * 주문 항목 특성: \ 특성 값: \이 잘못되었습니다. 주문을 승인하기 전에 특성 값을 수정하십시오. {#serviceorder-PATCH-serviceOrder-id__ul_xtx_xym_t4b} |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. * 잘못된 페이로드: 요청 본문 누락 - 요청 본문에 페이로드가 전달되지 않았습니다. * 잘못된 페이로드: serviceOrderItem 누락 - 서비스 주문 라인 항목 객체 또는 JSON이 누락되었습니다. * 잘못된 페이로드: serviceOrderItem ID가 누락 됨 - id 페이로드의 서비스 주문 라인 항목에 매개변수가 누락되었습니다. * 잘못된 페이로드: serviceOrderItem 작업 누락 - action 페이로드의 서비스 주문 라인 항목에 매개변수가 누락되었습니다. * 잘못된 페이로드: serviceOrderItem serviceOffering 누락 - 페이로드의 서비스 주문 라인 항목에서 서비스 오퍼링 객체 또는 JSON이 누락되었습니다. * 잘못된 페이로드: serviceOffering id가 누락 됨 - id 페이로드에 있는 서비스 오퍼링 객체의 서비스 주문 라인 항목에 매개변수가 누락되었습니다. * 잘못된 페이로드: 서비스 오퍼링이 없음 - 서비스 주문 라인 항목의 서비스 오퍼링이 유효하지 않습니다. * 잘못된 페이로드: serviceOrderItem 서비스 누락 - 서비스 주문 라인 항목의 서비스 객체 또는 JSON이 페이로드에서 누락되었습니다. * 잘못된 페이로드: 서비스 serviceSpecification이 누락됨 - 서비스 사양 객체 또는 서비스 주문 라인 항목의 JSON이 페이로드에서 누락되었습니다. * 잘못된 페이로드: serviceSpecification id가 없음 - id 서비스 사양 객체의 서비스 주문 라인 항목에 있는 매개변수가 페이로드에서 누락되었습니다. * 잘못된 페이로드: 서비스 사양이 없음 - 서비스 주문 라인 항목의 서비스 사양이 유효하지 않습니다. * 잘못된 페이로드: 서비스 인벤토리가 없음 - 주문 변경(작업 = 변경)에서 항목의 수량이 재고보다 많습니다. * 잘못된 페이로드: 서비스 인벤토리 ID가 누락됨 - 변경 주문 service.id 에서 페이로드에 누락되었습니다. * 잘못된 페이로드: 판매된 서비스가 비활성 상태임 - 변경 주문에서 페이로드에 지정된 서비스가 비활성 상태입니다. * 잘못된 페이로드: relatedParty가 누락됨 - 관련 당사자 객체가 페이로드에서 누락되었습니다. * 잘못된 페이로드: 고객 계정 또는 소비자가 없음 - 관련 당사자 고객 또는 소비자 객체가 페이로드에서 누락되었습니다. * 잘못된 페이로드: 고객 계정이 없음 - 지정된 관련 당사자 고객이 인스턴스에 존재하지 않습니다. * 잘못된 페이로드: 소비자가 없음 - 지정된 관련 당사자 소비자가 인스턴스에 없습니다. * 잘못된 페이로드: 주문 생성 실패 - 요청한 주문을 생성할 수 없습니다. * 주문 통화에 대한 기내 수정이 지원되지 않음 - 주문을 생성한 후에는 매개변수를 orderCurrency 업데이트할 수 없습니다. * 이 주문은 고객 주문 테이블에서 아직 생성되지 않았습니다. 자세한 내용은 인바운드 큐를 체크인하십시오. -- 입력한 주문 ID가 고객 주문 테이블에 없습니다. * 주문의 이행 유형이 "제공"이 아니므로 패치 요청을 할 수 없습니다. -- 배달이 아닌 이행 유형이 있는 주문에 대해 패치 요청이 이루어졌습니다. {#serviceorder-PATCH-serviceOrder-id__ul_g2v_rzm_t4b} |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
[표 18. 상태 코드]
{#serviceorder-PATCH-serviceOrder-id__table_xfv_2vk_5rb}
### 응답 본문 매개변수(JSON) {#serviceorder-PATCH-serviceOrder-id__section_b1v_xpk_5rb}
{#serviceorder-PATCH-serviceOrder-id__table_t5s_hm1_hwb__entry__2}
| 이름 | 설명 |
|-|-|
| committedDueDate | 주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 |
| externalId | 외부 서비스 주문의 고유한 주문 번호입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| id | 서비스 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 메모 | 고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "note": [ { "text": "String" } ] |
| note.text | 고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열 |
| orderDate | 주문의 날짜 및 타임스탬프입니다. 형식: YYYY--MM--DD HH:MM:SS 데이터 유형: 문자열 기본값: 빈 문자열 |
| 관련파티 | 주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] |
| relatedParty.id | 주문과 관련된 계정, 고객 또는 소비자 접촉 창구의 Sys_id 또는 external_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * 고객 연락처 * 소비자 {#serviceorder-PATCH-serviceOrder-id__ul_vvn_12p_kqb} 데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 |
| requestedStartDate | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 |
| serviceOrderItem | 서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 "serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ] |
| serviceOrderItem.action | 서비스 주문 항목에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 입력 필드에 있는 선택 목록 탭에서 정의합니다. 가능한 값: * add * 변경 * 삭제 {#serviceorder-PATCH-serviceOrder-id__ul_t4n_rqx_kqb}자세한 내용은 [Action types for customer and service orders](https://www.servicenow.com/docs/access?context=order-mgt-customer-order-types&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US) 문서를 참조하십시오. 데이터 유형: 문자열 |
| serviceOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| serviceOrderItem.committedDueDate | 주문 라인 항목에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 데이터 유형: 문자열 |
| serviceOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑할 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 "externalProductInventory": [ { "externalProductInventoryId": "String" } ] 주: 이전에는 이미 존재했던 외부 제품 인벤토리 ID를 사용하여 PATCH 주문을 생성할 때 작업이 중단되고 오류가 반환되었습니다. 릴리스에서는 Xanadu 기존 외부 제품 인벤토리 ID가 제공되고 오류가 발생하지 않을 때 이 매개변수가 무시됩니다. |
| serviceOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열 |
| serviceOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.orderRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "orderRelationship:" [ { "id": "String", "relationshipType": "String" } ] |
| serviceOrderItem.orderRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.orderRelationship.relationshipType | 두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: * 하일드 * 부모 존재 여부 * 필수 {#serviceorder-PATCH-serviceOrder-id__d2876e2334} `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열 |
| serviceOrderItem.place | 서비스를 설치할 위치의 맵입니다. 데이터 유형: 객체 "place:" { "id": "String", "@type": "String" } |
| serviceOrderItem.place.id | 위치\[cmn_location\] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| serviceOrderItem.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.quantity | 주문된 라인 항목 수입니다. 데이터 유형: 숫자 |
| serviceOrderItem.relatedParty | 광고 항목의 연락처 목록입니다. 데이터 유형: 배열 "relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } |
| serviceOrderItem.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.firstName | 연락처의 이름입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.lastName | 연락처의 성입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.phone | 연락처의 직장 전화 번호입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@referredType | 고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service | 고객이 구매한 서비스의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 "service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" } |
| serviceOrderItem.service.id | 판매된 서비스의 고유 식별자입니다. 이 값은 제품 인벤토리 \[sn_ind_tmt_orm_product_inventory\] 테이블의 sys_id 또는 외부 ID일 수 있습니다. 이 값은 변경/연결 해제 주문에 대해서만 반환됩니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic | 연결된 서비스의 특성을 설명하는 목록입니다. 현재와 다른 previousValue 서비스를 value 제공하는 서비스 특성만 반환됩니다. 데이터 유형: 배열 "serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ] |
| serviceOrderItem.service.serviceCharacteristic.name | 서비스와 연결된 특성 기록의 이름입니다. 특성 \[sn_prd_pm_characteristic\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.previousValue | 업데이트가 주문 변경용인 경우의 이전 특성 옵션 값입니다. 매개변수가 serviceOrderItem.actionadd가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.value | 서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification | 서비스와 연관된 서비스 사양에 대한 설명입니다. 데이터 유형: 객체 "serviceSpecification:" { "id": "String", "name": "String", "@type": "String" } |
| serviceOrderItem.service.serviceSpecification.id | 서비스 사양의 Initial_version 또는 external_id입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양 \[sn_prd_pm_service_specification\] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.name | 서비스 사양의 이름입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 상태 | 서비스 주문의 상태입니다. 자세한 내용은 문서를 참조하십시오. 데이터 유형: 문자열 |
[ ]
{#serviceorder-PATCH-serviceOrder-id__table_t5s_hm1_hwb}
### cURL 요청 {#serviceorder-PATCH-serviceOrder-id__example_jsc_1dc_vrb}
이 예는 서비스 주문을 업데이트하는 방법을 보여줍니다.
curl -X PATCH 'https://instance.service-now.com/api/sn_tmf_api/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
"externalId": "BSS748",
"priority": "1",
"description": "Managed Security",
"category": "TMF resource illustration",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"id": "1",
"author": "Jean Pontus",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration"
},
{
"id": "2",
"author": "Jean Pontus1",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "add",
"actionReason":"adding service package OLI",
"quantity": 1,
"@type": "ServiceOrderItem",
"service": {
"serviceState": "active",
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "CPE Type",
"valueType": "string",
"value": "Virtual"
},
{
"name": "Administration Support",
"valueType": "string",
"value": "Basic( Customer Managed)"
},
{
"name": "Firewall coverage",
"valueType": "string",
"value": "Standard(Up to 20 sites)"
},
{
"name": "Firewall Security",
"valueType": "string",
"value": "Basic"
}
],
"serviceSpecification": {
"id": "f99546ff07266010a7955b7e0ad300a8",
"name": "Managed Firewall Service",
"internalVersion": "1",
"@type": "Managed Firewall Service"
},
"serviceRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
]
},
"place": {
"id": "5671dd2ec3a53010188473ce3640dd81",
"@type": "Place"
}
}
],
"relatedParty":[
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
]
}'
응답 본문입니다.
{
"externalId": "BSS748",
"priority": "1",
"description": "Managed Security",
"category": "TMF resource illustration",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"id": "1",
"author": "Jean Pontus",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration"
},
{
"id": "2",
"author": "Jean Pontus1",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "add",
v"actionReason": "adding service package OLI",
"quantity": 1,
"@type": "ServiceOrderItem",
"service": {
"serviceState": "active",
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "CPE Type",
"valueType": "string",
"value": "Virtual"
},
{
"name": "Administration Support",
"valueType": "string",
"value": "Basic(Customer Managed)"
},
{
"name": "Firewall coverage",
"valueType": "string",
"value": "Standard(Up to 20 sites)"
},
{
"name": "Firewall Security",
"valueType": "string",
"value": "Basic"
}
],
"serviceSpecification": {
"id": "f99546ff07266010a7955b7e0ad300a8",
"name": "Managed Firewall Service",
"internalVersion": "1",
"@type": "Managed Firewall Service",
"sys_id": "f99546ff07266010a7955b7e0ad300a8",
"version": "",
"status": "published",
"internalId": "f99546ff07266010a7955b7e0ad300a8"
},
"serviceRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
]
},
"place": {
"id": "5671dd2ec3a53010188473ce3640dd81",
"@type": "Place"
}
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"orderType": "add",
"state": "revision_received",
"href": "/api/sn_tmf_api/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}
## 서비스 주문 오픈 API - POST /sn_tmf_api/order/serviceOrder/cancelserviceorder {#ariaid-title5}
지정된 서비스 주문을 취소합니다.
주:
이 엔드포인트는 반품 불가 지점에 도달한 주문에는 사용할 수 없습니다. 이행이 진행되는 동안에는 주문 라인 항목을 취소할 수 없습니다.
### URL 형식
기본 URL: /api/sn_tmf_api/order/serviceOrder/cancelserviceorder
### 지원되는 요청 매개변수
{#serviceorder-POST-cancelserviceord__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 19. 경로 매개변수]
{#serviceorder-POST-cancelserviceord__entry__6}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 20. 쿼리 매개변수]
{#serviceorder-POST-cancelserviceord__entry__10}
| 이름 | 설명 |
|-|-|
| cancellationReason (영문) | 취소 사유입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| serviceOrder | 서비스 주문에 대한 데이터를 포함합니다. 데이터 유형: 객체 "serviceOrder": { "id": "String", "href": "String", "@referredType": "String" } |
| serviceOrder.id | 필수 취소할 고객 주문의 Sys_id입니다. 고객 주문 \[sn_ind_tmt_orm_order\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrder.href | 취소할 고객 주문의 URL입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| serviceOrder.@referredType | 이 매개 변수의 값은 `ServiceOrder`여야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 요청취소날짜 | 주문을 취소할 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| @type | 이 매개 변수의 값은 `CancelServiceOrder`여야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
[표 21. 요청 본문 매개변수(JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-POST-cancelserviceord__table_omb_dvk_5rb__entry__2}{#serviceorder-POST-cancelserviceord__accept-JSON-only-entry-RESTAPI}{#serviceorder-POST-cancelserviceord__content_type-JSON-only-entry-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
[표 22. 요청 헤더]
{#serviceorder-POST-cancelserviceord__table_omb_dvk_5rb} {#serviceorder-POST-cancelserviceord__table_tzy_thy_ksb__entry__2}
| 헤더 | 설명 |
|-|-|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
[표 23. 응답 헤더]
{#serviceorder-POST-cancelserviceord__table_tzy_thy_ksb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-POST-cancelserviceord__entry__36}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. * 페이로드가 비어 있습니다. * 잘못된 페이로드입니다. 필수 필드 누락: \<필드 이름\>. * 잘못된 주문 ID입니다. * 잘못된 주문 ID: 이 주문은 고객 주문 테이블에서 아직 생성되지 않았습니다. 아직 생성되지 않은 주문에 대한 취소 요청이 이루어졌습니다. 주문은 인바운드 큐\[sn_tmt_core_inbound_queue\] 테이블에서 스케줄러가 기록을 선택할 때까지 기다리고 있습니다. {#serviceorder-POST-cancelserviceord__ul_lg1_5vt_5rb} |
[표 24. 상태 코드]
### 응답 본문 매개변수(JSON)
{#serviceorder-POST-cancelserviceord__entry__42}
| 이름 | 설명 |
|-|-|
| cancellationReason (영문) | 취소 사유입니다. 데이터 유형: 문자열 |
| id | 취소된 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| serviceOrder | 서비스 주문에 대한 데이터를 포함합니다. 데이터 유형: 객체 "serviceOrder": { "id": "String", "@referredType": "String" } |
| serviceOrder.id | 취소된 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| serviceOrder.@referredType | 이 매개 변수의 값은 `ServiceOrder`입니다. 데이터 유형: 문자열 |
| 요청취소날짜 | 주문을 취소할 날짜입니다. 데이터 유형: 문자열 |
| 상태 | 취소의 상태입니다. 취소 요청이 성공적으로 처리되면(201 상태 코드) 이 매개 변수의 값이 `완료됩니다`. 데이터 유형: 문자열 |
| @type | 이 매개 변수의 값은 `CancelServiceOrder`입니다. 데이터 유형: 문자열 |
[ ]
### cURL 요청
다음 코드 예제에서는 고객 주문을 취소합니다.
curl -X POST "https://instance.servicenow.com/api/sn_tmf_api/cancelserviceorder" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"cancellationReason": "Duplicate order",
"requestedCancellationDate": "2023-01-24T11:56:21.931Z",
"serviceOrder": {
"id": "5f4f5e5377a311101fa5a4d54b5a99fd",
"@referredType": "ServiceOrder"
},
"@type": "CancelServiceOrder"
}
{
"id": "5f4f5e5377a311101fa5a4d54b5a99fd",
"cancellationReason": "Duplicate order",
"requestedCancellationDate": "2023-01-24T11:56:21.931Z",
"@type": "CancelServiceOrder",
"serviceOrder": {
"id": "5f4f5e5377a311101fa5a4d54b5a99fd",
"@referredType": "ServiceOrder"
},
"state": "done"
}
## 서비스 주문 오픈 API -- POST /sn_tmf_api/order/serviceOrder {#ariaid-title6}
서비스 주문 또는 라인 항목을 생성, 업데이트 또는 삭제합니다.
추가 작업이 수신되고 수락되면 다음 테이블에 새 기록이 생성됩니다.
* 주문 \[sn_ind_tmt_orm_order\]
* 주문 특성 값 \[sn_ind_tmt_orm_order_characteristic_value\]
* 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\]
* 주문 라인 항목 연락처 \[sn_ind_tmt_orm_order_line_item_contact\]
* 주문 라인 관련 항목 \[sn_ind_tmt_orm_order_line_related_items\]
{#serviceorder-POST-order__ul_lxc_kxm_t4b}
### URL 형식
/api/sn_tmf_api/order/serviceOrder
### 지원되는 요청 매개변수
{#serviceorder-POST-order__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 25. 경로 매개변수]
{#serviceorder-POST-order__entry__6}
| 이름 | 설명 |
|-|-|
| 모드 | 비동기 주문 처리를 활성화합니다. 그러면 생성할 인바운드 큐\[sn_tmt_core_inbound_queue\] 테이블에 주문이 추가됩니다. 포함되지 않은 경우 주문은 동기적으로 처리됩니다. 가능한 값: async 데이터 유형: 문자열 |
[표 26. 쿼리 매개변수]
{#serviceorder-POST-order__entry__10}{#serviceorder-POST-order__svcOrdItem-ph-tmf641-externalid}{#serviceorder-POST-order__note-ph-tmf622}{#serviceorder-POST-order__note_text-ph-tmf622}{#serviceorder-POST-order__requestedCompletionDate-ph-tmf622}{#serviceorder-POST-order__reqStartDate-ph-tmf622}{#serviceorder-POST-order__svcOrdItem-ph-tmf641}{#serviceorder-POST-order__service_id-ph-tmf641}{#serviceorder-POST-order__svcOrderItemRel_id-ph-tmf641}{#serviceorder-POST-order__productOrderItemRelationship_relType-row-tmf622}{#serviceorder-POST-order__service-s-tmf641}
| 이름 | 설명 |
|-|-|
| committedDueDate | 주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/committed_due_date |
| externalId | 외부 서비스 주문의 고유한 주문 번호입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 메모 | 고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열{#serviceorder-POST-order__note_data_type-p-tmf622} "note": [ { "text": "String" } ] {#serviceorder-POST-order__note-codeblock-tmf622} 업데이트된 테이블/필드: sn_ind_tmt_orm_order |
| note.text | 고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열{#serviceorder-POST-order__note_text_data_type-p-tmf622} 업데이트된 테이블/필드: sn_ind_tmt_orm_order/의견 기본값: 빈 문자열 |
| orderDate | 주문의 날짜 및 타임스탬프입니다. 형식: YYYY--MM--DD HH:MM:SS 데이터 유형: 문자열 기본값: 빈 문자열 |
| 관련파티 | 주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 요청에는 고객 계정 또는 소비자 계정 정보가 포함된 항목이 하나 이상 나열되어야 합니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] |
| relatedParty.id | 필수 주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 \[customer_account\] 테이블, 연락처 \[customer_contact\] 테이블 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 업데이트된 테이블: sn_ind_tmt_orm_order |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * 고객 연락처 * 소비자 {#serviceorder-POST-order__ul_cdn_ddp_kqb} 데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열{#serviceorder-POST-order__reqCompDate_data_type-p-tmf622} 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_end_date 기본값: 빈 문자열 |
| requestedStartDate | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열{#serviceorder-POST-order__reqStartDate_data_type-p-tmf622} 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_start_date 기본값: 빈 문자열 |
| serviceOrderItem | 필수 서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열{#serviceorder-POST-order__svcOrdItem_data_type-p-tmf641} "serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ] {#serviceorder-POST-order__svcOrdItem-codeblock-tmf641} 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item |
| serviceOrderItem.action | 필수 서비스 주문 항목에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 입력 필드에 있는 선택 목록 탭에서 정의합니다. 가능한 값: * add * 변경 * 삭제 * 변경 없음 * resume * 매달다 {#serviceorder-POST-order__ul_grg_vgl_gqb}자세한 내용은 [Action types for customer and service orders](https://www.servicenow.com/docs/access?context=order-mgt-customer-order-types&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US) 문서를 참조하십시오. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item/작업 기본값: add |
| ServiceOrderItem.actionReason | 옵션입니다. 라인 항목의 이유에 대한 설명입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] table/action_reason. |
| serviceOrderItem.committedDueDate | 주문 라인 항목에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/committed_due_date |
| serviceOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑할 외부 ID를 포함하는 객체의 배열입니다. 데이터 형식: 개체 배열 "externalProductInventory": [ { "externalProductInventoryId": "String" } ] |
| serviceOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑할 외부 ID입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item/external_inventory_id 및 sn_prd_invt_product_inventory/sn_prd_invt_external_id |
| serviceOrderItem.id | 필수 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/external_id |
| serviceOrderItem.orderRelationship | 필수 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "orderRelationship:" [ { "id": "String", "relationshipType": "String" } ] {#serviceorder-POST-order__svcOrderItemRel-codeblock} 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item |
| serviceOrderItem.orderRelationship.id | 필수 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item/parent_line_item 또는 sn_ind_tmt_orm_order_line_related_items/related_order_line_item |
| serviceOrderItem.orderRelationship.relationshipType | 필수 두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: * 하일드 * 부모 존재 여부 * 필수 {#serviceorder-POST-order__ul_yqf_2ty_54b} `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열 |
| serviceOrderItem.place | 서비스를 설치할 위치의 맵입니다. 데이터 유형: 객체 "place:" { "id": "String", "@type": "String" } |
| serviceOrderItem.place.id | 필수 위치\[cmn_location\] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item/위치 기본값: 빈 문자열 |
| serviceOrderItem.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 장소에 대한 주석입니다. 데이터 유형: 문자열 |
| serviceOrderItem.quantity | 주문할 라인 항목 수를 설정합니다. 이 속성은 서비스 주문을 추가할 때만 적용할 수 있습니다. 즉, 속성 값은 action`add`입니다. 데이터 유형: 숫자 기본값: 빈 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order/수량 |
| serviceOrderItem.relatedParty | 광고 항목의 연락처 목록입니다. 데이터 유형: 배열 "relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } |
| serviceOrderItem.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.firstName | 연락처의 이름입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.lastName | 연락처의 성입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.phone | 연락처의 직장 전화 번호입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@referredType | 필수 고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service | 필수 고객이 구매한 서비스의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 "service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" } {#serviceorder-POST-order__service-codeblock-tmf641} 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item |
| serviceOrderItem.service.id | 판매된 서비스의 고유 식별자입니다. 이 값은 제품 인벤토리 \[sn_ind_tmt_orm_product_inventory\] 테이블의 sys_id 또는 외부 ID일 수 있습니다. 이 값은 변경/연결 해제 주문에만 사용됩니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic | 연결된 서비스의 특성을 설명하는 목록입니다. 현재와 다른 previousValue 서비스를 value 제공하는 서비스 특성만 반환됩니다. 데이터 유형: 배열 "serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ] |
| serviceOrderItem.service.serviceCharacteristic.name | 서비스와 연결된 특성 기록의 이름입니다. 특성 \[sn_prd_pm_characteristic\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.previousValue | 업데이트가 주문 변경용인 경우의 이전 특성 옵션 값입니다. 매개변수가 serviceOrderItem.actionadd가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.value | 서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceRelationship | 서비스와 관련된 제품 인벤토리 목록입니다. 데이터 유형: 배열 "serviceRelationship": [ { "id": "String", "relationshipType": "String" } ] |
| serviceOrderItem.service.serviceRelationship.id | 제품 인벤토리의 Sys_id 또는 sn_prd_invt_external_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 sys_id 또는 sn_prd_invt_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceRelationship.relationshipType | 서비스와 제품 인벤토리 간의 관계 유형입니다. 가능한 값: 필요 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification | 필수 서비스와 연관된 서비스 사양에 대한 설명입니다. 주: 변경 주문(serviceOrderItem.action`변경 여부)`은 시스템 속성 값에 따라 다르게 처리됩니다sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. * 속성이 true(기본값)로 설정되어 있을 때 서비스가 주문에 표시된 버전과 다른 버전인 경우 참조된 서비스 사양을 변경하여 서비스가 순서에 있는 버전으로 자동 업그레이드됩니다. 이렇게 하면 주문을 성공적으로 처리할 수 있습니다. * 속성이 false로 설정되어 있을 때 서비스가 주문에 표시된 버전과 다른 버전이면 버전 불일치로 인해 순서가 실패합니다. {#serviceorder-POST-order__ul_zbw_sdz_dbc} 데이터 유형: 객체 "serviceSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 service_specification 필드를 업데이트합니다. |
| serviceOrderItem.service.serviceSpecification.id | 필수 서비스 사양의 Initial_version 또는 external_id입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양 \[sn_prd_pm_service_specification\] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.internalVersion | 서비스 사양의 버전입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.name | 필수 서비스 사양의 이름입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.version | 서비스 사양의 External_version입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
[표 27. 요청 본문 매개변수(JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-POST-order__entry__114}{#serviceorder-POST-order__accept-JSON-only-entry-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
[표 28. 요청 헤더]
{#serviceorder-POST-order__table_tzy_thy_ksb__entry__2}
| 헤더 | 설명 |
|-|-|
| 컨텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
[표 29. 응답 헤더]
{#serviceorder-POST-order__table_tzy_thy_ksb}
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#serviceorder-POST-order__table_kmf_3jm_gqb__entry__2}{#serviceorder-POST-order__entry-200-status-code}{#serviceorder-POST-order__entry-404-status-code}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 201 | 성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다. * 다음 주문 항목 특성이 없습니다. 사양을 검토\ 주문을 승인하기 전에 주문 라인 항목의 특성 및 특성 옵션을 수정합니다. * 주문 항목 특성: \ 특성 값: \이 잘못되었습니다. 주문을 승인하기 전에 특성 값을 수정하십시오. {#serviceorder-POST-order__ul_r1r_jhm_gqb} |
| 202 | 허용. 비동기 모드에서 주문에 대한 성공적인 요청입니다. 즉, 매개변수가 mode`async` 로 설정되어 요청이 이루어졌고 기록이 인바운드 큐 \[sn_tmt_core_inbound_queue\] 테이블에서 처리되도록 예약되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. * 잘못된 페이로드: 요청 본문이 누락되었습니다. - 페이로드가 요청 본문에 전달되지 않았습니다. * 잘못된 페이로드: serviceOrderItem이 없습니다. - 서비스 주문 라인 항목 객체 또는 JSON이 누락되었습니다. * 잘못된 페이로드: serviceOrderItem ID가 누락되었습니다. -- 서비스 주문 라인 항목에서 ID가 누락되었습니다. * 잘못된 페이로드: serviceOrderItem 작업이 누락되었습니다. -- 페이로드에서 서비스 객체 또는 JSON이 누락되었습니다. * 잘못된 페이로드: serviceOrderItem 서비스가 누락되었습니다. -- 서비스 주문 라인 항목에서 서비스 속성이 누락되었습니다. * 잘못된 페이로드: serviceSpecification이 누락되었습니다. - 서비스 주문 라인 항목의 서비스 사양 객체 또는 JSON이 페이로드에서 누락되었습니다. * 잘못된 페이로드: serviceSpecification ID가 누락되었습니다. id- 서비스 사양 개체의 서비스 주문 라인 항목에 있는 매개변수가 페이로드에서 누락되었습니다. * 잘못된 페이로드: 서비스 사양이 없습니다. - 서비스 주문 라인 항목의 서비스 사양이 잘못되었습니다. * 잘못된 페이로드: 제품 인벤토리가 없습니다. - 변경 또는 삭제 주문(즉, 작업 = 변경 또는 삭제)에서 전송된 판매된 서비스가 시스템에 없습니다. * 잘못된 페이로드: 제품 인벤토리 ID가 누락되었습니다. -- 주문 변경 또는 삭제 시 판매된 제품 ID가 페이로드에서 누락되었습니다. * 잘못된 페이로드: 고객 계정 또는 소비자가 없음 - 관련 당사자 고객 또는 소비자 객체가 페이로드에서 누락되었습니다. * 잘못된 페이로드: 판매된 제품이 비활성 상태입니다. -- 주문 변경 또는 삭제에서 페이로드로 전송된 판매된 제품은 활성 상태가 아닙니다. * 잘못된 페이로드: 소비자가 없음 - 지정된 관련 당사자 소비자가 인스턴스에 없습니다. * 잘못된 페이로드: 고객 계정이 없습니다. -- 페이로드에 제공된 관련 당사자 고객이 시스템에 없습니다. * 잘못된 페이로드: 주문을 생성하지 못했습니다. - 요청한 주문을 생성할 수 없습니다. {#serviceorder-POST-order__ul_v1r_jhm_gqb} |
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
[표 30. 상태 코드]
{#serviceorder-POST-order__table_kmf_3jm_gqb}
### 응답 본문 매개변수(JSON)
{#serviceorder-POST-order__entry__134}{#serviceorder-POST-order__type-entry-tmf641}
| 이름 | 설명 |
|-|-|
| committedDueDate | 주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 |
| externalId | 외부 서비스 주문의 고유한 주문 번호입니다. 데이터 유형: 문자열 |
| href | 자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| id | 서비스 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 메모 | 고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "note": [ { "text": "String" } ] |
| note.text | 고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열 |
| orderDate | 주문의 날짜 및 타임스탬프입니다. 형식: YYYY--MM--DD HH:MM:SS 데이터 유형: 문자열 기본값: 빈 문자열 |
| orderId | 생성할 주문의 Sys_id입니다. 요청이 성공하면 처리할 일정에 따라 인바운드 큐\[sn_tmt_core_inbound_queue\] 테이블에 주문이 추가됩니다. 주: 이 값은 쿼리의 매개변수를 사용하여 주문이 비동기적으로 생성된 경우의 mode 유일한 결과입니다. { "orderId": "b0fc877ac3ab5110856d73ce3640dde0" } 데이터 유형: 문자열 |
| 관련파티 | 주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 데이터 유형: 배열 "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ] |
| relatedParty.id | 주문과 관련된 계정, 고객 또는 소비자 접촉 창구의 Sys_id 또는 external_id입니다. 계정 \[customer_account\], 연락처 \[customer_contact\] 또는 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객 유형입니다. 가능한 값: * 고객 * 고객 연락처 * 소비자 {#serviceorder-POST-order__ul_vvn_12p_kqb} 데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 |
| requestedStartDate | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 |
| serviceOrderItem | 서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 "serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ] |
| serviceOrderItem.action | 서비스 주문 항목에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 입력 필드에 있는 선택 목록 탭에서 정의합니다. 가능한 값: * add * 변경 * 삭제 * 변경 없음 * resume * 매달다 {#serviceorder-POST-order__ul_t4n_rqx_kqb}자세한 내용은 [Action types for customer and service orders](https://www.servicenow.com/docs/access?context=order-mgt-customer-order-types&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US) 문서를 참조하십시오. 데이터 유형: 문자열 |
| ServiceOrderItem.actionReason | 라인 항목을 추가하는 이유에 대한 설명입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.committedDueDate | 주문 라인 항목에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 데이터 유형: 문자열 |
| serviceOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑된 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 "externalProductInventory": [ { "externalProductInventoryId": "String" } ] |
| serviceOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열 |
| serviceOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.orderRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 "orderRelationship:" [ { "id": "String", "relationshipType": "String" } ] |
| serviceOrderItem.orderRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 \[sn_ind_tmt_orm_order_line_item\] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.orderRelationship.relationshipType | 두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: * 하일드 * 부모 존재 여부 * 필수 {#serviceorder-POST-order__d2876e2334} `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열 |
| serviceOrderItem.place | 서비스를 설치할 위치의 맵입니다. 데이터 유형: 객체 "place:" { "id": "String", "@type": "String" } |
| serviceOrderItem.place.id | 위치\[cmn_location\] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| serviceOrderItem.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.quantity | 주문된 라인 항목 수입니다. 데이터 유형: 숫자 |
| serviceOrderItem.relatedParty | 광고 항목의 연락처 목록입니다. 데이터 유형: 배열 "relatedParty:" { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } |
| serviceOrderItem.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.firstName | 연락처의 이름입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.lastName | 연락처의 성입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.phone | 연락처의 직장 전화 번호입니다. 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@referredType | 필수 고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| serviceOrderItem.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service | 고객이 구매한 서비스의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 "service:" { "id": "String", "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "@type": "String" } |
| serviceOrderItem.service.id | 판매된 서비스의 고유 식별자입니다. 이 값은 제품 인벤토리 \[sn_ind_tmt_orm_product_inventory\] 테이블의 sys_id 또는 외부 ID일 수 있습니다. 이 값은 변경/연결 해제 주문에 대해서만 반환됩니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic | 연결된 서비스의 특성을 설명하는 목록입니다. 현재와 다른 previousValue 서비스를 value 제공하는 서비스 특성만 반환됩니다. 데이터 유형: 배열 "serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", } ] |
| serviceOrderItem.service.serviceCharacteristic.name | 서비스와 연결된 특성 기록의 이름입니다. 특성 \[sn_prd_pm_characteristic\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.previousValue | 업데이트가 주문 변경용인 경우의 이전 특성 옵션 값입니다. 매개변수가 serviceOrderItem.actionadd가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceCharacteristic.value | 서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오[Create product characteristics and characteristic options](https://www.servicenow.com/docs/access?context=som-product-config-add-characteristics&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US). 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceRelationship | 서비스와 관련된 제품 인벤토리 목록입니다. 데이터 유형: 배열 "serviceRelationship": [ { "id": "String", "relationshipType": "String" } ] |
| serviceOrderItem.service.serviceRelationship.id | 제품 인벤토리의 Sys_id 또는 sn_prd_invt_external_id입니다. 제품 인벤토리 \[sn_prd_invt_product_inventory\] 테이블의 sys_id 또는 sn_prd_invt_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceRelationship.relationshipType | 서비스와 제품 인벤토리 간의 관계 유형입니다. 가능한 값: 필요 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification | 서비스와 연관된 서비스 사양에 대한 설명입니다. 데이터 유형: 객체 "serviceSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" } |
| serviceOrderItem.service.serviceSpecification.id | 서비스 사양의 Initial_version 또는 external_id입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양 \[sn_prd_pm_service_specification\] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.internalId | 서비스 사양의 Initial_version입니다. initial_version는 사양의 첫 번째 버전 sys_id입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.internalVersion | 서비스 사양의 버전입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.name | 서비스 사양의 이름입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.version | 서비스 사양의 External_version입니다. 서비스 사양\[sn_prd_pm_service_specification\] 테이블에 있습니다. 데이터 유형: 문자열 |
| serviceOrderItem.service.serviceSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| serviceOrderItem.state | 서비스 주문 항목의 상태입니다. 예를 들어 new입니다. 데이터 유형: 문자열 |
| serviceOrderItem.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 상태 | 서비스 주문의 상태입니다. 자세한 내용은 문서를 참조하십시오. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 이 값은 항상 ServiceOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
[ ]
### 비동기적으로 처리 {#serviceorder-POST-order__example_ynv_vhx_fwb}
이 예제에서는 쿼리 매개 변수를 사용하여 mode 비동기적으로 주문을 만드는 방법을 보여 줍니다. 주문이 생성 예정 일정에 따라 인바운드 큐 \[sn_tmt_core_inbound_queue\] 테이블에 추가됩니다.
curl -X POST 'https://instance.service-now.com/api/sn_tmf_api/serviceorder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
"externalId": "BSS748",
"priority": "1",
"description": "Managed Security",
"category": "TMF resource illustration",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"id": "1",
"author": "Jean Pontus",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration"
},
{
"id": "2",
"author": "Jean Pontus1",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "add",
"actionReason":"adding service package OLI",
"quantity": 1,
"@type": "ServiceOrderItem",
"service": {
"serviceState": "active",
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "CPE Type",
"valueType": "string",
"value": "Virtual"
},
{
"name": "Administration Support",
"valueType": "string",
"value": "Basic( Customer Managed)"
},
{
"name": "Firewall coverage",
"valueType": "string",
"value": "Standard(Up to 20 sites)"
},
{
"name": "Firewall Security",
"valueType": "string",
"value": "Basic"
}
],
"serviceSpecification": {
"id": "f99546ff07266010a7955b7e0ad300a8",
"name": "Managed Firewall Service",
"internalVersion": "1",
"@type": "Managed Firewall Service"
},
"serviceRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
]
},
"place": {
"id": "5671dd2ec3a53010188473ce3640dd81",
"@type": "Place"
}
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
]
}'
응답 본문입니다.
{
"orderId": "304e877ac3ab5110856d73ce3640dde5"
}
### 동기적으로 처리(기본값)
다음 예제에서는 add 속성을 설정하여serviceOrderItem.action 서비스 주문을 만드는 방법을 보여 줍니다.
curl "https://instance.service-now.com/api/sn_tmf_api/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"externalId": "BSS748",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"text": "This is a TMF service order illustration"
},
{
"text": "This is a TMF service order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "add",
"actionReason":"adding service package OLI",
"quantity": 1,
"@type": "ServiceOrderItem",
"service": {
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "Firewall Security",
"value": "Standard"
},
{
"name": "Firewall coverage",
"value": "Premium (Up to 50 sites)"
},
{
"name": "Administration Support",
"value": "Basic (Customer Managed)"
}
],
"serviceRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"serviceSpecification": {
"id": "f99546ff07266010a7955b7e0ad300a8",
"name": "Managed Firewall Service",
"@type": "Managed Firewall Service"
}
},
"relatedParty": [
{
"firstName": "Mike",
"lastName": "Hudson",
"email": "mike@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"@type": "Place"
}
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
]
}" \
--user 'username':'password'
응답 본문:
{
"externalId": "BSS748",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"text": "This is a TMF service order illustration"
},
{
"text": "This is a TMF service order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "add",
"actionReason":"adding service package OLI",
"quantity": 1,
"@type": "ServiceOrderItem",
"service": {
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "Firewall Security",
"value": "Standard"
},
{
"name": "Firewall coverage",
"value": "Premium (Up to 50 sites)"
},
{
"name": "Administration Support",
"value": "Basic (Customer Managed)"
}
],
"serviceRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"serviceSpecification": {
"id": "f99546ff07266010a7955b7e0ad300a8",
"name": "Managed Firewall Service",
"@type": "Managed Firewall Service",
"internalVersion": "2",
"version": "v2",
"internalId": "f99546ff07266010a7955b7e0ad300a8"
}
},
"relatedParty": [
{
"firstName": "Mike",
"lastName": "Hudson",
"email": "mike@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"@type": "Place"
},
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"id": "4f2af65ac3a030106e2473ce3640ddcf",
"href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
"orderDate": "2024-06-20T10:38:55.000Z",
"state": "new"
}
### cURL 요청 {#serviceorder-POST-order__example_vrq_jgm_gqb}
다음 예에서는 속성을 change로 설정하여 serviceOrderItem.action 서비스 주문을 업데이트합니다.
curl "https://instance.service-now.com/api/sn_tmf_api/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"externalId": "BSS748",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"text": "This is a TMF service order illustration"
},
{
"text": "This is a TMF service order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "change",
"actionReason":"change service package OLI",
"@type": "ServiceOrderItem",
"service": {
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "Firewall Security",
"value": "Premium",
"previousValue": "Standard"
}
],
"id": "4b5072aec3a83010abc8b5183c40dd42"
},
"relatedParty": [
{
"firstName": "Mike",
"lastName": "Hudson",
"email": "mike@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"@type": "Place"
}
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
]
}" \
--user 'username':'password'
응답 본문입니다.
{
"externalId": "BSS748",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"text": "This is a TMF service order illustration"
},
{
"text": "This is a TMF service order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "change",
"actionReason":"change service package OLI",
"@type": "ServiceOrderItem",
"service": {
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "Firewall Security",
"value": "Premium",
"previousValue": "Standard"
}
],
"id": "4b5072aec3a83010abc8b5183c40dd42"
},
"relatedParty": [
{
"firstName": "Mike",
"lastName": "Hudson",
"email": "mike@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"@type": "Place"
},
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"id": "4f2af65ac3a030106e2473ce3640ddcf",
"href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
"orderDate": "2024-06-20T10:38:55.000Z",
"state": "new"
}
### cURL 요청 {#serviceorder-POST-order__example_f5w_jgm_gqb}
다음 예에서는 속성을 delete로 설정하여 serviceOrderItem.action 서비스 주문 라인 항목을 삭제합니다.
curl "https://instance.service-now.com/api/sn_tmf_api/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"externalId": "BSS748",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"text": "This is a TMF service order illustration"
},
{
"text": "This is a TMF service order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "delete",
"actionReason":"delete service package OLI",
"@type": "ServiceOrderItem",
"service": {
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "Firewall Security",
"value": "Premium",
"previousValue": "Standard"
}
],
"id": "4b5072aec3a83010abc8b5183c40dd42"
},
"relatedParty": [
{
"firstName": "Mike",
"lastName": "Hudson",
"email": "mike@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"@type": "Place"
}
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
]
}" \
--user 'username':'password'
응답 본문입니다.
{
"externalId": "BSS748",
"requestedStartDate": "2018-01-15T09:37:40.508Z",
"requestedCompletionDate": "2018-01-15T09:37:40.508Z",
"@type": "ServiceOrder",
"note": [
{
"text": "This is a TMF service order illustration"
},
{
"text": "This is a TMF service order illustration no 2"
}
],
"serviceOrderItem": [
{
"id": "100",
"action": "delete",
"actionReason":"delete service package OLI",
"@type": "ServiceOrderItem",
"service": {
"@type": "CFS",
"serviceCharacteristic": [
{
"name": "Firewall Security",
"value": "Premium",
"previousValue": "Standard"
}
],
"id": "4b5072aec3a83010abc8b5183c40dd42"
},
"relatedParty": [
{
"firstName": "Mike",
"lastName": "Hudson",
"email": "mike@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"@type": "Place"
},
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"id": "4f2af65ac3a030106e2473ce3640ddcf",
"href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
"orderDate": "2024-06-20T10:38:55.000Z",
"state": "new"
}