listScheduledOrders
get
/ccstore/v1/scheduledOrders
This endpoints returns list of all scheduled orders which can be accessed by current logged-in user. Optionally takes the X-CCOrganization header to specify current Organization context of logged-in user.
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
limit of the scheduled orders list.
-
offset(optional): integer
Offset of the scheduled orders list.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listScheduledOrdersByProfile_response
Type:
Show Source
object-
items(optional):
array items
The array of the Scheduled orders by the profile id.
-
limit(optional):
integer
The limit results of the Scheduled orders in a page.
-
offset(optional):
integer
The offset results of the Scheduled orders.
-
total(optional):
integer
The total number of the Scheduled orders.
-
totalResults(optional):
integer
The total results of the Scheduled orders.
Nested Schema : items
Type:
Show Source
object-
createDate(optional):
string
The created date of the Scheduled order.
-
endDate(optional):
string
The end date of the Scheduled order.
-
Id(optional):
string
The Id of the Scheduled order.
-
lastScheduledRun(optional):
string
The last scheduled run of the user of the Scheduled order.
-
name(optional):
string
The name of the Scheduled order.
-
nextScheduledRun(optional):
string
The next scheduled run of the Scheduled order.
-
profileId(optional):
string
The profile Id of the user of the Scheduled order.
-
repositoryId(optional):
string
The repository Id of the user of the Scheduled order.
-
schedule(optional):
object schedule
The schedule of the Scheduled order.
-
siteId(optional):
string
The site Id of the user of the Scheduled order.
-
startDate(optional):
string
The start date of the Scheduled order.
-
state(optional):
string
The status of the Scheduled order.
-
templateOrder(optional):
object templateOrder
The template order of the Scheduled order.
-
templateOrderId(optional):
string
The template order id Id of the user of the Scheduled order.
-
type(optional):
string
The type of the Scheduled order.
-
version(optional):
integer
The version of the Scheduled order.
Nested Schema : schedule
Type:
objectThe schedule of the Scheduled order.
Show Source
-
daysOfWeek(optional):
array daysOfWeek
The days of week of the Scheduled order.
-
delay(optional):
integer
The delay of the first scheduled run after start date of the Periodic Scheduled order in milliseconds.
-
interval(optional):
integer
The interval in term of number of days of the Scheduled order.
-
monthsInYear(optional):
array monthsInYear
The months in year of the Scheduled order.
-
occurenceInDay(optional):
integer
The occurence in day on the Scheduled order.
-
period(optional):
integer
The period of repeating of the Periodic Scheduled order in milliseconds.
-
selectedDates(optional):
array selectedDates
The selected dates in a month in year for the Scheduled order.
-
weeksInMonth(optional):
array weeksInMonth
The weeks in month of the Scheduled order.
Nested Schema : templateOrder
Type:
objectThe template order of the Scheduled order.
Show Source
-
state(optional):
string
The state of the template order.
Nested Schema : selectedDates
Type:
arrayThe selected dates in a month in year for the Scheduled order.
Show Source
Example Response (application/json)
{
"total":2,
"totalResults":2,
"offset":20,
"limit":10,
"items":[
{
"templateOrderId":"o10001",
"endDate":"10/01/2015",
"templateOrder":{
"state":"TEMPLATE"
},
"profileId":"user1",
"name":"testScheduleOrder",
"nextScheduledRun":"10/02/2015",
"Id":"sch001",
"state":"inactive",
"startDate":"10/01/2015"
},
{
"templateOrderId":"o10001",
"endDate":"10/01/2018",
"templateOrder":{
"state":"PENDING_APPROVAL_TEMPLATE"
},
"profileId":"user1",
"name":"testScheduleOrder",
"nextScheduledRun":"10/02/2017",
"Id":"sch002",
"state":"active",
"startDate":"10/01/2015"
},
{
"templateOrderId":"o10002",
"endDate":"10/01/2017",
"templateOrder":{
"state":"PENDING_PAYMENT_TEMPLATE"
},
"profileId":"user1",
"name":"testScheduleOrder",
"nextScheduledRun":"01/02/2017",
"Id":"sch003",
"state":"active",
"startDate":"10/01/2015"
}
]
}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:
arrayAn 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