9.7.1 プロパティ定義一覧の取得
機能
プロパティ定義の一覧を取得します。取得できるのは,入出力種別が,in,outのサービスプロパティ,またはサービス共有プロパティです。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
GET http://host:port/Automation/version/objects/PropertyDefinitions
APIの実行ユーザーが権限を持つ,すべてのサービスおよびタスクを対象として,プロパティ定義の一覧を取得します。クエリパラメータを指定すると,取得する対象を絞り込めます。クエリパラメータは,次の形式で指定してください。
?クエリパラメータ=値[&クエリパラメータ=値...]
クエリパラメータ |
フィルタ条件 |
---|---|
serviceID |
指定した値と等しい |
taskID |
指定した値と等しい |
そのほかに指定できるクエリパラメータについては,「9.2.9 クエリパラメータ」を参照してください。
- 指定例
-
クエリパラメータとして,serviceIDに16731を,taskIDに512を指定する例を次に示します。
?serviceID=16731&taskID=512
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
401 |
Unauthorized |
ログイン権限がありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
レスポンスボディーには,リクエストで指定したクエリパラメータの条件に合致したデータが返却されます。レスポンスボディーのスキーマを次に示します。
{ "data" : [ {"プロパティ定義機能のリソース(PropertyDefinitions)のメンバー" : 値 ... }, ... ], "count" : クエリパラメータの条件に合致したデータの個数(0〜n) }
使用例
すべてのサービスおよびタスクを対象として,プロパティ定義の一覧を取得する場合の使用例を次に示します。
リクエストヘッダー: GET /Automation/v1/objects/PropertyDefinitions 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:36:09 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 5f652d484555f1b2f289a33be680d83212cd6e35_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 レスポンスボディー: { "data" : [ { "instanceID" : 44, "keyName" : "destinationHost", "displayName" : "Destination Host", "defaultValue" : "", "description" : "Specify the IP address or host name of the destination host. The destination host must be in a network environment that can communicate with the JP1/AO server. You cannot specify more than one destination host.", "mode" : "in", "required" : true }, { "instanceID" : 52, "keyName" : "destinationHost", "displayName" : "Destination Host", "defaultValue" : "", "description" : "Specify the IP address or host name of the destination host. The destination host must be in a network environment that can communicate with the JP1/AO server. You cannot specify more than one destination host.", "mode" : "in", "required" : true }, { "instanceID" : 82, "keyName" : "destinationHost", "displayName" : "Destination Host", "defaultValue" : "", "description" : "Specify the IP address or host name of the destination host. The destination host must be in a network environment that can communicate with the JP1/AO server. You cannot specify more than one destination host.", "mode" : "in", "required" : true }, { "instanceID" : 101, "keyName" : "destinationHost", "displayName" : "Destination Host", "defaultValue" : "", "description" : "Specify the IP address or host name of the destination host. The destination host must be in a network environment that can communicate with the JP1/AO server. You cannot specify more than one destination host.", "mode" : "in", "required" : true }, { "instanceID" : 267, "keyName" : "destinationHost", "displayName" : "Destination Host", "defaultValue" : "", "description" : "Specify the IPv4 address, IPv6 address or host name of the destination host. The destination host must be in a network environment that can communicate with the JP1/AO server. You cannot specify more than one destination host.", "mode" : "in", "required" : true }, { "instanceID" : 173, "keyName" : "foreachTask", "displayName" : "Repeatedly Executed Task", "defaultValue" : "", "description" : "Specify the full name of the jobnet to be executed repeatedly. You cannot specify a jobnet to be executed repeatedly if it is in a jobnet that is also executed repeatedly.", "mode" : "in", "required" : true }, { "instanceID" : 222, "keyName" : "stdoutProperty", "displayName" : "Standard Output Value", "defaultValue" : "", "description" : "Specify what is output to the standard output. Specify one or more keys of service property or reserved property (?dna_<propertyKey>?), literal characters, or any combination of the above.", "mode" : "in", "required" : true }, { "instanceID" : 121, "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 }, { "instanceID" : 129, "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 }, { "instanceID" : 144, "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 }, { "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 } ], "count" : 11 }
関連トピック