サービス予定 | Connect REST API 開発者ガイド

1/connect/scheduling/service-appointments

48.0

いいえ

POST、PATCH

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

JSON の例

1{
2  "serviceAppointment": {
3    "parentRecordId": "0012w000004oZXgAAM",
4    "workTypeId": "08q2w000000XmniAAC",
5    "serviceTerritoryId": "0Hh2w000000XmoXCAS",
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                "name": "Email",
17                "value": "rachel.adams@salesforce.com"
18            },
19            {
20                "name": "Phone",
21                "value": "111111111"
22            },
23            {
24                "name": "Description",
25                "value": "Test Description"
26 }
27]
28  },
29  "assignedResources": [
30    {
31      "serviceResourceId": "0Hn2w000000gDWDCA2",
32      "isRequiredResource": true,
33      "isPrimaryResource": true,
34      "extendedFields": []
35    },
36    {
37      "serviceResourceId": "0Hn2w000000gCqnCAE",
38      "isRequiredResource": true,
39      "isPrimaryResource": false,
40      "extendedFields": []
41    }
42  ]
43}

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

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

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
`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    "schedStartTime": "2020-09-15T16:00:00+0000",
7    "schedEndTime": "2020-09-22T16:45:00+0000",
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        "name": "Email",
17        "value": "rachel.adams@salesforce.com"
18      },
19      {
20        "name": "Phone",
21        "value": "111111111"
22      },
23      {
24        "name": "Description",
25        "value": "Test Description"
26      }
27    ],
28  "assignedResources": [
29    {
30      "serviceResourceId": "0Hnxx0000004CAeCAM",
31      "isRequiredResource": true,
32      "isPrimaryResource": false,
33      "extendedFields": []
34    },
35  ]
36}

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

スケジュール済み時刻が更新されると、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

Service Appointment Output