機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. コラボレーション処理
  4. 処理属性

コラボレーション処理のすべての属性を取得

get

/crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • CollabActionAttrVOAltKeyアクションの代替キーを使用して、コラボレーション・アクション属性を検索します。
      ファインダ変数
      • AttribName; string;コラボレーション処理属性の名前。
      • CollabActionId; integer;コラボレーション処理の一意の識別子。
    • PrimaryKey主キーで属性を検索します。
      ファインダ変数
      • AttribId; integer;コラボレーション処理属性の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AttribId; integer; アクション属性の一意の識別子。
    • AttribName; string;コラボレーション処理に関連付けられたビジネス・オブジェクト属性名。
    • ChannelId; integer; アクション属性に関連付けられたチャネル。
    • CollabActionId; integer; 属性に関連付けられたコラボレーション処理の一意の識別子。
    • ContextAttribFlag; boolean;コラボレーション・ネットワークおよびCX Salesとの間で受け渡すためのコンテキスト属性として、アクション属性が使用されるかどうかを示します。
    • ControlTypeCd; string; リストやテキスト・ボックスなどのコラボレーション・ネットワークに属性を表示するために使用されるUIコントロール。
    • CreatedBy; string; アクション属性を作成したユーザー。
    • CreationDate; string;アクション属性が作成された日付。
    • DataSource; string; type listの属性の値リストを取得するAPI。
    • DataSourceLabelAttrib; string; action属性の表示値として使用されるAPI属性。 これは、管理タイプがリストである処理属性に適用されます。
    • DataSourceValueAttrib; string;選択したアクション属性値の保存に使用するAPI属性。 これは、管理タイプがリストである処理属性に適用されます。
    • DataTypeCd; string;日時や数値などのコラボレーション処理属性のデータ型。
    • DeepLink; string; アクション属性に関連付けられたオブジェクトにリンクするディープ・リンクURLの形式。
    • DefaultValue; string; action属性のデフォルト値です。
    • DisplayName; string;コラボレーション・ネットワークに属性を表示したときに表示される処理属性のラベル。
    • DisplaySequence; integer;アクション属性の表示順序。
    • LastUpdateDate; string; アクション属性が最後に更新された日付。
    • LastUpdateLogin; string; アクション属性を最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; アクション属性を最後に更新したユーザー。
    • RequestAttribFlag; boolean。アクション属性がリクエスト・ペイロードの一部であるかどうかを示します。
    • ResponseAttribFlag; boolean。アクション属性がレスポンス・ペイロードの一部であるかどうかを示します。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : collaborationActions-actionAttributes
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : collaborationActions-actionAttributes-item-response
タイプ: object
ソースを表示
  • タイトル: Attribute ID
    読取り専用: true
    処理属性の一意の識別子。
  • タイトル: Attribute Name
    最大長: 64
    コラボレーション処理に関連付けられたビジネス・オブジェクト属性名です。
  • タイトル: Channel ID
    処理属性に関連付けられたチャネル。
  • タイトル: Action ID
    属性に関連付けられたコラボレーション処理の一意の識別子。
  • タイトル: Business Object Identifier
    最大長: 1
    デフォルト値: false
    コラボレーション・ネットワークおよびCX Salesとの間で受け渡すためのコンテキスト属性として処理属性が使用されるかどうかを示します。
  • タイトル: User Interface Component
    最大長: 30
    リストやテキスト・ボックスなどのコラボレーション・ネットワークに属性を表示するために使用されるUIコントロール。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    処理属性を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    処理属性が作成された日付。
  • タイトル: End Point
    最大長: 4000
    タイプの属性の値リストを取得するAPI。
  • タイトル: Option Label
    最大長: 64
    処理属性の表示値として使用されるAPI属性。 これは、管理タイプがリストである処理属性に適用されます。
  • タイトル: Option Value
    最大長: 64
    選択した処理属性値の保存に使用するAPI属性。 これは、管理タイプがリストである処理属性に適用されます。
  • タイトル: Data Type
    最大長: 30
    日時や数値など、コラボレーション処理属性のデータ型です。
  • タイトル: Default Value
    最大長: 4000
    処理属性のデフォルト値。
  • タイトル: Display Name
    最大長: 64
    コラボレーション・ネットワークで属性を表示したときに表示される処理属性のラベル。
  • タイトル: Display Sequence
    処理属性の表示順序。
  • タイトル: Last Updated Date
    読取り専用: true
    処理属性が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    処理属性を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    アクション属性を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Included in Request
    最大長: 1
    デフォルト値: false
    アクション属性がリクエスト・ペイロードの一部であるかどうかを示します。
  • タイトル: Included in Response
    最大長: 1
    デフォルト値: false
    アクション属性がレスポンス・ペイロードの一部であるかどうかを示します。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "items": [
        {
            "AttribId": 300100547011743,
            "AttribName": "DueDate",
            "CollabActionId": 300100547032351,
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2021-09-30T03:28:38.072+00:00",
            "DefaultValue": null,
            "LastUpdateDate": "2021-09-30T03:28:38.076+00:00",
            "LastUpdateLogin": "-1",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "RequestAttribFlag": true,
            "ResponseAttribFlag": false,
            "DisplaySequence": 2,
            "DataSource": null,
            "ControlTypeCd": "text",
            "ContextAttribFlag": false,
            "DisplayName": "Due Date",
            "DataTypeCd": "DATE",
            "DataSourceLabelAttrib": null,
            "DataSourceValueAttrib": null,
            "ChannelId": null,
            "DeepLink": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task/child/actionAttributes/300100547011743",
                    "name": "actionAttributes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task/child/actionAttributes/300100547011743",
                    "name": "actionAttributes",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task",
                    "name": "collaborationActions",
                    "kind": "item"
                }
            ]
        },
  .....
    ],
    "count": 5,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task/child/actionAttributes",
            "name": "actionAttributes",
            "kind": "collection"
        }
    ]
}
「トップに戻る」