2.9.8 プロパティ値の更新
機能
指定したIDのプロパティ値を更新します。
実行権限
Adminロール,Developロール,Modifyロール
APIのバージョン
v1
リクエスト形式
PUT http://host:port/Automation/version/objects/PropertyValues/id
リクエストのスキーマは,API「プロパティ値の取得」のレスポンスボディーと同じ形式です。「PropertyValue」のメンバーとして指定できるオブジェクトを,次の表で説明します。
機能 |
リソース名称 |
数 |
説明 |
---|---|---|---|
プロパティ値 |
PropertyValue |
1 |
指定したIDのPropertyValueリソース |
このオブジェクトに指定必須のプロパティについて,次に説明します。
リソース名称 |
メンバー名 |
数 |
---|---|---|
PropertyValue |
value |
1 |
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
400 |
Bad Request |
プロパティ値が不正です。または,編集できないリソースです。 |
401 |
Unauthorized |
ログイン権限がありません。 |
403 |
Forbidden |
更新権限がありません。 |
404 |
Not found |
権限が不正です。または,リソースがありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造を次に示します。
{ "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 }
使用例
instanceID=24のプロパティの値を更新する場合の使用例を示します。
リクエストヘッダー: 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 レスポンスヘッダー: 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 レスポンスボディー: { "instanceID" : 24, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.server", "value" : "server", "readOnly" : false, "hidden" : false }