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

コンテストを受ける

get

/crmRestApi/resources/11.13.18.05/contests/{ContestNumber}

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: 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
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : 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
ソースを表示
リンク
ContestHistory
パラメータ:
  • ContestNumber: $request.path.ContestNumber
コンテスト履歴
ContestParticipants
パラメータ:
  • ContestNumber: $request.path.ContestNumber
コンテスト・リソース
ContestScores
パラメータ:
  • ContestNumber: $request.path.ContestNumber
コンテスト・スコア
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
    "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"
        }
    ]
}
「トップに戻る」