2.9.2 Acquisition of property definition information
Function
Acquires information about the specified property definition.
Execution permissions
Admin role, Develop role, Modify role, Submit role
API version
v1
Request format
GET http://host:port/Automation/version/objects/PropertyDefinitions/id
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. |
404 |
Not found |
The requested resource or operation does not exist, or the user does not have read permission for the resource. |
412 |
Precondition failed |
The server is not available. |
500 |
Server-side error |
A server processing error occurred. |
Response schema
The following shows the structure of the response body for a request.
{ "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" : max-length, "minLength" : min-length, "minValue" : min-value, "maxValue" : max-value, "pattern" : "pattern", "valueList" : "value-list", "propertyGroupName" : "property-group-name", "validationScript" : "validation-script", "readOnly" : {true|false}, "hidden" : {true|false}, "reference" : {true|false}, "serviceTemplateID" : service-template-id, }
Usage example
In the following example, the API acquires information about the property definition whose instanceID is 158.
Request header: GET /Automation/v1/objects/PropertyDefinitions/158 HTTP/1.1 Host: 10.196.184.238:22015 Accept: application/json Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: useragent1 Accept-Language: ja Response header: 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 Response body: { "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, "maxLength" : 255, "minLength" : 1, "pattern" : "^[0-9a-zA-Z\\.\\-]*$", "propertyGroupName" : "reserved.defaultGroup", "validationScript" : "", "readOnly" : false, "hidden" : false, "reference" : false, "serviceTemplateID" : 5106 }