作業指示管理 API

リリースバージョン: Zurich

更新日 2025年07月31日

所要時間：125分

作業指示管理 API は、作業指示を作成、更新、取得するためのエンドポイントを提供します。

この API は、 ServiceNow Store で利用可能な Telecommunication Open APIs アプリケーションに含まれています。

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

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

作業指示管理 API は、TM Forum 作業指示管理 API REST 仕様のServiceNow実装です。この実装は、 TMF697 作業指示管理 API v5.0 に基づいています。

作業指示管理:GET /sn_tmf_api/work_order_management_api/workorder/{id}

作業指示 [wm_order] テーブルから指定された作業指示を取得します。

URL 形式

バージョニングされた URL: /api/sn_tmf_api/{api_version}/work_order_management_api/workorder/{id}

デフォルト URL: /api/sn_tmf_api/work_order_management_api/workorder/{id}

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

表 : 1. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
ID	作業指示書のSys_idまたは externalIdentifier 。テーブル:作業指示 [wm_order] フィールド:Sys_idまたはcorrelation_id データタイプ：文字列

表 : 2. クエリパラメーター
名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。有効な値： @type カテゴリ完了日説明 expectedCompletionDate href ID initiatedFrom priority requestedCompletionDate requestedStartDate shortDescription startDate state 作業指示番号デフォルト：すべてのフィールドを返します。データタイプ：文字列

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

ヘッダー

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

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

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

ステータスコード

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

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。

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


名前	説明
@type	この値は常に `WorkOrder` です。データタイプ：文字列
カテゴリ	`エンタープライズ`や`住宅`などの注文管理システムで使用できる作業指示のカテゴリ。データタイプ：文字列
完了日	作業指示が完了した日時。データタイプ：文字列
説明	作業指示の説明。データタイプ：文字列
expectedCompletionDate	プロバイダーによって指定された予定完了日時。データタイプ：文字列
externalIdentifier	ベンダーや相関 ID などの外部参照のリスト。データタイプ：アレイ `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	この値は常に `ExternalIdentifierRef` です。データタイプ：文字列
externalIdentifier.id	ベンダーや相関 ID などの外部参照。データタイプ：文字列
href	作業指示レコードへの相対リンク。データタイプ：文字列
ID	作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列
initiatedFrom	作業指示が開始された場所を示す参照 ID。たとえば、作業指示タスク [wm_task] テーブルからsys_idタスクがあるとします。データタイプ：文字列
注意	注文に関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	この値は常に `Note`です。データタイプ：文字列
note.author	メモの作成者。データタイプ：文字列
note.date	メモが作業指示に追加された日付。データタイプ：文字列
note.text	メモのテキスト。データタイプ：文字列
place	作業指示書に関連付けられた地理的な場所。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
place.relatedParty	場所のサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
place.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
place.relatedParty.name	サポートグループの名前。データタイプ：文字列
place.relatedParty.role	サポートグループのロール。データタイプ：文字列
priority	作業指示の優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
relatedParty	作業指示に関連する連絡先のリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
relatedParty.id	関係者の sys_id。テーブル:アカウント [customer_account]、会社 [core_company]、またはユーザー [sys_user] データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.role	関係者のロール。可能な値：アカウント会社コンシューマー連絡先データタイプ：文字列
関連製品注文	作業指示の製品注文のリスト。データタイプ：アレイ `"relatedProductOrder": [ { "@type": "String", "id": "String" } ]`
relatedProductOrder.@type	この値は常に `ProductOrderRef` です。データタイプ：文字列
relatedProductOrder.id	製品注文の sys_id。テーブル:製品注文 [sn_ind_tmt_orm_product_order] データタイプ：文字列
requestedCompletionDate	要求された完了日時。データタイプ：文字列
requestedStartDate	要求者によって指定された受注処理開始日。要求者が、指定された日付より前に履行を開始することをプロバイダーに許可できない場合に使用されます。データタイプ：文字列
shortDescription	作業指示の簡単なサマリー。データタイプ：文字列
startDate	注文が開始された日時。データタイプ：文字列
state	作業指示のステータス。可能な値：ドラフト認定待ち資格認定済みアサイン済み対応中完了データタイプ：文字列
作業指示アイテム	作業指示のタスクのリスト。データタイプ：アレイ `"workOrderItem": [ { "@type": "String", "description": "String", "id": "String", "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	この値は常に `WorkOrderItem` です。データタイプ：文字列
workOrderItem.description	タスクの説明。データタイプ：文字列
workOrderItem.id	タスクのSys_id。テーブル:作業指示タスク [wm_task] データタイプ：文字列
workOrderItem.shortDescription	タスクの簡単な説明。データタイプ：文字列
workOrderItem.state	タスクの状態。データタイプ：文字列
workOrderItem.work	タスクに必要な作業の説明。データタイプ: オブジェクト `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "relatedWork": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	この値は常に `WorkRefOrValue` です。データタイプ：文字列
workOrderItem.work.expectedCompletionDate	タスクの予定完了日。データタイプ：文字列
workOrderItem.work.id	タスクの作業タイプのSys_id。テーブル:作業タイプ [wm_work_type] データタイプ：文字列
workOrderItem.work.place	タスクに関連付けられた地理的な場所のリスト。 `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	この値は常に `RelatedPlaceRefOrValue` です。データタイプ：文字列
workOrderItem.work.place.place	場所に関する詳細。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
workOrderItem.work.place.place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
workOrderItem.work.place.role	タスクのコンテキストでのこの場所のロール。データタイプ：文字列
workOrderItem.work.relatedParty	タスクのサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
workOrderItem.work.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.relatedParty.name	サポートグループの名前。データタイプ：文字列
workOrderItem.work.relatedParty.role	サポートグループのロール。データタイプ：文字列
workOrderItem.work.relatedWork	関連する作業指示タスクのリスト。データタイプ：アレイ `"relatedWork": [ { "@type": "String", "id": "String" } ]`
workOrderItem.work.relatedWork.@type	この値は常に `WorkRefOrValue` です。データタイプ：文字列
workOrderItem.work.relatedWork.id	関連タスクのSys_id。テーブル:作業指示タスク [wm_task] データタイプ：文字列
workOrderItem.work.scheduledStartDate	タスクのスケジュールされた開始日。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment	タスクの割り当ての詳細。データタイプ：アレイ `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	この値は常に `WorkforceEmployeeAssignment` です。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.id	タスクにアサインされたグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	タスクにアサインされた従業員に関する詳細。データタイプ: オブジェクト `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	この値は常に `[個別]` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	従業員の電話番号のリスト。データタイプ：アレイ `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	この値は常に `PhoneContactMedium` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	従業員の電話番号。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	従業員のSys_id。テーブル：ユーザー [sys_user] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	従業員の名前。データタイプ：文字列
workOrderItem.work.workPriority	タスクの優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
workOrderItem.work.workType	タスクの作業タイプ。テーブル:作業タイプ [wm_work_type] フィールド:名前データタイプ：文字列
作業指示番号	作業指示書の一意の識別子 (WO0008004など)。テーブル:作業指示 [wm_order] フィールド:数値データタイプ：文字列
workOrderRelationship	作業指示書に対するタスク関係のリスト。データタイプ：アレイ `"workOrderRelationship": [ { "@type": "String", "id": "String", "relationshipType": "String" } ]`
workOrderRelationship.@type	この値は常に `OrderRelationship` です。データタイプ：文字列
workOrderRelationship.id	タスク関係のSys_id。テーブル:タスク関係 [task_rel_task] データタイプ：文字列
workOrderRelationship.relationshipType	タスクリレーションシップタイプ。データタイプ：文字列

cURL 要求

指定された作業指示を取得します。

curl "https://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workorder/27e756a1df113100dca6a5f59bf263da" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

応答本文。

{
   "@type": "WorkOrder",
   "href": "api/sn_tmf_api/workordermanagement/workorder/6d22c6f0ff0de650f8dfffffffffff98",
   "workOrderNumber": "WO0008004",
   "id": "6d22c6f0ff0de650f8dfffffffffff98",
   "category": "test",
   "shortDescription": "Test-Test",
   "description": "Test",
   "startDate": "",
   "requestedCompletionDate": "2025-04-19 07:17:04",
   "requestedStartDate": "",
   "state": "Awaiting Qualification",
   "priority": "4 - Low",
   "initiatedFrom": "",
   "completionDate": "",
   "expectedCompletionDate": "",
   "place": {
      "@type": "GeographicSite",
      "id": "920cf6ac73d423002728660c4cf6a799",
      "relatedParty": [
         {
            "@type": "RelatedPartyRef",
            "id": "320ee92637232000158bbfc8bcbe5d40",
            "name": "East Qualifiers",
            "role": "QualificationGroup"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "5408091a3b100300e81d47b334efc452",
         "name": "Ashley Parker",
         "role": "Contact"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Account"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Consumer"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "820351a1c0a8018b67c73d51c074097c",
         "name": "Acer",
         "role": "Company"
      }
   ],
   "appointment": {},
   "relatedProductOrder": [
      {
         "@type": "ProductOrderRef",
         "id": "19f5456dff092a50f8dfffffffffff01"
      },
      {
         "@type": "ProductOrderRef",
         "id": "7116456dff092a50f8dfffffffffff6e"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifierRef",
         "id": "r6879"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "2fa566fdff456a50f8dfffffffffffc6",
         "shortDescription": "abc",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "2fa566fdff456a50f8dfffffffffffc6",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "25ab8dcd0a0a0bb300bd8a8899934d72"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "bb420af0ff0de650f8dfffffffffff4a",
         "shortDescription": "Test",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "bb420af0ff0de650f8dfffffffffff4a",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "920cf6ac73d423002728660c4cf6a799"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "c301e379ff096a50f8dfffffffffff43",
         "shortDescription": "hi",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "c301e379ff096a50f8dfffffffffff43",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "6808184aeb211100420124e05206fe12"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      }
   ],
   "workOrderRelationship": [
      {
         "@type": "OrderRelationship",
         "id": "02016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "0e016b46ffcd6a50f8dfffffffffff30",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "66da174eff8d6a50f8dfffffffffffda",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "aada174eff8d6a50f8dfffffffffffd9",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "bd20e706ffcd6a50f8dfffffffffffc6",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "c2016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      }
   ],
   "note": [
      {
         "@type": "Note",
         "author": "System Administrator",
         "date": "2025-04-23",
         "text": "This is a note."
      }
   ]
}

作業指示管理:GET /sn_tmf_api/work_order_management_api/workordermanagement

作業指示 [wm_order] テーブルからすべての作業指示のリストを取得します。

URL 形式

バージョニングされた URL: /api/sn_tmf_api/{api_version}/work_order_management_api/workordermanagement

デフォルト URL: /api/sn_tmf_api/work_order_management_api/workordermanagement

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

表 : 7. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

表 : 8. クエリパラメーター
名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。有効な値： @type カテゴリ完了日説明 expectedCompletionDate href ID initiatedFrom priority requestedCompletionDate requestedStartDate shortDescription startDate state 作業指示番号デフォルト：すべてのフィールドを返します。データタイプ：文字列
ID	作業指示書のフィルタリングに使用するSys_ids。指定されたsys_idsに一致する作業指示のみが応答で返されます。テーブル:作業指示 [wm_order] データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。デフォルト：20 データタイプ：数値
offset	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。デフォルト：0 データタイプ：数値

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

ヘッダー

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

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

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
206	部分的なコンテンツ。要求が正常に処理され、ページネーションされた呼び出しで指定されたコンテンツの範囲の一部が返されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。

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


名前	説明
@type	この値は常に `WorkOrder` です。データタイプ：文字列
カテゴリ	`エンタープライズ`や`住宅`などの注文管理システムで使用できる作業指示のカテゴリ。データタイプ：文字列
完了日	作業指示が完了した日時。データタイプ：文字列
説明	作業指示の説明。データタイプ：文字列
expectedCompletionDate	プロバイダーによって指定された予定完了日時。データタイプ：文字列
externalIdentifier	ベンダーや相関 ID などの外部参照のリスト。データタイプ：アレイ `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	この値は常に `ExternalIdentifierRef` です。データタイプ：文字列
externalIdentifier.id	ベンダーや相関 ID などの外部参照。データタイプ：文字列
href	作業指示レコードへの相対リンク。データタイプ：文字列
ID	作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列
initiatedFrom	作業指示が開始された場所を示す参照 ID。たとえば、作業指示タスク [wm_task] テーブルからsys_idタスクがあるとします。データタイプ：文字列
注意	注文に関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	この値は常に `Note`です。データタイプ：文字列
note.author	メモの作成者。データタイプ：文字列
note.date	メモが作業指示に追加された日付。データタイプ：文字列
note.text	メモのテキスト。データタイプ：文字列
place	作業指示書に関連付けられた地理的な場所。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
place.relatedParty	場所のサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
place.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
place.relatedParty.name	サポートグループの名前。データタイプ：文字列
place.relatedParty.role	サポートグループのロール。データタイプ：文字列
priority	作業指示の優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
relatedParty	作業指示に関連する連絡先のリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
relatedParty.id	関係者の sys_id。テーブル:アカウント [customer_account]、会社 [core_company]、またはユーザー [sys_user] データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.role	関係者のロール。可能な値：アカウント会社コンシューマー連絡先データタイプ：文字列
関連製品注文	作業指示の製品注文のリスト。データタイプ：アレイ `"relatedProductOrder": [ { "@type": "String", "id": "String" } ]`
relatedProductOrder.@type	この値は常に `ProductOrderRef` です。データタイプ：文字列
relatedProductOrder.id	製品注文の sys_id。テーブル:製品注文 [sn_ind_tmt_orm_product_order] データタイプ：文字列
requestedCompletionDate	要求された完了日時。データタイプ：文字列
requestedStartDate	要求者によって指定された受注処理開始日。要求者が、指定された日付より前に履行を開始することをプロバイダーに許可できない場合に使用されます。データタイプ：文字列
shortDescription	作業指示の簡単なサマリー。データタイプ：文字列
startDate	注文が開始された日時。データタイプ：文字列
state	作業指示のステータス。可能な値：ドラフト認定待ち資格認定済みアサイン済み対応中完了データタイプ：文字列
作業指示アイテム	作業指示のタスクのリスト。データタイプ：アレイ `"workOrderItem": [ { "@type": "String", "description": "String", "id": "String", "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	この値は常に `WorkOrderItem` です。データタイプ：文字列
workOrderItem.description	タスクの説明。データタイプ：文字列
workOrderItem.id	タスクのSys_id。テーブル:作業指示タスク [wm_task] データタイプ：文字列
workOrderItem.shortDescription	タスクの簡単な説明。データタイプ：文字列
workOrderItem.state	タスクの状態。データタイプ：文字列
workOrderItem.work	タスクに必要な作業の説明。データタイプ: オブジェクト `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "relatedWork": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	この値は常に `WorkRefOrValue` です。データタイプ：文字列
workOrderItem.work.expectedCompletionDate	タスクの予定完了日。データタイプ：文字列
workOrderItem.work.id	タスクの作業タイプのSys_id。テーブル:作業タイプ [wm_work_type] データタイプ：文字列
workOrderItem.work.place	タスクに関連付けられた地理的な場所のリスト。 `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	この値は常に `RelatedPlaceRefOrValue` です。データタイプ：文字列
workOrderItem.work.place.place	場所に関する詳細。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
workOrderItem.work.place.place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
workOrderItem.work.place.role	タスクのコンテキストでのこの場所のロール。データタイプ：文字列
workOrderItem.work.relatedParty	タスクのサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
workOrderItem.work.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.relatedParty.name	サポートグループの名前。データタイプ：文字列
workOrderItem.work.relatedParty.role	サポートグループのロール。データタイプ：文字列
workOrderItem.work.relatedWork	関連する作業指示タスクのリスト。データタイプ：アレイ `"relatedWork": [ { "@type": "String", "id": "String" } ]`
workOrderItem.work.relatedWork.@type	この値は常に `WorkRefOrValue` です。データタイプ：文字列
workOrderItem.work.relatedWork.id	関連タスクのSys_id。テーブル:作業指示タスク [wm_task] データタイプ：文字列
workOrderItem.work.scheduledStartDate	タスクのスケジュールされた開始日。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment	タスクの割り当ての詳細。データタイプ：アレイ `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	この値は常に `WorkforceEmployeeAssignment` です。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.id	タスクにアサインされたグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	タスクにアサインされた従業員に関する詳細。データタイプ: オブジェクト `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	この値は常に `[個別]` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	従業員の電話番号のリスト。データタイプ：アレイ `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	この値は常に `PhoneContactMedium` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	従業員の電話番号。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	従業員のSys_id。テーブル：ユーザー [sys_user] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	従業員の名前。データタイプ：文字列
workOrderItem.work.workPriority	タスクの優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
workOrderItem.work.workType	タスクの作業タイプ。テーブル:作業タイプ [wm_work_type] フィールド:名前データタイプ：文字列
作業指示番号	作業指示書の一意の識別子 (WO0008004など)。テーブル:作業指示 [wm_order] フィールド:数値データタイプ：文字列
workOrderRelationship	作業指示書に対するタスク関係のリスト。データタイプ：アレイ `"workOrderRelationship": [ { "@type": "String", "id": "String", "relationshipType": "String" } ]`
workOrderRelationship.@type	この値は常に `OrderRelationship` です。データタイプ：文字列
workOrderRelationship.id	タスク関係のSys_id。テーブル:タスク関係 [task_rel_task] データタイプ：文字列
workOrderRelationship.relationshipType	タスクリレーションシップタイプ。データタイプ：文字列

cURL 要求

作業指示書の最初のページを取得します。

curl "https://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workordermanagement" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

応答本文。

[{
   "@type": "WorkOrder",
   "href": "api/sn_tmf_api/workordermanagement/workorder/6d22c6f0ff0de650f8dfffffffffff98",
   "workOrderNumber": "WO0008004",
   "id": "6d22c6f0ff0de650f8dfffffffffff98",
   "category": "test",
   "shortDescription": "Test-Test",
   "description": "Test",
   "startDate": "",
   "requestedCompletionDate": "2025-04-19 07:17:04",
   "requestedStartDate": "",
   "state": "Awaiting Qualification",
   "priority": "4 - Low",
   "initiatedFrom": "",
   "completionDate": "",
   "expectedCompletionDate": "",
   "place": {
      "@type": "GeographicSite",
      "id": "920cf6ac73d423002728660c4cf6a799",
      "relatedParty": [
         {
            "@type": "RelatedPartyRef",
            "id": "320ee92637232000158bbfc8bcbe5d40",
            "name": "East Qualifiers",
            "role": "QualificationGroup"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "5408091a3b100300e81d47b334efc452",
         "name": "Ashley Parker",
         "role": "Contact"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Account"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "",
         "name": "",
         "role": "Consumer"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "820351a1c0a8018b67c73d51c074097c",
         "name": "Acer",
         "role": "Company"
      }
   ],
   "appointment": {},
   "relatedProductOrder": [
      {
         "@type": "ProductOrderRef",
         "id": "19f5456dff092a50f8dfffffffffff01"
      },
      {
         "@type": "ProductOrderRef",
         "id": "7116456dff092a50f8dfffffffffff6e"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifierRef",
         "id": "r6879"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "2fa566fdff456a50f8dfffffffffffc6",
         "shortDescription": "abc",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "2fa566fdff456a50f8dfffffffffffc6",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "25ab8dcd0a0a0bb300bd8a8899934d72"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "bb420af0ff0de650f8dfffffffffff4a",
         "shortDescription": "Test",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "bb420af0ff0de650f8dfffffffffff4a",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "920cf6ac73d423002728660c4cf6a799"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "c301e379ff096a50f8dfffffffffff43"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      },
      {
         "@type": "WorkOrderItem",
         "id": "c301e379ff096a50f8dfffffffffff43",
         "shortDescription": "hi",
         "description": "",
         "state": "Draft",
         "work": {
            "@type": "WorkRefOrValue",
            "id": "c301e379ff096a50f8dfffffffffff43",
            "workType": "",
            "scheduledStartDate": "",
            "expectedCompletionDate": "",
            "workPriority": "4 - Low",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "6808184aeb211100420124e05206fe12"
                  }
               }
            ],
            "relatedWork": [
               {
                  "@type": "WorkRefOrValue",
                  "id": "2fa566fdff456a50f8dfffffffffffc6"
               },
               {
                  "@type": "WorkRefOrValue",
                  "id": "bb420af0ff0de650f8dfffffffffff4a"
               }
            ],
            "relatedParty": [],
            "workforceEmployeeAssignment": []
         }
      }
   ],
   "workOrderRelationship": [
      {
         "@type": "OrderRelationship",
         "id": "02016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "0e016b46ffcd6a50f8dfffffffffff30",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "66da174eff8d6a50f8dfffffffffffda",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "aada174eff8d6a50f8dfffffffffffd9",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "bd20e706ffcd6a50f8dfffffffffffc6",
         "relationshipType": "Contains::Task of"
      },
      {
         "@type": "OrderRelationship",
         "id": "c2016b46ffcd6a50f8dfffffffffff31",
         "relationshipType": "Contains::Task of"
      }
   ],
   "note": [
      {
         "@type": "Note",
         "author": "System Administrator",
         "date": "2025-04-23",
         "text": "This is a note."
      }
   ]
}]

作業指示管理 - PATCH /sn_tmf_api/work_order_management_api/workOrder/{id}

作業指示書と関連タスクを更新します。

作業指示 [wm_order] テーブルの作業指示レコードが更新されます。タスクレコードは、作業指示タスク [wm_task] テーブルで更新されます。

URL 形式

バージョニングされた URL: /api/sn_tmf_api/{api_version}/work_order_management_api/workOrder/{id}

デフォルト URL: /api/sn_tmf_api/work_order_management_api/workOrder/{id}

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

表 : 13. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列
ID	作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列

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

表 : 15. 要求本文パラメーター (JSON)
名前	説明
@type	この値は常に `WorkOrder` です。データタイプ：文字列
完了日	作業指示が完了した日時。データタイプ：文字列
説明	作業指示の説明。データタイプ：文字列
expectedCompletionDate	プロバイダーによって指定された予定完了日時。データタイプ：文字列
externalIdentifier	ベンダーや相関 ID などの外部参照のリスト。データタイプ：アレイ `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	この値は常に `ExternalIdentifierRef` です。データタイプ：文字列
externalIdentifier.id	ベンダーや相関 ID などの外部参照データタイプ：文字列
href	作業指示レコードへの相対リンク。データタイプ：文字列
ID	作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列
initiatedFrom	作業指示が開始された場所を示す参照 ID。たとえば、作業指示タスク [wm_task] テーブルからsys_idタスクがあるとします。データタイプ：文字列
注意	注文に関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	この値は常に `Note`です。データタイプ：文字列
note.author	メモの作成者。データタイプ：文字列
note.date	メモが作業指示に追加された日付。データタイプ：文字列
note.text	メモのテキスト。データタイプ：文字列
place	作業指示書に関連付けられた地理的な場所。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
place.relatedParty	場所のサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
place.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
place.relatedParty.name	サポートグループの名前。データタイプ：文字列
place.relatedParty.role	サポートグループのロール。データタイプ：文字列
priority	作業指示の優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
relatedParty	作業指示に関連する連絡先のリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
relatedParty.id	関係者の sys_id。テーブル:アカウント [customer_account]、会社 [core_company]、またはユーザー [sys_user] データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.role	関係者のロール。可能な値：アカウント会社コンシューマー連絡先データタイプ：文字列
requestedCompletionDate	要求された完了日時。データタイプ：文字列
requestedStartDate	要求者によって指定された受注処理開始日。要求者が、指定された日付より前に履行を開始することをプロバイダーに許可できない場合に使用されます。データタイプ：文字列
shortDescription	作業指示の簡単なサマリー。データタイプ：文字列
startDate	注文が開始された日時。データタイプ：文字列
state	作業指示のステータス。可能な値：ドラフト認定待ち資格認定済みアサイン済み対応中完了データタイプ：文字列
template_id	作業指示に使用するテンプレートのSys_id。テーブル:製品モデル [cmdb_model] データタイプ：文字列
作業指示アイテム	作業指示のタスクのリスト。データタイプ：アレイ `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	この値は常に `WorkOrderItem` です。データタイプ：文字列
workOrderItem.action	タスクの製品で実行するアクション。可能な値： add delete modify 変更なしデータタイプ：文字列
workOrderItem.completionDate	タスクが完了した日時。データタイプ：文字列
workOrderItem.description	タスクの説明。データタイプ：文字列
workOrderItem.id	タスクのSys_id。テーブル:作業指示タスク [wm_task] データタイプ：文字列
workOrderItem.note	タスクに関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	この値は常に `Note`です。データタイプ：文字列
workOrderItem.note.author	メモの作成者。データタイプ：文字列
workOrderItem.note.date	メモがタスクに追加された日付。データタイプ：文字列
workOrderItem.note.text	メモのテキスト。データタイプ：文字列
workOrderItem.shortDescription	タスクの簡単な説明。データタイプ：文字列
workOrderItem.state	タスクの状態。データタイプ：文字列
workOrderItem.work	タスクに必要な作業の説明。データタイプ: オブジェクト `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	この値は常に `WorkRefOrValue` です。データタイプ：文字列
workOrderItem.work.expectedCompletionDate	タスクの予定完了日。データタイプ：文字列
workOrderItem.work.id	タスクの作業タイプのSys_id。テーブル:作業タイプ [wm_work_type] データタイプ：文字列
workOrderItem.work.place	タスクに関連付けられた地理的な場所のリスト。 `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	この値は常に `RelatedPlaceRefOrValue` です。データタイプ：文字列
workOrderItem.work.place.place	場所に関する詳細。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
workOrderItem.work.place.place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
workOrderItem.work.place.role	タスクのコンテキストでのこの場所のロール。データタイプ：文字列
workOrderItem.work.relatedParty	タスクのサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
workOrderItem.work.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.relatedParty.name	サポートグループの名前。データタイプ：文字列
workOrderItem.work.relatedParty.role	サポートグループのロール。データタイプ：文字列
workOrderItem.work.scheduledStartDate	タスクのスケジュールされた開始日。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment	タスクの割り当ての詳細。データタイプ：アレイ `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	この値は常に `WorkforceEmployeeAssignment` です。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.id	タスクにアサインされたグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	タスクにアサインされた従業員に関する詳細。データタイプ: オブジェクト `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	この値は常に `[個別]` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	従業員の電話番号のリスト。データタイプ：アレイ `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	この値は常に `PhoneContactMedium` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	従業員の電話番号。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	従業員のSys_id。テーブル：ユーザー [sys_user] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	従業員の名前。データタイプ：文字列
workOrderItem.work.workPriority	タスクの優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
workOrderItem.work.workType	タスクの作業タイプ。テーブル:作業タイプ [wm_work_type] フィールド:名前データタイプ：文字列
作業指示番号	作業指示書の一意の識別子 (WO0008004など)。テーブル:作業指示 [wm_order] フィールド:数値データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。

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


名前	説明
@type	この値は常に `WorkOrder` です。データタイプ：文字列
完了日	作業指示が完了した日時。データタイプ：文字列
説明	作業指示の説明。データタイプ：文字列
expectedCompletionDate	プロバイダーによって指定された予定完了日時。データタイプ：文字列
externalIdentifier	ベンダーや相関 ID などの外部参照のリスト。データタイプ：アレイ `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	この値は常に `ExternalIdentifierRef` です。データタイプ：文字列
externalIdentifier.id	ベンダーや相関 ID などの外部参照。データタイプ：文字列
href	作業指示レコードへの相対リンク。データタイプ：文字列
ID	作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列
initiatedFrom	作業指示が開始された場所を示す参照 ID。たとえば、作業指示タスク [wm_task] テーブルからsys_idタスクがあるとします。データタイプ：文字列
注意	注文に関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	この値は常に `Note`です。データタイプ：文字列
note.author	メモの作成者。データタイプ：文字列
note.date	メモが作業指示に追加された日付。データタイプ：文字列
note.text	メモのテキスト。データタイプ：文字列
place	作業指示書に関連付けられた地理的な場所。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
place.relatedParty	場所のサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
place.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
place.relatedParty.name	サポートグループの名前。データタイプ：文字列
place.relatedParty.role	サポートグループのロール。データタイプ：文字列
priority	作業指示の優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
relatedParty	作業指示に関連する連絡先のリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
relatedParty.id	関係者の sys_id。テーブル:アカウント [customer_account]、会社 [core_company]、またはユーザー [sys_user] データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.role	関係者のロール。可能な値：アカウント会社コンシューマー連絡先データタイプ：文字列
requestedCompletionDate	要求された完了日時。データタイプ：文字列
requestedStartDate	要求者によって指定された受注処理開始日。要求者が、指定された日付より前に履行を開始することをプロバイダーに許可できない場合に使用されます。データタイプ：文字列
shortDescription	作業指示の簡単なサマリー。データタイプ：文字列
startDate	注文が開始された日時。データタイプ：文字列
state	作業指示のステータス。可能な値：ドラフト認定待ち資格認定済みアサイン済み対応中完了データタイプ：文字列
template_id	作業指示に使用するテンプレートのSys_id。テーブル:製品モデル [cmdb_model] データタイプ：文字列
作業指示アイテム	作業指示のタスクのリスト。データタイプ：アレイ `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	この値は常に `WorkOrderItem` です。データタイプ：文字列
workOrderItem.action	タスクの製品で実行するアクション。可能な値： add delete modify 変更なしデータタイプ：文字列
workOrderItem.completionDate	タスクが完了した日時。データタイプ：文字列
workOrderItem.description	タスクの説明。データタイプ：文字列
workOrderItem.id	タスクのSys_id。テーブル:作業指示タスク [wm_task] データタイプ：文字列
workOrderItem.note	タスクに関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	この値は常に `Note`です。データタイプ：文字列
workOrderItem.note.author	メモの作成者。データタイプ：文字列
workOrderItem.note.date	メモがタスクに追加された日付。データタイプ：文字列
workOrderItem.note.text	メモのテキスト。データタイプ：文字列
workOrderItem.shortDescription	タスクの簡単な説明。データタイプ：文字列
workOrderItem.state	タスクの状態。データタイプ：文字列
workOrderItem.work	タスクに必要な作業の説明。データタイプ: オブジェクト `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	この値は常に `WorkRefOrValue` です。データタイプ：文字列
workOrderItem.work.expectedCompletionDate	タスクの予定完了日。データタイプ：文字列
workOrderItem.work.id	タスクの作業タイプのSys_id。テーブル:作業タイプ [wm_work_type] データタイプ：文字列
workOrderItem.work.place	タスクに関連付けられた地理的な場所のリスト。 `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	この値は常に `RelatedPlaceRefOrValue` です。データタイプ：文字列
workOrderItem.work.place.place	場所に関する詳細。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
workOrderItem.work.place.place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
workOrderItem.work.place.role	タスクのコンテキストでのこの場所のロール。データタイプ：文字列
workOrderItem.work.relatedParty	タスクのサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
workOrderItem.work.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.relatedParty.name	サポートグループの名前。データタイプ：文字列
workOrderItem.work.relatedParty.role	サポートグループのロール。データタイプ：文字列
workOrderItem.work.scheduledStartDate	タスクのスケジュールされた開始日。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment	タスクの割り当ての詳細。データタイプ：アレイ `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	この値は常に `WorkforceEmployeeAssignment` です。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.id	タスクにアサインされたグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	タスクにアサインされた従業員に関する詳細。データタイプ: オブジェクト `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	この値は常に `[個別]` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	従業員の電話番号のリスト。データタイプ：アレイ `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	この値は常に `PhoneContactMedium` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	従業員の電話番号。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	従業員のSys_id。テーブル：ユーザー [sys_user] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	従業員の名前。データタイプ：文字列
workOrderItem.work.workPriority	タスクの優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
workOrderItem.work.workType	タスクの作業タイプ。テーブル:作業タイプ [wm_work_type] フィールド:名前データタイプ：文字列
作業指示番号	作業指示書の一意の識別子 (WO0008004など)。テーブル:作業指示 [wm_order] フィールド:数値データタイプ：文字列

cURL 要求

指定された作業指示を更新します。

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder/2d3f32f0df113100dca6a5f59bf263a9" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "@type": "WorkOrder",
   "description": "Fixed Fibre Broadband Installation",
   "shortDescription": "Fixed Fibre",
   "priority": "1 - Critical",
   "place": {
      "@type": "GeographicSite",
      "id": "f48b22530a0a0ba70001913a1c181eeb",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "781da52637232000158bbfc8bcbe5db8",
            "name": "Jane Smith",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "86a08090ffcd62105e0dffffffffff8b",
         "name": "Workforce Engineering Group",
         "role": "Consumer"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "3df59e8cff5d26105e0dffffffffff0e",
         "action": "add",
         "description": "FTTH Installation",
         "shortDescription": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "state": "Accepted",
         "work": {
            "@type": "WorkRefOrValue",
            "scheduledStartDate": "2024-04-22T14:23:06.528Z",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "description": "Cabinet Configuration",
            "name": "FTTH Installation",
            "workPriority": "high",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "b04b813bffc126105e0dffffffffff0d"
                  }
               }
            ],
            "note": {
               "@type": "Note",
               "text": "Demand Point Type: SDU"
            }
         }
      }
   ],
   "note": {
      "@type": "Note",
      "text": "This is important"
   }
}" \
--user 'username':'password'

応答本文。

{
   "@type": "WorkOrder",
   "description": "Fixed Fibre Broadband Installation",
   "shortDescription": "Fixed Fibre",
   "priority": "1 - Critical",
   "place": {
      "@type": "GeographicSite",
      "id": "f48b22530a0a0ba70001913a1c181eeb",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "781da52637232000158bbfc8bcbe5db8",
            "name": "Jane Smith",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "86a08090ffcd62105e0dffffffffff8b",
         "name": "Workforce Engineering Group",
         "role": "Consumer"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "id": "3df59e8cff5d26105e0dffffffffff0e",
         "action": "add",
         "description": "FTTH Installation",
         "shortDescription": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "state": "Accepted",
         "work": {
            "@type": "WorkRefOrValue",
            "scheduledStartDate": "2024-04-22T14:23:06.528Z",
            "workType": "38f719ec3b8a10103f09080044efc4cd",
            "description": "Cabinet Configuration",
            "name": "FTTH Installation",
            "workPriority": "high",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "b04b813bffc126105e0dffffffffff0d"
                  }
               }
            ],
            "note": {
               "@type": "Note",
               "text": "Demand Point Type: SDU"
            }
         }
      }
   ],
   "note": {
      "@type": "Note",
      "text": "This is important"
   },
   "id": "2d3f32f0df113100dca6a5f59bf263a9",
   "href": "/api/sn_tmf_api/work_order_management_api/workOrder/2d3f32f0df113100dca6a5f59bf263a9"
}

作業指示管理 - POST /sn_tmf_api/work_order_management_api/cancelWorkOrder

指定された作業指示と関連するすべてのタスクをキャンセルします。

URL 形式

バージョニングされた URL: /api/sn_tmf_api/{api_version}/work_order_management_api/cancelWorkOrder

デフォルト URL: /api/sn_tmf_api/work_order_management_api/cancelWorkOrder

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

表 : 19. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

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

表 : 21. 要求本文パラメーター (JSON)
名前	説明
@type	この値は常に `CancelWorkOrder` です。データタイプ：文字列
cancellationReason	作業指示書をキャンセルする理由。データタイプ：文字列
workOrder	作業指示の詳細。データタイプ: オブジェクト `"workOrder": { "@type": "String", "id": "String" }`
workOrder.@type	この値は常に `WorkOrderRef` です。データタイプ：文字列
workOrder.id	必須。キャンセルする作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 24. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。

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


名前	説明
@type	この値は常に `CancelWorkOrder` です。データタイプ：文字列
cancellationReason	作業指示書をキャンセルする理由。データタイプ：文字列
state	キャンセル要求のステータス。作業指示が正常にキャンセルされた場合、この値は `[キャンセル]` になります。データタイプ：文字列
workOrder	作業指示の詳細。データタイプ: オブジェクト `"workOrder": { "@type": "String", "id": "String" }`
workOrder.@type	この値は常に `WorkOrderRef` です。データタイプ：文字列
workOrder.id	キャンセルされた作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列

cURL 要求

指定された作業指示をキャンセルします。

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/cancelWorkOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "@type": "CancelWorkOrder",
   "cancellationReason": "Workforce unavailability",
   "workOrder": {
      "@type": "WorkOrderRef",
      "id": "f8ec1c38-4e4d-4378-a693-f95680e51e25"
   }
}" \
--user 'username':'password'

応答本文。

{
  "@type": "CancelWorkOrder",
  "cancellationReason": "Workforce unavailability",
  "state": "Cancelled",
  "workOrder": {
    "@type": "WorkOrderRef",
    "id": "f8ec1c38-4e4d-4378-a693-f95680e51e25"
  }
}

作業指示管理 - POST /sn_tmf_api/work_order_management_api/workOrder

作業指示書および関連タスクを作成します。

作業指示書のレコードが作業指示書 [wm_order] テーブルに作成されます。各タスクのレコードは、作業指示タスク [wm_task] テーブルに作成されます。

URL 形式

バージョニングされた URL: /api/sn_tmf_api/{api_version}/work_order_management_api/workOrder

デフォルト URL: /api/sn_tmf_api/work_order_management_api/workOrder

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

表 : 25. パスパラメーター
名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。`たとえば、v1` や `v2` などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列

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

表 : 27. 要求本文パラメーター (JSON)
名前	説明
@type	この値は常に `WorkOrder` です。データタイプ：文字列
カテゴリ	`エンタープライズ`や`住宅`などの注文管理システムで使用できる作業指示のカテゴリ。データタイプ：文字列
完了日	作業指示が完了した日時。データタイプ：文字列
説明	作業指示の説明。データタイプ：文字列
expectedCompletionDate	プロバイダーによって指定された予定完了日時。データタイプ：文字列
externalIdentifier	ベンダーや相関 ID などの外部参照のリスト。データタイプ：アレイ `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	この値は常に `ExternalIdentifierRef` です。データタイプ：文字列
externalIdentifier.id	ベンダーや相関 ID などの外部参照。データタイプ：文字列
href	作業指示レコードへの相対リンク。データタイプ：文字列
ID	作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列
initiatedFrom	作業指示が開始された場所を示す参照 ID。たとえば、作業指示タスク [wm_task] テーブルからsys_idタスクがあるとします。データタイプ：文字列
注意	注文に関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	この値は常に `Note`です。データタイプ：文字列
note.author	メモの作成者。データタイプ：文字列
note.date	メモが作業指示に追加された日付。データタイプ：文字列
note.text	メモのテキスト。データタイプ：文字列
place	作業指示書に関連付けられた地理的な場所。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
place.relatedParty	場所のサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
place.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
place.relatedParty.name	サポートグループの名前。データタイプ：文字列
place.relatedParty.role	サポートグループのロール。データタイプ：文字列
priority	作業指示の優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
relatedParty	作業指示に関連する連絡先のリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
relatedParty.id	関係者の sys_id。テーブル:アカウント [customer_account]、会社 [core_company]、またはユーザー [sys_user] データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.role	関係者のロール。可能な値：アカウント会社コンシューマー連絡先データタイプ：文字列
requestedCompletionDate	要求された完了日時。データタイプ：文字列
requestedStartDate	要求者によって指定された受注処理開始日。要求者が、指定された日付より前に履行を開始することをプロバイダーに許可できない場合に使用されます。データタイプ：文字列
shortDescription	作業指示の簡単なサマリー。データタイプ：文字列
startDate	注文が開始された日時。データタイプ：文字列
state	作業指示のステータス。可能な値：ドラフト認定待ち資格認定済みアサイン済み対応中完了データタイプ：文字列
template_id	作業指示に使用するテンプレートのSys_id。テーブル:製品モデル [cmdb_model] データタイプ：文字列
作業指示アイテム	作業指示のタスクのリスト。データタイプ：アレイ `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	この値は常に `WorkOrderItem` です。データタイプ：文字列
workOrderItem.action	タスクの製品で実行するアクション。可能な値： add delete modify 変更なしデータタイプ：文字列
workOrderItem.completionDate	タスクが完了した日時。データタイプ：文字列
workOrderItem.description	タスクの説明。データタイプ：文字列
workOrderItem.id	タスクのSys_id。テーブル:作業指示タスク [wm_task] データタイプ：文字列
workOrderItem.note	タスクに関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	この値は常に `Note`です。データタイプ：文字列
workOrderItem.note.author	メモの作成者。データタイプ：文字列
workOrderItem.note.date	メモがタスクに追加された日付。データタイプ：文字列
workOrderItem.note.text	メモのテキスト。データタイプ：文字列
workOrderItem.shortDescription	タスクの簡単な説明。データタイプ：文字列
workOrderItem.state	タスクの状態。データタイプ：文字列
workOrderItem.work	タスクに必要な作業の説明。データタイプ: オブジェクト `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	この値は常に `WorkRefOrValue` です。データタイプ：文字列
workOrderItem.work.expectedCompletionDate	タスクの予定完了日。データタイプ：文字列
workOrderItem.work.id	タスクの作業タイプのSys_id。テーブル:作業タイプ [wm_work_type] データタイプ：文字列
workOrderItem.work.place	タスクに関連付けられた地理的な場所のリスト。 `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	この値は常に `RelatedPlaceRefOrValue` です。データタイプ：文字列
workOrderItem.work.place.place	場所に関する詳細。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
workOrderItem.work.place.place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
workOrderItem.work.place.role	タスクのコンテキストでのこの場所のロール。データタイプ：文字列
workOrderItem.work.relatedParty	タスクのサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
workOrderItem.work.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.relatedParty.name	サポートグループの名前。データタイプ：文字列
workOrderItem.work.relatedParty.role	サポートグループのロール。データタイプ：文字列
workOrderItem.work.scheduledStartDate	タスクのスケジュールされた開始日。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment	タスクの割り当ての詳細。データタイプ：アレイ `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	この値は常に `WorkforceEmployeeAssignment` です。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.id	タスクにアサインされたグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	タスクにアサインされた従業員に関する詳細。データタイプ: オブジェクト `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	この値は常に `[個別]` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	従業員の電話番号のリスト。データタイプ：アレイ `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	この値は常に `PhoneContactMedium` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	従業員の電話番号。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	従業員のSys_id。テーブル：ユーザー [sys_user] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	従業員の名前。データタイプ：文字列
workOrderItem.work.workPriority	タスクの優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
workOrderItem.work.workType	タスクの作業タイプ。テーブル:作業タイプ [wm_work_type] フィールド:名前データタイプ：文字列
作業指示番号	作業指示書の一意の識別子 (WO0008004など)。テーブル:作業指示 [wm_order] フィールド:数値データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 30. ステータスコード
ステータスコード	説明
201	作成されました。作業指示が正常に作成されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。

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


名前	説明
@type	この値は常に `WorkOrder` です。データタイプ：文字列
カテゴリ	`エンタープライズ`や`住宅`などの注文管理システムで使用できる作業指示のカテゴリ。データタイプ：文字列
完了日	作業指示が完了した日時。データタイプ：文字列
説明	作業指示の説明。データタイプ：文字列
expectedCompletionDate	プロバイダーによって指定された予定完了日時。データタイプ：文字列
externalIdentifier	ベンダーや相関 ID などの外部参照のリスト。データタイプ：アレイ `"externalIdentifier": [ { "@type": "String", "id": "String" } ]`
externalIdentifier.@type	この値は常に `ExternalIdentifierRef` です。データタイプ：文字列
externalIdentifier.id	ベンダーや相関 ID などの外部参照。データタイプ：文字列
href	作業指示レコードへの相対リンク。データタイプ：文字列
ID	作業指示書のSys_id。テーブル:作業指示 [wm_order] データタイプ：文字列
initiatedFrom	作業指示が開始された場所を示す参照 ID。たとえば、作業指示タスク [wm_task] テーブルからsys_idタスクがあるとします。データタイプ：文字列
注意	注文に関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
note.@type	この値は常に `Note`です。データタイプ：文字列
note.author	メモの作成者。データタイプ：文字列
note.date	メモが作業指示に追加された日付。データタイプ：文字列
note.text	メモのテキスト。データタイプ：文字列
place	作業指示書に関連付けられた地理的な場所。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String", "relatedParty": [Array] }`
place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
place.relatedParty	場所のサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
place.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
place.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
place.relatedParty.name	サポートグループの名前。データタイプ：文字列
place.relatedParty.role	サポートグループのロール。データタイプ：文字列
priority	作業指示の優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
relatedParty	作業指示に関連する連絡先のリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
relatedParty.id	関係者の sys_id。テーブル:アカウント [customer_account]、会社 [core_company]、またはユーザー [sys_user] データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.role	関係者のロール。可能な値：アカウント会社コンシューマー連絡先データタイプ：文字列
requestedCompletionDate	要求された完了日時。データタイプ：文字列
requestedStartDate	要求者によって指定された受注処理開始日。要求者が、指定された日付より前に履行を開始することをプロバイダーに許可できない場合に使用されます。データタイプ：文字列
shortDescription	作業指示の簡単なサマリー。データタイプ：文字列
startDate	注文が開始された日時。データタイプ：文字列
state	作業指示のステータス。可能な値：ドラフト認定待ち資格認定済みアサイン済み対応中完了データタイプ：文字列
template_id	作業指示に使用するテンプレートのSys_id。テーブル:製品モデル [cmdb_model] データタイプ：文字列
作業指示アイテム	作業指示のタスクのリスト。データタイプ：アレイ `"workOrderItem": [ { "@type": "String", "action": "String", "completionDate": "String", "description": "String", "id": "String", "note": {Object}, "shortDescription": "String", "state": "String", "work": {Object} } ]`
workOrderItem.@type	この値は常に `WorkOrderItem` です。データタイプ：文字列
workOrderItem.action	タスクの製品で実行するアクション。可能な値： add delete modify 変更なしデータタイプ：文字列
workOrderItem.completionDate	タスクが完了した日時。データタイプ：文字列
workOrderItem.description	タスクの説明。データタイプ：文字列
workOrderItem.id	タスクのSys_id。テーブル:作業指示タスク [wm_task] データタイプ：文字列
workOrderItem.note	タスクに関するメモのリスト。データタイプ：アレイ `"note": [ { "@type": "String", "author": "String", "date": "String", "text": "String" } ]`
workOrderItem.note.@type	この値は常に `Note`です。データタイプ：文字列
workOrderItem.note.author	メモの作成者。データタイプ：文字列
workOrderItem.note.date	メモがタスクに追加された日付。データタイプ：文字列
workOrderItem.note.text	メモのテキスト。データタイプ：文字列
workOrderItem.shortDescription	タスクの簡単な説明。データタイプ：文字列
workOrderItem.state	タスクの状態。データタイプ：文字列
workOrderItem.work	タスクに必要な作業の説明。データタイプ: オブジェクト `"work": { "@type": "String", "expectedCompletionDate": "String", "id": "String", "place": [Array], "relatedParty": [Array], "scheduledStartDate": "String", "workforceEmployeeAssignment": [Array], "workPriority": "String", "workType": "String" }`
workOrderItem.work.@type	この値は常に `WorkRefOrValue` です。データタイプ：文字列
workOrderItem.work.expectedCompletionDate	タスクの予定完了日。データタイプ：文字列
workOrderItem.work.id	タスクの作業タイプのSys_id。テーブル:作業タイプ [wm_work_type] データタイプ：文字列
workOrderItem.work.place	タスクに関連付けられた地理的な場所のリスト。 `"place": [ { "@type": "String", "place": {Object}, "role": "String" } ]`
workOrderItem.work.place.@type	この値は常に `RelatedPlaceRefOrValue` です。データタイプ：文字列
workOrderItem.work.place.place	場所に関する詳細。データタイプ: オブジェクト `"place": { "@type": "String", "id": "String" }`
workOrderItem.work.place.place.@type	この値は常に `GeographicSite` です。データタイプ：文字列
workOrderItem.work.place.place.id	場所のSys_id。テーブル:場所 [cmn_location] データタイプ：文字列
workOrderItem.work.place.role	タスクのコンテキストでのこの場所のロール。データタイプ：文字列
workOrderItem.work.relatedParty	タスクのサポートグループのリスト。データタイプ：アレイ `"relatedParty": [ { "@type": "String", "id": "String", "name": "String", "role": "String" } ]`
workOrderItem.work.relatedParty.@type	この値は常に `RelatedPartyRef` です。データタイプ：文字列
workOrderItem.work.relatedParty.id	サポートグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.relatedParty.name	サポートグループの名前。データタイプ：文字列
workOrderItem.work.relatedParty.role	サポートグループのロール。データタイプ：文字列
workOrderItem.work.scheduledStartDate	タスクのスケジュールされた開始日。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment	タスクの割り当ての詳細。データタイプ：アレイ `"workforceEmployeeAssignment": [ { "@type":"String", "id": "String", "workforceEmployee": {Object} } ]`
workOrderItem.work.workforceEmployeeAssignment.@type	この値は常に `WorkforceEmployeeAssignment` です。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.id	タスクにアサインされたグループのSys_id。テーブル： Group [sys_user_group] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee	タスクにアサインされた従業員に関する詳細。データタイプ: オブジェクト `"workforceEmployee": { "@type": "String", "contactMedium": [Array], "id": "String", "name": "String" }`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.@type	この値は常に `[個別]` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium	従業員の電話番号のリスト。データタイプ：アレイ `"contactMedium": [ { "@type": "String", "phoneNumber": "String" } ]`
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.@type	この値は常に `PhoneContactMedium` です。データタイプ：文字列
workOrderItem.work.work.workforceEmployeeAssignment.workforceEmployee.contactMedium.phoneNumber	従業員の電話番号。データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.id	従業員のSys_id。テーブル：ユーザー [sys_user] データタイプ：文字列
workOrderItem.work.workforceEmployeeAssignment.workforceEmployee.name	従業員の名前。データタイプ：文字列
workOrderItem.work.workPriority	タスクの優先度ランキング。可能な値： 1：重大 2：高 3：中 4：低 5：計画中データタイプ：文字列
workOrderItem.work.workType	タスクの作業タイプ。テーブル:作業タイプ [wm_work_type] フィールド:名前データタイプ：文字列
作業指示番号	作業指示書の一意の識別子 (WO0008004など)。テーブル:作業指示 [wm_order] フィールド:数値データタイプ：文字列

cURL 要求

テンプレートを使用して作業指示とタスクを作成します。

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "id": "323",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "templateId": "191ba0e0df113100dca6a5f59bf26336",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   }
}" \
--user 'username':'password'

応答本文。

{
   "id": "ca6d72d1ffa96210b79dffffffffffa1",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "templateId": "191ba0e0df113100dca6a5f59bf26336",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   },
   "href": "api/sn_tmf_api/work_order_management_api/workOrder/ca6d72d1ffa96210b79dffffffffffa1"
}

cURL 要求

テンプレートを使用せずに作業指示とタスクを作成します。

curl "http://instance.servicenow.com/api/sn_tmf_api/work_order_management_api/workOrder" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "id": "323",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   }
}" \
--user 'username':'password'

応答本文。

{
   "id": "24fc3259ffa96210b79dffffffffff56",
   "@type": "WorkOrder",
   "category": "service",
   "shortDescription": "Fixed Fibre Broadband Installation sb",
   "description": "Fixed Fibre description",
   "startDate": "2025-07-22T14:23:06.528Z",
   "requestedCompletionDate": "2024-06-22T14:23:06.528Z",
   "requestedStartDate": "2024-06-22T14:23:06.528Z",
   "priority": "2 - High",
   "expectedCompletionDate": "2025-07-28T14:23:06.528Z",
   "initiatedFrom": "d090df34df113100dca6a5f59bf26335",
   "place": {
      "@type": "GeographicSite",
      "id": "423e85f037d0200044e0bfc8bcbe5d12",
      "relatedParty": [
         {
            "role": "QualificationGroup",
            "id": "539546b237232000158bfc8bcbe5d7",
            "@type": "PartyRef",
            "@referredType": "Individual"
         }
      ]
   },
   "relatedParty": [
      {
         "@type": "RelatedPartyRef",
         "id": "d79249762fc1a610b79db3bf42faf3d2",
         "name": "Workforce Engineering Group",
         "role": "Company"
      },
      {
         "@type": "RelatedPartyRef",
         "id": "b88d14843bc02300bfe04d72f3efc4cd",
         "name": "Workforce Engineering Group",
         "role": "Contact"
      }
   ],
   "externalIdentifier": [
      {
         "@type": "ExternalIdentifier",
         "id": "1223412"
      }
   ],
   "workOrderItem": [
      {
         "@type": "WorkOrderItem",
         "action": "add",
         "id": "12232332",
         "description": "FTTH Installation",
         "completionDate": "2024-04-22T14:23:06.528Z",
         "work": {
            "@type": "WorkRefOrValue",
            "workType": "999469283bca10103f09080044efc4cf",
            "orderDate": "2024-04-22 14:23:06.528",
            "scheduledStartDate": "2025-06-25 14:23:06.528",
            "expectedCompletionDate": "2025-08-22 14:23:06.528",
            "workPriority": "2 - High",
            "place": [
               {
                  "@type": "RelatedPlaceRefOrValue",
                  "role": "string",
                  "place": {
                     "@type": "GeographicSite",
                     "id": "16ff753837d0200044e0bfc8bcbe5d5f"
                  }
               }
            ],
            "relatedParty": [
               {
                  "@type": "RelatedPartyRef",
                  "id": "4c0482b237232000158bbfc8bcbe5d09",
                  "name": "Louisiana Dispatchers",
                  "role": "DispatchGroup"
               }
            ],
            "workforceEmployeeAssignment": [
               {
                  "@type": "WorkforceEmployeeAssignment",
                  "id": "7172ea0037332000158bbfc8bcbe5db6",
                  "workforceEmployee": {
                     "@type": "Individual",
                     "name": "Athelstan Amos",
                     "id": "46c1293aa9fe1981000dc753e75ebeee"
                  }
               }
            ]
         },
         "note": {
            "@type": "Note",
            "id": "afa9-3d90aaa8da0f",
            "text": "This is a work order task note."
         }
      }
   ],
   "note": {
      "@type": "Note",
      "id": "afa9-3d90aaa8da0f",
      "text": "This is a work order note."
   },
   "href": "api/sn_tmf_api/work_order_management_api/workOrder/24fc3259ffa96210b79dffffffffff56"
}