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

処理の更新

patch

/crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}

リクエスト

パス・パラメータ

ActivityId(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=
TemplateId(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=
UserActionId(required): integer(int64)

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

ActionIntent: 文字列(バイト)

タイトル: Action Intent

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

タイトル: Active

最大長: 1

アクションがアクティブか非アクティブかを示すブール値。
ApplicationRoles: string

タイトル: Application Roles

最大長: 1000

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

タイトル: Filter Condition

最大長: 1000

このアクションの修飾に使用するGroovyスクリプト。
ConfirmationMessage: string

タイトル: Confirmation Message

最大長: 1024

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

タイトル: Content Type

最大長: 50

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

タイトル: Contextual

最大長: 1

スマート処理がコンテキスト処理であるかどうかを示します。
DataPrivilege: string

タイトル: Data Security Privilege

最大長: 250

権限名、オブジェクト名およびオブジェクト・キーを含むJSON文字列。
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

この処理が内部かどうかを示すブール型。
MassActionFlag: boolean

タイトル: Mass Action

最大長: 1

この処理を一括処理できるかどうかを示すブール・タイプです。
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の起動時に更新される属性。
UserActionNavigation: array Smart Action User Interface Definitions

タイトル: Smart Action User Interface Definitions

アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。
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内の変数のメタデータをバインドします。
UserPrivilege: string

タイトル: User Security Privilege

最大長: 2000

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

{
    "type":"object",
    "properties":{
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":false
        },
        "IncludedIn":{
            "title":"Included In",
            "maxLength":150,
            "type":"string",
            "description":"The view object this action is part of. Could contain more than one comma-separated value.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true
        },
        "ContextualFlag":{
            "title":"Contextual",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the smart action is contextual.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionNavigation-item-patch-request"
            }
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":1024,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionRequestPayload-item-patch-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":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
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        },
        "Condition":{
            "title":"Filter Condition",
            "maxLength":1000,
            "type":"string",
            "description":"Groovy script used to qualify this action.",
            "nullable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionURLBinding-item-patch-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":150,
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true
        },
        "InternalFlag":{
            "title":"Restricted",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action is internal.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true
        },
        "UserPrivilege":{
            "title":"User Security Privilege",
            "maxLength":2000,
            "type":"string",
            "description":"The user security privilege.",
            "nullable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is active or inactive.",
            "nullable":true
        },
        "DataPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":250,
            "type":"string",
            "description":"JSON string containing the Privilege name, the object name, and the object key.",
            "nullable":true
        },
        "ApplicationRoles":{
            "title":"Application Roles",
            "maxLength":1000,
            "type":"string",
            "description":"The application roles associated with the smart action.",
            "nullable":true
        }
    }
}

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

タイプ: array

タイトル: Smart Action User Interface Definitions

アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。

ソースを表示

Array of: object schema

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionNavigation-item-patch-request"
    }
}

ネストされたスキーマ : スマート・アクションのRESTペイロード定義

タイプ: array

タイトル: Smart Action REST Payload Definitions

リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。

ソースを表示

Array of: object activityTemplates-Activity-smartActions-UserActionRequestPayload-item-patch-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionRequestPayload-item-patch-request"
    }
}

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

タイプ: array

タイトル: Smart Action User Interface Definitions

URL内の変数のメタデータをバインドします。

ソースを表示

Array of: object activityTemplates-Activity-smartActions-UserActionURLBinding-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionURLBinding-item-patch-request"
    }
}

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

タイプ: object

ソースを表示

SystemActionFlag: boolean

タイトル: System Action

最大長: 1

デフォルト値: false

処理がシード済かカスタムかを示すブール値。
UserActionNavAppUsage: string

タイトル: Application Usage

最大長: 50

アプリケーションの使用状況。
UserActionNavBody: string

タイトル: Navigation Metadata

最大長: 1000

特定の用途に必要なナビゲーションのMetadata。
UserActionNavType: string

タイトル: Navigation Type

最大長: 100

特定の用途に対して複数のナビゲーション・フローを持つようにプロビジョニングします。

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application usage.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : activityTemplates-Activity-smartActions-UserActionRequestPayload-item-patch-request

タイプ: object

ソースを表示

Binding: string

タイトル: Payload Value Binding Type

最大長: 64

値のバインディング・タイプを示します。
MandatoryFlag: boolean

タイトル: Mandatory

最大長: 1

ペイロードが必須かどうかを示すブール値。
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

キー値ペアの値が単一の値でない場合は、これが設定されます。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":250,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : activityTemplates-Activity-smartActions-UserActionURLBinding-item-patch-request

タイプ: object

ソースを表示

Binding: string

タイトル: URL Binding Type

最大長: 64

これは、URLバインディング・ランタイムを処理するためのヒントです。
SystemActionFlag: boolean

タイトル: System Action

最大長: 1

デフォルト値: false

ブール・インジケータ。
URLBindingName: string

タイトル: URL Binding Parameter Name

最大長: 50

ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアのキーです。
Value: string

タイトル: URL Binding Parameter Value

最大長: 80

ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアの値です。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":80,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":50,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

ActionIntent: 文字列(バイト)

タイトル: Action Intent

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

タイトル: Active

最大長: 1

アクションがアクティブか非アクティブかを示すブール値。
ApplicationRoles: string

タイトル: Application Roles

最大長: 1000

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

タイトル: Filter Condition

最大長: 1000

このアクションの修飾に使用するGroovyスクリプト。
ConfirmationMessage: string

タイトル: Confirmation Message

最大長: 1024

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

タイトル: Content Type

最大長: 50

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

タイトル: Contextual

最大長: 1

スマート処理がコンテキスト処理であるかどうかを示します。
DataPrivilege: string

タイトル: Data Security Privilege

最大長: 250

権限名、オブジェクト名およびオブジェクト・キーを含むJSON文字列。
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

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

タイトル: Smart Action User Interface Definitions

アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。
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内の変数のメタデータをバインドします。
UserPrivilege: string

タイトル: User Security Privilege

最大長: 2000

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

{
    "type":"object",
    "properties":{
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "IncludedIn":{
            "title":"Included In",
            "maxLength":150,
            "type":"string",
            "description":"The view object this action is part of. Could contain more than one comma-separated value.",
            "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 if the smart action is contextual.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionNavigation-item-response"
            }
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"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":"Boolean type indicating if 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":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"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 list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "Condition":{
            "title":"Filter Condition",
            "maxLength":1000,
            "type":"string",
            "description":"Groovy script used to qualify this action.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this 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":"Boolean type indicating if this action is internal.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "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":"Boolean value indicating if the action is active or inactive.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":250,
            "type":"string",
            "description":"JSON string containing the Privilege name, the object name, and the object key.",
            "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

タイトル: Smart Action User Interface Definitions

アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。

ソースを表示

Array of: object activityTemplates-Activity-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionNavigation-item-response"
    }
}

ネストされたスキーマ : スマート・アクションのRESTペイロード定義

タイプ: array

タイトル: Smart Action REST Payload Definitions

リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。

ソースを表示

Array of: object activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response"
    }
}

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

タイプ: array

タイトル: Smart Action User Interface Definitions

URL内の変数のメタデータをバインドします。

ソースを表示

Array of: object activityTemplates-Activity-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-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."
        }
    }
}

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

タイプ: object

ソースを表示

links: array Links

タイトル: Links

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

タイトル: System Action

最大長: 1

デフォルト値: false

処理がシード済かカスタムかを示すブール値。
UserActionNavAppUsage: string

タイトル: Application Usage

最大長: 50

アプリケーションの使用状況。
UserActionNavBody: string

タイトル: Navigation Metadata

最大長: 1000

特定の用途に必要なナビゲーションのMetadata。
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":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application usage.",
            "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"
    }
}

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

キー値ペアの値が単一の値でない場合は、これが設定されます。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":250,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "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 path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "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"
    }
}

ネストされたスキーマ : activityTemplates-Activity-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エンドポイントの場合、これはキー値ペアの値です。

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":80,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "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":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":50,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key 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/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionNavigation

パラメータ:

ActivityId: $request.path.ActivityId
TemplateId: $request.path.TemplateId
UserActionId: $request.path.UserActionId

アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。

UserActionRequestPayload

操作: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionRequestPayload

パラメータ:

ActivityId: $request.path.ActivityId
TemplateId: $request.path.TemplateId
UserActionId: $request.path.UserActionId

リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。

UserActionURLBinding

操作: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/child/UserActionURLBinding

パラメータ:

ActivityId: $request.path.ActivityId
TemplateId: $request.path.TemplateId
UserActionId: $request.path.UserActionId

アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。

executeAction

操作: /crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity/{ActivityId}/child/smartActions/{UserActionId}/action/executeAction

パラメータ:

ActivityId: $request.path.ActivityId
TemplateId: $request.path.TemplateId
UserActionId: $request.path.UserActionId

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

「トップに戻る」