listTypes

get

/ccadmin/v1/appeasementTypes

List appeasement types based on the search criteria entered.

Request

Supported Media Types
Query Parameters
  • This controls which fields are returned in the response body.
  • This is the field to specify the number of records to be fetched per REST call.
  • This field specifies the offset/starting index from which data to be fetched.
  • Search criteria - Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |active|boolean|active flag of the appeasement type| |isOrderRequired|boolean|specifies whether order is mandatory for the type| |id|string|id of the appeasement type| |description|string|description of the appeasement type| |displayName|string|name of the appeasement type| Search criteria in SCIM Format should be as: active eq true.
  • This field specifies the sort order of the list to be fetched.
  • Indicates if the total results should be included in the response.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listTypes_response
Type: object
Show Source
Example:
{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":250,
    "sort":[
        {
            "property":"id",
            "order":"asc"
        }
    ],
    "items":[
        {
            "displayName":"Order",
            "description":"Appeasement to be applied on a given order",
            "active":true,
            "id":"order",
            "isOrderRequired":true
        }
    ]
}
Nested Schema : items
Type: array
Array containing the object representation of appeasement types. See getType for detailed description of the values of each property.
Show Source
Nested Schema : sort
Type: array
An array that specifies the sort order.
Show Source
Nested Schema : getType_response
Type: object
Show Source
Example:
{
    "displayName":"Order",
    "description":"Appeasement to be applied on a given order",
    "active":true,
    "id":"order",
    "isOrderRequired":true
}
Nested Schema : items
Type: object
Show Source

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: Below is the list of error codes: |Error Code|Description| |------------------|------------------| |85000|Invalid SCIM filter format.| |85003|Invalid attribute in query| |900025|An internal error occured while processing the input request|
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