The following operation is the initial step to obtain details about commands that the execute action function can run.
Execution permission
Admin, Modify
Request line
GET baseURL/v1/services/CustomAction/actions/getCommandActionTemplateDetail
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
Name of the action. |
|
href |
string |
URL for the action. |
|
method |
string |
Name of the method. |
|
type |
string |
Data format for the object. |
|
parameters |
anyType[] |
A list of GetCommandActionTemplateDetailParam objects necessary to execute an operation. For details, see the table below. |
GetCommandActionTemplateDetailParam
{
"componentID":"...",
"nodeID":"...",
"templateFileName":"..."
}
GetCommandActionTemplateDetailParam (Type: GetCommandActionTemplateDetailParam)
|
Attribute |
Type |
Description |
|---|---|---|
|
componentID |
string |
ID of the component specified as the action execution target. The ID of the device that the component belongs to must also be specified. To execute an action for a device, omit this parameter. |
|
nodeID |
string |
ID of the device specified as the action execution target |
|
templateFileName |
string |
Name of the template file in which the action is registered |
Status codes
|
Status code |
Reason phrase |
Description |
|---|---|---|
|
200 |
OK |
Success. |
|
401 |
Unauthorized |
No login privilege. |
|
404 |
Not Found |
The resource was not found. |
|
412 |
Precondition Failed |
The server is not available. |
|
500 |
Internal Server Error |
Server processing error. |
|
503 |
Service Unavailable |
Analyzer detail view server communication error. |
Example code
[Request Header]
GET /Analytics/v1/services/CustomAction/actions/getCommandActionTemplateDetail
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json
[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:56:29 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json
[Response Body]
{
"name" : "getCommandActionTemplateDetail",
"href" : "http://localhost:22015/Analytics/v1/services/CustomAction/actions/getCommandActionTemplateDetail/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ {
"componentID" : "0",
"nodeID" : "0",
"templateFileName" : ""
} ]
}