Jump to

• Request
• Response

listTypes

get

/ccadmin/v1/appeasementTypes

List appeasement types based on the search criteria entered.

Request

Supported Media Types

• application/json

Query Parameters

• fields(optional): string
  This controls which fields are returned in the response body.
• limit(optional): integer
  This is the field to specify the number of records to be fetched per REST call.
• offset(optional): integer
  This field specifies the offset/starting index from which data to be fetched.
• q: string
  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.
• sort(optional): string
  This field specifies the sort order of the list to be fetched.
• totalResults(optional): boolean
  Indicates if the total results should be included in the response.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listTypes_response

Type: object

Show Source

• items(optional): array items
  Array containing the object representation of appeasement types. See getType for detailed description of the values of each property.
• limit(optional): integer
  Limit of number of appeasement types.
• offset(optional): integer
  Numeric offset of the first appeasement type item returned.
• sort(optional): array sort
  An array that specifies the sort order.
• total(optional): integer
  Total number of appeasement types. Deprecated.
• totalResults(optional): integer
  Total number of appeasement types.

{
    "properties":{
        "total":{
            "description":"Total number of appeasement types. Deprecated.",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total number of appeasement types.",
            "type":"integer"
        },
        "offset":{
            "description":"Numeric offset of the first appeasement type item returned.",
            "type":"integer"
        },
        "limit":{
            "description":"Limit of number of appeasement types.",
            "type":"integer"
        },
        "sort":{
            "description":"An array that specifies the sort order.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The name of the property to use for sorting.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"Array containing the object representation of appeasement types. See getType for detailed description of the values of each property.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/getType_response"
            }
        }
    },
    "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
            }
        ]
    }
}

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

• Array of: object getType_response

{
    "description":"Array containing the object representation of appeasement types. See getType for detailed description of the values of each property.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/getType_response"
    }
}

Nested Schema : sort

Type: array

An array that specifies the sort order.

Show Source

• Array of: object items

{
    "description":"An array that specifies the sort order.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The name of the property to use for sorting.",
                "type":"string"
            },
            "order":{
                "description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
                "type":"string"
            }
        }
    }
}

Nested Schema : getType_response

Type: object

Show Source

• active(optional): boolean
  Indicates whether appeasement type is enabled or disabled.
• description(optional): string
  Description of the appeasement type.
• displayName(optional): string
  Name of the appeasement type.
• id(optional): string
  Id of the appeasement type.
• isOrderRequired(optional): boolean
  Indicates whether order is mandatory for the type.

{
    "properties":{
        "displayName":{
            "description":"Name of the appeasement type.",
            "type":"string"
        },
        "description":{
            "description":"Description of the appeasement type.",
            "type":"string"
        },
        "active":{
            "description":"Indicates whether appeasement type is enabled or disabled.",
            "type":"boolean"
        },
        "id":{
            "description":"Id of the appeasement type.",
            "type":"string"
        },
        "isOrderRequired":{
            "description":"Indicates whether order is mandatory for the type.",
            "type":"boolean"
        }
    },
    "example":{
        "displayName":"Order",
        "description":"Appeasement to be applied on a given order",
        "active":true,
        "id":"order",
        "isOrderRequired":true
    }
}

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

• order(optional): string
  Whether this property should be sorted ascending ("asc") or descending ("dsc").
• property(optional): string
  The name of the property to use for sorting.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The name of the property to use for sorting.",
            "type":"string"
        },
        "order":{
            "description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
            "type":"string"
        }
    }
}

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

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top