ApiActionResultDataModel

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 (ScriptResultEntityData)
    }
  ],
  "parameters": [
    {
      object (WidgetApiWorkflowStepParameterDataModel)
    }
  ],
  "blockStepId": string,
  "creationTimeUnixTimeInMs": string,
  "executionTimeMs": string,
  "firstResultUnixTime": string,
  "modificationTimeUnixTimeInMs": string,
  "propertiesSerializableDictionary": {
    string: string,
    ...
  },
  "startLoopStepIdentifier": string,
  "tenantId": string,
  "workflowInstanceId": string,
  "actionCategory": enum (ActionCategoryEnum),
  "shouldCreateActivity": boolean,
  "resultCode": integer,
  "isFavorite": boolean,
  "status": enum (ActionStatusEnum),
  "isAsyncPollingResult": boolean,
  "isSkippedAndNotExecuted": boolean,
  "isStartLoopStepResult": boolean,
  "loopIteration": integer
}
Fields
id

string (int64 format)

Required. Id is the unique identifier of the action result.

executingUser

string

Optional. ExecutingUser is the user who executed the action.

providerIdentifier

string

Optional. ProviderIdentifier is the identifier of the action provider.

integration

string

Optional. Integration is the name of the integration.

actionIdentifier

string

Optional. ActionIdentifier is the identifier of the action.

caseId

string (int64 format)

Optional. CaseId is the ID of the case associated with the action.

entityIdentifier

string

Optional. EntityIdentifier is the identifier of the entity associated with the action.

message

string

Optional. Message is the message associated with the action result.

resultJsonObject

string

Optional. ResultJsonObject is the result JSON object.

targetedEntitiesJsonObject

string

Optional. TargetedEntitiesJsonObject is the targeted entities JSON object.

resultEntitiesJsonObject

string

Optional. ResultEntitiesJsonObject is the result entities JSON object.

resultValue

string

Optional. ResultValue is the result value.

resultName

string

Optional. ResultName is the name of the result.

properties

map (key: string, value: string)

Optional. Properties is a map of properties.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

indicatorIdentifier

string

Optional. IndicatorIdentifier is the identifier of the indicator.

workflowId

string

Optional. WorkflowId is the ID of the workflow.

workflowStep

string

Optional. WorkflowStep is the ID of the workflow step.

workflowStepInstanceName

string

Optional. WorkflowStepInstanceName is the name of the workflow step instance.

integrationInstanceIdentifier

string

Optional. IntegrationInstanceIdentifier is the identifier of the integration instance.

integrationInstanceName

string

Optional. IntegrationInstanceName is the name of the integration instance.

integrationInstanceEnvironment

string

Optional. IntegrationInstanceEnvironment is the environment of the integration instance.

alertDisplayName

string

Optional. AlertDisplayName is the display name of the alert.

scriptResultEntityData[]

object (ScriptResultEntityData)

Optional. ScriptResultEntityData is a list of script result entity data.

parameters[]

object (WidgetApiWorkflowStepParameterDataModel)

Optional. Parameters is a list of workflow step parameters.

blockStepId

string

Optional. BlockStepId is the ID of the block step.

creationTimeUnixTimeInMs

string (int64 format)

Optional. CreationTimeUnixTimeInMs is the creation time of the action result in milliseconds since the Unix epoch.

executionTimeMs

string (int64 format)

Optional. ExecutionTimeMs is the execution time of the action in milliseconds since the Unix epoch.

firstResultUnixTime

string (int64 format)

Optional. FirstResultUnixTime is the time of the first result in milliseconds since the Unix epoch.

modificationTimeUnixTimeInMs

string (int64 format)

Optional. ModificationTimeUnixTimeInMs is the modification time of the action result in milliseconds since the Unix epoch.

propertiesSerializableDictionary

map (key: string, value: string)

Optional. PropertiesSerializableDictionary is a map of properties.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

startLoopStepIdentifier

string

Optional. StartLoopStepIdentifier is the ID of the start loop step.

tenantId

string

Optional. TenantId is the ID of the tenant.

workflowInstanceId

string (int64 format)

Optional. WorkflowInstanceId is the ID of the workflow instance.

actionCategory

enum (ActionCategoryEnum)

Optional. ActionCategory is the category of the action.

shouldCreateActivity

boolean

Optional. ShouldCreateActivity indicates whether an activity should be created.

resultCode

integer

Optional. ResultCode is the result code of the action.

isFavorite

boolean

Optional. IsFavorite indicates whether the action result is a favorite.

status

enum (ActionStatusEnum)

Optional. Status is the status of the action result.

isAsyncPollingResult

boolean

Optional. IsAsyncPollingResult indicates if the result is an async polling result.

isSkippedAndNotExecuted

boolean

Optional. IsSkippedAndNotExecuted indicates if the action is skipped and not executed.

isStartLoopStepResult

boolean

Optional. IsStartLoopStepResult indicates if the result is a start loop step result.

loopIteration

integer

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.