アクションの取得
get
/crmRestApi/resources/11.13.18.05/internalServiceRequests/{SrId}/child/smartActions/{UserActionId}
リクエスト
パス・パラメータ
- SrId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
- UserActionId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : internalServiceRequests-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
処理が属するRESTリソース。 -
Href: string
タイトル:
REST Endpoint
最大長:150
アクションを実行するRESTエンドポイント。 -
IncludedInApplication: string
タイトル:
Included in Application
最大長:512
このアクションを使用できるアプリケーションのリスト。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Method: string
タイトル:
HTTP Method
最大長:15
HREFで使用するHTTPメソッド。 -
ObjectFunctionName: string
タイトル:
Object Function
最大長:64
スマート・アクションに関連付けられたオブジェクト関数。 -
PageType: string
タイトル:
Page Type
最大長:256
このアクションを使用できるページのリスト。 -
SmartSuggestFlag: boolean
タイトル:
Smart Suggest
最大長:1
処理に対してスマート提案が使用可能かどうかを示します。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
アクションがシード済かカスタムかを示すブール型。 -
UpdateOfAttributes: string
タイトル:
Attributes to Update
最大長:512
処理UIの起動時に更新される属性。 -
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
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。 -
UserActionURLBinding: array Smart Action User Interface Definitions
タイトル:
Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ:
array
タイトル:
Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
ソースを表示
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ:
array
タイトル:
Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : internalServiceRequests-smartActions-UserActionRequestPayload-item-response
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
Payload Value Binding Type
最大長:64
値のバインディング・タイプを示します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MandatoryFlag: boolean
タイトル:
Mandatory
最大長:1
ペイロードが必須かどうかを示すブール値。 -
RequestPayloadId: integer (int64)
スマート・アクションのペイロードを一意に識別します。 内部使用。
-
RequestPayloadName: string
タイトル:
Request Payload Attribute Name
最大長:256
ペイロードを形成するキー値ペアのキー。 -
SmartSuggestPath: string
タイトル:
Smart Suggest Path
最大長:2048
スマート候補に使用されるパス。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
ブール値。 -
Value: string
タイトル:
Request Payload Attribute Value
最大長:250
ペイロードを形成するキー値ペアの値。 -
ValueStruct: string
タイトル:
Payload Value Structure
最大長:20
キー値ペアの値が単一の値でない場合は、これが設定されます。
ネストされたスキーマ : internalServiceRequests-smartActions-UserActionURLBinding-item-response
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
URL Binding Type
最大長:64
これは、URLバインディング・ランタイムを処理するためのヒントです。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
ブール・インジケータ。 -
URLBindingId: integer (int64)
スマート・アクションのURLバインドを一意に識別します。 内部使用。
-
URLBindingName: string
タイトル:
URL Binding Parameter Name
最大長:50
ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアのキーです。 -
Value: string
タイトル:
URL Binding Parameter Value
最大長:80
ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアの値です。
リンク
- UserActionNavigation
-
パラメータ:
- SrId:
$request.path.SrId
- UserActionId:
$request.path.UserActionId
アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。 - SrId:
- UserActionRequestPayload
-
パラメータ:
- SrId:
$request.path.SrId
- UserActionId:
$request.path.UserActionId
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。 - SrId:
- UserActionURLBinding
-
パラメータ:
- SrId:
$request.path.SrId
- UserActionId:
$request.path.UserActionId
アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。 - SrId:
- executeAction
-
パラメータ:
- SrId:
$request.path.SrId
- UserActionId:
$request.path.UserActionId
このメソッドを使用すると、RESTベースのアクションを実行できます。 - SrId: