listPromotionFolders
get
/ccadmin/v1/promotionFolders
List Promotion Folders. Get a list of promotion folders including support for pagination and sorting.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The number of items to return.
-
offset(optional): integer
Index of the first element to return.
-
q(optional): string
A SCIM filter string for selecting a subset of all promotion folders. See [https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2](https://tools.ietf.org/html/draft-ietf-scim-api-12#section-3.2.2)section 3.2.2.2 of the SCIM specification for details on the SCIM filter format. Example: Get all promotion folders whose name contains holiday: q=name co "holiday" name is the only relevant property on promotion folder that can be used with q parameter filtering. Text, date and time values appearing in SCIM filters should be quoted, with date and time values using ISO-8601 format. Numeric and boolean values should not be quoted.
-
sort(optional): string
Sorting criteria. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |property|string|The property the listing is sorted by.| |order|string|Sort order: asc or desc.|
-
total(optional): integer
The total number of items.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listPromotionFolders_response
Type:
Show Source
object
-
items(optional):
array items
The items returned by the listing.
-
limit(optional):
integer
The number of items to return.
-
offset(optional):
integer
Index of the first element to return.
-
sort(optional):
array sort
Sorting criteria.
-
total(optional):
integer
The total number of items. Deprecated.
-
totalResults(optional):
integer
The total number of items.
Nested Schema : items
Type:
Show Source
object
-
name(optional):
string
The name of the promotion folder.
-
parentFolder(optional):
object parentFolder
Parent Folder object of the current folder.
-
path(optional):
string
Promotion folder's absolute path, it is a concatenation of it's parent folder's names and it's own name separated by '/'
-
repositoryId(optional):
string
The promotion folder id.
Nested Schema : parentFolder
Type:
object
Parent Folder object of the current folder.
Show Source
-
repositoryId(optional):
string
The promotion folder's repository id
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Sort order: asc or desc.
-
property(optional):
string
The property the listing is sorted by.
Example Response (application/json)
{
"total":2,
"totalResults":2,
"offset":0,
"limit":2,
"sort":[
{
"property":"path",
"order":"asc"
}
],
"items":[
{
"path":"Holiday Discount",
"parentFolder":null,
"repositoryId":"promoFolder100001",
"name":"Holiday Discount"
},
{
"path":"Holiday Discount/Winter Discount",
"parentFolder":{
"repositoryId":"promoFolder100001"
},
"repositoryId":"promoFolder100002",
"name":"Winter Discount"
}
]
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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