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

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

get

/crmRestApi/resources/11.13.18.05/collaborations

リクエスト

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

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

    • GetCollaborationsForObjectFinderコレクションの検索に使用される事前定義されたファインダ。
      ファインダ変数
      • ObjectId; string;コラボレーションが関連付けられているレコードの一意の識別子。
      • ObjectName;文字列;コラボレーション・レコードに関連付けられているオブジェクト・タイプの残りのリソース名(商談など)。
      • 検証、ブール。コラボレーションweb URLが外部コラボレーション・ツールでまだ有効かどうかを検証するかどうかを決定します。 値はtrueおよびfalseです。
    • PrimaryKey主キーとのコラボレーションを検索します。
      ファインダ変数
      • CollabId; string;コラボレーションの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CollabId; string;コラボレーションの一意の識別子。
    • CreatedBy; string;コラボレーションを作成したユーザー。
    • CreationDate; string;コラボレーションが作成された日付。
    • 説明;文字列;コラボレーション・ツールに表示されるコラボレーションの説明。たとえば、Microsoft Teamsに示すチームの説明など。
    • LastUpdateDate; string;コラボレーションが最後に更新された日付。
    • LastUpdateLogin; string;コラボレーションを最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string;コラボレーションを最後に更新したユーザー。
    • 名前;文字列;コラボレーション・ツールに表示されるコラボレーションの名前。たとえば、Microsoft Teamsに示すチーム名などです。
    • ObjectId; string; 商談IDなど、コラボレーションが関連付けられているレコードの一意の識別子。
    • ObjectName; string;コラボレーションが関連付けられているレコードのオブジェクト・タイプの残りのリソース名(商談など)。
    • Weburl; string;コラボレーション・ツールのコラボレーションの外部URL。たとえば、Microsoft TeamsのTeamへのURL。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : コラボレーション
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : collaborations-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 64
    コラボレーションの一意の識別子。
  • 読取り専用: true
    最大長: 64
    コラボレーションを作成したユーザー。
  • 読取り専用: true
    コラボレーションが作成された日付。
  • 最大長: 1024
    コラボレーション・ツールに表示されるコラボレーションの説明。たとえば、Microsoft Teamsに示されているチームの説明などです。
  • 読取り専用: true
    コラボレーションが最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    コラボレーションを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    コラボレーションを最後に更新したユーザーのログイン詳細。
  • Links
  • 最大長: 128
    コラボレーション・ツールに表示されるコラボレーションの名前。たとえば、Microsoft Teamsに示されているチーム名などです。
  • 最大長: 64
    商談IDなど、コラボレーションが関連付けられているレコードの一意の識別子。
  • 最大長: 128
    商談など、コラボレーションが関連付けられているレコードのオブジェクト・タイプの残りのリソース名。
  • 最大長: 80
    リソース・チーム・オブジェクトとコラボレーションが関連付けられているオブジェクト・タイプ間の関係の名前。 これは、オブジェクト・タイプがカスタム・オブジェクトの場合に使用されます。
  • 読取り専用: true
    最大長: 512
    コラボレーション・ツールのコラボレーションへの外部URL。たとえば、Microsoft TeamsのTeamへのURLです。
トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行して、すべてのコラボレーションを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "items": [
        {
            "CollabId": "300100565031495",
            "CreatedBy": "MHoope",
            "CreationDate": "2022-11-14T10:52:27.004+00:00",
            "LastUpdateDate": "2022-11-14T10:52:27.005+00:00",
            "LastUpdateLogin": null,
            "LastUpdatedBy": "MHoope",
            "Weburl": "https://teams.microsoft.com/l/team/19%3a2kyClEznOdMa9cPBTQu2D-aKua5zl9-rdx4pYrCDkHU1%40thread.tacv2/conversations?groupId=75292f03-d7af-4b20-a4bc-5ca29351c7fb&tenantId=33b71f2d-7f52-4370-bd2c-08efb530b1c3",
            "ObjectId": "300100565031470",
            "ObjectName": "accounts",
            "Name": "Accounts - AccountTestingDes",
            "Description": "This team is specifically for the AccountTestingDes account: abcd",
            "TeamRelationshipName": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/300100565031495",
                    "name": "collaborations",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/300100565031495",
                    "name": "collaborations",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations",
            "name": "collaborations",
            "kind": "collection"
        }
    ]
}
「トップに戻る」