ADMINISTRATIVE_STATUS_CHANGE
Allows to change the administrative status of an entity
entity.device
entity.subscription
entity.subscriber
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "ADMINISTRATIVE_STATUS_CHANGE" ,
5 "response" : null ,
6 "title" : "Administrative Status Change"
7 }
8 ]
CONFIGURE_CONSOLE_PARAMETERS
Configure the Console Parameters
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "SET_DEVICE_PARAMETERS" ,
5 "response" : [
6 {
7 "description" : "List of values of the variables" ,
8 "name" : "variableList" ,
9 "properties" : [
10 {
11 "description" : "name of the variable" ,
12 "name" : "variableName" ,
13 "title" : "type" ,
14 "type" : "string"
15 },
16 {
17 "description" : "value of the variable" ,
18 "name" : "variableValue" ,
19 "title" : "type" ,
20 "type" : "parameter"
21 },
22 {
23 "attributes" : {
24 "list" : [
25 "SUCCESS" ,
26 "PARAM_NOT_SUPPORTED" ,
27 "INVALID_FORMAT" ,
28 "WRONG_VALUE" ,
29 "UNKNOWN"
30 ]
31 },
32 "description" : "Result code of Set Operation" ,
33 "name" : "resultCode" ,
34 "subtype" : "string" ,
35 "title" : "Result Code" ,
36 "type" : "enumeration"
37 },
38 {
39 "description" : "Result description of Set Operation" ,
40 "name" : "resultDescription" ,
41 "title" : "Result Description" ,
42 "type" : "string"
43 }
44 ],
45 "subtype" : "object" ,
46 "title" : "Variable List" ,
47 "type" : "array"
48 }
49 ],
50 "title" : "Get Result"
51 }
52 ]
CONFIGURE_SECTIONALIZER_PARAMETERS
Configure the Sectionalizer Parameters
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "SET_DEVICE_PARAMETERS" ,
5 "response" : [
6 {
7 "description" : "List of values of the variables" ,
8 "name" : "variableList" ,
9 "properties" : [
10 {
11 "description" : "name of the variable" ,
12 "name" : "variableName" ,
13 "title" : "type" ,
14 "type" : "string"
15 },
16 {
17 "description" : "value of the variable" ,
18 "name" : "variableValue" ,
19 "title" : "type" ,
20 "type" : "parameter"
21 },
22 {
23 "attributes" : {
24 "list" : [
25 "SUCCESS" ,
26 "PARAM_NOT_SUPPORTED" ,
27 "INVALID_FORMAT" ,
28 "WRONG_VALUE" ,
29 "UNKNOWN"
30 ]
31 },
32 "description" : "Result code of Set Operation" ,
33 "name" : "resultCode" ,
34 "subtype" : "string" ,
35 "title" : "Result Code" ,
36 "type" : "enumeration"
37 },
38 {
39 "description" : "Result description of Set Operation" ,
40 "name" : "resultDescription" ,
41 "title" : "Result Description" ,
42 "type" : "string"
43 }
44 ],
45 "subtype" : "object" ,
46 "title" : "Variable List" ,
47 "type" : "array"
48 }
49 ],
50 "title" : "Get Result"
51 }
52 ]
CONFIGURE_SECTIONALIZERS
Configure a list of Sectionalizers
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "SECTIONALIZER_CONFIGURATION" ,
5 "response" : null ,
6 "title" : "Sectionalizer configuration"
7 }
8 ]
EQUIPMENT_DIAGNOSTIC
Equipment auodiagnostic
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "EQUIPMENT_DIAGNOSTIC" ,
5 "response" : null ,
6 "title" : "Autodiagnostic Action"
7 }
8 ]
FACTORY_RESET
Remote factory reset
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "FACTORY_RESET" ,
5 "response" : null ,
6 "title" : "Factory Reset Action"
7 }
8 ]
GET_DEVICE_PARAMETERS
Allows obtain values of a list of variables
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "GET_DEVICE_PARAMETERS" ,
5 "response" : [
6 {
7 "description" : "List of values of the variables" ,
8 "name" : "variableList" ,
9 "properties" : [
10 {
11 "description" : "name of the variable" ,
12 "name" : "variableName" ,
13 "title" : "type" ,
14 "type" : "string"
15 },
16 {
17 "description" : "value of the variable" ,
18 "name" : "variableValue" ,
19 "title" : "type" ,
20 "type" : "parameter"
21 },
22 {
23 "attributes" : {
24 "list" : [
25 "SUCCESS" ,
26 "PARAM_NOT_SUPPORTED" ,
27 "UNKNOWN"
28 ]
29 },
30 "description" : "Result code of Get Operation" ,
31 "name" : "resultCode" ,
32 "subtype" : "string" ,
33 "title" : "Result Code" ,
34 "type" : "enumeration"
35 },
36 {
37 "description" : "Result description of Get Operation" ,
38 "name" : "resultDescription" ,
39 "title" : "Result Description" ,
40 "type" : "string"
41 }
42 ],
43 "subtype" : "object" ,
44 "title" : "Variable List" ,
45 "type" : "array"
46 }
47 ],
48 "title" : "Get Result"
49 }
50 ]
IoTAdeunis_set_parameters
Set IoTAdeunis parameter
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "SET_DEVICE_PARAMETERS" ,
5 "response" : [
6 {
7 "description" : "List of values of the variables" ,
8 "name" : "variableList" ,
9 "properties" : [
10 {
11 "description" : "name of the variable" ,
12 "name" : "variableName" ,
13 "title" : "type" ,
14 "type" : "string"
15 },
16 {
17 "description" : "value of the variable" ,
18 "name" : "variableValue" ,
19 "title" : "type" ,
20 "type" : "parameter"
21 },
22 {
23 "attributes" : {
24 "list" : [
25 "SUCCESS" ,
26 "PARAM_NOT_SUPPORTED" ,
27 "INVALID_FORMAT" ,
28 "WRONG_VALUE" ,
29 "UNKNOWN"
30 ]
31 },
32 "description" : "Result code of Set Operation" ,
33 "name" : "resultCode" ,
34 "subtype" : "string" ,
35 "title" : "Result Code" ,
36 "type" : "enumeration"
37 },
38 {
39 "description" : "Result description of Set Operation" ,
40 "name" : "resultDescription" ,
41 "title" : "Result Description" ,
42 "type" : "string"
43 }
44 ],
45 "subtype" : "object" ,
46 "title" : "Variable List" ,
47 "type" : "array"
48 }
49 ],
50 "title" : "Get Result"
51 }
52 ]
IoTAtimTM_set_parameters
Set IoTAtimTM parameters
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "SET_DEVICE_PARAMETERS" ,
5 "response" : [
6 {
7 "description" : "List of values of the variables" ,
8 "name" : "variableList" ,
9 "properties" : [
10 {
11 "description" : "name of the variable" ,
12 "name" : "variableName" ,
13 "title" : "type" ,
14 "type" : "string"
15 },
16 {
17 "description" : "value of the variable" ,
18 "name" : "variableValue" ,
19 "title" : "type" ,
20 "type" : "parameter"
21 },
22 {
23 "attributes" : {
24 "list" : [
25 "SUCCESS" ,
26 "PARAM_NOT_SUPPORTED" ,
27 "INVALID_FORMAT" ,
28 "WRONG_VALUE" ,
29 "UNKNOWN"
30 ]
31 },
32 "description" : "Result code of Set Operation" ,
33 "name" : "resultCode" ,
34 "subtype" : "string" ,
35 "title" : "Result Code" ,
36 "type" : "enumeration"
37 },
38 {
39 "description" : "Result description of Set Operation" ,
40 "name" : "resultDescription" ,
41 "title" : "Result Description" ,
42 "type" : "string"
43 }
44 ],
45 "subtype" : "object" ,
46 "title" : "Variable List" ,
47 "type" : "array"
48 }
49 ],
50 "title" : "Get Result"
51 }
52 ]
POWER_OFF_EQUIPMENT
Powers offs equipment on target entity
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "POWER_OFF_EQUIPMENT" ,
5 "response" : null ,
6 "title" : "Power Off"
7 }
8 ]
POWER_ON_EQUIPMENT
Remote turn on
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "POWER_ON_EQUIPMENT" ,
5 "response" : null ,
6 "title" : "Power On"
7 }
8 ]
REBOOT_EQUIPMENT
Allows remotely reboot CHs
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "REBOOT_EQUIPMENT" ,
5 "response" : null ,
6 "title" : "Reboot Action"
7 }
8 ]
REFRESH_INFO
On demand retrieving the Info
entity.device
entity.subscription
entity.subscriber
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "REFRESH_INFO" ,
5 "response" : null ,
6 "title" : "Refresh Information"
7 }
8 ]
REFRESH_LOCATION
On demand retrieving the location
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "REFRESH_LOCATION" ,
5 "response" : null ,
6 "title" : "Refresh Location"
7 }
8 ]
REFRESH_PRESENCE
On demand retrieving the Presence
entity.device
entity.subscription
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "REFRESH_PRESENCE" ,
5 "response" : null ,
6 "title" : "Refresh Presence"
7 }
8 ]
RESET_COMMUNICATIONS
reset a communications channel
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "RESET_COMMUNICATIONS" ,
5 "response" : null ,
6 "title" : "Reset Communications Action"
7 }
8 ]
SEND_COMMAND
Send a command to an entity
SET_CLOCK_EQUIPMENT
Allows to set to date the device internal clock
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "SET_CLOCK_EQUIPMENT" ,
5 "response" : null ,
6 "title" : "Set Clock Action"
7 }
8 ]
SET_DEVICE_PARAMETERS
Allows set values of a list of variables
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "SET_DEVICE_PARAMETERS" ,
5 "response" : [
6 {
7 "description" : "List of values of the variables" ,
8 "name" : "variableList" ,
9 "properties" : [
10 {
11 "description" : "name of the variable" ,
12 "name" : "variableName" ,
13 "title" : "type" ,
14 "type" : "string"
15 },
16 {
17 "description" : "value of the variable" ,
18 "name" : "variableValue" ,
19 "title" : "type" ,
20 "type" : "parameter"
21 },
22 {
23 "attributes" : {
24 "list" : [
25 "SUCCESS" ,
26 "PARAM_NOT_SUPPORTED" ,
27 "INVALID_FORMAT" ,
28 "WRONG_VALUE" ,
29 "UNKNOWN"
30 ]
31 },
32 "description" : "Result code of Set Operation" ,
33 "name" : "resultCode" ,
34 "subtype" : "string" ,
35 "title" : "Result Code" ,
36 "type" : "enumeration"
37 },
38 {
39 "description" : "Result description of Set Operation" ,
40 "name" : "resultDescription" ,
41 "title" : "Result Description" ,
42 "type" : "string"
43 }
44 ],
45 "subtype" : "object" ,
46 "title" : "Variable List" ,
47 "type" : "array"
48 }
49 ],
50 "title" : "Get Result"
51 }
52 ]
SHUT_DOWN_COMMUNICATIONS
disable a specific communications channel
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "SHUT_DOWN_COMMUNICATIONS" ,
5 "response" : null ,
6 "title" : "Shut Down Communications Action"
7 }
8 ]
SIM_REPLACEMENT
STATUS_DIAGNOSTIC
Remote factory reset
entity.device
entity.subscription
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "CONFIGURATION" ,
5 "response" : null ,
6 "title" : "Configuration"
7 },
8 {
9 "description" : "" ,
10 "name" : "COMPONENTS" ,
11 "response" : null ,
12 "title" : "Components"
13 },
14 {
15 "description" : "" ,
16 "name" : "COMMUNICATIONS" ,
17 "response" : null ,
18 "title" : "Communications"
19 },
20 {
21 "description" : "" ,
22 "name" : "PROVISION" ,
23 "response" : null ,
24 "title" : "Provision"
25 },
26 {
27 "description" : "" ,
28 "name" : "PRESENCE" ,
29 "response" : null ,
30 "title" : "Presence"
31 },
32 {
33 "description" : "" ,
34 "name" : "EQUIPMENT_DIAGNOSTICS" ,
35 "response" : null ,
36 "title" : "Equipment Diagnostic"
37 }
38 ]
UPDATE
Device Firmware, Software and Configuration Update
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "ACCEPTED" ,
5 "response" : null ,
6 "title" : "Accepted"
7 },
8 {
9 "description" : "" ,
10 "name" : "BEGINUPDATE" ,
11 "response" : null ,
12 "title" : "Begin Update"
13 },
14 {
15 "description" : "" ,
16 "name" : "ENDUPDATE" ,
17 "response" : null ,
18 "title" : "End Update"
19 },
20 {
21 "description" : "" ,
22 "name" : "DOWNLOADFILE" ,
23 "response" : null ,
24 "title" : "Download File"
25 },
26 {
27 "description" : "" ,
28 "name" : "BEGININSTALL" ,
29 "response" : null ,
30 "title" : "Begin Install"
31 },
32 {
33 "description" : "" ,
34 "name" : "ENDINSTALL" ,
35 "response" : null ,
36 "title" : "End Install"
37 },
38 {
39 "description" : "" ,
40 "name" : "BEGINPREACTION" ,
41 "response" : null ,
42 "title" : "Begin Preaction"
43 },
44 {
45 "description" : "" ,
46 "name" : "ENDPREACTION" ,
47 "response" : null ,
48 "title" : "End Preaction"
49 },
50 {
51 "description" : "" ,
52 "name" : "BEGINPOSTACTION" ,
53 "response" : null ,
54 "title" : "Begin PostAction"
55 },
56 {
57 "description" : "" ,
58 "name" : "ENDPOSTACTION" ,
59 "response" : null ,
60 "title" : "End PostAction"
61 }
62 ]
WAKE_UP_COMMUNICATIONS
enable a specific communications channel
Steps
1 [
2 {
3 "description" : "" ,
4 "name" : "WAKE_UP_COMMUNICATIONS" ,
5 "response" : null ,
6 "title" : "Wake Up Communications Action"
7 }
8 ]