9.7.2　プロパティ定義情報の取得

機能

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

実行権限

Adminロール，Developロール，Modifyロール，Submitロール

APIのバージョン

リクエスト形式

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

ステータスコード

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

ステータスコード	メッセージ	説明
200	OK	成功しました。
401	Unauthorized	ログイン権限がありません。
404	Not found	リクエストされたリソースまたは操作がありません。または，ユーザーにリソースの読み取り権限がありません。
412	Precondition failed	サーバが利用できません。
500	Server-side error	サーバ処理エラーが発生しました。

レスポンスのスキーマ

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

{
  "instanceID" : instance-id,
  "keyName" : "key-name",
  "displayName" : "display-name",
  "defaultValue" : "default-value",
  "type" : "type",
  "visibility" : "visibility",
  "scope" : "scope",
  "description" : "description",
  "mode" : "mode",
  "required" : {true|false},
  "maxLength" : maxLength,
  "minLength" : minLength,
  "minValue" : "minRange",
  "maxValue" : "maxRange",
  "pattern" : "pattern",
  "valueList" : "valueList",
  "propertyGroupName" : "propertyGroupName"
}

使用例

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

リクエストヘッダー:

GET /Automation/v1/objects/PropertyDefinitions/158 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:37:24 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 3096d91c11fd92d841b3513ed988ba758237cd1_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" : 158,
  "keyName" : "remoteHost",
  "displayName" : "Remote Host",
  "defaultValue" : "",
  "description" : "Specify the IP address or host name of the remote host. The remote host must be in a network environment that can communicate with the server. You cannot specify more than one remote host.",
  "mode" : "in",
  "required" : true
}

ページの先頭へ

9.7.2 プロパティ定義情報の取得

9.7.2　プロパティ定義情報の取得