機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. コンテスト

すべてのコンテストの取得

get

/crmRestApi/resources/11.13.18.05/contests

リクエスト

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

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

    • PrimaryKey主キーを使用してコンテストを検索します。
      ファインダ変数
      • ContestId; integer;コンテストの一意の識別子
    • RowFinderコンテスト番号を使用してすべてのコンテストを検索します。
      ファインダ変数
      • ContestNumber; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ConflictId; integer;競合ID
    • ContestId; integer; Contest ID
    • ContestName;文字列;コンテスト名
    • ContestNumber; string; Contest Number
    • CreatedBy;文字列;作成者
    • CreationDate;文字列;作成日
    • 説明;文字列;説明
    • EndDate;文字列;終了日
    • KPIAggregation;文字列; KPI計算タイプ
    • KPIDescription;文字列; KPI説明
    • KPIId;整数; KPI ID
    • KPIName;文字列; KPI名
    • KPINumber;文字列; KPI番号
    • LastUpdateDate; string;最終更新日
    • LastUpdateLogin; string;最終更新ログイン
    • LastUpdatedBy; string;最終更新者
    • ObjectVersionNumber; integer;オブジェクト・バージョン番号
    • OwnerId;整数;所有者ID
    • OwnerName;文字列;所有者名
    • OwnerNumber;文字列;所有者番号
    • OwnerUniqueName;文字列;所有者一意名
    • StartDate;文字列;開始日
  • "?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
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : contests-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : コンテスト履歴
タイプ: array
タイトル: Contest History
コンテスト履歴
ソースを表示
ネストされたスキーマ : コンテスト・リソース
タイプ: array
タイトル: Contest Resources
コンテスト・リソース
ソースを表示
ネストされたスキーマ : コンテスト・スコア
タイプ: array
タイトル: Contest Scores
コンテスト・スコア
ソースを表示
ネストされたスキーマ : contests-ContestHistory-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : contests-ContestParticipants-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : contests-ContestScores-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : コンテスト・スコア詳細
タイプ: array
タイトル: Contest Score Details
コンテスト・スコア詳細
ソースを表示
ネストされたスキーマ : contests-ContestScores-ContestScoreDetails-item-response
タイプ: object
ソースを表示
トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contests

レスポンス本文の例

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

{
    "items": [
        {
            "ContestId": 300100547824052,
            "ContestNumber": "CDRM_1039",
            "ContestName": "ContestAppointmentsCompleted_2021-08-10 10:52:17",
            "Description": "Testing_2021-08-10 10:52:17",
            "OwnerId": 300100206486893,
            "StartDate": "2021-08-10T10:51:38+00:00",
            "EndDate": "2021-09-09T10:52:18+00:00",
            "KPIId": 100100144204795,
            "CreatedBy": "cbarry",
            "CreationDate": "2021-08-10T10:50:40+00:00",
            "LastUpdatedBy": "cbarry",
            "LastUpdateDate": "2021-08-10T10:50:42.547+00:00",
            "LastUpdateLogin": "C92581ABB72CF83AE0533AFDF40A3E1C",
            "ObjectVersionNumber": 1,
            "ConflictId": 0,
            "OwnerName": "Conor Barry",
            "OwnerNumber": "CDRM_900650",
            "OwnerUniqueName": "Conor Barry",
            "KPIName": "Appointments Completed",
            "KPINumber": "SEED_6_S",
            "KPIDescription": "Measures the number of appointments completed.",
            "UpdateFlag": true,
            "DeleteFlag": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039",
                    "name": "contests",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039",
                    "name": "contests",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039/child/ContestHistory",
                    "name": "ContestHistory",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039/child/ContestParticipants",
                    "name": "ContestParticipants",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests/CDRM_1039/child/ContestScores",
                    "name": "ContestScores",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contests",
            "name": "contests",
            "kind": "collection"
        }
    ]
}
「トップに戻る」