機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アカウント
  4. スマートなアクション

すべてのスマート・アクションの取得

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions

リクエスト

パス・パラメータ
  • アカウント・パーティの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 参照IDを使用してスマート処理参照を検索します。
      ファインダ変数:
      • UserActionId; integer; ファインダ・サービスにパラメータとして渡されるスマート・アクション参照ID。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ConfirmationMessage; string; スマート・アクションの実行前に表示される確認メッセージ。 肯定的なレスポンスにより、スマート・アクションを実行できます。
    • ContentType; string;スマート・アクションREST操作のメディア・タイプ。
    • DisplayLabel; string;スマート・アクションの表示名。
    • Entity; string;スマート処理が関連付けられているプライマリ・オブジェクト。 たとえば、スマート処理でリードのポイントが作成された場合、リードはプライマリ・オブジェクトです。
    • Href; string;スマート・アクションRESTリソースの相対パス。 パスにはパス・パラメータを含めることができます。
    • IncludedInApplication; string; スマート・アクションが関連付けられているクライアント・アプリケーション。
    • メソッド、文字列。スマート・アクションREST操作のHTTPメソッド。
    • ObjectFunctionName; string;スマート・アクションに関連付けられたオブジェクト関数。
    • PageType; string; このアクションを使用できるページのリスト。
    • SmartSuggestFlag; boolean;アクションに対してスマート提案が有効になっているかどうかを示します。
    • SystemActionFlag; boolean。アクションがシードされているかカスタムであるかを示します。
    • UpdateOfAttributes; string;データ入力フォームの使用によって更新されるオブジェクト属性。 使用するフォームを決定するためにアプリケーションで使用されます。 値はオブジェクト・スコープであり、オブジェクトのすべてのスマート・アクションで一意である必要があります。
    • UserActionId; integer; スマート・アクション定義の一意のシステム割当て識別子。
    • UserActionName; string; システムに割り当てられた一意のスマート・アクション名。
    • UserActionRank; integer;クライアント・アプリケーションに表示されるスマート・アクションのリストにおけるスマート・アクションの相対位置を定義する数値。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accounts-smartActions
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : accounts-smartActions-item-response
タイプ: object
ソースを表示
  • タイトル: Action Intent
    アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。
  • タイトル: Confirmation Message
    最大長: 1024
    スマート・アクションの実行前に表示される確認メッセージ。 肯定的なレスポンスにより、スマート・アクションを実行できます。
  • タイトル: Content Type
    最大長: 50
    スマート・アクションREST操作のメディア・タイプ。
  • タイトル: Action Name
    最大長: 256
    スマート・アクションの表示名。
  • タイトル: Parent Entity
    最大長: 150
    スマート処理が関連付けられているプライマリ・オブジェクト。 たとえば、スマート処理でリードのポイントが作成された場合、リードはプライマリ・オブジェクトです。
  • タイトル: REST Endpoint
    最大長: 150
    スマート・アクションRESTリソースの相対パス。 パスにはパス・パラメータを含めることができます。
  • タイトル: Included in Application
    最大長: 512
    スマート・アクションが関連付けられているクライアント・アプリケーション。
  • Links
  • タイトル: HTTP Method
    最大長: 15
    スマート・アクションREST操作のHTTPメソッド。
  • タイトル: Object Function
    最大長: 64
    スマート・アクションに関連付けられたオブジェクト関数。
  • タイトル: Page Type
    最大長: 256
    このアクションを使用できるページのリスト。
  • タイトル: Smart Suggest
    最大長: 1
    処理に対してスマート提案が使用可能かどうかを示します。
  • タイトル: System Action
    最大長: 1
    処理がシード済かカスタムかを示します。
  • タイトル: Attributes to Update
    最大長: 512
    データ入力フォームを使用した結果として更新されるオブジェクト属性。 使用するフォームを決定するためにアプリケーションで使用されます。 値はオブジェクト・スコープであり、オブジェクトのすべてのスマート・アクションで一意である必要があります。
  • タイトル: User Action ID
    スマート処理定義の一意のシステム割当識別子。
  • タイトル: Action Name
    最大長: 256
    一意のシステム割当スマート処理名。
  • Smart Action User Interface Definitions
    タイトル: Smart Action User Interface Definitions
    ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。 各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
  • タイトル: Priority
    クライアント・アプリケーションに表示されるスマート・アクションのリストでのスマート・アクションの相対的な位置を定義する番号。
  • Smart Action REST Payload Definitions
    タイトル: Smart Action REST Payload Definitions
    ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
  • Smart Action REST Path Parameter Definitions
    タイトル: Smart Action REST Path Parameter Definitions
    パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ: array
タイトル: Smart Action User Interface Definitions
ユーザー・インタフェース定義リソースは、スマート処理に関連付けられたユーザー・インタフェースを表示するために使用されます。 各ユーザー・インタフェースをクライアント・アプリケーションにマッピングできます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ: array
タイトル: Smart Action REST Payload Definitions
ペイロード定義リソースは、スマート・アクションのRESTリクエスト・ペイロードの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : スマート処理RESTパス・パラメータ定義
タイプ: array
タイトル: Smart Action REST Path Parameter Definitions
パス・パラメータ定義リソースは、スマート・アクションのRESTリクエスト・パス・パラメータの名前と値のペア定義を表示するために使用されます。 レスポンス・ペイロードで返されたスマート・アクション・アイテムまたはコレクション・リンクは、RESTリクエストが処理された時点で有効です。 親オブジェクト・コンテキストを変更すると、以前に有効なスマート・アクションが無効になる可能性があります。
ソースを表示
ネストされたスキーマ : accounts-smartActions-UserActionNavigation-item-response
タイプ: object
ソースを表示
  • Links
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。
  • タイトル: Application Usage
    最大長: 50
    UserActionNavIdで識別されるスマート・アクション・ユーザー・インタフェース・エンドポイント定義に関連付けられたクライアント・アプリケーション。
  • タイトル: Navigation Metadata
    最大長: 1000
    スマート・アクションのユーザー・インタフェース・エンドポイントのメタデータ定義。
  • タイトル: Primary Key
    スマート処理ユーザー・インタフェース定義の一意のシステム割当識別子。
  • タイトル: Navigation Type
    最大長: 100
    起動するユーザー・インタフェースを決定するためにアプリケーションで使用されるテキスト値。
ネストされたスキーマ : accounts-smartActions-UserActionRequestPayload-item-response
タイプ: object
ソースを表示
  • タイトル: Payload Value Binding Type
    最大長: 64
    名前と値のペアの値プロパティの分類。 バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。 値STATICは、割り当てられる値が単純な文字列であることを示します。 NULL値は、値タイプがJSON_ARRAY_STRINGであることを示します。
  • Links
  • タイトル: Mandatory
    最大長: 1
    RESTペイロード本文のパラメータ値が必須かどうかを示します。 Trueの場合、ランタイム検証によって値が確実に定義されます。
  • スマート・アクションRESTペイロード本文パラメータの名前と値のペア定義の一意のシステム割当識別子。
  • タイトル: Request Payload Attribute Name
    最大長: 256
    名前と値のペアの名前プロパティに割り当てられた値。
  • タイトル: Smart Suggest Path
    最大長: 2048
    スマート候補に使用されるパス。
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。
  • タイトル: Request Payload Attribute Value
    最大長: 250
    名前と値のペアの値プロパティに割り当てられた値。
  • タイトル: Payload Value Structure
    最大長: 20
    値JSON_ARRAY_STRINGは、名前と値のペアの値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単一エンティティではなく、データの配列を表すことを示します。 配列文字列は、名前と値のペア、およびバインディングと必須プロパティの定義です。 配列文字列は、[{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]などの特定のパターンに従います。 null値は、値プロパティが、オブジェクト属性名や単純なテキスト文字列などの単純な単一エンティティを表すことを示します。
ネストされたスキーマ : accounts-smartActions-UserActionURLBinding-item-response
タイプ: object
ソースを表示
  • タイトル: URL Binding Type
    最大長: 64
    名前と値のペアの値プロパティの分類。 UserActionURLBindingインスタンスのバインディング値は、RUNTIMEである必要があります。 バインディング値RUNTIMEは、割り当てられる値がオブジェクト属性の実行時値であることを示します。
  • Links
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    スマート処理がシード済かカスタムかを示すシステム割当値。 Trueは、スマート処理がシードされていることを示します。 値は、smartActions.SystemActionFlagから自動的に導出されます。
  • スマート・アクションRESTパス・パラメータの名前と値のペア定義の一意のシステム割当識別子。
  • タイトル: URL Binding Parameter Name
    最大長: 50
    名前と値のペアの名前プロパティに割り当てられた値。
  • タイトル: URL Binding Parameter Value
    最大長: 80
    名前と値のペアの値プロパティに割り当てられた値。
リンク
getActionEvaluationAttributesForResource
パラメータ:
  • PartyNumber: $request.path.PartyNumber
このメソッドを使用すると、アクションを評価するためにリソースからすべての属性を取得できます。
getAttributesForResource
パラメータ:
  • PartyNumber: $request.path.PartyNumber
スマート・アクションの属性を取得します。
getEntities
パラメータ:
  • PartyNumber: $request.path.PartyNumber
スマート・アクションのすべてのエンティティを取得します。
getObjectFunctions
パラメータ:
  • PartyNumber: $request.path.PartyNumber
スマート・アクションに関連付けられたすべてのオブジェクト関数を取得します。
processMassAction
パラメータ:
  • PartyNumber: $request.path.PartyNumber
このメソッドを使用すると、複数のオブジェクト行に対するアクションを処理できます。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行することによって、すべてのスマート・アクションを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "items": [
        {
            "UserActionId": 100100297712745,
            "UserActionName": "SDA-merge-accounts",
            "DisplayLabel": "Merge",
            "IncludedInApplication": "ORACLE-Workspace-APP",
            "UpdateOfAttributes": null,
            "Entity": "accounts",
            "Href": "/crmRestApi/resources/11.13.18.05/resolutionRequests",
            "Method": "POST",
            "ContentType": "application/vnd.oracle.adf.resourceitem+json",
            "ConfirmationMessage": null,
            "UserActionRank": 100,
            "PageType": null,
            "SmartSuggestFlag": false,
            "ObjectFunctionName": null,
            "SystemActionFlag": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/100100297712745",
                    "name": "smartActions",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/100100297712745",
                    "name": "smartActions",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397",
                    "name": "accounts",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/100100297712745/child/UserActionNavigation",
                    "name": "UserActionNavigation",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/100100297712745/child/UserActionRequestPayload",
                    "name": "UserActionRequestPayload",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/100100297712745/child/UserActionURLBinding",
                    "name": "UserActionURLBinding",
                    "kind": "collection"
                }
            ]
        },
        ....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions",
            "name": "smartActions",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/action/getEntities",
            "name": "getEntities",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/action/getAttributesForResource",
            "name": "getAttributesForResource",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/action/getObjectFunctions",
            "name": "getObjectFunctions",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/action/getActionEvaluationAttributesForResource",
            "name": "getActionEvaluationAttributesForResource",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000015957397/child/smartActions/action/processMassAction",
            "name": "processMassAction",
            "kind": "other"
        }
    ]
}
「トップに戻る」