サービス注文オープン API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：148分

サービス注文オープン API は、サービス注文を行うための標準化されたメカニズムを有効にするエンドポイントを提供します。

この API は、TM Forum サービス注文管理 API 仕様の ServiceNow® 実装です。この実装は、 TMF641 サービス注文管理 API ユーザーガイド v4.1.1 (2021 年 3 月) に基づいています。サービス注文オープン API は、TM フォーラムによって適合性認定を受けています

TMF 準拠ロゴ

この API にアクセスするには、通信事業向け注文管理 (sn_ind_tmt_orm) プラグインを有効にする必要があります。詳細については、「Install Order Management 」を参照してください。注文管理テーブルとロールの詳細については、「Components installed with Order Management」を参照してください。

この API は sn_tmf_api 名前空間内で提供されます。

呼び出し元ユーザーには sn_ind_tmt_orm.order_integrator ロールが必要です。

この API を拡張して、必須パラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングをカスタマイズできます。詳細については、「『 Service Order Open API Developer Guide (サービス注文オープン API 開発者ガイド)』。

サービス注文オープン API – GET /sn_tmf_api/order/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_tmf_api/order/serviceOrder

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
なし

表 : 2. クエリパラメーター
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。データタイプ：文字列デフォルト:すべてのフィールドが返されます。
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：20 最大:100
オフセット	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。データタイプ：数値デフォルト：0
状況	注文をステータスでフィルタリングします。このパラメーターの値と一致するステータスの注文のみが応答に返されます。データタイプ：文字列デフォルト:すべてのステータスが返されます。

表 : 3. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
なし

表 : 5. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
「リンク」	クエリ結果間を移動するための次のリンクが含まれています。第 1 最終次へ前へ
X-合計-数	ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。
206	応答で返された部分的なリソース (ページネーションあり)。
400	要求が正しくありません。考えられる理由: 無効なパスパラメーター無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)


名前	説明
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:注文のリターンノーポイントに達していません。注文は変更またはキャンセルできます。データタイプ：ブーリアン
関連パーティー	注文の連絡先のリスト。データタイプ：オブジェクトのアレイ `"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	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.quantity	注文された品目の数。データタイプ：数値
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所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	サービスに関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
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	サービス仕様の初期バージョン。データタイプ：文字列テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの sys_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.service.serviceType	サービスタイプ。データタイプ：文字列
serviceOrderItem.service.state	販売済み製品のステータス。たとえば、新規です。データタイプ：文字列
serviceOrderItem.state	サービス注文アイテムのステータス。たとえば、新規です。データタイプ：文字列
serviceOrderItem.version	サービス注文品目バージョン。データタイプ：文字列
serviceOrderItem.@type	TMF Open API 標準の一部です。この値は常に `ServiceOrderItem` です。この情報は保存されません。データタイプ：文字列
状況	サービス注文のステータス。詳しくは、「Service order states」を参照してください。データタイプ：文字列
@type	TMF Open API 標準の一部です。この値は常に `ServiceOrder` です。この情報は保存されません。データタイプ：文字列

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

サービス注文オープン API – GET /sn_tmf_api/order/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_tmf_api/order/serviceOrder/{id}

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
ID	取得するサービス注文のSys_id。データタイプ：文字列テーブル:注文 [sn_ind_tmt_orm_order]

表 : 8. クエリパラメーター
名前	説明
なし

表 : 9. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
なし

表 : 11. 応答ヘッダー
ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

表 : 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": "" } ] }` オーダーの作成が失敗し、受信キュー [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": "/" } ] }`
400	要求が正しくありません。考えられる理由: クエリパラメーターがありません無効な URI
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)


名前	説明
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:注文のリターンノーポイントに達していません。注文は変更またはキャンセルできます。データタイプ：ブーリアン
関連パーティー	注文の連絡先のリスト。データタイプ：オブジェクトのアレイ `"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	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.quantity	注文された品目の数。データタイプ：数値
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所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	サービスに関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
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	サービス仕様の初期バージョン。データタイプ：文字列テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの sys_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.service.serviceType	サービスタイプ。データタイプ：文字列
serviceOrderItem.service.state	販売済み製品のステータス。たとえば、新規です。データタイプ：文字列
serviceOrderItem.state	サービス注文アイテムのステータス。たとえば、新規です。データタイプ：文字列
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_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}

指定されたサービス注文を更新します。

URL 形式

デフォルト URL: /api/sn_tmf_api/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フィールド。
externalId	外部サービス注文の一意の注文番号。データタイプ：文字列テーブルまたはフィールドが更新されました:sn_ind_tmt_orm_order
注意	注文時に顧客が行った追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]` 保存場所:sn_ind_tmt_orm_order
note.text	注文時に顧客が行った追加のメモ/コメント。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。デフォルト：空白の文字列
関連パーティー	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。要求には、顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。データタイプ：アレイ `"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テーブルの [アクション辞書エントリ] フィールドの [選択リスト] タブで定義されます。可能な値：追加変更 delete 変更なし再開停止する詳細については、「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" } ]` 注: 以前は、既に存在する外部製品インベントリ 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" } ]` テーブルまたはフィールドが更新されました: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	必須です。 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	必須です。場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所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 または外部 ID にすることができます。この値は、変更/切断注文にのみ使用されます。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic	関連付けられたサービスの特性を説明するリスト。 previousValueと異なる現在のvalueを持つサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	サービスに関連付けられた特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.previousValue	更新が変更オーダー用である場合の以前の特性オプションの値。serviceOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.value	サービスに関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
serviceOrderItem.service.serviceSpecification	必須です。サービスに関連付けられたサービス仕様の説明。注: 変更指示 (serviceOrderItem.action が `変更`) は、 sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder システムプロパティの値に基づいて異なる方法で処理されます。このプロパティが true (デフォルト) に設定されている場合、サービスが注文に示されているバージョンと異なる場合、参照されるサービス仕様を変更することで、サービスは注文のバージョンに自動的にアップグレードされます。これにより、注文を正常に処理できます。プロパティが false に設定されている場合、サービスが注文に示されているバージョンと異なる場合、バージョンの不一致により注文は失敗します。データタイプ: オブジェクト `"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 のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 17. 応答ヘッダー
ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
201	成功。特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客発注書明細レコードの作業メモフィールドに次のコメントを保存します。 `次の注文品目特性が存在しません。注文を承認する前に、仕様<specification.name>を確認し、注文明細品目の特性と特性オプションを修正してください。` `注文アイテム特性:特性値<characteristic.value>を持つ<characteristic.name>は無効です。注文を承認する前に特性値を修正してください。`
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 値と同じかそれ以降にする必要があります。データタイプ：文字列
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	顧客のタイプ。可能な値：顧客顧客連絡先コンシューマーデータタイプ：文字列
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テーブルの [アクション辞書エントリ] フィールドの [選択リスト] タブで定義されます。可能な値：追加変更 delete 詳細については、「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" } ]` 注: 以前は、既に存在する外部製品インベントリ 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	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所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 または外部 ID にすることができます。この値は、変更/切断オーダーに対してのみ返されます。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic	関連付けられたサービスの特性を説明するリスト。 previousValueと異なる現在のvalueを持つサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	サービスに関連付けられた特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.previousValue	更新が変更オーダー用である場合の以前の特性オプションの値。serviceOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.value	サービスに関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
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_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": "Choice",
            "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": "Choice",
            "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

指定されたサービス注文をキャンセルします。

注:

このエンドポイントは、戻れない地点に達した注文には使用できません。フルフィルメントの進行中に注文明細品目をキャンセルすることはできません。

URL 形式

デフォルト URL: /api/sn_tmf_api/order/serviceOrder/cancelserviceorder

サポートされている要求パラメーター

表 : 19. パスパラメーター
名前	説明
なし

表 : 20. クエリパラメーター
名前	説明
なし

表 : 21. 要求本文パラメーター (JSON)
名前	説明
キャンセルの理由	キャンセルの理由。データタイプ：文字列デフォルト：空白の文字列
サービス注文	サービス注文に関するデータ。データタイプ: オブジェクト `"serviceOrder": { "id": "String", "href": "String", "@referredType": "String" }`
serviceOrder.id	必須です。キャンセルする顧客注文のSys_id。データタイプ：文字列テーブル:顧客注文 [sn_ind_tmt_orm_order]
serviceOrder.href	キャンセルする顧客注文の URL。データタイプ：文字列デフォルト：空白の文字列
serviceOrder.@referredType	このパラメーターの値は `ServiceOrder` である必要があります。データタイプ：文字列デフォルト：空白の文字列
requestedCancellationDate	注文をキャンセルする日付。データタイプ：文字列デフォルト：空白の文字列
@type	このパラメーターの値は `CancelServiceOrder` である必要があります。データタイプ：文字列デフォルト：空白の文字列

ヘッダー

表 : 22. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 23. 応答ヘッダー
ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

表 : 24. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。以下のいずれかの理由が考えられます。空のペイロード。無効なペイロードです。必須フィールドがありません:<フィールド名>。無効な注文 ID。無効な注文 ID: `この注文はまだ顧客注文テーブルで作成されていません`。まだ作成されていない注文に対してキャンセル要求が行われました。注文は受信キュー [sn_tmt_core_inbound_queue] テーブルにあり、スケジューラーがレコードを取得するのを待機しています。

応答本文のパラメーター (JSON)


名前	説明
キャンセルの理由	キャンセルの理由。データタイプ：文字列
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_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

サービス注文または品目を作成、更新、または削除します。

追加アクションを受信して承認すると、次のテーブルに新しいレコードが作成されます。

順序 [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_tmf_api/order/serviceOrder

サポートされている要求パラメーター

表 : 25. パスパラメーター
名前	説明
なし

表 : 26. クエリパラメーター
名前	説明
mode	非同期注文処理を有効にします。つまり、オーダーが受信キュー [sn_tmt_core_inbound_queue] テーブルに追加されて作成されます。含まれていない場合、注文は同期的に処理されます。有効な値:非同期データタイプ：文字列

表 : 27. 要求本文パラメーター (JSON)
名前	説明
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じかそれ以降にする必要があります。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのcommitted_due_dateフィールド。
externalId	外部サービス注文の一意の注文番号。データタイプ：文字列テーブルまたはフィールドが更新されました:sn_ind_tmt_orm_order
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
注意	注文時に顧客が行った追加のメモのリスト。データタイプ：オブジェクトのアレイ `"note": [ { "text": "String" } ]` 保存場所:sn_ind_tmt_orm_order
note.text	注文時に顧客が行った追加のメモ/コメント。データタイプ：文字列格納場所:sn_ind_tmt_orm_orderテーブルのコメントフィールド。デフォルト：空白の文字列
orderDate	注文の日付とタイムスタンプ。形式:YYYY-MM-DD HH:MM:SS データタイプ：文字列デフォルト：空白の文字列
関連パーティー	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。要求には、顧客アカウントまたはコンシューマーアカウント情報を含むアイテムを少なくとも 1 つリストする必要があります。データタイプ：アレイ `"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テーブルの [アクション辞書エントリ] フィールドの [選択リスト] タブで定義されます。可能な値：追加変更 delete 変更なし再開停止する詳細については、「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	必須です。 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	必須です。場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所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 または外部 ID にすることができます。この値は、変更/切断注文にのみ使用されます。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic	関連付けられたサービスの特性を説明するリスト。 previousValueと異なる現在のvalueを持つサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	サービスに関連付けられた特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.previousValue	更新が変更オーダー用である場合の以前の特性オプションの値。serviceOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.value	サービスに関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
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 に設定されている場合、サービスが注文に示されているバージョンと異なる場合、バージョンの不一致により注文は失敗します。データタイプ: オブジェクト `"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. 応答ヘッダー
ヘッダー	説明
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。

ステータスコード

表 : 30. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
201	成功。特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客発注書明細レコードの作業メモフィールドに次のコメントを保存します。次の注文品目特性が存在しません。注文を承認する前に、仕様<specification.name>を確認し、注文明細品目の特性と特性オプションを修正してください。注文アイテム特性:特性値<characteristic.value>の<characteristic.name>が無効です。注文を承認する前に特性値を修正してください。
202	承認済み。非同期モードで注文が正常に要求されました。つまり、 mode パラメーターが `非同期` に設定された状態で要求が行われ、レコードは受信キュー [sn_tmt_core_inbound_queue] テーブルで処理されるようにスケジュールされています。
400	要求が正しくありません。以下のいずれかの理由が考えられます。無効なペイロード:コンシューマーが存在しません:指定された関係者コンシューマーがインスタンスに存在しません。無効なペイロード：顧客アカウントが存在しません。 – ペイロードで指定された関係者顧客がシステムに存在しません。無効なペイロード:顧客アカウントまたはコンシューマーがありません:関係者の顧客またはコンシューマーオブジェクトがペイロードにありません。無効なペイロード：注文の作成に失敗しました。- 要求された注文を作成できません。無効なペイロード：製品在庫が存在しません。- 変更または削除の順序 (つまり、アクション = 変更または削除) では、送信された販売済みサービスがシステムに存在しません。無効なペイロード：製品在庫 ID がありません。 - 変更または削除指示で、販売済み製品 ID がペイロードにありません。無効なペイロード：要求本文がありません。- ペイロードが要求本文で渡されませんでした。無効なペイロード：serviceOrderItem アクションがありません。 – ペイロードにサービスオブジェクトまたは JSON がありません。無効なペイロード：serviceOrderItem ID がありません。 – サービス発注書明細に ID がありません。無効なペイロード：serviceOrderItem がありません。- サービス発注書明細オブジェクトまたは JSON がありません。無効なペイロード：serviceOrderItem サービスがありません。 – サービス発注書明細にサービスプロパティがありません。無効なペイロード：サービス仕様が存在しません。- サービス発注書明細のサービス仕様が無効です。無効なペイロード：serviceSpecification ID がありません。- サービス仕様オブジェクトのサービス発注書明細の id パラメーターがペイロードにありません。無効なペイロード：serviceSpecification がありません。- サービス発注書明細のサービス仕様オブジェクトまたは JSON がペイロードにありません。無効なペイロード：販売済み製品が非アクティブです - 変更または削除指示で、ペイロードで送信された販売済み製品がアクティブな状態ではありません。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)


名前	説明
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	顧客のタイプ。可能な値：顧客顧客連絡先コンシューマーデータタイプ：文字列
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テーブルの [アクション辞書エントリ] フィールドの [選択リスト] タブで定義されます。可能な値：追加変更 delete 変更なし再開停止する詳細については、「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	2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild 親がある必要 `HasChild` と `HasParent` は、親子関係に使用されます。[`必須]` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	場所 [cmn_location] テーブル内の関連する場所レコードのSys_id。製品注文アイテムに対して ( productOrderItem.action パラメーターを使用して) 変更アクションを使用する場合、要求を新しい場所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 または外部 ID にすることができます。この値は、変更/切断オーダーに対してのみ返されます。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic	関連付けられたサービスの特性を説明するリスト。 previousValueと異なる現在のvalueを持つサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.name	サービスに関連付けられた特性レコードの名前。特性 [sn_prd_pm_characteristic] テーブルにあります。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.previousValue	更新が変更オーダー用である場合の以前の特性オプションの値。serviceOrderItem.actionパラメーターが `add` 以外の場合、要求は変更指示です。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.value	サービスに関連付けられた特性オプション値。特性オプション値の詳細については、「 Create product characteristics and characteristic options」を参照してください。データタイプ：文字列
serviceOrderItem.service.serviceCharacteristic.valueType	特性値のタイプ。可能な値： Array.Date Array.Datetime Array.Decimal Array.Integer Array.Object Array.Single Line Test チェックボックス選択肢日付、住所メール整数、日付/時刻オブジェクト 1 行テキストはい/いいえデータタイプ：文字列
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	サービス仕様の初期バージョン。データタイプ：文字列テーブル:サービス仕様 [sn_prd_pm_service_specification] テーブルの sys_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.state	サービス注文アイテムのステータス。たとえば、新規です。データタイプ：文字列
serviceOrderItem.@type	TMF Open API 標準の一部です。この値は常に `ServiceOrderItem` です。この情報は保存されません。データタイプ：文字列
状況	サービス注文のステータス。詳しくは、「Service order states」を参照してください。データタイプ：文字列
@type	TMF Open API 標準の一部です。この値は常に `ServiceOrder` です。この情報は保存されません。データタイプ：文字列

非同期処理

この例では、 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"
}

同期的に処理中 (デフォルト)

次の例は、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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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 要求

次の例では、 serviceOrderItem.action プロパティを change に設定してサービス注文を更新します。

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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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 要求

次の例では、 serviceOrderItem.action プロパティを delete に設定して、サービス注文明細品目を削除します。

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",
                  "valueType": "Choice",
                  "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",
                  "valueType": "Choice",
                  "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"
}

サービス注文オープン API – POST /sn_tmf_api/order/serviceOrder/outboundresponse

送信要求 [sn_tmt_core_outbound_request] テーブル内の指定されたドメイン注文レコードのフルフィルメントステータスを更新します。

この方法を使用するには、送信要求テーブルに指定されたドメイン注文レコードが含まれている必要があります。また、要求本文で指定されたレコードまたはステータスが既存の送信レコードにない場合は、メソッドの検証でエラーがスローされます。

注:

このエンドポイントを使用して、このテーブルに新しいレコードを作成することはできません。

ドメイン注文の詳細については、「 Install Order Management 」を参照してください。

URL 形式

/api/sn_tmf_api/order/serviceOrder/outboundresponse

サポートされている要求パラメーター

表 : 31. パスパラメーター
名前	説明
なし

表 : 32. クエリパラメーター
名前	説明
なし

表 : 33. 要求本文パラメーター (JSON)
名前	説明
externalId	必須です。フルフィルメントのために送信されたドメイン注文レコードの送信要求識別子。データタイプ：文字列テーブル:送信要求 [sn_tmt_core_outbound_request] テーブルの request_id フィールド内。
サービス注文アイテム	必須です。外部フルフィルメントステータスを更新する必要があるドメイン注文のリスト。データタイプ：オブジェクトのアレイ `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	必須です。外部フルフィルメントステータスを更新するドメイン注文レコードのSys_id。データタイプ：文字列テーブル:ドメイン注文 [sn_ind_tmt_orm_domain_order]
ServiceOrderItem.state	必須です。ドメイン注文の外部フルフィルメントステータス。有効な値：エラー履行済み保留中データタイプ：文字列

ヘッダー

表 : 34. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 35. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 36. ステータスコード
ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。以下のいずれかの理由が考えられます。 `無効なペイロード:externalId がありません:`外部 ID (externalId) が渡されなかったことを示します。 `無効なペイロード:serviceOrderItem ステータスがありません:` 外部フルフィルメントステータス (ServiceOrderItem.state) が 1 つ以上のドメイン注文で渡されなかったことを示します。 `外部 ID が無効です。正しい外部 ID を渡してください`:渡された外部 ID (externalId) がシステムに存在しないことを示します。 `ドメイン注文 ID が無効です。正しいドメイン注文 ID を渡してください`:渡されたドメイン注文 ID (ServiceOrderItem.id) がシステムに存在しないことを示します。 `渡されたドメイン注文 ID が外部 ID に関連付けられていません`:外部 ID (externalId) がどのドメイン注文にも関連付けられていないことを示します。システムは、ペイロードで渡された外部 ID に関連付けられているドメイン注文のみを更新します。 `無効なフルフィルメントステータス:正しいフルフィルメントステータスを指定してください`:1 つ以上のドメイン注文で渡されたフルフィルメントステータス (ServiceOrderItem.state) が有効ではないことを示します。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター (JSON)


名前	説明
externalId	フルフィルメントのために送信されたドメイン注文レコードの送信要求識別子。データタイプ：文字列テーブル:送信要求 [sn_tmt_core_outbound_request] テーブルの request_id フィールド内。
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
orderDate	注文の日付とタイムスタンプ。形式:YYYY-MM-DD HH:MM:SS データタイプ：文字列デフォルト：空白の文字列
サービス注文アイテム	外部フルフィルメントステータスを更新する必要があるドメイン注文のリスト。データタイプ：オブジェクトのアレイ `"ServiceOrderItem": [ { "id": "String", "state": "String" } ]`
ServiceOrderItem.id	外部フルフィルメントステータスを更新するドメイン注文レコードのSys_id。データタイプ：文字列テーブル:ドメイン注文 [sn_ind_tmt_orm_domain_order]
ServiceOrderItem.state	ドメイン注文の外部フルフィルメントステータス。可能な値：エラー履行済み保留中データタイプ：文字列

cURL 要求

次のコード例は、このエンドポイントを呼び出す方法を示しています。

curl "http://instance.servicenow.com/api/sn_tmf_api/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"
    }
  ]
}