2.5.1 Acquisition of a list of services

Function

Acquires a list of services registered in JP1/AO.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

Request format

GET http://host:port/Automation/version/objects/Services

This API function acquires a list of all services for which the user who executed the API function has permissions. By specifying query parameters, you can filter the services for which you want to acquire the list. Specify query parameters in the following format:

?query-parameter=value[&query-parameter=value...]

Table 2‒48: List of query parameters that can be specified for the API function Acquisition of a list of services
Query parameter	Filter condition
serviceGroupID	Equal to the specified value
serviceTemplateID
favorite
propertyKey	keyName for a PropertyValues resource that contains the specified value
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: name description tags serviceTemplateName vendorName 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.

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-the-resources-for-service-functionality(Services)" : 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 services.

Request header:

GET /Automation/v1/objects/Services HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: 10.196.184.182:22015
User-Agent: curl/7.36.0
Accept: application/json
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Thu, 30 Jul 2015 02:30:37 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO fdef80b1cbd2d625cdbda39c16fda15f68a3d8c_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" : 5137,
    "name" : "Execute Remote Command",
    "description" : "Executes a command on the remote execution target server.",
    "tags" : "Windows,Linux,Execute Script",
    "serviceTemplateName" : "Execute Remote Command",
    "createTime" : "2015-08-07T14:44:07.000+09:00",
    "modifyTime" : "2015-08-07T14:44:07.000+09:00",
    "serviceState" : "test",
    "serviceGroupName" : "DefaultServiceGroup",
    "iconURL" : "http://10.196.184.182:22015/Automation/icon/services/com.hitachi.software.dna.cts/remoteCommandExe/01.20.00",
    "vendorName" : "Hitachi,Ltd.",
    "version" : "01.20.00",
    "favorite" : false,
    "failedCount" : 0,
    "completedCount" : 0,
    "executedCount" : 0,
    "latest" : true,
    "supportedScheduleType" : "immediate,schedule,recurrence",
    "submitCount" : 0,
    "serviceTemplateID" : 5106,
    "serviceGroupID" : 3,
    "supportedActionType" : "forciblyStop,retry"
  } ],
  "count" : 1
}