ApiActionResultDataModel represents the result of an API action.
| JSON representation |
|---|
{ "id": string, "executingUser": string, "providerIdentifier": string, "integration": string, "actionIdentifier": string, "caseId": string, "entityIdentifier": string, "message": string, "resultJsonObject": string, "targetedEntitiesJsonObject": string, "resultEntitiesJsonObject": string, "resultValue": string, "resultName": string, "properties": { string: string, ... }, "indicatorIdentifier": string, "workflowId": string, "workflowStep": string, "workflowStepInstanceName": string, "integrationInstanceIdentifier": string, "integrationInstanceName": string, "integrationInstanceEnvironment": string, "alertDisplayName": string, "scriptResultEntityData": [ { object ( |
| Fields | |
|---|---|
id |
Required. Id is the unique identifier of the action result. |
executingUser |
Optional. ExecutingUser is the user who executed the action. |
providerIdentifier |
Optional. ProviderIdentifier is the identifier of the action provider. |
integration |
Optional. Integration is the name of the integration. |
actionIdentifier |
Optional. ActionIdentifier is the identifier of the action. |
caseId |
Optional. CaseId is the ID of the case associated with the action. |
entityIdentifier |
Optional. EntityIdentifier is the identifier of the entity associated with the action. |
message |
Optional. Message is the message associated with the action result. |
resultJsonObject |
Optional. ResultJsonObject is the result JSON object. |
targetedEntitiesJsonObject |
Optional. TargetedEntitiesJsonObject is the targeted entities JSON object. |
resultEntitiesJsonObject |
Optional. ResultEntitiesJsonObject is the result entities JSON object. |
resultValue |
Optional. ResultValue is the result value. |
resultName |
Optional. ResultName is the name of the result. |
properties |
Optional. Properties is a map of properties. An object containing a list of |
indicatorIdentifier |
Optional. IndicatorIdentifier is the identifier of the indicator. |
workflowId |
Optional. WorkflowId is the ID of the workflow. |
workflowStep |
Optional. WorkflowStep is the ID of the workflow step. |
workflowStepInstanceName |
Optional. WorkflowStepInstanceName is the name of the workflow step instance. |
integrationInstanceIdentifier |
Optional. IntegrationInstanceIdentifier is the identifier of the integration instance. |
integrationInstanceName |
Optional. IntegrationInstanceName is the name of the integration instance. |
integrationInstanceEnvironment |
Optional. IntegrationInstanceEnvironment is the environment of the integration instance. |
alertDisplayName |
Optional. AlertDisplayName is the display name of the alert. |
scriptResultEntityData[] |
Optional. ScriptResultEntityData is a list of script result entity data. |
parameters[] |
Optional. Parameters is a list of workflow step parameters. |
blockStepId |
Optional. BlockStepId is the ID of the block step. |
creationTimeUnixTimeInMs |
Optional. CreationTimeUnixTimeInMs is the creation time of the action result in milliseconds since the Unix epoch. |
executionTimeMs |
Optional. ExecutionTimeMs is the execution time of the action in milliseconds since the Unix epoch. |
firstResultUnixTime |
Optional. FirstResultUnixTime is the time of the first result in milliseconds since the Unix epoch. |
modificationTimeUnixTimeInMs |
Optional. ModificationTimeUnixTimeInMs is the modification time of the action result in milliseconds since the Unix epoch. |
propertiesSerializableDictionary |
Optional. PropertiesSerializableDictionary is a map of properties. An object containing a list of |
startLoopStepIdentifier |
Optional. StartLoopStepIdentifier is the ID of the start loop step. |
tenantId |
Optional. TenantId is the ID of the tenant. |
workflowInstanceId |
Optional. WorkflowInstanceId is the ID of the workflow instance. |
actionCategory |
Optional. ActionCategory is the category of the action. |
shouldCreateActivity |
Optional. ShouldCreateActivity indicates whether an activity should be created. |
resultCode |
Optional. ResultCode is the result code of the action. |
isFavorite |
Optional. IsFavorite indicates whether the action result is a favorite. |
status |
Optional. Status is the status of the action result. |
isAsyncPollingResult |
Optional. IsAsyncPollingResult indicates if the result is an async polling result. |
isSkippedAndNotExecuted |
Optional. IsSkippedAndNotExecuted indicates if the action is skipped and not executed. |
isStartLoopStepResult |
Optional. IsStartLoopStepResult indicates if the result is a start loop step result. |
loopIteration |
Optional. LoopIteration is the loop iteration number. |
ActionCategoryEnum
ActionCategoryEnum represents the category of an action.
| Enums | |
|---|---|
INVESTIGATION |
Investigation action category. |
INSTRUCTION |
Instruction action category. |
COMMUNICATION |
Communication action category. |
REMEDIATION |
Remediation action category. |
CONTAINMENT |
Containment action category. |
MANAGEMENT |
Management action category. |
SELECTION |
Selection action category. |
CUSTOM |
Custom action category. |
FLOW |
Flow action category. |
ActionStatusEnum
ActionStatusEnum represents the status of an action.
| Enums | |
|---|---|
FAULTED |
Faulted action status. |
ASYNC_PENDING |
Async pending action status. |
COMPLETED |
Completed action status. |
PENDING_USER_INPUT |
Pending user input action status. |
PENDING_PREVIOUS_STEPS |
Pending previous steps action status. |
STARTED |
Started action status. |
FAULTED_AND_SKIPPED |
Faulted and skipped action status. |
HANDLED_TIMEDOUT |
Handled timed out action status. |
UNHANDLED_TIMEDOUT |
Unhandled timed out action status. |
TERMINATED |
Terminated action status. |
NOT_RUN_AND_SKIPPED |
Not run and skipped action status. |
PENDING_ACTION_TIMEOUT |
Pending action timeout status. |
PENDING_ACTION_TIMEOUT_AND_SKIPPED |
Pending action timeout and skipped status. |