1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Agent
  4. Profile Request

listProfileRequests

get

/ccagent/v1/profileRequests

List Profile Requests. This operation is used to get the collection of profile requests from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of profile request.

Request

Supported Media Types
Query Parameters
  • This is the field to determine number of records to be fetched per REST call.
  • This field determines the offset/starting index from which data to be fetched.
  • Query string built as per the SCIM standards that helps to search entered string across profile request properties like 'requestedOrganizationName'.
  • This field determines the sort order of the list to be fetched.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listProfileRequests_response
Type: object
Show Source
Nested Schema : items
Type: array
list of profile request
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : organization
Type: object
Organization
Show Source
Nested Schema : profile
Type: object
Profile Object
Show Source
Nested Schema : site
Type: object
Site
Show Source
Example Response (application/json)
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:9080/ccagentui/v1/profileRequests"
        }
    ],
    "items":[
        {
            "requestedOrganizationName":"Oracle",
            "organization":{
                "id":"100001"
            },
            "profile":{
                "firstName":"User",
                "lastName":"Test",
                "customerContactId":"CRMID_1",
                "id":"100001",
                "email":"user@example.com"
            },
            "requestedOrganizationID":null,
            "id":100001,
            "status":"approved"
        }
    ],
    "___etag___":"eyJ2ZXJzaW9uIjowLCJ1cmkiOiJvcmdhbml6YXRpb25SZXF1ZXN0cyIsImhhc2giOiJ4S1JsMHc9PSJ9"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |85000|Invalid Query Expression.| |50012|Invalid Sort options.| |10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset'.| |100019|If there was any internal error while getting profile requests list.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top