Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

スマートなアクションの取得 - サポートなし

get

/crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}

リクエスト

パス・パラメータ

CaseNumber(required): string

ケースの代替キー識別子。
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のデフォルト・バージョンを選択します。

ルート・スキーマ : cases-smartActions-item-response

タイプ: object

ソースを表示

ActionIntent: 文字列(バイト)

タイトル: Action Intent

アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。
ActiveFlag: boolean

タイトル: Active

最大長: 1

処理がアクティブか非アクティブかを示します。非アクティブなアクションは、どのような状況でもクライアント・アプリケーションには返されません。 Trueは、スマート・アクションがアクティブであることを示します。
ApplicationRoles: string

タイトル: Application Roles

最大長: 1000

スマート処理に関連付けられたアプリケーション・ロール。
Condition: string

タイトル: Filter Condition

最大長: 1000

アクションをクライアント・アプリケーションに戻すことができるかどうかを判断するために実行時に評価されるブール・スクリプト。また、アクションがクライアント・アプリケーションに戻されるかどうかを判断するために、追加の評価も行われます。
ConfirmationMessage: string

タイトル: Confirmation Message

最大長: 1024

実行中のアクションの確認を求めるメッセージ。
ContentType: string

タイトル: Content Type

最大長: 50

RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。
ContextualFlag: boolean

タイトル: Contextual

最大長: 1

コンテキスト・フラグを示します。
DataPrivilege: string

タイトル: Data Security Privilege

最大長: 250

アクションをクライアント・アプリケーションに戻すために、認証されたユーザー・ロールを付与する必要があるデータ・セキュリティ権限。また、アクションがクライアント・アプリケーションに戻されるかどうかを判断するために、追加の評価も行われます。
DisplayLabel: string

タイトル: Action Name

最大長: 256

コンシューマ・フレンドリなアクション名。
Entity: string

タイトル: Parent Entity

最大長: 150

アクションが属するRESTリソース。
Href: string

タイトル: REST Endpoint

最大長: 150

アクションを実行するRESTエンドポイント。
IncludedIn: string

タイトル: Included In

最大長: 150

スマート処理が関連付けられているプライマリ・オブジェクトに対応するビュー・オブジェクト。
IncludedInApplication: string

タイトル: Included in Application

最大長: 512

このアクションを使用できるアプリケーションのリスト。
InternalFlag: boolean

タイトル: Restricted

最大長: 1

処理が内部タイプかどうかを示します。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
MassActionFlag: boolean

タイトル: Mass Action

最大長: 1

処理を一括処理できるかどうかを示します。
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

処理がシード済かカスタムかを示します。
UpdateOfAttributes: string

タイトル: Attributes to Update

最大長: 512

処理UIの起動時に更新される属性。
UserActionId: integer (int64)

タイトル: User Action ID

スマート・アクション定義の一意の識別子。
UserActionName: string

タイトル: Action Name

最大長: 256

属性は、名前を持つ処理を一意に識別します。内部使用。
UserActionNavigation: array User Interface Definitions

タイトル: User Interface Definitions

ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
UserActionRank: integer (int64)

タイトル: Priority

処理の優先度を示す番号。
UserActionRequestPayload: array Payload Definitions

タイトル: Payload Definitions

ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
UserActionURLBinding: array Path Parameter Definitions

タイトル: Path Parameter Definitions

パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
UserPrivilege: string

タイトル: User Security Privilege

最大長: 2000

ユーザー・セキュリティ権限。

{
    "type":"object",
    "properties":{
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The REST resources the Action belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "IncludedIn":{
            "title":"Included In",
            "maxLength":150,
            "type":"string",
            "description":"The View Object corresponding to the primary object the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextualFlag":{
            "title":"Contextual",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates  the contexual flag.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The list of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/cases-smartActions-UserActionNavigation-item-response"
            }
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The consumer friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the Action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":1024,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/cases-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The Page Type.",
            "nullable":true,
            "x-queryable":true
        },
        "Condition":{
            "title":"Filter Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The boolean script evaluated at runtime to determine if the action can be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the smart suggest flag.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Path Parameter Definitions",
            "type":"array",
            "description":"The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/cases-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":150,
            "type":"string",
            "description":"The REST endpoint to perform the Action.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalFlag":{
            "title":"Restricted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action is internal type.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserPrivilege":{
            "title":"User Security Privilege",
            "maxLength":2000,
            "type":"string",
            "description":"The User Security Privilege.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action is active or inactive. Inactive actions are not returned to client applications under any circumstance. 'True' indicates the smart action is active.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The attribute uniquely identifies the action with name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":250,
            "type":"string",
            "description":"The data security privilege that the authenticated user role must be granted, in order for the action to be returned to the client application. Additional evaluations also are carried out to determine if the action will be returned to the client application.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationRoles":{
            "title":"Application Roles",
            "maxLength":1000,
            "type":"string",
            "description":"The application roles associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : ユーザー・インタフェース定義

タイプ: array

タイトル: User Interface Definitions

ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。

ソースを表示

Array of: object cases-smartActions-UserActionNavigation-item-response

{
    "title":"User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/cases-smartActions-UserActionNavigation-item-response"
    }
}

ネストされたスキーマ : ペイロード定義

タイプ: array

タイトル: Payload Definitions

ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。

ソースを表示

Array of: object cases-smartActions-UserActionRequestPayload-item-response

{
    "title":"Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/cases-smartActions-UserActionRequestPayload-item-response"
    }
}

ネストされたスキーマ : パス・パラメータ定義

タイプ: array

タイトル: Path Parameter Definitions

パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。

ソースを表示

Array of: object cases-smartActions-UserActionURLBinding-item-response

{
    "title":"Path Parameter Definitions",
    "type":"array",
    "description":"The path parameters definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/cases-smartActions-UserActionURLBinding-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : cases-smartActions-UserActionNavigation-item-response

タイプ: object

ソースを表示

links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
SystemActionFlag: boolean

タイトル: System Action

最大長: 1

デフォルト値: false

スマート処理がシード済かカスタムかを示します。 Trueは、スマート処理がシードされていることを示します。値は、smartActions.SystemActionFlagから自動的に導出されます。
UserActionNavAppUsage: string

タイトル: Application Usage

最大長: 50

UserActionNavIdで識別されるスマート・アクション・ユーザー・インタフェース・エンドポイント定義に関連付けられたクライアント・アプリケーション。
UserActionNavBody: string

タイトル: Navigation Metadata

最大長: 1000

スマート・アクションのユーザー・インタフェース・エンドポイントのメタデータ定義。
UserActionNavId: integer (int64)

タイトル: Primary Key

スマート処理ユーザー・インタフェース定義の一意の識別子。
UserActionNavType: string

タイトル: Navigation Type

最大長: 100

起動するユーザー・インタフェースを決定するためにアプリケーションで使用されるテキスト値。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : cases-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

最大長: 1

RESTペイロード本文のパラメータ値が必須かどうかを示します。 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値は、値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単純な単一エンティティを表すことを示します。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":250,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The smart suggest path.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : cases-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

名前と値のペアの値プロパティに割り当てられた値。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":80,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":50,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

UserActionNavigation

操作: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation

パラメータ:

CaseNumber: $request.path.CaseNumber
UserActionId: $request.path.UserActionId

UserActionRequestPayload

操作: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload

パラメータ:

CaseNumber: $request.path.CaseNumber
UserActionId: $request.path.UserActionId

UserActionURLBinding

操作: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding

パラメータ:

CaseNumber: $request.path.CaseNumber
UserActionId: $request.path.UserActionId

executeAction

操作: /crmRestApi/resources/11.13.18.05/cases/{CaseNumber}/child/smartActions/{UserActionId}/action/executeAction

パラメータ:

CaseNumber: $request.path.CaseNumber
UserActionId: $request.path.UserActionId

このメソッドを使用すると、RESTベースのアクションを実行できます。

「トップに戻る」