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

Connect REST API 開発者ガイド

Connect REST API 開発者ガイド
概要
クイックスタート
機能の操作
例
リソース
Chatter のリソース
リクエストボディ
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
Alternative Payment Method 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
Audience Criterion Input
Audience Criterion Value Input
Audience Input
Authorization API Payment Method Input
Authorization Reversal Input
Authorization Input
Available Territory Slots Input
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Boost and Bury Rule Condition Input
Boost and Bury Rule Input
Boost and Bury Rule Target Expression Input
Bot Version Activation Input
Calculate Taxes Input
Calculate Taxes Item Group Input
Calculate Taxes Line Item Input
Cancel Asset Input
Canvas Capability Input
Capacity Request Input
Capture Input
Card Payment Method Input
Card Payment Method Tokenization Input
Cart Coupon Input
Cart Inventory Reservation Input (パイロット)
Cart Input
Cart Item Input
Cart Item Promotion Collection Input
Cart Item Promotion Input
Cart Messages Visibility Input
Cart to Wishlist Input
Category Import Abort Input
Category Import Input
Category Settings Input
Change Asset Input
Change Input
Change Item Input
Change Item Fee Input
Chatter Stream 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
Coupon Code Redemption Input
Create Credit Memo Input
Create Invoice From Change Orders Input
Create Multiple Invoices From Change Orders Input
Create Order Payment Summary Input
Credential Custom Header Input
Credential Input
Credential Value Input
Custom List Audience Criteria Input
Custom Recommendation Audience Input
Custom Recommendation Definition Input
Dashboard Component Snapshot Input
Data Category Group Collection Input
Data Category Group Input
Data Category Input
Data Cloud Calculated Insight Input
Data Cloud Identity Resolution Config Input
Data Cloud Identity Resolution Config Patch Input
Data Cloud Identity Resolution Match Criterion Input
Data Cloud Identity Resolution Match Criterion Party Identification Info Input
Data Cloud Identity Resolution Match Rule Input
Data Cloud Identity Resolution Reconciliation Field Rule Input
Data Cloud Identity Resolution Reconciliation Rule Input
Data Cloud Identity Resolution Reconciliation Source Input
Data Cloud Identity Resolution Run Now Input
Data Cloud Query Input
Data Cloud Segment Dbt Input
Data Cloud Segment Dbt Model Input
Data Cloud Segment Input
Digest Job Input
Direct Message Capability Input
Distinct Value Refinement Input
Distribute Picked Quantities Input
Distribute To Orders Input
Duplicate Job Input
Duplicate Job Status Input
Ensure Funds Async Input
Ensure Refunds Async Input
Entitlement Settings Input
Environment Hub SSO User Mapping Input
Extended Fields Input
Extension Input
Extensions Capability Input
External Credential Input
External Credential Parameter Input
External Credential Principal 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 Share Link 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
Find Routes With Fewest Splits Group Using OCI Input
Find Routes With Fewest Splits 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 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
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
Item Quantity Input
Knowledge Article View Stat Input
Lead Input
Line Adjustment 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 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
Named Credential Callout Options Input
Named Credential Input
Named Credential Parameter Input
Network Connection 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
Object 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
Order Item Summary Adjustment Collection Input
Order Item Summary Adjustment Input
Order Item Summary Input
Order Summary Adjustment Aggregates Async Input
Order Summary Graph Input
Order Summary Graphs Input
Order Summary Input
Order Summary Lookup Input
Order Summary Verification Input
Order to Cart Input
Payment Group Input
Payment Method Input
Payment Method Tokenization Input
Payment Token Input
Apple Pay Domain Input
Payment Intents 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
Program Application Input
Program Application Item Input
Program Application File Input
Product Search Input
Promotion Cart Delivery Group Input
Promotion Cart Input
Promotion Cart Item Input
Promotion Evaluation Input
Promotion Parent Products Input
Promotion Product Categories Input
Promotion Product Evaluation Input
Promotion Product 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 Fee Input
Return Order Line Item Input
Sale API Payment Method Input
Sale Input
Saved Payment Method Input
Scheduled Custom Recommendation Input
Searchable Attribute Input
Searchable Attributes Collection Input
Search Product Setting Collection Input
Search Product Setting Input
Include Search Rule Collection Input
Include Search Rule Input
Sequence Order Payment Summary Input
Service Appointment Input
Service Appointment Update Input
Service Appointments Create Input
Share Captured Activity Input
Share Input
Shifts from Pattern Input
Skill Requirement Input
Ship to Address Input
Social Customer Service Configuration Input
Social Customer Service Message Type Settings Input
Social Customer Service Provider Settings Input
Social Post Mass Approval Input
Sort Rule Input
Sort Rules Collection Input
Status Capability Input
Stream Subscription Input
Survey Description Input
Survey Email Input
Survey Integer Question Response Input
Survey Invitation Settings Input
Survey Page Response Input
Survey Question Response Input
Survey Recipient Engagement Context Input
Survey Recipient Survey Subjects Input
Survey Response Input
Survey Selection Question Choice Input
Survey Selection Question Response 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
Waitlist Check In Input
Webstore Settings Input
Wishlist Input
Wishlist Item Input
Wishlist Update Input
Work Type Input
レスポンスボディ
付録
PDF

Action Link Definition Input

アクションリンクの定義。アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを特定の Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバへの API コールを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合することで、ユーザは生産性を高め、イノベーションを促進できます。

使用方法

コンテキスト変数は、actionUrl、headers、および requestBody プロパティで使用できます。コンテキスト変数を使用して、アクションリンクを実行したユーザに関する情報をサーバ側のコードに渡すことができます。アクションリンクが実行されたときに、Salesforce によって値が代入されます。

使用可能なコンテキスト変数を次に示します。

コンテキスト変数 説明
{!actionLinkId} ユーザが実行したアクションリンクの ID。
{!actionLinkGroupId} ユーザが実行したアクションリンクが含まれるアクションリンクグループの ID。
{!communityId} ユーザがアクションリンクを実行したサイトの ID。内部組織の場合、値は空のキー "000000000000000000" になります。
{!communityUrl} ユーザがアクションリンクを実行したサイトの URL。内部組織の場合、値は空の文字列 "" になります。
{!orgId} ユーザがアクションリンクを実行した組織の ID。
{!userId} アクションリンクを実行したユーザの ID。
ルート XML タグ
<actionLinkDefinition>
JSON の例
次の例ではテンプレートを使用していません。
1{
2   "actionType":"Api",
3   "actionUrl":"/services/data/v59.0/chatter/feed-elements",
4   "groupDefault":"true",
5   "labelKey":"Post",
6   "method":"Post",
7   "requiresConfirmation":"true",
8   "requestBody":"{\"subjectId\": \"me\",\"feedElementType\": \"FeedItem\",\"body\": {\"messageSegments\": [{\"type\": \"Text\",\"text\": \"Testing a post created via an API action link.\"}]}}",
9   "headers":[
10   {
11      "name":"Content-Type", "value":"application/json"
12   }]
13}
次の例ではテンプレートを使用しています。
1{
2   "templateId":"07gD00000004C9r",
3   "templateBindings":[
4      {
5         "key":"Bindings.version",
6         "value":"v33.0"
7      }
8   ]
9}
プロパティ
名前 型 説明 必須か省略可能 使用可能なバージョン
actionType String アクションリンクの種別を定義します。値は次のとおりです。
  • Api — アクションリンクは、アクション URL で同期 API をコールします。Salesforce は、サーバから返された HTTP 状況コードに基づいて状況を SuccessfulStatus または FailedStatus に設定します。
  • ApiAsync — アクションリンクは、アクション URL で非同期 API をコールします。アクションは、非同期操作の完了時にサードパーティが /connect/action-links/actionLinkId への要求を行って状況を SuccessfulStatus または FailedStatus に設定するまで、PendingStatus 状態のままになります。
  • Download — アクションリンクは、アクション URL からファイルをダウンロードします。
  • Ui — アクションリンクはアクション URL の Web ページをユーザに表示します。

ユーザがアクションを実行する前にページを読み込む必要がある場合、Ui を使用します。たとえば、アクションの実行前にユーザが入力を行う場合やユーザに情報を表示したりする場合などです。

 必須

アクションリンクテンプレートに定義できます。

 33.0
actionUrl String アクションリンクの URL。たとえば、Ui アクションリンク URL は Web ページになります。Download アクションリンク URL は、ダウンロードするファイルへのリンクになります。Ui および Download アクションリンク URL がクライアントに提供されます。Api または ApiAsync アクションリンク URL は REST リソースになります。Api および ApiAsync アクションリンク URL はクライアントに提供されません。Salesforce へのリンクは、相対リンクにすることができます。他のすべてのリンクは、https:// で始まる絶対リンクにする必要があります。

API のアップグレードや機能変更が原因の問題を回避するために、actionUrl にはバージョン管理された API を使用することをお勧めします (https://www.example.com/​api/v1/exampleResource など)。API がバージョン管理されていない場合、Action Link Group Definition Input の expirationDate プロパティを使用して API のアップグレードや機能変更による問題を避けることができます。

ヒント

 必須

アクションリンクテンプレートに定義できます。

 33.0
excludedUserId String アクションの実行から除外する単一ユーザの ID。excludedUserId を指定した場合、userId を指定できません。 省略可能

[ユーザ表示設定] および [カスタムユーザ(別名)] 項目を使用してアクションリンクテンプレートに定義できます。

 33.0
groupDefault Boolean このアクションがアクションリンクグループのデフォルトアクションリンクである場合は true、それ以外の場合は false。各アクションリンクグループに含めることができるデフォルトアクションリンクは 1 つだけです。Salesforce UI では、デフォルトアクションリンクには区別しやすいスタイルが適用されます。 省略可能

アクションリンクテンプレートに定義できます。

 33.0
headers Request Header Input[] Api および ApiAsync アクションリンク種別の要求ヘッダー。

「認証」を参照してください。

 省略可能

アクションリンクテンプレートに定義できます。

 33.0
labelKey String ユーザインターフェースに表示される表示ラベルのセットのキー。セットには、NewStatus、PendingStatus、SuccessStatus、FailedStatus の状態の表示ラベルが含まれます。たとえば、Approve キーを使用する場合、[承認]、[待機中]、[承認済み]、[失敗] の表示ラベルが含まれます。

キーおよび表示ラベルの完全なリストについては、「アクションリンクの表示ラベル」を参照してください。

アクションリンクに適した定義済み表示ラベルがない場合は、カスタム表示ラベルを使用します。カスタム表示ラベルを使用するには、アクションリンクテンプレートを作成します。「アクションリンクテンプレートの作成」を参照してください。

 必須

アクションリンクテンプレートに定義できます。

 33.0
method String 次のいずれかの HTTP メソッド。
  • HttpDelete — 成功した場合は HTTP 204 を返します。レスポンスボディまたは出力クラスは空です。
  • HttpGet — 成功した場合は HTTP 200 を返します。
  • HttpHead — 成功した場合は HTTP 200 を返します。レスポンスボディまたは出力クラスは空です。
  • HttpPatch — 成功した場合は HTTP 200 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。
  • HttpPost — 成功した場合は HTTP 201 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。例外は、成功時に HTTP 200 を返すバッチ投稿リソースおよびメソッドです。
  • HttpPut — 成功した場合は HTTP 200 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。
 必須

アクションリンクテンプレートに定義できます。

 33.0
requestBody String Api および ApiAsync アクションリンク種別のリクエストボディ。

requestBody 値の疑問符文字をエスケープします。

メモ

 省略可能

アクションリンクテンプレートに定義できます。

 33.0
requires​Confirmation Boolean ユーザにアクションを確認するように要求する場合は true、それ以外の場合は false。 必須

アクションリンクテンプレートに定義できます。

 33.0
userId String アクションを実行できるユーザの ID。指定しない場合や null の場合、すべてのユーザがアクションを実行できます。userId を指定した場合、excludedUserId を指定できません。 省略可能

[ユーザ表示設定] および [カスタムユーザ(別名)] 項目を使用してアクションリンクテンプレートに定義できます。

 33.0