2.7.1 Acquisition of a list of tasks
Function
Acquires a list of tasks.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/Tasks
This API acquires a list of all tasks for which the user who executed the API has permissions. By specifying query parameters, you can filter the tasks 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 |
scheduleID |
|
serviceGroupID |
|
serviceTemplateID |
|
tags |
Whether all values are contained. You can specify multiple values by separating them with a comma (,). |
q |
For the following schema, a full-text search is performed to determine whether the specified value is contained:
If you specify multiple values by separating them with a half-width space character, a full-text search is performed to determine whether all of the specified values are contained. This query parameter is not case sensitive. |
For details about other query parameters that can be specified, see 2.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 |
The 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-task-functionality(Tasks)" : value ... }, ... ], "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 tasks.
Request header: GET /Automation/v1/objects/Tasks HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.36.0 Host: 10.196.184.182:22015 Accept: application/json Response header: HTTP/1.1 200 OK Date: Fri, 31 Jul 2015 02:00:18 GMT Server Cosminexus HTTP Server is not blacklisted Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO baa98567d9a18be55be1594ea9677ab1da826a3_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: { "data" : [ { "instanceID" : 3042, "name" : "Execute Remote Command_20150731105831", "status" : "waiting", "scheduledStartTime" : "2015-07-31T11:30:00.000+09:00", "submitter" : "System", "submitTime" : "2015-07-31T11:00:06.000+09:00", "modifyTime" : "2015-07-31T11:00:06.000+09:00", "serviceState" : "release", "scheduleType" : "schedule", "description" : "", "serviceName" : "Execute Remote Command", "tags" : "Windows,Linux,Execute Script", "serviceGroupName" : "DefaultServiceGroup", "toDo" : false, "notes" : "", "serviceTemplateID" : 560, "scheduleID" : 3020, "serviceGroupID" : 3, "serviceID" : 2004, "supportedActionType" : "forciblyStop,retry" } ], "count" : 1 }