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

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

get

/crmRestApi/resources/11.13.18.05/collaborationActions

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • CollabActionHierarchyFinderアクション階層内の指定されたアクションの下にあるすべての子アクションを検索します。
      ファインダ変数
      • BindCollabActionNumber; string;コラボレーション・アクションの公開一意識別子。
    • CollabActionNumberFinderコラボレーション処理番号でコラボレーション処理を検索します。
      ファインダ変数
      • CollabActionNumber; string;コラボレーション・アクションの代替の一意の識別子。
    • CollabActionVOAltKey代替キー処理番号を使用してコラボレーション処理を検索します。
      ファインダ変数
      • CollabActionNumber; string;コラボレーション・アクションの代替の一意の識別子。
    • CollabRootActionSearchTermFinder検索語に一致する最上位レベルのコラボレーション処理を検索します。
      ファインダ変数
      • BindSearchTerm; string;コラボレーション処理を検索する検索語。
    • PrimaryKey主キーでコラボレーション処理を検索します。
      ファインダ変数
      • CollabActionId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CatalogCd; string; ビジネス・オブジェクトのエンドポイントを生成するために使用されるRESTカタログ。
    • ChannelId; integer; コラボレーション・アクションに関連付けられたサービス・チャネルの一意の識別子。
    • CollabActionCd; string; コラボレーション・アクションを識別する一意のコード。
    • CollabActionId; integer;コラボレーション処理の一意の識別子。
    • CollabActionMethod; string; GETやPOSTなどのコラボレーション・アクションによって起動されるREST APIアクション。
    • CollabActionName; string;コラボレーション・アクションの表示名。
    • CollabActionNumber; string;コラボレーション・アクションの代替の一意の識別子。
    • CollabActionTypeCd; string; APIのコールやダイアログの表示など、コラボレーション・アクションの実行時の動作を指定します。
    • ControlTypeCd; string; コラボレーション・ネットワークでアクションを表示するために使用されるUIコントロール。
    • CreatedBy; string;コラボレーション・アクションを作成したユーザー。
    • CreationDate; string;コラボレーション処理が作成された日付。
    • 説明;文字列;コラボレーション・アクションの説明。
    • DisplaySequence; integer;コラボレーション処理の表示順序。 これは主に、コラボレーション・ネットワークUIに表示される子処理に適用されます。
    • LastUpdateDate; string; コラボレーション・アクションが最後に更新された日付。
    • LastUpdateLogin; string;コラボレーション・アクションを最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; コラボレーション処理を最後に更新したユーザー。
    • ObjectName;文字列。サービス・リクエストや商談など、コラボレーション処理に関連付けられたビジネス・オブジェクト。
    • ParentActionId; integer;コラボレーション処理に対する親処理の一意の識別子。
    • RequestContentType; string; REST APIリクエスト・ペイロードのコンテンツ・タイプ。
    • RequestEndPoint; string;コラボレーション・アクションのリクエストAPIのエンドポイント。
    • ResponseContentType; string; REST APIレスポンスのコンテンツ・タイプ。
    • ResponseEntityTypeCd; string;処理属性やペイロードなどのコラボレーション処理のレスポンス・タイプ。
    • ResponseMsgTypeCd; string; プライベートやパブリックなど、コラボレーション・ネットワークでのアクション・レスポンスの表示を示します。
    • StatusCd; string; DRAFTやACTIVEなどのコラボレーション処理のステータス。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : collaborationActions
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : collaborationActions-item-response
タイプ: object
ソースを表示
  • Action Attributes
    タイトル: Action Attributes
    属性リソースを使用すると、コラボレーション・ネットワークで使用される属性を表示、作成、更新および削除できます。 これらの属性は、処理の実行時にコラボレーション・ネットワークから送受信されます。
  • タイトル: REST Catalog
    最大長: 30
    デフォルト値: crmRestApi
    ビジネス・オブジェクトのエンドポイントの生成に使用されるRESTカタログ。
  • タイトル: Channel ID
    コラボレーション処理に関連付けられたサービス・チャネルの一意の識別子。
  • タイトル: Action Code
    最大長: 30
    コラボレーション処理を識別する一意のコード。
  • タイトル: Action ID
    読取り専用: true
    コラボレーション処理の一意の識別子。
  • タイトル: Action Method
    最大長: 64
    GETやPOSTなど、コラボレーション処理によって呼び出されるREST API処理。
  • タイトル: Action Name
    最大長: 64
    コラボレーション処理の表示名。
  • タイトル: Action Number
    最大長: 30
    コラボレーション処理の代替一意識別子。
  • タイトル: Action Type
    最大長: 30
    APIのコールやダイアログの表示など、コラボレーション・アクションの実行時の動作を指定します。
  • タイトル: User Interface Component
    最大長: 30
    コラボレーション・ネットワークで処理を表示するために使用されるUIコントロール。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    コラボレーション処理を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    コラボレーション処理が作成された日付。
  • タイトル: Description
    最大長: 1000
    コラボレーション処理の説明。
  • タイトル: Display Sequence
    コラボレーション処理の表示順序。 これは主に、コラボレーション・ネットワークUIに表示される子処理に適用されます。
  • タイトル: Last Updated Date
    読取り専用: true
    コラボレーション処理が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    コラボレーション処理を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    コラボレーション処理を最後に更新したユーザーのログイン詳細。
  • Links
  • タイトル: Business Object
    最大長: 64
    サービス・リクエストや商談など、コラボレーション処理に関連付けられたビジネス・オブジェクト。
  • タイトル: Parent Action ID
    コラボレーション処理の親処理の一意識別子です。
  • タイトル: Request Content Type
    最大長: 64
    REST APIリクエスト・ペイロードのコンテンツ・タイプ。
  • タイトル: Request End Point
    最大長: 4000
    コラボレーション・アクションのリクエストAPIのエンドポイント。
  • タイトル: Request Payload
    リクエストAPIのリクエスト・ペイロード。
  • タイトル: Response Content Type
    最大長: 64
    REST APIレスポンスのコンテンツ・タイプ。
  • タイトル: Response Type
    最大長: 30
    処理属性やペイロードなど、コラボレーション処理のレスポンス・タイプ。
  • タイトル: Response Visibility
    最大長: 30
    プライベートまたはパブリックなど、コラボレーション・ネットワークでの処理レスポンスの表示を示します。
  • タイトル: Response Payload
    コラボレーション処理のレスポンス。
  • タイトル: Status
    最大長: 30
    デフォルト値: DRAFT
    DRAFTやACTIVEなどのコラボレーション処理のステータス。
ネストされたスキーマ : 処理属性
タイプ: array
タイトル: Action Attributes
属性リソースを使用すると、コラボレーション・ネットワークで使用される属性を表示、作成、更新および削除できます。 これらの属性は、処理の実行時にコラボレーション・ネットワークから送受信されます。
ソースを表示
ネストされたスキーマ : 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 GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collaborationActions

レスポンス本文の例

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

{
    "items": [
        {
            "CollabActionId": 100100144185911,
            "CollabActionName": "My Accounts",
            "CollabActionMethod": "GET",
            "RequestEndPoint": "/crmRestApi/resources/latest/accounts?finder=MyAccounts&onlyData=true&limit=5",
            "RequestContentType": "application/vnd.oracle.adf.resourceitem+json",
            "ResponseContentType": null,
            "CreationDate": "2020-03-16T17:26:41.877+00:00",
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "LastUpdateDate": "2021-06-10T09:43:07.769+00:00",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "LastUpdateLogin": "-1",
            "ResponseEntityTypeCd": "OBJECT",
            "ResponseMsgTypeCd": "PRIVATE",
            "CollabActionCd": "/ec-my-accounts",
            "CollabActionTypeCd": "INVOKE_API",
            "ObjectName": "Account",
            "ParentActionId": null,
            "ControlTypeCd": null,
            "DisplaySequence": 1,
            "ChannelId": null,
            "CollabActionNumber": "/ec-my-accounts",
            "Description": null,
            "StatusCd": "ACTIVE",
            "CatalogCd": "crmRestApi",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts",
                    "name": "collaborationActions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts",
                    "name": "collaborationActions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts/child/actionAttributes",
                    "name": "actionAttributes",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts/enclosure/RequestPayload",
                    "name": "RequestPayload",
                    "kind": "other"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/%2Fec-my-accounts/enclosure/ResponsePayload",
                    "name": "ResponsePayload",
                    "kind": "other"
                }
            ]
        },
  .....
    ],
    "count": 11,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions",
            "name": "collaborationActions",
            "kind": "collection"
        }
    ]
}
「トップに戻る」