2.6.9 Resume of a schedule
Function
Resumes the specified schedule.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/Schedules/id/actions/resume/ invoke
The following shows the structure of the request body.
{ "name" : "resume", "href" : "http://host:port/Automation/version/objects/Schedules/id/actions/resume/invoke", "method" : "POST", "parameters" : [ ] }
Status code
The following table describes the various status codes that can be returned as the response to a request.
Status code |
Message |
Description |
---|---|---|
200 |
OK |
Processing has been successfully completed. Or, the task status was "Waiting". |
400 |
Bad Request |
A query parameter is invalid. |
401 |
Unauthorized |
The user does not have login permission. |
404 |
Not found |
The permission is invalid, or the resource does not exist. |
409 |
Conflict |
The status of the task is neither Waiting nor Holding. |
412 |
Precondition failed |
The server is not available. |
500 |
Server-side error |
A server processing error occurred. |
Response schema
The following shows the structure of the response body for a request.
{ "instanceId" : "instance-id", "created" : "created-date-and-time", "updated" : "updated-date-and-time", "completed" : "completed-date-and-time", "state" : "state", "affectedResources" : [ {...} ] }
The following table describes the object that can be output as affectedResources (member).
Output |
Resource name |
Number |
Description |
---|---|---|---|
Link to the affected schedule |
String |
1 |
Link to the affected resource for schedule functionality (Schedules) |
Usage example
In the following example, the API resumes the schedule whose instanceID is 2193.
Request header: POST /Automation/v1/objects/Schedules/2193/actions/resume/invoke HTTP/1.1 Host: 10.196.184.238:22015 Accept: application/json Content-Type: application/json Content-Length: 172 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: useragent1 Accept-Language: ja Response header: HTTP/1.1 200 OK Date: Mon, 14 Jul 2014 12:33:56 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO f214b39fba479af17375f1ad0e052124041ea60_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810 Access-Control-Allow-Origin: * Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS Access-Control-Allow-Credentials: true Cache-Control: no-cache Transfer-Encoding: chunked Content-Type: application/json Response body: { "instanceID" : "a109b95d-e7ef-4982-ab24-2d062b38e088", "created" : "2014-07-14T05:33:56.925-0700", "updated" : "2014-07-14T05:33:56.925-0700", "completed" : "2014-07-14T05:33:56.925-0700", "state" : "success", "affectedResource" : [ "http://10.196.184.238:22015/Automation/v1/objects/Schedules/2193" ] }