この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

サービス予定

サービス予定を作成および更新します。
リソース
使用可能なバージョン
48.0
Chatter が必要かどうか
いいえ
HTTP のメソッド
POST、PATCH

PATCH はバージョン 51.0 以降で使用できます。

POST のリクエストボディ
JSON の例
認証されていないユーザの JSON の例
プロパティ
名前 説明 必須か省略可能 使用可能なバージョン
assignedResources Assigned Resource Input[] サービス予定に割り当てられたサービスリソース。

予定を作成するときには、assignedResources 内で extendedFields を使用して、自分が編集アクセス権を持っている任意の項目 (カスタム項目を含む) に値を追加できます。

メモ

省略可能 48.0
lead Lead Input[] 見込み客またはリード。 serviceAppointment が指定されていない場合は必須

認証されていないゲストユーザとのサービス予定を作成するには必須。

メモ

48.0
schedulingPolicyId String AppointmentSchedulingPolicy オブジェクトの ID。リクエストボディでスケジュールポリシーが渡されない場合、デフォルトの設定が使用されます。時間枠の決定時に使用される唯一のスケジュールポリシー設定は、取引先訪問時間の適用です。 省略可能 48.0
serviceAppointment Service Appointment Input[] 顧客のサービス作業を完了するための予定。

予定を作成するときには、serviceAppointment 内で extendedFields を使用して、自分が編集アクセス権を持っている任意の項目 (カスタム項目を含む) に値を追加できます。

メモ

lead が指定されていない場合は必須 48.0
PATCH のリクエストボディ
JSON の例
スケジュール済み時刻を更新する要求の例

スケジュール済み時刻が更新されると、API によって対応する Salesforce カレンダーの行動が更新され、時刻がブロックされます。

メモ

作業種別を更新する要求の例
サービステリトリーを更新する要求の例
プロパティ
名前 説明 必須か省略可能 使用可能なバージョン
assignedResources Assigned Resource Input[] サービス予定に割り当てられたサービスリソース。

予定を更新するときには、必要なリソースの完全なリストを渡します。

サービス予定に割り当てられたリソースを渡さないと、その割り当て済みリソースは API によって削除されます。たとえば、既存のサービス予定に割り当て済みリソース A と B があり、割り当て済みリソース B と C を渡したとします。その場合、API によって既存の作業種別とサービステリトリーに対してリソース B と C の作業可能性がチェックされ、両方が作業可能である場合には、次のようにサービス予定が更新されます。
  • リソース A — 削除される
  • リソース B — 更新される
  • リソース C — 作成される

ただし、割り当て済みリソースをまったく渡さなかった場合には、変更がないと見なされます。

予定を更新するときには、assignedResources 内で extendedFields を使用して、自分が編集アクセス権を持っている任意の項目 (カスタム項目を含む) に値を追加できます。

メモ

省略可能 51.0
schedulingPolicyId String AppointmentSchedulingPolicy オブジェクトの ID。リクエストボディでスケジュールポリシーが渡されない場合、デフォルトの設定が使用されます。時間枠の決定時に使用される唯一のスケジュールポリシー設定は、取引先訪問時間の適用です。 省略可能 51.0
serviceAppointment Service Appointment Input[] 顧客のサービス作業を完了するための予定。

予定を更新するときには、更新する必要がある項目のみを渡します。

予定を更新するときには、serviceAppointment 内で extendedFields を使用して、自分が編集アクセス権を持っている任意の項目 (カスタム項目を含む) に値を追加できます。

メモ

必須 51.0
serviceAppointmentId String 更新するサービス予定の ID。 必須 51.0
POST および PATCH のレスポンスボディ
Service Appointment Output