서비스 주문 개방형 API

릴리스 버전: Washingtondc

업데이트 날짜 2024년 02월 01일

읽기138분

Service Order Open API는 서비스 주문을 위한 표준화된 메커니즘을 제공합니다.

이 API는 Open API TMForum TMF641 Service Ordering Management API 사양의 구현입니다 ServiceNow® .

이 API에 Order Management for Telecommunications 액세스하려면 (sn_ind_tmt_orm) 플러그인을 활성화해야 합니다. 자세한 내용은 Install Order Management 문서를 참조하십시오. 테이블, 엔터티 및 관계에 대한 Order Management 자세한 내용은 을 참조하십시오 Order Management data model.

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

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

이 API를 확장하여 필수 매개변수, 요청 본문 유효성 검사, 추가 REST 작업 및 필드 매핑을 사용자 지정할 수 있습니다. 자세한 내용은 Service Order Open API 개발자 가이드에 나와 있습니다.

서비스 주문 개방형 API – GET /sn_ind_tmt_orm/serviceorder

모든 서비스 주문을 검색합니다.

이 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]

URL 형식

/api/sn_ind_tmt_orm/serviceorder

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
없음

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

표 3. 요청 본문 매개변수(JSON)
이름	설명
없음

헤더

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

표 4. 요청 헤더
헤더	설명
없음

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

상태 코드

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

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

응답 본문 매개변수(JSON)


이름	설명
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열
expectedCompletionDate (예상완료일)	주문이 완료될 날짜입니다. 데이터 유형: 문자열
ID	요청된 서비스 주문의 Sys_id입니다. 데이터 유형: 문자열
참고	주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	연결된 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
note.date	메모가 생성된 날짜입니다. 데이터 유형: 문자열
note.text	주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열
PONN	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. 이행이 진행되는 동안에는 주문을 수정하거나 취소할 수 없습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 주문을 수정하거나 취소할 수 있습니다. 데이터 유형: 부울
관련 당사자	주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 데이터 유형: 배열 `"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	고객의 유형입니다. 가능한 값: 소비자 고객 고객연락처 데이터 유형: 문자열
relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
requestedCompletionDate	고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열
requestedStartDate (요청된 시작 날짜)	고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열
서비스주문 항목	서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. `"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 문서를 참조하십시오. 데이터 유형: 문자열
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	두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하차일드 부모 해스 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `Requires` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
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: 주문 라인 항목에 대한 반품 불가 지점에 도달하지 않았습니다. 주문 라인 항목은 수정하거나 취소할 수 있습니다. 데이터 유형: 부울
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	서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열
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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
상태	서비스 주문의 상태입니다. 자세한 내용은 Service order states 문서를 참조하십시오. 데이터 유형: 문자열
@type	TMF Open API 표준의 일부입니다. 이 값은 항상 `ServiceOrder`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

cURL 요청

이 예에서는 모든 서비스 주문을 검색합니다.

curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/serviceorder' \
--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"
   }
]

서비스 주문 개방형 API – GET /sn_ind_tmt_orm/serviceorder/{id}

지정된 서비스 주문을 조회합니다.

이 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]

URL 형식

/api/sn_ind_tmt_orm/serviceorder/{id}입니다.

지원되는 요청 매개변수

표 7. 경로 매개변수
이름	설명
ID	검색할 서비스 주문의 Sys_id입니다. 순서 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열

표 8. 쿼리 매개변수
이름	설명
없음

표 9. 요청 본문 매개변수(JSON)
이름	설명
없음

헤더

표 10. 요청 헤더
헤더	설명
없음

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

상태 코드

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

표 12. 상태 코드
상태 코드	설명
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": "" } ] }` 200 OK 응답은 주문 생성에 실패하고 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블의 기록이 오류 상태일 때 발생합니다. 오류 메시지 필드에는 인바운드 큐 테이블 기록에 대한 세부 정보가 포함됩니다. 예: `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
400	잘못된 요청. 가능한 이유: 쿼리 매개변수 누락 잘못된 URI
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열
expectedCompletionDate (예상완료일)	주문이 완료될 날짜입니다. 데이터 유형: 문자열
ID	요청된 서비스 주문의 Sys_id입니다. 데이터 유형: 문자열
참고	주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	연결된 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
note.date	메모가 생성된 날짜입니다. 데이터 유형: 문자열
note.text	주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열
PONN	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. 이행이 진행되는 동안에는 주문을 수정하거나 취소할 수 없습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 주문을 수정하거나 취소할 수 있습니다. 데이터 유형: 부울
관련 당사자	주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 데이터 유형: 배열 `"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	고객의 유형입니다. 가능한 값: 소비자 고객 고객연락처 데이터 유형: 문자열
relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
requestedCompletionDate	고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열
requestedStartDate (요청된 시작 날짜)	고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열
서비스주문 항목	서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"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 데이터 유형: 문자열
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	두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하차일드 부모 해스 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `Requires` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
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: 주문 라인 항목에 대한 반품 불가 지점에 도달하지 않았습니다. 주문 라인 항목은 수정하거나 취소할 수 있습니다. 데이터 유형: 부울
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	서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열
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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
상태	서비스 주문의 상태입니다. 자세한 내용은 Service order states 문서를 참조하십시오. 데이터 유형: 문자열
@type	TMF Open API 표준의 일부입니다. 이 값은 항상 `ServiceOrder`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

cURL 요청

다음 예제에서는 지정된 서비스 주문을 검색합니다.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/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"
}

Service Order Open API - PATCH /sn_ind_tmt_orm/order/serviceorder/{id}

지정된 서비스 주문을 업데이트합니다.

URL 형식

기본 URL: / api/sn_ind_tmt_orm/order/serviceOrder/{id}

지원되는 요청 매개변수

표 13. 경로 매개변수
이름	설명
ID	업데이트할 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열

표 14. 쿼리 매개변수
이름	설명
없음

표 15. 요청 본문 매개변수(JSON)
이름	설명
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 주문 라인 항목에 대한 작업이 `일시 중단` 또는 `재개`인 경우 이 매개변수를 업데이트할 수 없습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/committed_due_date
외부 ID	외부 서비스 주문의 고유 주문 번호입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order
참고	주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note:" [ { "text": "String" } ]` 테이블/필드 업데이트됨: sn_ind_tmt_orm_order
note.text	주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/설명 기본값: 빈 문자열
orderDate	고객 주문 요청의 날짜입니다. 데이터 유형: 문자열
관련 당사자	주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 요청은 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"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	고객의 유형입니다. 가능한 값: 소비자 고객 고객연락처 데이터 유형: 문자열
relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
requestedCompletionDate	고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_end_date 기본값: 빈 문자열
requestedStartDate (요청된 시작 날짜)	고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_start_date 기본값: 빈 문자열
서비스주문 항목	필수 서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"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" } ]` 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item
serviceOrderItem.action	필수 서비스 주문 항목에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 입력 필드에 있는 선택 목록 탭에서 정의됩니다. 가능한 값: add 변경 삭제 변경 없음 이력서 일시 중단 자세한 내용은 Action types for customer and service orders 문서를 참조하십시오. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/작업
serviceOrderItem.actionReason	옵션입니다. 라인 항목의 이유에 대한 설명입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블/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" } ]` 테이블/필드 업데이트됨: 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	필수 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하차일드 부모 해스 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `Requires` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
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" }` 테이블/필드 업데이트됨: 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	변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 `add`가 아닌 경우 serviceOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 문서를 참조하십시오. 데이터 유형: 문자열
serviceOrderItem.service.serviceCharacteristic.value	서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열
serviceOrderItem.service.serviceSpecification	필수 서비스와 연결된 서비스 사양에 대한 설명입니다. 데이터 유형: 객체 `"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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

헤더

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

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

상태 코드

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

표 18. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
201	성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다. `다음 주문 항목 특성이 없습니다. 주문을 승인하기 전에 사양 <specification.name> 검토하고 주문 라인 항목에서 특성 및 특성 옵션을 수정하십시오.` `주문 항목 특성: <> 특성 값: <characteristic.namecharacteristic.value>이(가) 잘못되었습니다. 주문을 승인하기 전에 특성 값을 수정하십시오.`
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가 고객 주문 테이블에 없습니다. `주문의 이행 유형이 "배송"이 아니므로 패치 요청을 할 수 없습니다.` – 패치 요청이 이행 유형이 배송이 아닌 주문에 대해 수행되었습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열
외부 ID	외부 서비스 주문의 고유 주문 번호입니다. 데이터 유형: 문자열
ID	서비스 주문의 Sys_id입니다. 데이터 유형: 문자열
참고	주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]`
note.text	주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열
관련 당사자	주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 데이터 유형: 배열 `"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	고객의 유형입니다. 가능한 값: 고객 고객연락처 데이터 유형: 문자열
relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
requestedCompletionDate	고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열
requestedStartDate (요청된 시작 날짜)	고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열
서비스주문 항목	서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"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 변경 삭제 자세한 내용은 Action types for customer and service orders 문서를 참조하십시오. 데이터 유형: 문자열
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	두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하차일드 부모 해스 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `Requires` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
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	변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 `add`가 아닌 경우 serviceOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 문서를 참조하십시오. 데이터 유형: 문자열
serviceOrderItem.service.serviceCharacteristic.value	서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열
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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
상태	서비스 주문의 상태입니다. 자세한 내용은 Service order states 문서를 참조하십시오. 데이터 유형: 문자열

cURL 요청

이 예에서는 서비스 주문을 업데이트하는 방법을 보여줍니다.

curl -X PATCH 'https://instance.service-now.com/api/sn_ind_tmt_orm/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":     "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"
        }
    ]
}'
Sarsij Kumar02:14
Change the response as well to the following
Sarsij Kumar02:14
{
  "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",
          "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_ind_tmt_orm/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

응답 본문입니다.

{
  "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": [    "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_ind_tmt_orm/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

서비스 주문 Open API - POST /sn_ind_tmt_orm/cancelserviceorder

지정된 서비스 주문을 취소합니다.

주:

반품 불가 지점에 도달한 주문에는 이 엔드포인트를 사용할 수 없습니다. 이행이 진행되는 동안에는 주문 라인 항목을 취소할 수 없습니다.

URL 형식

기본 URL: / api/sn_ind_tmt_orm/cancelserviceorder

지원되는 요청 매개변수

표 19. 경로 매개변수
이름	설명
없음

표 20. 쿼리 매개변수
이름	설명
없음

표 21. 요청 본문 매개변수(JSON)
이름	설명
cancellationReason	취소 사유입니다. 데이터 유형: 문자열 기본값: 빈 문자열
서비스 주문	서비스 주문에 대한 데이터를 포함합니다. 데이터 유형: 객체 `"serviceOrder": { "id": "String", "href": "String", "@referredType": "String" }`
serviceOrder.id	필수 취소할 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열
서비스주문.href	취소할 고객 주문의 URL입니다. 데이터 유형: 문자열 기본값: 빈 문자열
serviceOrder.@referredType	이 매개 변수의 값은 `ServiceOrder`여야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열
requestedCancellationDate	주문을 취소할 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열
@type	이 매개 변수의 값은 `CancelServiceOrder`여야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열

헤더

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

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

상태 코드

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

표 24. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. 페이로드가 비어 있습니다. 잘못된 페이로드입니다. 필수 필드 누락: <필드 이름> 잘못된 주문 ID입니다. 잘못된 주문 ID: `이 주문은 고객 주문 테이블에서 아직 생성되지` 않았습니다. 아직 생성되지 않은 주문에 대해 취소 요청이 수행되었습니다. 주문은 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에 있으며 스케줄러가 기록을 선택할 때까지 기다리고 있습니다.

응답 본문 매개변수(JSON)


이름	설명
cancellationReason	취소 사유입니다. 데이터 유형: 문자열
ID	취소된 주문의 Sys_id입니다. 데이터 유형: 문자열
서비스 주문	서비스 주문에 대한 데이터를 포함합니다. 데이터 유형: 객체 `"serviceOrder": { "id": "String", "@referredType": "String" }`
serviceOrder.id	취소된 주문의 Sys_id입니다. 데이터 유형: 문자열
serviceOrder.@referredType	이 매개 변수의 값은 `ServiceOrder`입니다. 데이터 유형: 문자열
requestedCancellationDate	주문을 취소할 날짜입니다. 데이터 유형: 문자열
상태	취소의 상태입니다. 취소 요청이 성공적으로 처리되면(201 상태 코드) 이 매개변수의 값은 `완료`됩니다. 데이터 유형: 문자열
@type	이 매개 변수의 값은 `CancelServiceOrder`입니다. 데이터 유형: 문자열

cURL 요청

다음 코드 예제에서는 고객 주문을 취소합니다.

curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/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_ind_tmt_orm/serviceorder

서비스 주문 또는 라인 항목을 생성, 업데이트 또는 삭제합니다.

추가 작업이 수신되고 수락되면 다음 테이블에 새 기록이 생성됩니다.

순서 [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]

URL 형식

/api/sn_ind_tmt_orm/serviceorder

지원되는 요청 매개변수

표 25. 경로 매개변수
이름	설명
없음

표 26. 쿼리 매개변수
이름	설명
모드	비동기 주문 처리를 활성화합니다. 즉, 생성할 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에 주문이 추가됩니다. 포함되지 않은 경우 주문은 동기식으로 처리됩니다. 가능한 값: async 데이터 유형: 문자열

표 27. 요청 본문 매개변수(JSON)
이름	설명
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/committed_due_date
외부 ID	외부 서비스 주문의 고유 주문 번호입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order
참고	주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note:" [ { "text": "String" } ]` 테이블/필드 업데이트됨: sn_ind_tmt_orm_order
note.text	주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/설명 기본값: 빈 문자열
orderDate	고객 주문 요청의 날짜입니다. 데이터 유형: 문자열
관련 당사자	주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 요청은 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"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	고객의 유형입니다. 가능한 값: 고객 고객연락처 소비자 데이터 유형: 문자열
relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
requestedCompletionDate	고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_end_date 기본값: 빈 문자열
requestedStartDate (요청된 시작 날짜)	고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_start_date 기본값: 빈 문자열
서비스주문 항목	필수 서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"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" } ]` 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item
serviceOrderItem.action	필수 서비스 주문 항목에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 입력 필드에 있는 선택 목록 탭에서 정의됩니다. 가능한 값: add 변경 삭제 변경 없음 이력서 일시 중단 자세한 내용은 Action types for customer and service orders 문서를 참조하십시오. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/작업 기본값: add
ServiceOrderItem.actionReason	옵션입니다. 라인 항목의 이유에 대한 설명입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블/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" } ]` 테이블/필드 업데이트됨: 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	필수 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하차일드 부모 해스 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `Requires` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
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" }` 테이블/필드 업데이트됨: 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	변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 `add`가 아닌 경우 serviceOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 문서를 참조하십시오. 데이터 유형: 문자열
serviceOrderItem.service.serviceCharacteristic.value	서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열
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", "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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

헤더

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

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

상태 코드

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

표 30. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
201	성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다. 다음 주문 항목 특성이 없습니다. 주문을 승인하기 전에 사양 <specification.name> 검토하고 주문 라인 항목에서 특성 및 특성 옵션을 수정하십시오. 주문 항목 특성: <> 특성 값: <characteristic.namecharacteristic.value>이 잘못되었습니다. 주문을 승인하기 전에 특성 값을 수정하십시오.
202	허용. 비동기 모드에서 주문을 성공적으로 요청했습니다. 즉, 매개변수가 mode`async` 로 설정된 상태에서 요청이 이루어졌고 기록은 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에서 처리되도록 예약되어 있습니다.
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. 잘못된 페이로드: 요청 본문이 없습니다. - 페이로드가 요청 본문에 전달되지 않았습니다. 잘못된 페이로드: serviceOrderItem 누락. - 서비스 주문 품목 객체 또는 JSON이 누락되었습니다. 잘못된 페이로드: serviceOrderItem ID가 누락되었습니다. – 서비스 주문 라인 항목에 ID가 없습니다. 잘못된 페이로드: serviceOrderItem 작업이 누락되었습니다. – 서비스 객체 또는 JSON이 페이로드에서 누락되었습니다. 잘못된 페이로드: serviceOrderItem 서비스가 누락되었습니다. – 서비스 주문 라인 항목에서 서비스 속성이 누락되었습니다. 잘못된 페이로드: serviceSpecification이 누락되었습니다. - 서비스 주문 라인 항목의 서비스 사양 객체 또는 JSON이 페이로드에서 누락되었습니다. 잘못된 페이로드: serviceSpecification ID가 누락되었습니다. id- 서비스 사양 개체의 서비스 주문 라인 항목에 있는 매개변수가 페이로드에서 누락되었습니다. 잘못된 페이로드: 서비스 사양이 존재하지 않습니다. - 서비스 주문 라인 항목의 서비스 사양이 잘못되었습니다. 잘못된 페이로드: 제품 인벤토리가 없습니다. - 변경 또는 삭제 주문(즉, 작업 = 변경 또는 삭제)에서 전송된 판매된 서비스가 시스템에 존재하지 않습니다. 잘못된 페이로드: 제품 인벤토리 ID가 누락되었습니다. – 주문 변경 또는 삭제 중에 판매된 제품 ID가 페이로드에서 누락되었습니다. 잘못된 페이로드: 고객 계정 또는 소비자 없음 - 관련 당사자 고객 또는 소비자 객체가 페이로드에서 누락되었습니다. 잘못된 페이로드: 판매된 제품이 비활성 상태입니다. – 주문 변경 또는 삭제에서 페이로드로 전송된 판매된 제품은 활성 상태가 아닙니다. 잘못된 페이로드: 소비자가 없음 - 지정된 관련 당사자 소비자가 인스턴스에 없습니다. 잘못된 페이로드: 고객 계정이 존재하지 않습니다. – 페이로드에 제공된 관련 당사자 고객이 시스템에 없습니다. 잘못된 페이로드: 주문 생성에 실패했습니다. - 요청한 주문을 생성할 수 없습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열
외부 ID	외부 서비스 주문의 고유 주문 번호입니다. 데이터 유형: 문자열
ID	서비스 주문의 Sys_id입니다. 데이터 유형: 문자열
참고	주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]`
note.text	주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열
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	고객의 유형입니다. 가능한 값: 고객 고객연락처 소비자 데이터 유형: 문자열
relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
requestedCompletionDate	고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열
requestedStartDate (요청된 시작 날짜)	고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열
서비스주문 항목	서비스 주문의 라인 항목과 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"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 변경 삭제 변경 없음 이력서 일시 중단 자세한 내용은 Action types for customer and service orders 문서를 참조하십시오. 데이터 유형: 문자열
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	두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하차일드 부모 해스 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `Requires` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
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	변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 `add`가 아닌 경우 serviceOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 문서를 참조하십시오. 데이터 유형: 문자열
serviceOrderItem.service.serviceCharacteristic.value	서비스와 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열
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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
상태	서비스 주문의 상태입니다. 자세한 내용은 Service order states 문서를 참조하십시오. 데이터 유형: 문자열
@type	TMF Open API 표준의 일부입니다. 이 값은 항상 `ServiceOrder`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

비동기적으로 처리

이 예제에서는 query 매개 변수를 사용하여 mode 비동기적으로 주문을 만드는 방법을 보여 줍니다. 생성할 일정에 따라 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에 주문이 추가됩니다.

curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/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_ind_tmt_orm/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",
   "state": "new"
}

cURL 요청

다음 예제에서는 속성을 change로 설정하여 serviceOrderItem.action 서비스 주문을 업데이트합니다.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/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",
   "state": "new"
}

cURL 요청

다음 예에서는 속성을 delete로 serviceOrderItem.action 설정하여 서비스 주문 라인 항목을 삭제합니다.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/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",
   "state": "new"
}

서비스 주문 개방형 API – POST /sn_ind_tmt_orm/serviceorder/outboundresponse

아웃바운드 요청 [sn_tmt_core_outbound_request] 테이블에서 지정된 도메인 주문 기록의 이행 상태를 업데이트합니다.

이 방법을 사용하려면 아웃바운드 요청 테이블에 지정된 도메인 주문 기록이 포함되어야 합니다. 또한 요청 본문에 지정된 기록이나 상태가 기존 아웃바운드 기록에 없는 경우 메서드 유효성 검사에서 오류가 발생합니다.

주:

이 엔드포인트를 사용하여 이 테이블에 새 기록을 생성할 수 없습니다.

도메인 주문에 대한 자세한 내용은 을 참조하십시오 Order Management data model.

URL 형식

/api/sn_ind_tmt_orm/serviceorder/outboundresponse

지원되는 요청 매개변수

표 31. 경로 매개변수
이름	설명
없음

표 32. 쿼리 매개변수
이름	설명
없음

표 33. 요청 본문 매개변수(JSON)
이름	설명
외부 ID	필수 이행을 위해 전송된 도메인 주문 기록의 아웃바운드 요청 식별자입니다. 아웃바운드 요청 [sn_tmt_core_outbound_request] 테이블의 request_id 필드에 있습니다. 데이터 유형: 문자열
서비스오더항목	필수 외부 이행 상태를 업데이트해야 하는 도메인 주문 목록입니다. 데이터 유형: 객체 배열 `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	필수 외부 이행 상태를 업데이트할 도메인 주문 기록의 Sys_id입니다. Domain Order [sn_ind_tmt_orm_domain_order] 테이블에 있습니다. 데이터 유형: 문자열
ServiceOrderItem.state	필수 도메인 주문의 외부 이행 상태입니다. 유효한 값은 다음과 같습니다. 오류 성취 보류 중 데이터 유형: 문자열

헤더

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

표 35. 응답 헤더
헤더	설명
없음

상태 코드

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

표 36. 상태 코드
상태 코드	설명
201	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. `잘못된 페이로드: externalId 누락:` 외부 ID(externalId)가 전달되지 않았음을 나타냅니다. `잘못된 페이로드: serviceOrderItem 상태가 누락됨:` 외부 이행 상태(ServiceOrderItem.state)가 하나 이상의 도메인 주문에 전달되지 않았음을 나타냅니다. `잘못된 외부 ID입니다. 올바른 외부 ID를 전달하십시오: 전달된 외부 ID`(externalId)가 시스템에 없음을 나타냅니다. `잘못된 도메인 주문 ID입니다. 올바른 도메인 주문 ID를 전달하십시오: 전달된 도메인 주문 ID`(ServiceOrderItem.id)가 시스템에 없음을 나타냅니다. 전달된 도메인 주문 ID가 외부 ID`와 연결되어 있지 않음: 외부 ID`(externalId)가 도메인 주문과 연결되어 있지 않음을 나타냅니다. 시스템은 페이로드에 전달된 외부 ID와 연결된 도메인 주문만 업데이트합니다. 잘못된 이행 상태: `올바른 이행 상태를 제공하십시오:` 하나 이상의 도메인 주문에 대해 전달된 이행 상태(ServiceOrderItem.state)가 유효하지 않음을 나타냅니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON)


이름	설명
외부 ID	이행을 위해 전송된 도메인 주문 기록의 아웃바운드 요청 식별자입니다. 아웃바운드 요청 [sn_tmt_core_outbound_request] 테이블의 request_id 필드에 있습니다. 데이터 유형: 문자열
서비스오더항목	외부 이행 상태를 업데이트해야 하는 도메인 주문 목록입니다. 데이터 유형: 객체 배열 `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	외부 이행 상태를 업데이트할 도메인 주문 기록의 Sys_id입니다. Domain Order [sn_ind_tmt_orm_domain_order] 테이블에 있습니다. 데이터 유형: 문자열
ServiceOrderItem.state	도메인 주문의 외부 이행 상태입니다. 가능한 값: 오류 성취 보류 중 데이터 유형: 문자열

cURL 요청

다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다.

curl "http://instance.servicenow.com/api/sn_ind_tmt_orm/serviceorder/outboundresponse" \ 
--request POST \
--header "Accept:application/json" \
--data "{ 
  "externalId": "607017d243322110461f99612bb8f25c",
  "serviceOrderItem": [
    {
      "id": "19913c3577b301108e191e599a5a9988",
      "state": "error"
    }
  ]
}"
--user 'username':'password'

응답:

{
  "externalId": "607017d243322110461f99612bb8f25c",
  "serviceOrderItem": [
    {
      "id": "19913c3577b301108e191e599a5a9988",
      "state": "error"
    }
  ]
}