2.9.6 プロパティ値の一括更新
機能
次に示すプロパティ値を一括更新します。
特定のタスクに関連するプロパティ値
特定のサービスに関連するプロパティ値
サービス共有プロパティの値
複数のサービスのプロパティ値
実行権限
Adminロール,Developロール,Modifyロール
APIのバージョン
v1
リクエスト形式
PUT http://host:port/Automation/version/objects/PropertyValues
リクエストボディーの構造は,次のようになっています。
{ "pagination" : { }, "data" : [...], "count" : X※ }
- 注※
Xには任意の番号が入ります。
リクエストのスキーマで「data」のメンバーとして指定できるオブジェクトを,次の表で説明します。
機能 |
リソース名称 |
数 |
説明 |
---|---|---|---|
プロパティ値 |
PropertyValue |
1 |
更新するPropertyValueリソース |
このオブジェクトに指定必須のプロパティについて,次に説明します。
リソース名称 |
メンバー名 |
数 |
---|---|---|
PropertyValue |
instanceID |
0~n |
value |
||
readOnly |
||
hidden |
クエリパラメータを指定しない場合は,サービス共有プロパティを一括更新します。
serviceIDのクエリパラメータを指定すると,一括更新する対象を絞り込めます。「readOnly」および「hidden」の属性の更新は,クエリパラメータを指定した場合に可能です。クエリパラメータは次の形式で指定してください。
?クエリパラメータ=値[&クエリパラメータ=値...]
クエリパラメータ |
フィルタ条件 |
---|---|
serviceID |
指定した値と等しい |
そのほかに指定できるクエリパラメータについては,「2.2.9 クエリパラメータ」を参照してください。
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
400 |
Bad Request |
プロパティ値が不正です。または,編集できないリソースです。 |
401 |
Unauthorized |
ログイン権限がありません。 |
403 |
Forbidden |
更新権限がありません。 |
404 |
Not found |
権限が不正です。または,リソースがありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造を次に示します。
{ "data" : [ {"プロパティ値機能のリソース(PropertyValues)のメンバー" : 値 ... }, ... ], "count" : クエリパラメータの条件に合致したデータの個数(0~n) }
使用例
サービス共有プロパティを一括更新する場合の使用例を示します。
リクエストヘッダー: PUT /Automation/v1/objects/PropertyValues HTTP/1.1 Host: 10.196.184.238:22015 Accept: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: useragent1 Accept-Language: ja レスポンスヘッダー: HTTP/1.1 200 OK Date: Mon, 14 Jul 2014 12:40:16 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 1aa95d66e62d885b5583da3620bd166fd3a3_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 レスポンスボディー: { "data" : [ { "instanceID" : 25, "type" : "boolean", "keyName" : "com.hitachi.software.dna.sys.mail.notify", "value" : "false", "readOnly" : false, "hidden" : false }, { "instanceID" : 24, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.server", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 18, "type" : "integer", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.port", "value" : "25", "readOnly" : false, "hidden" : false }, { "instanceID" : 5, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.userid", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 14, "type" : "password", "keyName" : "com.hitachi.software.dna.sys.mail.smtp.password", "readOnly" : false, "hidden" : false }, { "instanceID" : 9, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.from", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 20, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.to", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 28, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.cc", "value" : "", "readOnly" : false, "hidden" : false }, { "instanceID" : 21, "type" : "string", "keyName" : "com.hitachi.software.dna.sys.mail.bcc", "value" : "", "readOnly" : false, "hidden" : false } ], "count" : 9 }