Hitachi

JP1 Version 10 JP1/Automatic Operation 画面・コマンド・APIリファレンス


9.7.5 プロパティ値の取得

機能

指定したプロパティ値の情報を取得します。

実行権限

Adminロール,Developロール,Modifyロール,Submitロール

APIのバージョン

v1

リクエスト形式

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

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。

ステータスコード

メッセージ

説明

200

OK

成功しました。

401

Unauthorized

ログイン権限がありません。

404

Not found

リクエストされたリソースまたは操作がありません。または,ユーザーにリソースの読み取り権限がありません。

412

Precondition failed

サーバが利用できません。

500

Server-side error

サーバ処理エラーが発生しました。

レスポンスのスキーマ

リクエストに対するレスポンスボディーの構造を次に示します。

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

使用例

instanceID=7のプロパティ値の情報を取得する場合の使用例を示します。

リクエストヘッダー:

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

レスポンスヘッダー:

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 2dafa6e61f242ce903f1797053d0ebfba5566_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

レスポンスボディー:

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