9.7.4 Acquisition of a list of property values
Function
Acquires a list of the following values:
-
Service share properties
-
Properties related to a specific service
-
Properties related to a specific schedule
-
Properties related to a specific task
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/PropertyValues
This API acquires a list of property values for all services, schedules, and tasks, for which the user who executed the API has permissions. By specifying query parameters, you can filter the property values 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 |
Equal to the specified value |
taskID |
Equal to the specified value |
For details about other query parameters that can be specified, see 9.2.9 Query parameter.
- Example
-
The following example specifies 16731 for serviceID and 512 for taskID as query parameters.
?serviceID=16731&taskID=512
If you want to acquire the property value for a service, schedule, or task, you need to specify a query parameter for the corresponding serviceID, scheduleID, or taskID. If no query parameter is specified, only service share properties are returned as the response.
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. |
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-property-value-management-functionality(PropertyValues)" : 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 property values for all services, schedules, and tasks.
Request header: GET /Automation/v1/objects/PropertyValues 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:40:06 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 56ca4c95167e4ce4aeb51fa73a85b2923d65e28e_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" : 18, "type" : "boolean", "keyName" : "com.hitachi.software.dna.sys.mail.notify", "value" : "false", }, { "instanceID" : 11, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.server", "value" : "", }, { "instanceID" : 20, "type" : "integer", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.port", "value" : "25", }, { "instanceID" : 5, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.userid", "value" : "", }, { "instanceID" : 13, "type" : "password", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.password", }, { "instanceID" : 17, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.from", "value" : "", }, { "instanceID" : 12, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.to", "value" : "", }, { "instanceID" : 7, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.cc", "value" : "", }, { "instanceID" : 6, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.bcc", "value" : "", } ], "count" : 9 }
Related topic