2.9.8 Update of a property value

Function

Updates the property value that has the specified ID.

Execution permissions

Admin role, Develop role, Modify role

API version

Request format

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

The request schema has the same format as the response body for the API function Acquisition of a property value. The following table describes the object that can be specified as PropertyValue (member).

Table 2‒79: Object that can be specified as PropertyValue (member)
Function	Resource name	Number	Description
Property value	PropertyValue	1	PropertyValue resource that has the specified ID

The following table describes the property that must be specified for this object.

Resource name	Member name	Number
PropertyValue	value	1

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 property value is invalid, or the resource cannot be edited.
401	Unauthorized	The user does not have login permission.
403	Forbidden	The user does not have update permission.
404	Not found	The permission is invalid, or the resource does not exist.
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 function updates the value of the property whose instanceID is 24.

Request header:

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

Response header:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:40:59 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO d37375c943b0fcff62645a210ed9a96d116e153_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" : 24,
  "type" : "string",
  "keyName" : "com.hitachi.software.dna.sys.mail.smtp.server",
  "value" : "server",
  "readOnly" : false,
  "hidden" : false
}

To Page Top