サービス注文オープン API

リリースバージョン: Xanadu

更新日 2024年08月01日

所要時間：145分

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

この API は、Open API TMForum TMF641 Service Ordering Management API 仕様の ServiceNow® 実装です。

TMF 適合ロゴ

この API にアクセスするには、通信事業向け注文管理 (sn_ind_tmt_orm) プラグインを有効にする必要があります。詳細については、「Install Order Management 」を参照してください。注文管理テーブル、エンティティ、およびリレーションシップの詳細については、「Order Management data model」を参照してください。

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

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

この API を拡張して、必要なパラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングに関するカスタマイズを実行できます。詳細については、次を参照してください：サービス注文オープン 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. クエリパラメータ
名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。データタイプ：文字列デフォルト:返されるすべてのフィールド。
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。デフォルト：20 最大：100 データタイプ：数値
offset	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。デフォルト：0 データタイプ：数値
state	注文をステータスでフィルターします。ステータスがこのパラメーターの値に一致する注文のみが応答で返されます。データタイプ：文字列デフォルト:すべての状況が返されます。

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

ヘッダー

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

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

表 : 5. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。たとえば、`offset=2` および `limit=3` の場合、Content-Range ヘッダーの値は `items 3-5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
Link	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

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

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

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


名前	Description (説明)
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じか、それ以降である必要があります。データタイプ：文字列
expectedCompletionDate	注文が完了する日付。データタイプ：文字列
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
id	要求されたサービスオーダーの sys_id。データタイプ：文字列
note	注文時に顧客が追加したメモを説明するオブジェクトのアレイ。データタイプ：アレイ `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	関連するメモを作成したユーザーの名前。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
orderDate	注文の日付とタイムスタンプ。形式：YYYY-MM-DD HH:MM:SS データタイプ：文字列デフォルト：空白の文字列
ponr	注文が返品不可期日に達したかどうかを示すフラグ。有効な値： true：注文の返品不可期日に達しました。履行の進行中は、注文を変更またはキャンセルできません。 false：注文の返品不可期日に達していません。注文を変更またはキャンセルできます。データタイプ：ブーリアン
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。データタイプ：アレイ `"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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
serviceOrderItem	サービスオーダーの品目と関連アクションを説明するオブジェクトのアレイ。 `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]` データタイプ：アレイ
serviceOrderItem.action	サービスオーダーアイテムで実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリー] フィールドの [選択リスト] タブで定義されます。詳細については、「Action types for customer and service orders」を参照してください。データタイプ：文字列
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 HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.quantity	注文された品目の数。データタイプ：数値
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	場所 [cmn_location] テーブルの関連付けられた場所レコードの sys_id。データタイプ：文字列
serviceOrderItem.place.@type	TMF オープン 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 オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
serviceOrderItem.service	顧客が購入したサービスのインスタンスの詳細の説明。データタイプ：オブジェクト `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }`
serviceOrderItem.service.serviceCharacteristic	関連付けられたサービスの特性を説明するリスト。現在の value が previousValue と異なるサービス特性のみが返されます。データタイプ：オブジェクトのアレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.value	サービスに関連付けられた特性オプション値。特性オプション値の詳細については、以下を参照してくださいCreate product characteristics and characteristic options。データタイプ：文字列
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	サービスと製品在庫間の関係のタイプ。可能な値： Requires データタイプ：文字列
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 オープン API 標準の一部。この値は常に `ServiceSpecificationRef`です。この情報は保存されません。データタイプ：文字列
serviceOrderItem.service.serviceType	サービスタイプ。データタイプ：文字列
serviceOrderItem.service.state	販売済み製品のステータス。たとえば、new です。データタイプ：文字列
serviceOrderItem.state	サービスオーダーアイテムのステータス。たとえば、new です。データタイプ：文字列
serviceOrderItem.version	サービスオーダー品目のバージョン。データタイプ：文字列
serviceOrderItem.@type	TMF オープン API 標準の一部。この値は常に `ServiceOrderItem` です。この情報は保存されません。データタイプ：文字列
state	サービスオーダーのステータス。詳しくは、「Service order states」を参照してください。データタイプ：文字列
@type	TMF オープン 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	要求が正常に処理されました。応答で完全なリソースが返されました (ページネーションなし)。選択した注文に処理の問題がある場合、応答は正常とエラーメッセージを返します。 200 OK 応答は、注文が受信キュー [sn_tmt_core_inbound_queue] テーブルにあり、スケジューラーが処理するレコードを選択するのを待っている場合に発生します。[エラーメッセージ] フィールドには、レコードの詳細が含まれます。例： `{ "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)


名前	Description (説明)
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じか、それ以降である必要があります。データタイプ：文字列
expectedCompletionDate	注文が完了する日付。データタイプ：文字列
id	要求されたサービスオーダーの sys_id。データタイプ：文字列
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
note	注文時に顧客が追加したメモを説明するオブジェクトのアレイ。データタイプ：アレイ `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	関連するメモを作成したユーザーの名前。データタイプ：文字列
note.date	メモが作成された日付。データタイプ：文字列
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
orderDate	注文の日付とタイムスタンプ。形式：YYYY-MM-DD HH:MM:SS データタイプ：文字列デフォルト：空白の文字列
ponr	注文が返品不可期日に達したかどうかを示すフラグ。有効な値： true：注文の返品不可期日に達しました。履行の進行中は、注文を変更またはキャンセルできません。 false：注文の返品不可期日に達していません。注文を変更またはキャンセルできます。データタイプ：ブーリアン
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。データタイプ：アレイ `"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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
serviceOrderItem	サービスオーダーの品目と関連アクションを説明するオブジェクトのアレイ。データタイプ：アレイ `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "quantity": "Number", "place": {Object}, "ponr": Boolean, "relatedParty": {Object}, "service": {Object}, "state": "String", "@type": "String", "version": "String" } ]`
serviceOrderItem.action	サービスオーダーアイテムで実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリー] フィールドの [選択リスト] タブで定義されます。詳細については、「Action types for customer and service orders」を参照してください。データタイプ：文字列
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 HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.quantity	注文された品目の数。データタイプ：数値
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	場所 [cmn_location] テーブルの関連付けられた場所レコードの sys_id。データタイプ：文字列
serviceOrderItem.place.@type	TMF オープン 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 オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
serviceOrderItem.service	顧客が購入したサービスのインスタンスの詳細の説明。 `"service:" { "serviceCharacteristic": [Array], "serviceRelationship": [Array], "serviceSpecification": {Object}, "serviceType": "String", "state": "String", "@type": "String" }` データタイプ：オブジェクト
serviceOrderItem.service.serviceCharacteristic	関連付けられたサービスの特性を説明するリスト。現在の value が previousValue と異なるサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String", "valueType": "String" } ]`
serviceOrderItem.service.serviceCharacteristic.value	サービスに関連付けられた特性オプション値。特性オプション値の詳細については、以下を参照してくださいCreate product characteristics and characteristic options。データタイプ：文字列
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	サービスと製品在庫間の関係のタイプ。可能な値： Requires データタイプ：文字列
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 オープン API 標準の一部。この値は常に `ServiceSpecificationRef`です。この情報は保存されません。データタイプ：文字列
serviceOrderItem.service.serviceType	サービスタイプ。データタイプ：文字列
serviceOrderItem.service.state	販売済み製品のステータス。たとえば、new です。データタイプ：文字列
serviceOrderItem.state	サービスオーダーアイテムのステータス。たとえば、new です。データタイプ：文字列
serviceOrderItem.version	サービスオーダー品目のバージョン。データタイプ：文字列
serviceOrderItem.@type	TMF オープン API 標準の一部。この値は常に `ServiceOrderItem` です。この情報は保存されません。データタイプ：文字列
state	サービスオーダーのステータス。詳しくは、「Service order states」を参照してください。データタイプ：文字列
@type	TMF オープン 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)
名前	Description (説明)
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じか、それ以降である必要があります。注文品目のアクションが `一時停止` または `再開`の場合、このパラメーターは更新できません。データタイプ：文字列更新されたテーブル/フィールド:sn_ind_tmt_orm_order/committed_due_date
externalId	外部サービスオーダーの一意の注文番号。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order
note	注文時に顧客が追加したメモを説明するオブジェクトのアレイ。データタイプ：アレイ `"note": [ { "text": "String" } ]` 更新されたテーブル/フィールド：sn_ind_tmt_orm_order
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order/comments デフォルト：空白の文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。要求には、顧客アカウントまたはコンシューマーアカウント情報を含むアイテムが少なくとも 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	顧客のタイプ。可能な値：コンシューマーカスタマー CustomerContact データタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order/expected_end_date デフォルト：空白の文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order/expected_start_date デフォルト：空白の文字列
serviceOrderItem	必須です。サービスオーダーの品目と関連アクションを説明するオブジェクトのアレイ。データタイプ：アレイ `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` 更新されたテーブル/フィールド：sn_ind_tmt_orm_order_line_item
serviceOrderItem.action	必須です。サービスオーダーアイテムで実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリー] フィールドの [選択リスト] タブで定義されます。可能な値： add change 削除変更なし再開停止する詳細については、「Action types for customer and service orders」を参照してください。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order_line_item/action
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_item/related_order_line_item
serviceOrderItem.orderRelationship.relationshipType	必須です。 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	必須です。場所 [cmn_location] テーブルの関連付けられた場所レコードの sys_id。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order_line_item/location
serviceOrderItem.place.@type	TMF オープン API 標準の一部。オーダー品目の場所の注釈。データタイプ：文字列
serviceOrderItem.quantity	注文する品目の数を設定します。このプロパティは、サービス注文を追加する場合にのみ適用されます。つまり、 action プロパティの値は `add` です。データタイプ：数値デフォルト:空の文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order/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 オープン 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	関連付けられたサービスの特性を説明するリスト。現在の value が previousValue と異なるサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "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.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 オープン API 標準の一部。この値は常に `ServiceSpecificationRef`です。この情報は保存されません。データタイプ：文字列
serviceOrderItem.@type	TMF オープン API 標準の一部。この値は常に `ServiceOrderItem` です。この情報は保存されません。データタイプ：文字列
@type	TMF オープン API 標準の一部。この値は常に `ServiceOrder` です。この情報は保存されません。データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
201	成功。特性または特性オプション情報に問題がある場合、エンドポイントは関連する顧客オーダー品目レコードの作業メモフィールドに次のコメントを保存します。 `次の注文アイテム特性は存在しません：仕様 <specification.name> を確認し、注文を承認する前に発注書明細の特性と特性オプションを修正してください。` `注文アイテム特性：<characteristic.name> と特性値：<characteristic.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)


名前	Description (説明)
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じか、それ以降である必要があります。データタイプ：文字列
externalId	外部サービスオーダーの一意の注文番号。データタイプ：文字列
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
id	サービスオーダーの sys_id。データタイプ：文字列
note	注文時に顧客が追加したメモを説明するオブジェクトのアレイ。データタイプ：アレイ `"note": [ { "text": "String" } ]`
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
orderDate	注文の日付とタイムスタンプ。形式：YYYY-MM-DD HH:MM:SS データタイプ：文字列デフォルト：空白の文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。データタイプ：アレイ `"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	顧客のタイプ。可能な値： Customer CustomerContact コンシューマーデータタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
serviceOrderItem	サービスオーダーの品目と関連アクションを説明するオブジェクトのアレイ。データタイプ：アレイ `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
serviceOrderItem.action	サービスオーダーアイテムで実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリー] フィールドの [選択リスト] タブで定義されます。可能な値： add change 削除詳細については、「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 HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	場所 [cmn_location] テーブルの関連付けられた場所レコードの sys_id。データタイプ：文字列
serviceOrderItem.place.@type	TMF オープン 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 オープン 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	関連付けられたサービスの特性を説明するリスト。現在の value が previousValue と異なるサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "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.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 オープン API 標準の一部。この値は常に `ServiceSpecificationRef`です。この情報は保存されません。データタイプ：文字列
serviceOrderItem.@type	TMF オープン API 標準の一部。この値は常に `ServiceOrderItem` です。この情報は保存されません。データタイプ：文字列
state	サービスオーダーのステータス。詳しくは、「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": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic( Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty":[
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}'

応答本文。

{
  "externalId": "BSS748",
  "priority": "1",
  "description": "Managed Security",
  "category": "TMF resource illustration",
  "requestedStartDate": "2018-01-15T09:37:40.508Z",
  "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
  "@type": "ServiceOrder",
  "note": [
    {
      "id": "1",
      "author": "Jean Pontus",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration"
    },
    {
      "id": "2",
      "author": "Jean Pontus1",
      "date": "2019-04-30T08:13:59.509Z",
      "text": "This is a TMF product order illustration no 2"
    }
  ],
  "serviceOrderItem": [
    {
      "id": "100",
      "action": "add",
      v"actionReason": "adding service package OLI",
      "quantity": 1,
      "@type": "ServiceOrderItem",
      "service": {
        "serviceState": "active",
        "@type": "CFS",
        "serviceCharacteristic": [
          {
            "name": "CPE Type",
            "valueType": "string",
            "value": "Virtual"
          },
          {
            "name": "Administration Support",
            "valueType": "string",
            "value": "Basic(Customer Managed)"
          },
          {
            "name": "Firewall coverage",
            "valueType": "string",
            "value": "Standard(Up to 20 sites)"
          },
          {
            "name": "Firewall Security",
            "valueType": "string",
            "value": "Basic"
          }
        ],
        "serviceSpecification": {
          "id": "f99546ff07266010a7955b7e0ad300a8",
          "name": "Managed Firewall Service",
          "internalVersion": "1",
          "@type": "Managed Firewall Service",
          "sys_id": "f99546ff07266010a7955b7e0ad300a8",
          "version": "",
          "status": "published",
          "internalId": "f99546ff07266010a7955b7e0ad300a8"
        },
        "serviceRelationship": [
          {
            "id": "326d13f45b5620102dff5e92dc81c785",
            "relationshipType": "Requires"
          }
        ]
      },
      "place": {
        "id": "5671dd2ec3a53010188473ce3640dd81",
        "@type": "Place"
      }
    }
  ],
  "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
  "orderType": "add",
  "state": "revision_received",
  "href": "/api/sn_tmf_api/order/serviceOrder/a831e56e77602110c8b3a4d54b5a9954"
}

サービス注文オープン API - POST /sn_tmf_api/order/serviceOrder/cancelserviceorder

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

注:

このエンドポイントは、ポイント・オブ・ノー・リターンに達した注文には使用できません。履行の進行中は、注文品目をキャンセルできません。

URL 形式

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

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

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

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

表 : 21. 要求本文パラメーター (JSON)
名前	説明
cancellationReason	キャンセルの理由。データタイプ：文字列デフォルト：空白の文字列
サービス注文	サービス注文に関するデータが含まれています。データタイプ: オブジェクト `"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)


名前	説明
cancellationReason	キャンセルの理由。データタイプ：文字列
id	キャンセルされた注文の sys_id。データタイプ：文字列
サービス注文	サービス注文に関するデータが含まれています。データタイプ: オブジェクト `"serviceOrder": { "id": "String", "@referredType": "String" }`
serviceOrder.id	キャンセルされた注文の sys_id。データタイプ：文字列
serviceOrder.@referredType	このパラメーターの値は `ServiceOrder` です。データタイプ：文字列
requestedCancellationDate	注文をキャンセルする日付。データタイプ：文字列
state	キャンセルのステータス。キャンセル要求が正常に処理された場合 (ステータスコード 201)、このパラメーターの値は `done` になります。データタイプ：文字列
@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] テーブルに追加されて作成されます。含まれていない場合、注文は同期的に処理されます。可能な値:async データタイプ：文字列

表 : 27. 要求本文パラメーター (JSON)
名前	Description (説明)
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じか、それ以降である必要があります。データタイプ：文字列更新されたテーブル/フィールド:sn_ind_tmt_orm_order/committed_due_date
externalId	外部サービスオーダーの一意の注文番号。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
note	注文時に顧客が追加したメモを説明するオブジェクトのアレイ。データタイプ：アレイ `"note": [ { "text": "String" } ]` 更新されたテーブル/フィールド：sn_ind_tmt_orm_order
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order/comments デフォルト：空白の文字列
orderDate	注文の日付とタイムスタンプ。形式：YYYY-MM-DD HH:MM:SS データタイプ：文字列デフォルト：空白の文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。要求には、顧客アカウントまたはコンシューマーアカウント情報を含むアイテムが少なくとも 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	顧客のタイプ。可能な値： Customer CustomerContact コンシューマーデータタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order/expected_end_date デフォルト：空白の文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order/expected_start_date デフォルト：空白の文字列
serviceOrderItem	必須です。サービスオーダーの品目と関連アクションを説明するオブジェクトのアレイ。データタイプ：アレイ `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]` 更新されたテーブル/フィールド：sn_ind_tmt_orm_order_line_item
serviceOrderItem.action	必須です。サービスオーダーアイテムで実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリー] フィールドの [選択リスト] タブで定義されます。可能な値： add change 削除変更なし再開停止する詳細については、「Action types for customer and service orders」を参照してください。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order_line_item/action デフォルト: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_item/related_order_line_item
serviceOrderItem.orderRelationship.relationshipType	必須です。 2 つの品目間の関係のタイプ。この情報は、関係階層を識別するために使用されます。可能な値： HasChild HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	必須です。場所 [cmn_location] テーブルの関連付けられた場所レコードの sys_id。データタイプ：文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order_line_item/location デフォルト：空白の文字列
serviceOrderItem.place.@type	TMF オープン API 標準の一部。オーダー品目の場所の注釈。データタイプ：文字列
serviceOrderItem.quantity	注文する品目の数を設定します。このプロパティは、サービス注文を追加する場合にのみ適用されます。つまり、 action プロパティの値は `add` です。データタイプ：数値デフォルト:空の文字列更新されたテーブル/フィールド：sn_ind_tmt_orm_order/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 オープン 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	関連付けられたサービスの特性を説明するリスト。現在の value が previousValue と異なるサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "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.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	サービスと製品在庫間の関係のタイプ。可能な値： Requires データタイプ：文字列
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 オープン API 標準の一部。この値は常に `ServiceSpecificationRef`です。この情報は保存されません。データタイプ：文字列
serviceOrderItem.@type	TMF オープン API 標準の一部。この値は常に `ServiceOrderItem` です。この情報は保存されません。データタイプ：文字列
@type	TMF オープン API 標準の一部。この値は常に `ServiceOrder` です。この情報は保存されません。データタイプ：文字列

ヘッダー

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

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

ステータスコード

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

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


名前	Description (説明)
committedDueDate	注文に対してアクションを実行する必要がある日時。この値は、各注文品目の committedDueDate 値と同じか、それ以降である必要があります。データタイプ：文字列
externalId	外部サービスオーダーの一意の注文番号。データタイプ：文字列
href	リソースレコードへの相対リンク。データタイプ：文字列デフォルト：空白の文字列
id	サービスオーダーの sys_id。データタイプ：文字列
note	注文時に顧客が追加したメモを説明するオブジェクトのアレイ。データタイプ：アレイ `"note": [ { "text": "String" } ]`
note.text	注文時に顧客が作成した追加のメモ/コメント。データタイプ：文字列
orderDate	注文の日付とタイムスタンプ。形式：YYYY-MM-DD HH:MM:SS データタイプ：文字列デフォルト：空白の文字列
orderId	作成する注文のSys_id。要求が成功すると、処理されるスケジュールに従って注文が受信キュー [sn_tmt_core_inbound_queue] テーブルに追加されます。注: この値は、 mode クエリパラメーターを使用して注文が非同期で作成された場合の唯一の結果です。 `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` データタイプ：文字列
relatedParty	注文の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。データタイプ：アレイ `"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	顧客のタイプ。可能な値： Customer CustomerContact コンシューマーデータタイプ：文字列
relatedParty.@type	TMF オープン API 標準の一部。オーダー品目に関する連絡先の注釈。この値は常に `RelatedParty` です。この情報は保存されません。データタイプ：文字列
requestedCompletionDate	顧客によって要求された配送日。データタイプ：文字列
requestedStartDate	顧客によって要求された注文開始日。データタイプ：文字列
serviceOrderItem	サービスオーダーの品目と関連アクションを説明するオブジェクトのアレイ。データタイプ：アレイ `"serviceOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "orderRelationship": [Array], "place": {Object}, "quantity": "Number", "relatedParty": {Object}, "service": {Object}, "@type": "String", "version": "String" } ]`
serviceOrderItem.action	サービスオーダーアイテムで実行するアクション。可能なアクションは、sn_ind_tmt_orm_order_line_item テーブルの [アクション辞書エントリー] フィールドの [選択リスト] タブで定義されます。可能な値： add change 削除変更なし再開停止する詳細については、「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 HasParent 必要 `HasChild` と `HasParent` は親子関係に使用されます。`Requires` は水平関係に使用されます (品目には別の品目が必要です)。データタイプ：文字列
serviceOrderItem.place	サービスをインストールする場所のマップ。データタイプ: オブジェクト `"place:" { "id": "String", "@type": "String" }`
serviceOrderItem.place.id	場所 [cmn_location] テーブルの関連付けられた場所レコードの sys_id。データタイプ：文字列
serviceOrderItem.place.@type	TMF オープン 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 オープン 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	関連付けられたサービスの特性を説明するリスト。現在の value が previousValue と異なるサービス特性のみが返されます。データタイプ：アレイ `"serviceCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "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.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	サービスと製品在庫間の関係のタイプ。可能な値： Requires データタイプ：文字列
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 オープン API 標準の一部。この値は常に `ServiceSpecificationRef`です。この情報は保存されません。データタイプ：文字列
serviceOrderItem.state	サービスオーダーアイテムのステータス。たとえば、new です。データタイプ：文字列
serviceOrderItem.@type	TMF オープン API 標準の一部。この値は常に `ServiceOrderItem` です。この情報は保存されません。データタイプ：文字列
state	サービスオーダーのステータス。詳しくは、「Service order states」を参照してください。データタイプ：文字列
@type	TMF オープン 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 プロパティを add に設定してサービス注文を作成する方法を示しています。

curl "https://instance.service-now.com/api/sn_tmf_api/serviceorder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "add",
         "actionReason":"adding service package OLI",
         "quantity": 1,
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

応答本文：

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "add",
         "actionReason":"adding service package OLI",
         "quantity": 1,
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Standard"
               },
               {
                  "name": "Firewall coverage",
                  "value": "Premium (Up to 50 sites)"
               },
               {
                  "name": "Administration Support",
                  "value": "Basic (Customer Managed)"
               }
            ],
            "serviceRelationship": [
               {
                  "id": "326d13f45b5620102dff5e92dc81c785",
                  "relationshipType": "Requires"
               }
            ],
            "serviceSpecification": {
               "id": "f99546ff07266010a7955b7e0ad300a8",
               "name": "Managed Firewall Service",
               "@type": "Managed Firewall Service",
               "internalVersion": "2",
               "version": "v2",
               "internalId": "f99546ff07266010a7955b7e0ad300a8"
            }
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

cURL 要求

次の例では、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",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

応答本文。

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "change",
         "actionReason":"change service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

cURL 要求

次の例では、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",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         }
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ]
}" \
--user 'username':'password'

応答本文。

{
   "externalId": "BSS748",
   "requestedStartDate": "2018-01-15T09:37:40.508Z",
   "requestedCompletionDate": "2018-01-15T09:37:40.508Z",
   "@type": "ServiceOrder",
   "note": [
      {
         "text": "This is a TMF service order illustration"
      },
      {
         "text": "This is a TMF service order illustration no 2"
      }
   ],
   "serviceOrderItem": [
      {
         "id": "100",
         "action": "delete",
         "actionReason":"delete service package OLI",
         "@type": "ServiceOrderItem",
         "service": {
            "@type": "CFS",
            "serviceCharacteristic": [
               {
                  "name": "Firewall Security",
                  "value": "Premium",
                  "previousValue": "Standard"
               }
            ],
            "id": "4b5072aec3a83010abc8b5183c40dd42"
         },
         "relatedParty": [
            {
               "firstName": "Mike",
               "lastName": "Hudson",
               "email": "mike@example.com",
               "phone": "1234567890",
               "@type": "RelatedParty",
               "@referredType": "OrderLineItemContact"
            }
         ],
         "place": {
            "id": "920cf6ac73d423002728660c4cf6a799",
            "@type": "Place"
         },
         "state": "new"
      }
   ],
   "relatedParty": [
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
        },
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
        },
        {
            "id": "59f16de1c3b67110ff00ed23a140dd9e",
            "name": "Funco External",
            "@type": "RelatedParty",
            "@referredType": "Consumer"
        }
    ],
   "id": "4f2af65ac3a030106e2473ce3640ddcf",
   "href": "/api/sn_tmf_api/order/serviceOrder/4f2af65ac3a030106e2473ce3640ddcf",
   "orderDate": "2024-06-20T10:38:55.000Z",
   "state": "new"
}

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

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

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

注:

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

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

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 が無効です。Please pass the correct external id`:渡された外部 ID (externalId) がシステムに存在しないことを示します。 `無効なドメイン注文 ID。Please pass the correct domain order 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"
    }
  ]
}