JOC API

Version 1.12.9

http(s)://test.sos-berlin.com:3001/joc/api

Download RAML
JOC API
/orders/set_state
POST

modify the state (node) or end state

parameters can be modified and suspended orders can be resumed at the same time


Parameters in the POST body schema

Name Type Description Example Default
jobschedulerId required, string JobScheduler Master ID scheduler
orders required, array Specified the orders which should be modified. [{
"jobChain":"/sos/reporting/Inventory",
"orderId":"Inventory"
"state":"secondStep"
"endState":"nothingToDo"
"resume":true
}]
state optional, string
field of each orders item
Name of the desired job chain node
endState optional, string
field of each orders item
Name of the desired job chain end node
params optional, array
field of each orders item
Parameter params:[{"name":"...","value":"..."}]
resume optional, boolean
field of each orders item
resumes a suspended order iff true false
auditLog optional, object Object which contains comment, timeSpent and ticketLink. {
"comment":"It was not really necessary!",
"timeSpent":2
}
comment optional, string Field in auditLog to comment this action, e.g. the reason.
timeSpent optional, string Field in auditLog to enter the time spent in minutes. 5
ticketLink optional, string Field in auditLog to enter a link to a corresponding ticket.