サービス予定

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

JSON の例

1{
2  "serviceAppointment": {
3    "parentRecordId": "0012w000004oZXgAAM",
4    "workTypeId": "08q2w000000XmniAAC",
5    "serviceTerritoryId": "0Hh2w000000XmoXCAS",
6    "engagementChannelTypeId": "0eFRM00000000Bv2AI",
7    "schedStartTime": "2020-02-26T15:00:00.000Z",
8    "schedEndTime": "2020-02-26T16:00:00.000Z",
9    "street": "1 Market Street",
10    "city": "San Francisco",
11    "state": "CA",
12    "postalCode": "94105",
13    "country": "USA",
14    "appointmentType": "In Person",
15    "extendedFields": [
16 {
17                "name": "Email",
18                "value": "rachel.adams@salesforce.com"
19            },
20            {
21                "name": "Phone",
22                "value": "111111111"
23            },
24            {
25                "name": "Description",
26                "value": "Test Description"
27 }
28]
29  },
30  "assignedResources": [
31    {
32      "serviceResourceId": "0Hn2w000000gDWDCA2",
33      "isRequiredResource": true,
34      "isPrimaryResource": true,
35      "extendedFields": []
36    },
37    {
38      "serviceResourceId": "0Hn2w000000gCqnCAE",
39      "isRequiredResource": true,
40      "isPrimaryResource": false,
41      "extendedFields": []
42    }
43  ]
44}

認証されていないユーザーの JSON の例

1{
2  "serviceAppointment": {
3    "workTypeId": "08q2w000000XmniAAC",
4    "serviceTerritoryId": "0Hh2w000000XmoXCAS",
5    "engagementChannelTypeId": "0eFRM00000000Bv2AI",
6    "schedStartTime": "2020-02-26T15:00:00.000Z",
7    "schedEndTime": "2020-02-26T16:00:00.000Z",
8    "street": "1 Market Street",
9    "city": "San Francisco",
10    "state": "CA",
11    "postalCode": "94105",
12    "country": "USA",
13    "appointmentType": "In Person",
14    "extendedFields": []
15  },
16  "assignedResources": [
17    {
18      "serviceResourceId": "0Hn2w000000gDWDCA2",
19      "isRequiredResource": true,
20      "isPrimaryResource": true,
21      "extendedFields": []
22    }
23  ],
24  "lead": {
25        "firstName": "Rachel",
26        "lastName": "Adams",       
27        "phone": "012-345-6789",            
28        "email": "rachel.adams@salesforce.com",
29        "company": "Salesforce",
30        "extendedFields": []
31    }
32}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
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

JSON の例

1{
2  "serviceAppointmentId": "08pxx0000004C92AAE",
3  "serviceAppointment": {
4    "workTypeId": "08pxx0000004C92AAE",
5    "serviceTerritoryId": "0Hh2xx0000004CAeCAM",
6    "engagementChannelTypeId": "0eFRM0000004CC22AM", 
7    "schedStartTime": "2020-09-15T16:00:00+0000",
8    "schedEndTime": "2020-09-22T16:45:00+0000",
9    "street": "1 Market Street",
10    "city": "San Francisco",
11    "state": "CA",
12    "postalCode": "94105",
13    "country": "USA",
14    "appointmentType": "In Person",
15    "extendedFields": [
16      {
17        "name": "Email",
18        "value": "rachel.adams@salesforce.com"
19      },
20      {
21        "name": "Phone",
22        "value": "111111111"
23      },
24      {
25        "name": "Description",
26        "value": "Test Description"
27      }
28    ],
29  "assignedResources": [
30    {
31      "serviceResourceId": "0Hnxx0000004CAeCAM",
32      "isRequiredResource": true,
33      "isPrimaryResource": false,
34      "extendedFields": []
35    },
36  ]
37}

スケジュール済み時刻を更新する要求の例

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

メモ

1{
2  "serviceAppointmentId": "08pxx0000004C92AAE",
3  "serviceAppointment": {
4    "schedStartTime": "2020-09-15T16:00:00+0000",
5    "schedEndTime": "2020-09-22T16:45:00+0000",
6}

作業種別を更新する要求の例

1{
2  "serviceAppointmentId": "08pxx0000004C92AAE",
3  "serviceAppointment": {
4    "workTypeId": "08qxx0000004C92AAE",
5}

サービステリトリーを更新する要求の例

1{
2  "serviceAppointmentId": "08pxx0000004C92AAE",
3  "serviceAppointment": {
4    "serviceTerritoryId": "0Hhxx0000004CAeCAM"
5}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
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