--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # 予約オープン:POST /sn_tmf_api/appointment/appointment # 予約オープン:POST /sn_tmf_api/appointment/appointment {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：10分 作業指示書の予約を行うことができます。 ## URL 形式 /api/sn_tmf_api/appointment/appointment ## サポートされている要求パラメーター {#apptOpen-POST-appointment__table_lr2_mwt_dcc__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 1. パスパラメーター] {#apptOpen-POST-appointment__table_lr2_mwt_dcc} {#apptOpen-POST-appointment__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメータ] {#apptOpen-POST-appointment__entry__10}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime}{#apptOpen-POST-appointment__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime} | 名前 | 説明 | |-|-| | カテゴリ | 必須。予約サービス設定用に設定されたレコードプロデューサーのsys_id。レコードプロデューサーは、関連する予約サービス設定レコード - 予約サービス設定 \[sn_apptmnt_booking_service_config\] テーブルの \[カタログアイテム\] フィールドで定義されます。 データタイプ：文字列 | | relatedEntity | 影響を受ける作業指示のリスト。 データタイプ：アレイ "relatedEntity": [ { "id": "String", "@referredType": "String" } ] | | relatedEntity.id | 必須。作業指示 \[wm_order\] テーブルにあるレコードのsys_id。 データタイプ：文字列 | | relatedEntity.@referredType | アイテムまたはサービスのタイプ。`たとえば、WorkOrder` です。 データタイプ：文字列 | | relatedEntity.role | エンティティロールの説明。`たとえば、作業指示など`です。 データタイプ：文字列 | | relatedParty | 予約の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。要求には、顧客アカウント情報を含むアイテムが少なくとも 1 つリストされている必要があります。 データタイプ：アレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] | | relatedParty.id | 必須。作業指示書に関連付けられている顧客連絡先のsys_idまたはexternal_id。連絡先 \[customer_contact\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | 顧客の名前。 データタイプ：文字列 | | relatedParty.@referredType | 顧客のタイプ。`たとえば、個人`です。 データタイプ：文字列 | | relatedParty.role | 必須。連絡先の事前定義されたロール。`たとえば、顧客`です。 データタイプ：文字列 | | 関連場所 | 予約に関連する場所のリスト。 "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] データタイプ：アレイ | | relatedPlace.id | 必須。場所 \[cmn_location\] テーブルにリストされている場所のsys_id。 データタイプ：文字列 | | relatedPlace.name | 場所 \[cmn_location\] テーブルにリストされている場所の名前。`例:251 Reddy St, Darwin, CA 93522` データタイプ：文字列 | | relatedPlace.@referredType | 場所のタイプ。たとえば、 `市区町村`です。 データタイプ：文字列 | | relatedPlace.role | 場所ロールの説明。たとえば、作業指示などです。 データタイプ：文字列 | | タイムゾーン | 必須。指定された予約スロットを予約するときに使用するタイムゾーン。 | | validFor | 必須。予約が有効な日付範囲。 データタイプ: オブジェクト "validFor": { "startDateTime": "String", "endDateTime": "String" } | | validFor.startDateTime | タイムスロットの開始日。 形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。 データタイプ：文字列 | | validFor.endDateTime | タイムスロットの終了日。 形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。 データタイプ：文字列 | [表 : 3. 要求本文パラメーター] ## ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#apptOpen-POST-appointment__entry__50}{#apptOpen-POST-appointment__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 4. 要求ヘッダー] {#apptOpen-POST-appointment__entry__54}{#apptOpen-POST-appointment__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 5. 応答ヘッダー] ## ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#apptOpen-POST-appointment__entry__58}{#apptOpen-POST-appointment__entry-200-status-code}{#apptOpen-POST-appointment__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 6. ステータスコード] ## 応答本文のパラメーター {#apptOpen-POST-appointment__entry__64} | 名前 | 説明 | |-|-| | カテゴリ | 予約サービス設定用に設定されたレコードプロデューサーのsys_id。レコードプロデューサーは、関連する予約サービス設定レコード - 予約サービス設定 \[sn_apptmnt_booking_service_config\] テーブルの \[カタログアイテム\] フィールドで定義されます。 データタイプ：文字列 | | creationDate | 予約レコードが作成された日時。 データタイプ：文字列 | | id | 作成された予約のsys_id。予約サービスの設定 \[sn_apptmnt_booking_service_config\] テーブルにあります。 データタイプ：文字列 | | href | 予約レコードへの相対リンク。 データタイプ：文字列 | | lastUpdate | 予約レコードが最後に更新された日時。 データタイプ：文字列 | | relatedEntity | 影響を受ける作業指示のリスト。 データタイプ：アレイ "relatedEntity": [ { "id": "String", "@referredType": "String" } ] | | relatedEntity.id | 作業指示 \[wm_order\] テーブルにあるレコードのsys_id。 データタイプ：文字列 | | relatedEntity.@referredType | アイテムまたはサービスのタイプ。 データタイプ：文字列 | | relatedEntity.role | エンティティロールの説明。 データタイプ：文字列 | | relatedParty | 予約の連絡先のリスト。各連絡先はアレイ内のオブジェクトです。要求には、顧客アカウント情報を含むアイテムが少なくとも 1 つリストされている必要があります。 データタイプ：アレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] | | relatedParty.id | 作業指示書に関連付けられている顧客連絡先のsys_idまたはexternal_id。連絡先 \[customer_contact\] テーブルにあります。 データタイプ：文字列 | | relatedParty.name | 顧客の名前。 データタイプ：文字列 | | relatedParty.@referredType | 顧客のタイプ。 データタイプ：文字列 | | relatedParty.role | 連絡先の事前定義されたロール。 データタイプ：文字列 | | 関連場所 | 予約に関連する場所のリスト。 "relatedPlace": [ { "id": "String", "name": "String", "@referredType": "String", "role": "String" } ] データタイプ：アレイ | | relatedPlace.id | 場所 \[cmn_location\] テーブルにリストされている場所のsys_id。 データタイプ：文字列 | | relatedPlace.name | 場所 \[cmn_location\] テーブルにリストされている場所の名前。 データタイプ：文字列 | | relatedPlace.@referredType | 場所のタイプ。 データタイプ：文字列 | | relatedPlace.role | 場所ロールの説明。 データタイプ：文字列 | | タイムゾーン | 指定された予約スロットを予約するときに使用するタイムゾーン。 | | validFor | 予約が有効な日付範囲。 データタイプ: オブジェクト "validFor": { "startDateTime": "String", "endDateTime": "String" } | | validFor.startDateTime | タイムスロットの開始日。 データタイプ：文字列 | | validFor.endDateTime | タイムスロットの終了日。 データタイプ：文字列 | | 正常終了 | 要求が成功したかどうかを示すフラグ。 可能な値： * true:要求が成功しました。 * false:要求が失敗しました。 データタイプ：ブーリアン | [ ] ## cURL 要求 次の例は、新しい予約を作成する方法を示しています... curl "https://instance.servicenow.com/api/sn_tmf_api/appointment/appointment" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ \"validFor\": { \"startDateTime\": \"2024-08-19 09:00:00\", \"endDateTime\": \"2024-08-19 11:00:00\" }, \"category\": \"e4c1116b3b810300ce8a4d72f3efc40f\", \"relatedParty\": [ { \"id\": \"eaf68911c35420105252716b7d40ddde\", \"name\": \"Sally Thomas\", \"role\": \"customer\", \"@referredType\": \"Individual\" } ], \"relatedPlace\": { \"id\": \"25ab9c4d0a0a0bb300f7dabdc0ca7c1c\", \"name\": \"100 South Charles Street, Baltimore,MD\", \"role\": \"interventionAddress\", \"@referredType\": \"GeographicAddress\" }, \"relatedEntity\": [ { \"id\": \"48dbfbf9201f0250f877303e8a020dcd\", \"role\": \"work order\", \"@referredType\": \"WorkOrder\" } ], \"timeZone\": \"US/Arizona\" }" \ --user 'username':'password' 応答： { "validFor": { "startDateTime": "2024-07-19 09:00:00", "endDateTime": "2024-07-19 11:00:00" }, "category": "e4c1116b3b810300ce8a4d72f3efc40f", "relatedParty": [ { "id": "eaf68911c35420105252716b7d40ddde", "name": "Sally Thomas", "role": "customer", "@referredType": "Individual" } ], "relatedPlace": { "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c", "name": "100 South Charles Street, Baltimore,MD", "role": "interventionAddress", "@referredType": "GeographicAddress" }, "relatedEntity": [ { "id": "48dbfbf9201f0250f877303e8a020dcd", "role": "work order", "@referredType": "WorkOrder" } ], "timeZone": "US/Arizona", "success": true, "id": "feacb7f9201f0250f877303e8a020d38", "href": "api/sn_tmf_api/appointment/appointment/feacb7f9201f0250f877303e8a020d38", "creationDate": "2024-07-10 22:45:01", "lastUpdate": "2024-07-10 22:45:01" }