2.9.1 Acquisition of a list of property definitions

Function

Acquires a list of property definitions. The API function targets service properties for which the input/output type is in or out, or service share properties.

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...] 

For details about other query parameters that can be specified, see 2.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.

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:192.168.146.132:22015
User-Agent:sample rest client/1.00.0
Accept:application/json
Accept-Language: en
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Mon, 26 Oct 2015 02:47:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 552c3db4cc540ed80ae43b191bde72ec914673_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_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" : 9002,
    "keyName" : "common.targetHost",
    "displayName" : "Host name of execution target server",
    "defaultValue" : "",
    "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" : 9033
  }, {
    "instanceID" : 9097,
    "keyName" : "common.targetHost",
    "displayName" : "Host name of execution target server",
    "defaultValue" : "",
    "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" : 9095
  }, {
    "instanceID" : 5513,
    "keyName" : "service.errorMessage",
    "displayName" : "Summary Message",
    "defaultValue" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Stores a summary message of the task execution results.",
    "mode" : "out",
    "required" : false,
    "propertyGroupName" : "System_Properties",
    "validationScript" : "",
    "readOnly" : true,
    "hidden" : true,
    "reference" : false,
    "serviceTemplateID" : 5485
  }, {
    "instanceID" : 5715,
    "keyName" : "service.errorMessage",
    "displayName" : "Error message",
    "defaultValue" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Set the error message displayed in the Task Details window in the Messages area.",
    "mode" : "out",
    "required" : false,
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 5658
  }, {
    "instanceID" : 6087,
    "keyName" : "service.errorMessage",
    "displayName" : "Error message",
    "defaultValue" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Set the error message displayed in the Task Details window in the Messages area.",
    "mode" : "out",
    "required" : false,
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 6096
  }, {
    "instanceID" : 6183,
    "keyName" : "service.errorMessage",
    "displayName" : "Error message",
    "defaultValue" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Set the error message displayed in the Task Details window in the Messages area.",
    "mode" : "out",
    "required" : false,
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 6178
  }, {
    "instanceID" : 9306,
    "keyName" : "service.errorMessage",
    "displayName" : "service.errorMessage",
    "defaultValue" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "",
    "mode" : "out",
    "required" : false,
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 9303
  }, {
    "instanceID" : 5594,
    "keyName" : "/FP_GenericApplication/service.errorMessage",
    "displayName" : "Summary Message",
    "defaultValue" : "",
    "type" : "string",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Stores a summary message of the task execution results.",
    "mode" : "out",
    "required" : false,
    "propertyGroupName" : "/FP_GenericApplication/System_Properties",
    "validationScript" : "",
    "readOnly" : true,
    "hidden" : true,
    "reference" : false,
    "serviceTemplateID" : 5658
  }, {
    "instanceID" : 6177,
    "keyName" : "/localeTest/plugin.destinationHost",
    "displayName" : "display name:Destination host",
    "defaultValue" : "",
    "type" : "string",
    "visibility" : "config",
    "scope" : "local",
    "description" : "For this property, specify the IPv4 address, IPv6 address, or host name of the target host. You must specify a host that is part of a network configuration in which the server and the target host are able to communicate directly.",
    "mode" : "in",
    "required" : true,
    "propertyGroupName" : "reserved.defaultGroup",
    "validationScript" : "",
    "readOnly" : false,
    "hidden" : false,
    "reference" : false,
    "serviceTemplateID" : 6178
  }, {
    "instanceID" : 9029,
    "keyName" : "common.remoteCommand",
    "displayName" : "Command",
    "defaultValue" : "",
    "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" : 9033
  }, {
    "instanceID" : 9136,
    "keyName" : "common.remoteCommand",
    "displayName" : "Command",
    "defaultValue" : "",
    "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" : 9095
  }, {
    "instanceID" : 5515,
    "keyName" : "fileProvisioning.nfsSetting.nfsEnable",
    "displayName" : "Enable NFS Provisioning",
    "defaultValue" : "true",
    "type" : "boolean",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Enable NFS",
    "mode" : "in",
    "required" : false,
    "propertyGroupName" : "NFS_Settings",
    "validationScript" : "",
    "readOnly" : true,
    "hidden" : true,
    "reference" : false,
    "serviceTemplateID" : 5485
  }, {
    "instanceID" : 10,
    "keyName" : "com.hitachi.software.dna.sys.mail.notify",
    "displayName" : "Email notification",
    "defaultValue" : "false",
    "type" : "boolean",
    "visibility" : "config",
    "scope" : "share",
    "description" : "Enables or disables the email notification functionality. (Built-in shared service property)",
    "mode" : "in",
    "required" : true,
    "readOnly" : false,
    "hidden" : false
  }, {
    "instanceID" : 9024,
    "keyName" : "common.remoteCommandParameter",
    "displayName" : "Command parameters",
    "defaultValue" : "",
    "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" : 9033
  }, {
    "instanceID" : 9137,
    "keyName" : "common.remoteCommandParameter",
    "displayName" : "Command parameters",
    "defaultValue" : "",
    "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" : 9095
  }, {
    "instanceID" : 5690,
    "keyName" : "/FP_GenericApplication/fileProvisioning.nfsSetting.nfsEnable",
    "displayName" : "Enable NFS Provisioning",
    "defaultValue" : "true",
    "type" : "boolean",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "Enable NFS",
    "mode" : "in",
    "required" : false,
    "propertyGroupName" : "/FP_GenericApplication/NFS_Settings",
    "validationScript" : "",
    "readOnly" : true,
    "hidden" : true,
    "reference" : false,
    "serviceTemplateID" : 5658
  }, {
    "instanceID" : 5402,
    "keyName" : "fileProvisioning.nfsSetting.nfsPathOption",
    "displayName" : "Path Options",
    "defaultValue" : "true",
    "type" : "boolean",
    "visibility" : "exec",
    "scope" : "local",
    "description" : "",
    "mode" : "in",
    "required" : false,
    "propertyGroupName" : "NFS_Settings",
    "validationScript" : "",
    "readOnly" : true,
    "hidden" : true,
    "reference" : false,
    "serviceTemplateID" : 5485
  }, {
    "instanceID" : 5,
    "keyName" : "com.hitachi.software.dna.sys.mail.smtp.server",
    "displayName" : "SMTP server address",
    "defaultValue" : "",
    "type" : "string",
    "visibility" : "config",
    "scope" : "share",
    "description" : "Specifies the SMTP server address. The address can be specified as an IPv4 or IPv6 address, or as a host name. Only one of the above can be specified. Multiple addresses cannot be specified by separating them with commas. (Built-in shared service property)",
    "mode" : "in",
    "required" : false,
    "maxLength" : 255,
    "minLength" : 0,
    "readOnly" : false,
    "hidden" : false
  } ],
  "count" : 18
}