9.5.1 Acquisition of a list of schedules
Function
Acquires a list of schedules set for the specified task.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/Schedules
This API acquires a list of all schedules for which the user who executed the API has permissions. By specifying query parameters, you can filter the schedules for which you want to acquire the list. Specify query parameters in the following format:
?query-parameter=value[&query-parameter=value...]
|
Query parameter |
Filter condition |
|---|---|
|
serviceID |
Equal to the specified value |
|
scheduleStatus# |
Schedule information for unexecuted tasks |
- #
-
To acquire schedule information for unexecuted tasks, specify running for scheduleStatus.
For details about other query parameters that can be specified, see 9.2.9 Query parameter.
- Example
-
The following example specifies 2015 for serviceID as a query parameter.
?serviceID=2015
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. |
|
400 |
Bad Request |
A query parameter is invalid. |
|
401 |
Unauthorized |
The user does not have login permission. |
|
412 |
Precondition failed |
The server is not available. |
|
500 |
Server-side error |
A server processing error occurred. |
Response schema
Data that matches the conditions specified by query parameters in a request is returned in the response body. The following shows the schema of the response body.
{
"data" : [ {"member-of-a-resource-for-schedule-functionality(Schedules)" : vlaue ... }, ... ],
"count" : number-of-data-items-that-match-the-conditions-specified-by-query-parameters(0-to-n)
}Usage example
In the following example, the API acquires a list of all schedules.
Request header:
GET /Automation/v1/objects/Schedules 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:25:42 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO c181cf3ee24e93ce964562788bccda3381a647f5_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:
{
"data" : [ {
"instanceID" : 2060,
"name" : "testService1_20140714044426_Resubmit",
"submitter" : "System",
"scheduleType" : "immediate",
"createTime" : "2014-07-14T05:19:39.000-0700",
"modifyTime" : "2014-07-14T05:19:39.000-0700",
"description" : "",
"serviceState" : "release",
"serviceID" : 2015
}, {
"instanceID" : 2029,
"name" : "testService1_20140714045613",
"submitter" : "System",
"scheduleType" : "immediate",
"createTime" : "2014-07-14T04:56:15.000-0700",
"modifyTime" : "2014-07-14T04:56:15.000-0700",
"description" : "",
"serviceState" : "release",
"serviceID" : 2015
}, {
"instanceID" : 2025,
"name" : "testService1_20140714044426",
"submitter" : "System",
"scheduleType" : "immediate",
"createTime" : "2014-07-14T04:45:34.000-0700",
"modifyTime" : "2014-07-14T04:45:34.000-0700",
"description" : "",
"serviceState" : "release",
"serviceID" : 2015
}, {
"instanceID" : 2056,
"name" : "Execute remote command_20140714045708",
"submitter" : "System",
"scheduleType" : "immediate",
"createTime" : "2014-07-14T04:57:09.000-0700",
"modifyTime" : "2014-07-14T04:57:09.000-0700",
"description" : "",
"serviceState" : "test",
"serviceID" : 2040
}, {
"instanceID" : 2134,
"name" : "stop_20140714052330",
"submitter" : "System",
"scheduleType" : "immediate",
"createTime" : "2014-07-14T05:23:32.000-0700",
"modifyTime" : "2014-07-14T05:23:32.000-0700",
"description" : "",
"serviceState" : "test",
"serviceID" : 2092
} ],
"count" : 5
}
Related topic