2.9.7 Acquisition of a property value

Function

Acquires information about the specified property value.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

Request format

GET http://host:port/Automation/version/objects/PropertyValues/id

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.
404	Not found	The requested resource or operation does not exist, or the user does not have read permission for the resource.
412	Precondition failed	The server is not available.
500	Server-side error	A server processing error occurred.

Response schema

The following shows the structure of the response body for a request.

{
  "instanceID" : instance-id,
  "type" : "type",
  "keyName" : "key-name",
  "value" : "value",
  "readOnly" : {true|false},
  "hidden" : {true|false},
  "serviceID" : service-id,
  "scheduleID" : schedule-id,
  "taskID" : task-id
}

Usage example

In the following example, the API acquires information about the property value whose instanceID is 7.

Request header:

GET /Automation/v1/objects/PropertyValues/7 HTTP/1.1
Host: 10.196.184.238:22015
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:40:54 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO c9f651825563b97bf5d72fea6b1b1cde07a3f41_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_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:

{
  "instanceID" : 7,
  "type" : "string",
  "keyName" : "com.hitachi.software.dna.sys.mail.cc",
  "value" : "",
  "readOnly" : false,
  "hidden" : false
}

To Page Top