1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Contests

Get all contests

get

/crmRestApi/resources/11.13.18.05/contests

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

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

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Find a contest using the primary key.
      Finder Variables
      • ContestId; integer; The unique identifier of the contest
    • RowFinder Find all contests using the contest number.
      Finder Variables
      • ContestNumber; string; The unique alternate identifier of the contest.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ConflictId; integer; Conflict ID
    • ContestId; integer; Contest ID
    • ContestName; string; Contest Name
    • ContestNumber; string; Contest Number
    • CreatedBy; string; Created By
    • CreationDate; string; Creation Date
    • Description; string; Description
    • EndDate; string; End Date
    • KPIAggregation; string; KPI Calculation Type
    • KPIDescription; string; KPI Description
    • KPIId; integer; KPI ID
    • KPIName; string; KPI Name
    • KPINumber; string; KPI Number
    • LastUpdateDate; string; Last Updated Date
    • LastUpdateLogin; string; Last Update Login
    • LastUpdatedBy; string; Last Updated By
    • ObjectVersionNumber; integer; Object Version Number
    • OwnerId; integer; Owner ID
    • OwnerName; string; Owner Name
    • OwnerNumber; string; Owner Number
    • OwnerUniqueName; string; Owner Unique Name
    • StartDate; string; Start Date
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : contests
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : contests-item-response
Type: object
Show Source
Nested Schema : Contest History
Type: array
Title: Contest History
Contest History
Show Source
Nested Schema : Contest Resources
Type: array
Title: Contest Resources
Contest Resources
Show Source
Nested Schema : Contest Scores
Type: array
Title: Contest Scores
Contest Scores
Show Source
Nested Schema : contests-ContestHistory-item-response
Type: object
Show Source
Nested Schema : contests-ContestParticipants-item-response
Type: object
Show Source
Nested Schema : contests-ContestScores-item-response
Type: object
Show Source
Nested Schema : Contest Score Details
Type: array
Title: Contest Score Details
Contest Score Details
Show Source
Nested Schema : contests-ContestScores-ContestScoreDetails-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all contests by submitting a get request on the REST resource using cURL.

cURL Command

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

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "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"
        }
    ]
}
Back to Top