2.9.4 Acquisition of lists of property definitions and property values

Function

Acquires lists of property definitions and property values.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

Request format

GET http://host:port/Automation/version/objects/PropertyInformations

When executing the API function, make sure that you specify query parameters to filter property definitions and property values for which you want to acquire the lists. Specify query parameters in the following format:

?query-parameter=value[&query-parameter=value...] 

For details about other query parameters that can be specified, see 2.2.9 Query parameter.

Status code

The following table describes the various status codes that can be returned as the response to a request.

Response schema

The following shows the structure of the response body for a request.

{
  "data" : [ {"member-of-the-resources-for--property-definition-and-property-value-functionality(PropertyInformations)" : value ... }, ... ],
  "count" : number-of-data-items-that-match-the-conditions-specified-by-query-parameters(0-to-n)
}

Usage example

In the following example, the API function acquires the lists of property definitions and property values for the service whose serviceID is 2004.

Request header:

GET /Automation/v1/objects/PropertyInformations?serviceID=2004 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Fri, 31 Jul 2015 06:27:14 GMT
Server Cosminexus HTTP Server is not blacklisted
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 94728cefd3f4c996534144711565199189dd8_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_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

Response body:


{
  "data" : [ {
    "instanceID" : 2010,
    "keyName" : "common.targetHost",
    "displayName" : "Host name of execution target server",
    "defaultValue" : "",
    "value" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Specifies the host name or IP address of the execution target server. IPv6 addresses are not supported.",
    "mode" : "in",
    "required" : true,
    "maxLength" : 255,
    "minLength" : 1,
    "pattern" : "^[0-9a-zA-Z\\.\\-]*$",
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 560,
    "serviceID" : 2004
  }, {
    "instanceID" : 2013,
    "keyName" : "common.remoteCommand",
    "displayName" : "Command",
    "defaultValue" : "",
    "value" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Specify the full path of the command to be executed on the execution target server. If the path contains a space, enclose the entire path in double quotation marks.",
    "mode" : "in",
    "required" : true,
    "maxLength" : 256,
    "minLength" : 1,
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 560,
    "serviceID" : 2004
  }, {
    "instanceID" : 2017,
    "keyName" : "common.remoteCommandParameter",
    "displayName" : "Command parameters",
    "defaultValue" : "",
    "value" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Specify the parameters for the command to be executed on the execution target server. If a parameter contains a space, enclose the entire parameter in double quotation marks.",
    "mode" : "in",
    "required" : false,
    "maxLength" : 1024,
    "minLength" : 1,
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 560,
    "serviceID" : 2004
  }, {
    "instanceID" : 2016,
    "keyName" : "common.stdoutProperty",
    "displayName" : "Standard output string",
    "defaultValue" : "",
    "value" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "This property contains the character string output to standard output by the specified command. ",
    "mode" : "out",
    "required" : false,
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 560,
    "serviceID" : 2004
  } ],
  "count" : 4
}