9.5.4 Acquisition of information necessary for canceling a schedule
Function
Acquires information necessary for canceling 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/cancel
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. |
|
401 |
Unauthorized |
The user does not have login permission. |
|
404 |
Not found |
The permission is invalid, or the resource does not exist. |
|
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.
{
"name" : "cancel",
"href" : "http://host:port/Automation/version/objects/Schedules/id/actions/cancel/invoke",
"method" : "POST",
"parameters" : [ {...} ]
}
Usage example
In the following example, the API acquires information necessary for canceling the schedule whose instanceID is 2193.
Request header:
GET /Automation/v1/objects/Schedules/2193/actions/cancel HTTP/1.1
Host:10.196.184.238:22015
Accept:application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Response header:
HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:34:39 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO d0f2fa4f5046c92521664920b9d84e652bcb6dee_V0300
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:
{
"name" : "cancel",
"href" : "http://10.196.184.238:22015/Automation/v1/objects/Schedules/2193/actions/cancel/invoke",
"method" : "POST",
"parameters" : [ ]
}
Related topic