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

Connect REST API 開発者ガイド

Connect REST API 開発者ガイド
概要
クイックスタート
機能の操作
例
リソース
リクエストのボディ
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Activity Reminder Input
住所の入力
Adjust Item Input
Adjust Order Item Summary Input
Alternative Input
Announcement Input
Article Topic Assignment Job Input
Asset Action Input
Asset Action Source Input
Asset File Input
Asset State Period Input
Assigned Resource Input
Associated Actions Capability Input
Async Query Input
Audience Criterion Input
Audience Criterion Value Input
Audience Input
Available Territory Slots Input
Authorization API Payment Method Input
Authorization Reversal Input
Authorization Input
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Bot Version Activation Input
Cancel Asset Input
Canvas Capability Input
Capacity Request Input
Capture Input
Alternative Payment Method Input
Card Payment Method Input
Card Payment Method Tokenization Input
Cart Input
Cart Item Input
Cart Item Promotion Collection Input
Cart Item Promotion Input
Cart Messages Visibility Input
Cart to Wishlist Input
Change Asset Input
Category Settings Input
Change Input
Change Item Input
Change Item Fee Input
Chatter Stream Input
Cart Coupon Input
Checkout Address Input
Checkout Input
Checkout Payment Input
Checkout Start Input
Clean Input
Close Capability Input
Comment Capabilities Input
Comment Input
Commerce Address Field Input
Commerce Address Input
Commerce Einstein Activity Job Input
Community Input
Confirm Held FO Capacity Input
Confirm Held FO Capacity Request Input
Connectors Call Input
Connectors Call List Input
Contact Information Input
Content Capability Input
Conversation Entries Update Input
Conversation Entry Update Input
Create Credit Memo Input
Create Invoice From Change Orders Input
Create Multiple Invoices From Change Orders Input
Create Order Payment Summary Input
Credential Input
Credential Value Input
Custom List Audience Criteria Input
Custom Recommendation Audience Input
Custom Recommendation Definition Input
Customer Data Platform Query Input
Customer Data Platform Segment Dbt Input
Customer Data Platform Segment Dbt Model Input
Customer Data Platform Segment Input
Dashboard Component Snapshot Input
Digest Job Input
Direct Message Capability Input
Distinct Value Refinement Input
Duplicate Job Input
Duplicate Job Status Input
資金を非同期で確認の入力
返金を非同期で確認の入力
Entitlement Settings Input
Environment Hub SSO User Mapping Input
Extended Fields Input
Extension Input
Extensions Capability Input
Facetable Attribute Input
Facetable Attributes Collection Input
Feed Element Capabilities Input
Feed Entity Share Capability Input
Feed Favorite Input
Feed Item Input
Feed Item Topic Input
File ID Input
File Input
File Shares Input
Files Capability Input
Files Connect Field Value Input
Files Connect Item Input
Files Connect Permission Collection Input
Files Connect Permission Input
Find Routes With Fewest Splits Input
OCI を使用した分割が最も少ないルートの検索の入力
Find Routes With Fewest Splits Group Using OCI Input
Find Routes With Fewest Splits Using OCI Item Input
Folder Input
Folder Item Input
Following Input
Form Field Input
Form Input
Form Submission Field Input
Form Submission Input
Fulfillment Group Input
履行注文の入力
Fulfillment Order Invoice Input
Fulfillment Order Line Item Input
Fulfillment Order Line Items To Cancel Input
Generate Asset Input
Generic Batch Collection Input
Generic Batch Input
Get FO Capacity Values Request Input
Global Product Import Input
Order Summary Graph Input
Order Summary Graphs Input
Group Chatter Settings Input
Group Information Input
Group Input
Group Member Input
Group Membership Request Update
Group Record Input
Hold FO Capacity Input
Hold FO Capacity Request Input
Import Configuration Input
Import Settings Input
Import Source Input
Inner Ensure Funds Async Input
Invite Collection Input
Invoice To Pay Input
Knowledge Article View Stat Input
Lead Input
Link Capability Input
List Current Share Collection Input
Location Availability Input
Location Input
Managed Content Input
Managed Content Publish Input
Managed Content Type Searchable Input
Managed Content Unpublish Input
Managed Content Variant Update Input
Media Settings Input
Managed Social Account Setup Input
Managed Topic Input
Managed Topic Position Collection Input
Managed Topic Position Input
Message Body Input
Message Segment Input: Entity Link
Message Segment Input: Hash Tag
Message Segment Input: Inline Image
Message Segment Input: Link
Message Segment Input: Markup Begin
Message Segment Input: Markup End
Message Segment Input: Mention
Message Segment Input: Text
Messaging Channel Input
Microbatching Ingestion Input
Moderation Flag Input
Multiple Ensure Funds Async Input
Multiple Fulfillment Order Input
Multiple Fulfillment Order Invoices Input
Mute Capability Input
New User Audience Criteria Input
Next Best Action Strategy Input
Notification App Setting Input
Notification Collection Input
Notification Input
Notification Member Input
Notification Setting Input
OAuth Credential Auth URL Input
OCI Create Reservation Input
OCI Create Reservation Single Input
OCI Fulfill Reservation Input
OCI Fulfill Reservation Single Input
OCI Get Inventory Availability Input
OCI Release Reservation Input
OCI Release Reservation Single Input
OCI Transfer Reservation Input
OCI Transfer Reservation Single Input
Object Input
Order Item Summary Input
Order Item Summary Adjustment Collection Input
Order Item Summary Adjustment Input
Order Summary Adjustment Aggregates Async Input
Order Summary Input
Order to Cart Input
Payment Group Input
Payment Method Input
Payment Method Tokenization Input
Payment Token Input
Photo Input
Pin Capability Input
Poll Capability Input
Post Auth Input
Post Authorization API Payment Method Input
Price Settings Input
Pricing Input
Pricing Line Item Input
Product Import Cancel Input
Product Import Input
Product Search Grouping Input
Product Search Input
Promotion Cart Input
Promotion Cart Delivery Group Input
Promotion Cart Item Input
Promotion Evaluation Input
Promotion Parent Products Input
Promotion Product Categories Input
Push Notification Input
Quantity With SKU Input
Question and Answers Capability Input
Rank Average Distance Input
Read By Capability Input
Recommendation Reaction Input
Record Capability Input
Recordset Filter Criteria Input
Referenced Refund Input
Release Held FO Capacity Input
Release Held FO Capacity Request Input
Request Header Input
Return Items Input
Return Order Input
Return Order Item Delivery Charge Input
Return Order Item Fee Input
Return Order Item Input
Return Order Line Item Input
Return Order Line Item Fee Input
Sale API Payment Method Input
Sale Input
Scheduled Custom Recommendation Input
Searchable Attribute Input
Searchable Attributes Collection Input
Search Product Setting Collection Input
Search Product Setting Input
Sequence Order Payment Summary Input
Service Appointment Input
Service Appointments Create Input
Service Appointment Update Input
Share Captured Activity Input
Share Input
Shifts from Pattern Input
Skill Requirement Input
Social Customer Service Configuration Input
Social Customer Service Message Type Settings Input
Social Customer Service Provider Settings Input
Sort Rule Input
Sort Rules Collection Input
Social Post Mass Approval Input
Status Capability Input
Stream Subscription Input
Survey Description Input
Survey Email Input
Survey Invitation Settings Input
Survey Response Input
Survey Page Response Input
Survey Question Response Input
Survey Integer Question Response Input
Survey Recipient Engagement Context Input
Survey Recipient Survey Subjects Input
Survey Selection Question Response Input
Survey Selection Question Choice Input
Survey Text Question Response Input
Target Collection Input
Target Collection Update Input
Target Input
Target Location Input
Target Update Input
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
Topics Capability Input
Up Down Vote Capability Input
User Chatter Settings Input
User ID Collection Input
User Input
User Message
User Message Recipient Input
User Message Recipient List Input
User Mission Activity Input
User Status Input
User Stream (Conversation) Input
Verified Capability Input
Webstore Settings Input
Wishlist Input
Wishlist Item Input
Wishlist Update Input
Work Type Input
レスポンスのボディ
付録
PDF

Service Appointment Update Input

サービス予定を更新するための入力表現。既存の予定のスケジュール済み時刻、割り当て済みリソース、サービステリトリー、または作業種別を更新するために使用します。

制限事項

リソースを使用して、次のものを変更することはできません。
  • 親レコード ID (parentRecordId) とサービス予定 ID (serviceAppointmentId)
  • キャンセル済みの予定。
  • 過去の日付の予定。
  • lead の詳細。
  • マルチリソーススケジュールが有効になっている場合、1 回の要求で新しいリソースを追加し、さらにそれをプライマリリソースにすることはできません。1 回の要求で新しいリソースを追加してから、別の要求を実行してそのリソースをプライマリリソースとして追加します。
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