9.7.1 Acquisition of a list of property definitions
Function
Acquires a list of property definitions for service properties or service share properties whose input/output type is in or out.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/PropertyDefinitions
This API acquires a list of property definitions for all services and tasks for which the user who executed the API has permissions. By specifying query parameters, you can filter the property definitions for which you want to acquire the list. Specify query parameters in the following format:
?query-parameter=value[&query-parameter=value...]
|
Query parameter |
Filter condition |
|---|---|
|
serviceID |
Equal to the specified value |
|
taskID |
Equal to the specified value |
For details about other query parameters that can be specified, see 9.2.9 Query parameter.
- Example
-
The following example specifies 16731 for serviceID and 512 for taskID as query parameters.
?serviceID=16731&taskID=512
Status code
The following table describes the various status codes that can be returned as the response to a request.
|
Status code |
Message |
Description |
|---|---|---|
|
200 |
OK |
Processing has been successfully completed. |
|
401 |
Unauthorized |
The user does not have login permission. |
|
412 |
Precondition failed |
The server is not available. |
|
500 |
Server-side error |
A server processing error occurred. |
Response schema
Data that matches the conditions specified by query parameters in a request is returned in the response body. The following shows the schema of the response body.
{
"data" : [ {"member-of-the-resources-for-property-definition-functionality(PropertyDefinitions)" : value ... }, ... ],
"count" : number-of-data-items-that-matches-the-conditions-specified-by-query-parameters(0-to-n)
}Usage example
In the following example, the API acquires a list of property definitions for all services and tasks.
Request header:
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
Response header:
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
Response body:
{
"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
}
Related topic