listExecutionStatusForScheduledOrderById
get
/ccstore/v1/scheduledOrders/status/{id}
List Execution Status For Scheduled Order By Id. It will list the execution status for a scheduled order . Optionally takes the X-CCOrganization header to specify current Organization context of logged in user.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The id of the Scheduled order.
Query Parameters
-
limit(optional): integer
limit of the scheduled orders list.
-
offset(optional): integer
Offset of the scheduled orders list.
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listExecutionStatusForScheduledOrderById_response
Type:
Show Source
object-
items(optional):
array items
The array of the Scheduled orders by the 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-
endDate(optional):
string
The end date of the Scheduled order.
-
executionStatusList(optional):
array executionStatusList
The status list of executed scheduled orders
-
Id(optional):
string
The Id of the Scheduled order.
Nested Schema : executionStatusList
Type:
arrayThe status list of executed scheduled orders
Show Source
Nested Schema : items
Type:
Show Source
object-
errorMessages(optional):
string
The error messages list.
-
executionDate(optional):
string
The date for previous scheduled run
-
id(optional):
string
The Id of the Scheduled order.
-
orderId(optional):
string
The Id of the Scheduled order.
-
orderSubmitted(optional):
boolean
The status of order.
-
orderTotal(optional):
number
Total order value.
-
repositoryId(optional):
string
The Id of the Scheduled order.
-
scheduledOrderId(optional):
string
The Id of the Scheduled order.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":250,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccstoreui/v1/scheduledOrders/status/sco20002"
}
],
"items":[
{
"scheduledOrderId":"sco20002",
"errorMessages":[
"hi this is error"
],
"orderId":"o40414",
"repositoryId":"0001",
"executionDate":"2016-12-08T00:00:00.000Z",
"id":"0001",
"orderSubmitted":false,
"orderTotal":123
}
]
}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