Analyze Action APIs
Execute Action (POST)
Execute Action.
Route
|
URI |
/api/v1/Analyze/Action/{actionId}/Execute |
|
Method |
POST |
|
Result |
JSON – ChangeResult |
Request Payload
ExecuteActionParameter object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
EntryId |
int |
No |
The ID of the grid entry. |
|
Parameter |
string[] |
No |
|
|
GridColumnDefinitions |
GridColumnDefinition[] |
No |
|
|
DynamicGridColumnDefinitions |
GridColumnDefinition[] |
No |
|
|
FormDataJson |
string |
No |
|
|
Comment |
string |
No |
|
|
ActionId |
Guid? |
No |
|
|
ParameterSingleLine |
object[] |
No |
|
|
TargetParameter |
string |
No |
|
|
Action |
string |
Yes |
|
Response Structure Returns ChangeResult object containing:
- Success: bool value
- Data: object value
- ResponseId: Guid? value
- ErrorDetails: ExternalInterfaceException value
Example
POST http://localhost/api/v1/Analyze/Action/{actionId}/Execute Content-Type: application/json
{
"EntryId": 1,
"Parameter": {},
"GridColumnDefinitions": {},
"DynamicGridColumnDefinitions": {},
"FormDataJson": "sample",
"Comment": "sample",
"ActionId": "123e4567-e89b-12d3-a456-426614174000",
"ParameterSingleLine": {},
"TargetParameter": "sample",
"Action": "sample"
}
Example Response
{ "Success": true, "Data": {}, "ResponseId": "123e4567-e89b-12d3-a456-426614174000", "ErrorDetails": {} }
Get Parameter Form Template With Selection State (POST)
Returns the input parameter for the given action <paramref name="actionId"/> or null if no input required.
Route
|
URI |
/api/v1/Analyze/Action/{actionId}/Form |
|
Method |
POST |
|
Result |
JSON – SuccessResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
actionId |
Guid |
Yes |
|
Response Structure Returns SuccessResult object containing:
-
success: bool value
-
data: object value
Example
POST http://localhost/api/v1/Analyze/Action/{actionId}/Form
Example Response
{ "success": true, "data": {} }
Get Parameter Form Template (GET)
Returns the input parameter for the given action <paramref name="actionId"/> or null if no input required.
Route
|
URI |
/api/v1/Analyze/Action/{actionId}/Form |
|
Method |
GET |
|
Result |
JSON – SuccessResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
actionId |
Guid |
Yes |
|
Response Structure Returns SuccessResult object containing:
-
success: bool value
-
data: object value
Example
GET http://localhost/api/v1/Analyze/Action/{actionId}/Form
Example Response
{ "success": true, "data": {} }
Get Next Parameter Form Template (POST)
Returns the next step input parameter for the given action <paramref name="actionId"/>. The <paramref name="requestParam"/> contains the previous input parameter template and the step number.
Route
|
URI |
/api/v1/Analyze/Action/{actionId}/NextForm |
|
Method |
POST |
|
Result |
JSON – IActionResult |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
actionId |
Guid |
Yes |
|
|
requestParam |
object |
No |
|
Example
POST http://localhost/api/v1/Analyze/Action/{actionId}/NextForm
Get Alert Events (GET)
Returns Alert Events.
Route
|
URI |
/api/v1/Analyze/Action/GetAlertEvents |
|
Method |
GET |
|
Result |
JSON – IActionResult |
Parameters
None
Example
GET http://localhost/api/v1/Analyze/Action/GetAlertEvents
Get File System Change (GET)
Get File System Change.
Route
|
URI |
/api/v1/Analyze/Action/GetFileSystemChange |
|
Method |
GET |
|
Result |
JSON – IActionResult |
Parameters
None
Example
GET http://localhost/api/v1/Analyze/Action/GetFileSystemChange
Get Supported Culture (GET)
Returns all supported Culture (Language).
Route
|
URI |
/api/v1/Analyze/Action/GetSupportedCulture |
|
Method |
GET |
|
Result |
JSON – IActionResult |
Parameters
None
Example
GET http://localhost/api/v1/Analyze/Action/GetSupportedCulture
Get Time Zone Info (GET)
Returns all Time Zone Info
Route
|
URI |
/api/v1/Analyze/Action/GetTimeZoneInfo |
|
Method |
GET |
|
Result |
JSON – IActionResult |
Parameters
None
Example
GET http://localhost/api/v1/Analyze/Action/GetTimeZoneInfo