スマートなアクションの取得 - サポートなし
get
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/smartActions/{UserActionId}
リクエスト
パス・パラメータ
- SrNumber(required): string
サービス・リクエストの識別に使用される一意の番号。 サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。 たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。
- UserActionId(required): integer(int64)
スマート・アクション定義の一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : serviceRequests-smartActions-item-response
タイプ:
ソースを表示
object-
ActionIntent: 文字列(バイト)
タイトル:
Action Intentアクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。 -
ConfirmationMessage: string
タイトル:
Confirmation Message最大長:1024スマート・アクションの実行前に表示される確認メッセージ。 肯定的なレスポンスにより、スマート・アクションを実行できます。 -
ContentType: string
タイトル:
Content Type最大長:50スマート・アクションREST操作のメディア・タイプ。 -
DisplayLabel: string
タイトル:
Action Name最大長:256スマート・アクションの表示名。 -
Entity: string
タイトル:
Parent Entity最大長:150スマート処理が関連付けられているプライマリ・オブジェクト。 たとえば、スマート処理でリードのポイントが作成された場合、リードはプライマリ・オブジェクトです。 -
Href: string
タイトル:
REST Endpoint最大長:150スマート・アクションRESTリソースの相対パス。 パスにはパス・パラメータを含めることができます。 -
IncludedInApplication: string
タイトル:
Included in Application最大長:512スマート・アクションが関連付けられているクライアント・アプリケーション。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
Method: string
タイトル:
HTTP Method最大長:15スマート・アクションREST操作のHTTPメソッド。 -
ObjectFunctionName: string
タイトル:
Object Function最大長:64スマート処理用のオブジェクト関数。 -
PageType: string
タイトル:
Page Type最大長:256このアクションを使用できるページのリスト。 -
SmartSuggestFlag: boolean
タイトル:
Smart Suggest最大長:1処理がスマート提示可能かどうかを示します。 -
SystemActionFlag: boolean
タイトル:
System Action最大長:1スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。 -
UpdateOfAttributes: string
タイトル:
Attributes to Update最大長:512データ入力フォームを使用した結果として更新されるオブジェクト属性。 使用するフォームを決定するためにアプリケーションで使用されます。 値はオブジェクト・スコープであり、オブジェクトのすべてのスマート・アクションで一意である必要があります。 -
UserActionId: integer (int64)
タイトル:
User Action IDスマート・アクション定義の一意の識別子。 -
UserActionName: string
タイトル:
Action Name最大長:256スマート・アクション名の一意の識別子。 - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer (int64)
タイトル:
Priorityクライアント・アプリケーションに表示されるスマート・アクションのリストでのスマート・アクションの相対的な位置を定義する番号。 -
UserActionRequestPayload: array Smart Action REST Payload Definitions
タイトル:
Smart Action REST Payload Definitionsペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。 -
UserActionURLBinding: array Smart Action REST Path Parameter Definitions
タイトル:
Smart Action REST Path Parameter Definitionsパス・パラメータ・リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ:
arrayタイトル:
Smart Action REST Payload Definitionsペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : スマート処理RESTパス・パラメータ定義
タイプ:
arrayタイトル:
Smart Action REST Path Parameter Definitionsパス・パラメータ・リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object-
href: string
タイトル:
hyperlink reference関連リソースへのURI。 -
kind: string
タイトル:
kind許可された値:[ "collection", "item", "describe", "other" ]関連リソースの種類。 -
name: string
タイトル:
name関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : serviceRequests-smartActions-UserActionRequestPayload-item-response
タイプ:
ソースを表示
object-
Binding: string
タイトル:
Payload Value Binding Type最大長:64名前と値のペアの値プロパティの分類。 バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。 値STATICは、割り当てられる値が単純な文字列であることを示します。 NULL値は、値タイプがJSON_ARRAY_STRINGであることを示します。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
MandatoryFlag: boolean
タイトル:
Mandatory最大長:1RESTペイロード本文のパラメータ値が必須かどうかを示します。 Trueの場合、ランタイム検証によって値が確実に定義されます。 -
RequestPayloadId: integer (int64)
スマート・アクションRESTペイロード本文パラメータの名前と値のペア定義の一意のシステム割当識別子。
-
RequestPayloadName: string
タイトル:
Request Payload Attribute Name最大長:256名前と値のペアの名前プロパティに割り当てられた値。 -
SmartSuggestPath: string
タイトル:
Smart Suggest Path最大長:2048スマート候補に使用されるパス。 -
SystemActionFlag: boolean
タイトル:
System Action最大長:1デフォルト値:falseスマート処理がシード済かカスタムかを示します。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。 -
Value: string
タイトル:
Request Payload Attribute Value最大長:250名前と値のペアの値プロパティに割り当てられた値。 -
ValueStruct: string
タイトル:
Payload Value Structure最大長:20値JSON_ARRAY_STRINGは、名前と値のペアの値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単一エンティティではなく、データの配列を表すことを示します。 配列文字列は、名前と値のペア、およびバインディングと必須プロパティの定義です。 配列文字列は、[{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]などの特定のパターンに従います。 null値は、値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単純な単一エンティティを表すことを示します。
ネストされたスキーマ : serviceRequests-smartActions-UserActionURLBinding-item-response
タイプ:
ソースを表示
object-
Binding: string
タイトル:
URL Binding Type最大長:64名前と値のペアの値プロパティの分類。 UserActionURLBindingインスタンスのバインディング値は、RUNTIMEである必要があります。 バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
SystemActionFlag: boolean
タイトル:
System Action最大長:1デフォルト値:falseスマート処理がシード済かカスタムかを示します。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。 -
URLBindingId: integer (int64)
スマート・アクションRESTパス・パラメータの名前と値のペア定義の一意の識別子。
-
URLBindingName: string
タイトル:
URL Binding Parameter Name最大長:50名前と値のペアの名前プロパティに割り当てられた値。 -
Value: string
タイトル:
URL Binding Parameter Value最大長:80名前と値のペアの値プロパティに割り当てられた値。
リンク
- UserActionNavigation
-
パラメータ:
- SrNumber:
$request.path.SrNumber - UserActionId:
$request.path.UserActionId
ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。 各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。 - SrNumber:
- UserActionRequestPayload
-
パラメータ:
- SrNumber:
$request.path.SrNumber - UserActionId:
$request.path.UserActionId
ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。 - SrNumber:
- UserActionURLBinding
-
パラメータ:
- SrNumber:
$request.path.SrNumber - UserActionId:
$request.path.UserActionId
パス・パラメータ・リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。 - SrNumber:
- executeAction
-
パラメータ:
- SrNumber:
$request.path.SrNumber - UserActionId:
$request.path.UserActionId
このメソッドを使用すると、RESTベースのアクションを実行できます。 - SrNumber: