2.9.3 Acquisition of a list of operations for a property definition
Function
Acquires a list of operations that can be executed for 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/actions
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 permission is invalid, or the resource does not exist. |
412 |
Precondition failed |
The request conflicts with another request, or the request does not match the current status of the object. |
500 |
Server-side error |
A server processing error occurred. |
Response schema
The following shows the structure of the response body for a request.
{
"data" : [ {"member-of-the-resources-for-property-definition-functionality(PropertyDefinitions)" : 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 acquires a list of operations that can be executed for the property definition whose instanceID is 158.
Request header:
GET /Automation/v1/objects/PropertyDefinitions/158/actions HTTP/1.1
Host: 10.196.184.238:22015
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Response header:
HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:38:20 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 78d4d9d37740a76bfe7212277228eb2db759bb10_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" : [ ],
"count" : 0
}