Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.9.10 Acquisition of a list of property groups

Function

Acquires a list of property groups that the properties retained by a service belong to.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

Request format

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

When you execute the API function, make sure that you specify a query parameter to filter property groups for which you want to acquire the list. You cannot specify multiple query parameters. Specify a query parameter in the following format:

?query-parameter=value
Table 2‒80: List of query parameters that can be specified for the API function Acquisition of a list of property groups

Query parameter

Filter condition

serviceTemplateID

Equal to the specified value

serviceID

scheduleID

taskID

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 a query parameter in a request is returned in the response body. The following shows the schema of the response body.

{
  "data" : [ {"member-of-the-resources-for-property-group-functionality(PropertyGroups)" : value ... }, ... ],
  "count" : number-of-data-items-that-match-the-conditions-specified-by-the-query-parameter(0-to-n)
}

Usage example

In the following example, the API function acquires a list of property groups that the properties retained by the service whose serviceID is 3134 belong to.

Request header:

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

Response header:

HTTP/1.1 200 OK
Date: Mon, 03 Aug 2015 04:06:07 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO b3e9a4ed913c5b5bc941f48bfb1333ced0f1fff6_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" : [ {
    "keyName" : "reserved.defaultGroup",
    "displayName" : "reserved.defaultGroup",
    "description" : "",
    "ordinal" : 0,
    "validationScript" : "",
    "display" : "config,submit,taskDetail"
  } ],
  "count" : 1
}