2.6.7 Pause of a schedule

Function

Pauses the specified schedule.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

Request format

POST http://host:port/Automation/version/objects/Schedules/id/actions/suspend/invoke

The following shows the structure of the request body.

{
  "name" : "suspend",
  "href" : "http://host:port/Automation/version/objects/Schedules/id/actions/suspend/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 "Suspended".
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 not Waiting.
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).

Table 2‒56: Object that can be output as affectedResources (member) (Pause of a schedule)
Output	Resource name	Number	Description
Link to the affected schedule	String	1	Link to the affected Schedules resource

Usage example

In the following example, the API pauses the schedule whose instanceID is 2193.

Request header:

POST /Automation/v1/objects/Schedules/2193/actions/suspend/invoke HTTP/1.1
Host: 10.196.184.238:22015
Accept: application/json
Content-Type: application/json
Content-Length: 174
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:32:16 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" : "3a6ac368-e49c-49ec-ac5b-380370800551",
  "created" : "2014-07-14T05:32:16.519-0700",
  "updated" : "2014-07-14T05:32:16.519-0700",
  "completed" : "2014-07-14T05:32:16.519-0700",
  "state" : "success",
  "affectedResource" : [ "http://10.196.184.238:22015/Automation/v1/objects/Schedules/2193" ]
}

To Page Top