ApiWorkflowStepInstanceDataModel

ApiWorkflowStepInstanceDataModel represents a workflow step instance.

JSON representation 
{
  "identifier": string,
  "originalStepIdentifier": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "instanceName": string,
  "name": string,
  "integration": string,
  "description": string,
  "actionProvider": string,
  "actionName": string,
  "type": enum (WorkflowStepInstanceTypeValue),
  "parameters": [
    {
      object (ApiWorkflowStepParameterDataModel)
    }
  ],
  "workflowIdentifier": string,
  "parentWorkflowIdentifier": string,
  "workflowInstanceIdentifier": string,
  "caseId": string,
  "indicatorIdentifier": string,
  "alertGroupIdentifier": string,
  "status": enum (WorkflowStepInstanceStatusValue),
  "executingUser": string,
  "message": string,
  "resultValue": string,
  "results": [
    {
      object (LegacyPlaybookScriptResultEntityData)
    }
  ],
  "targetEntities": [
    {
      object (ApiSecurityEntityDataModel)
    }
  ],
  "resultEntities": [
    {
      object (ApiSecurityEntityDataModel)
    }
  ],
  "properties": {
    string: string,
    ...
  },
  "actionDef": {
    object (ApiActionDefinitionDataModel)
  },
  "blockStepId": string,
  "jsonResultObject": string,
  "integrationInstanceIdentifier": string,
  "integrationInstanceName": string,
  "integrationInstanceEnvironment": string,
  "pendingStepProperties": {
    object (ApiPendingStepInstanceDataModel)
  },
  "stepInstanceIdentifier": string,
  "loopIteration": integer,
  "startLoopStepIdentifier": string,
  "parentWorkflowLoopIteration": integer,
  "loopName": string,
  "isAutomatic": boolean,
  "isSkippable": boolean,
  "autoSkipOnFailure": boolean,
  "isDebugMockData": boolean,
  "allowedToExecute": boolean,
  "resultCode": integer,
  "skipComment": string
}
Fields
identifier

string

Required. Identifier is the unique identifier of the step.
originalStepIdentifier

string

Required. OriginalStepIdentifier is the original identifier of the step.
creationTimeUnixTimeInMs

string (int64 format)

Required. CreationTimeUnixTimeInMs is the creation time of the step. Represents DateTime CreationTimeUnixTimeInMs as unix time
modificationTimeUnixTimeInMs

string (int64 format)

Required. ModificationTimeUnixTimeInMs is the modification time of the step. Represents DateTime ModificationTimeUnixTimeInMs as unix time
instanceName

string

Required. InstanceName is the name of the instance.
name

string

Required. Name is the name of the step.
integration

string

Required. Integration is the integration of the step.
description

string

Required. Description is the description of the step.
actionProvider

string

Required. ActionProvider is the provider of the action.
actionName

string

Required. ActionName is the name of the action.
type

enum (WorkflowStepInstanceTypeValue)

Required. Type is the type of the step.
parameters[]

object (ApiWorkflowStepParameterDataModel)

Optional. Parameters is a list of parameters for the step.
workflowIdentifier

string

Required. WorkflowIdentifier is the identifier of the workflow.
parentWorkflowIdentifier

string

Optional. ParentWorkflowIdentifier is the identifier of the parent workflow.
workflowInstanceIdentifier

string (int64 format)

Required. WorkflowInstanceIdentifier is the identifier of the workflow instance.
caseId

string (int64 format)

Required. CaseId is the identifier of the case.
indicatorIdentifier

string

Optional. IndicatorIdentifier is the identifier of the indicator.
alertGroupIdentifier

string

Optional. AlertGroupIdentifier is the identifier of the alert group.
status

enum (WorkflowStepInstanceStatusValue)

Required. Status is the status of the step.
executingUser

string

Optional. ExecutingUser is the user executing the step.
message

string

Optional. Message is the message of the step.
resultValue

string

Optional. ResultValue is the result value of the step.
results[]

object (LegacyPlaybookScriptResultEntityData)

Optional. Results is a list of script results.
targetEntities[]

object (ApiSecurityEntityDataModel)

Optional. TargetEntities is a list of target entities.
resultEntities[]

object (ApiSecurityEntityDataModel)

Optional. ResultEntities is a list of result entities.
properties

map (key: string, value: string)

Optional. Properties is a map of properties for the step.

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

object (ApiActionDefinitionDataModel)

Optional. ActionDef is the action definition.
blockStepId

string

Optional. BlockStepId is the identifier of the block step.
jsonResultObject

string

Optional. JsonResultObject is the JSON result object.
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.
pendingStepProperties

object (ApiPendingStepInstanceDataModel)

Optional. PendingStepProperties is the pending step properties.
stepInstanceIdentifier

string

Output only. StepInstanceIdentifier is the combined identifier of the step instance.
loopIteration

integer

Optional. LoopIteration is the current loop iteration.
startLoopStepIdentifier

string

Optional. StartLoopStepIdentifier is the identifier of the start loop step.
parentWorkflowLoopIteration

integer

Optional. ParentWorkflowLoopIteration is the loop iteration of the parent workflow.
loopName

string

Optional. LoopName is the name of the loop.
isAutomatic

boolean

Optional. IsAutomatic indicates if the step is automatic.
isSkippable

boolean

Optional. IsSkippable indicates if the step is skippable.
autoSkipOnFailure

boolean

Optional. AutoSkipOnFailure indicates if the step should be skipped on failure.
isDebugMockData

boolean

Optional. IsDebugMockData indicates if debug mock data is enabled for the step.
allowedToExecute

boolean

Optional. AllowedToExecute indicates if the user is allowed to execute the step.
resultCode

integer

Optional. ResultCode is the result code of the step.
skipComment

string

Optional. SkipComment is the comment for skipping the step.

WorkflowStepInstanceTypeValue

WorkflowStepInstanceTypeValue represents the type of a workflow step instance.

Enums
WORKFLOW_STEP_INSTANCE_TYPE_VALUE_UNSPECIFIED The type is unspecified.
ACTION The type is action.
MULTI_CHOICE_QUESTION The type is multi choice question.
PREVIOUS_ACTION The type is previous action.
CASE_DATA_CONDITION The type is case data condition.
CONDITION The type is condition.
BLOCK The type is block.
OUTPUT The type is output.
PARALLEL_ACTIONS_CONTAINER The type is parallel actions container.
FOR_EACH_START_LOOP The type is for each start loop.
FOR_EACH_END_LOOP The type is for each end loop.
FLOW The type is flow.
FOR_EACH_LOOP_CONTAINER The type is for each loop container.

WorkflowStepInstanceStatusValue

WorkflowStepInstanceStatusValue represents the status of a workflow step instance.

Enums
WORKFLOW_STEP_INSTANCE_STATUS_VALUE_UNSPECIFIED The status is unspecified.
FAULTED The status is faulted.
IN_PROGRESS The status is in progress.
COMPLETED The status is completed.
PENDING_USER_INPUT The status is pending user input.
PENDING_PREVIOUS_STEPS The status is pending previous steps.
STARTED The status is started.
FAULTED_AND_SKIPPED The status is faulted and skipped.
HANDLED_TIMEDOUT The status is handled timed out.
UNHANDLED_TIMEDOUT The status is unhandled timed out.
TERMINATED The status is terminated.
NOT_RUN_AND_SKIPPED The status is not run and skipped.
PENDING_ACTION_TIMEOUT The status is pending action timeout.
PENDING_ACTION_TIMEOUT_AND_SKIPPED The status is pending action timeout and skipped.
NO_STATUS The status is no status.
PENDING_RETRY The status is pending retry.

LegacyPlaybookScriptResultEntityData

ScriptResultEntityData represents a script result entity.

JSON representation 
{
  "title": string,
  "type": string,
  "csvLines": [
    string
  ],
  "attachments": {
    string: string,
    ...
  },
  "htmls": {
    string: string,
    ...
  },
  "links": [
    string
  ],
  "content": string,
  "rawJson": string,
  "entity": string,
  "isForEntity": boolean
}
Fields
title

string

Optional. Title is the title of the script result.
type

string

Optional. Type is the type of the script result.
csvLines[]

string

Optional. CSVLines is a list of CSV lines.
attachments

map (key: string, value: string)

Optional. Attachments is a map of attachments.

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

map (key: string, value: string)

Optional. Htmls is a map of HTML content.

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

string

Optional. Content is the content of the script result.
rawJson

string

Optional. RawJson is the raw JSON of the script result.
entity

string

Optional. Entity is the entity associated with the script result.
isForEntity

boolean

Optional. IsForEntity indicates if the script result is for an entity.

ApiActionDefinitionDataModel

ApiActionDefinitionDataModel represents an action definition.

JSON representation 
{
  "name": string,
  "description": string,
  "script": string,
  "integrationIdentifier": string,
  "scriptResultName": string,
  "dynamicResultsMetadata": [
    {
      object (ApiDynamicResultMetadata)
    }
  ],
  "creator": string,
  "version": number,
  "id": string,
  "parameters": [
    {
      object (LegacyPlaybookApiActionParameter)
    }
  ],
  "timeoutSeconds": string,
  "asyncPollingIntervalInSeconds": string,
  "totalIntervalTimeoutForAsyncInSeconds": string,
  "defaultResultValue": string,
  "integrationInstances": [
    {
      object (ApiIntegrationInstanceDataModel)
    }
  ],
  "actionWidgetTemplateIdentifier": string,
  "isEnabled": boolean,
  "isAsync": boolean,
  "hasJsonResult": boolean
}
Fields
name

string

Required. Name is the name of the action.
description

string

Optional. Description is the description of the action.
script

string

Optional. Script is the script of the action.
integrationIdentifier

string

Required. IntegrationIdentifier is the identifier of the integration.
scriptResultName

string

Optional. ScriptResultName is the name of the script result.
dynamicResultsMetadata[]

object (ApiDynamicResultMetadata)

Optional. DynamicResultsMetadata is a list of dynamic results metadata.
creator

string

Required. Creator is the creator of the action.
version

number

Required. Version is the version of the action.
id

string (int64 format)

Required. Id is the unique identifier of the action.
parameters[]

object (LegacyPlaybookApiActionParameter)

Optional. Parameters is a list of parameters for the action.
timeoutSeconds

string (int64 format)

Required. TimeoutSeconds is the timeout for the action in seconds.
asyncPollingIntervalInSeconds

string (int64 format)

Required. AsyncPollingIntervalInSeconds is the polling interval for async actions in seconds.
totalIntervalTimeoutForAsyncInSeconds

string (int64 format)

Required. TotalIntervalTimeoutForAsyncInSeconds is the total timeout for async actions in seconds.
defaultResultValue

string

Optional. DefaultResultValue is the default result value of the action.
integrationInstances[]

object (ApiIntegrationInstanceDataModel)

Optional. IntegrationInstances is a list of integration instances.
actionWidgetTemplateIdentifier

string

Optional. ActionWidgetTemplateIdentifier is the identifier of the action widget template.
isEnabled

boolean

Optional. IsEnabled indicates if the action is enabled.
isAsync

boolean

Optional. IsAsync indicates if the action is asynchronous.
hasJsonResult

boolean

Optional. HasJsonResult indicates if the action has a JSON result.

ApiDynamicResultMetadata

ApiDynamicResultMetadata represents metadata for a dynamic result.

JSON representation 
{
  "resultName": string,
  "resultExample": string
}
Fields
resultName

string

Required. ResultName is the name of the result.
resultExample

string

Optional. ResultExample is an example of the result.

LegacyPlaybookApiActionParameter

LegacyPlaybookApiActionParameter represents a parameter for an action.

JSON representation 
{
  "id": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "customActionId": string,
  "defaultValue": string,
  "description": string,
  "name": string,
  "value": string,
  "type": enum (ActionParameterType),
  "optionalValues": [
    string
  ],
  "isMandatory": boolean
}
Fields
id

string (int64 format)

Required. Id is the unique identifier of the parameter.
creationTimeUnixTimeInMs

string (int64 format)

Required. CreationTimeUnixTimeInMs is the creation time of the parameter. Represents DateTime CreationTimeUnixTimeInMs as unix time
modificationTimeUnixTimeInMs

string (int64 format)

Required. ModificationTimeUnixTimeInMs is the modification time of the parameter. Represents DateTime ModificationTimeUnixTimeInMs as unix time
customActionId

string (int64 format)

Required. CustomActionId is the identifier of the custom action.
defaultValue

string

Optional. DefaultValue is the default value of the parameter.
description

string

Optional. Description is the description of the parameter.
name

string

Required. Name is the name of the parameter.
value

string

Optional. Value is the value of the parameter.
type

enum (ActionParameterType)

Required. Type is the type of the parameter.
optionalValues[]

string

Optional. OptionalValues is a list of optional values for the parameter.
isMandatory

boolean

Required. IsMandatory indicates if the parameter is mandatory.

ActionParameterType

ActionParameterType represents the type of an action parameter.

Enums
ACTION_PARAMETER_TYPE_UNSPECIFIED The action parameter type is unspecified.
STRING The action parameter type is string.
BOOLEAN The action parameter type is boolean.
WFS_REPOSITORY The action parameter type is WFS repository.
USER_REPOSITORY The action parameter type is user repository.
STAGES_REPOSITORY The action parameter type is stages repository.
CLOSECASE_REASON_REPOSITORY The action parameter type is closecase reason repository.
CLOSECASE_ROOTCAUSE_REPOSITORY The action parameter type is closecase rootcause repository.
PRIORITIES_REPOSITORY The action parameter type is priorities repository.
EMAILCONTENT The action parameter type is email content.
CONTENT The action parameter type is content.
PASSWORD The action parameter type is password.
ENTITY_TYPE The action parameter type is entity type.
MULTIVALUES The action parameter type is multivalues.
LIST The action parameter type is list.
CODE The action parameter type is code.
TIMESPANSECONDS The action parameter type is timespanseconds.
MULTIPLECHOICEPARAMETER The action parameter type is multiplechoiceparameter.

ApiIntegrationInstanceDataModel

ApiIntegrationInstanceDataModel represents an integration instance.

JSON representation 
{
  "identifier": string,
  "integrationIdentifier": string,
  "environmentIdentifier": string,
  "instanceName": string,
  "instanceDescription": string,
  "isConfigured": boolean,
  "isRemote": boolean,
  "isSystemDefault": boolean
}
Fields
identifier

string

Required. Identifier is the unique identifier of the integration instance.
integrationIdentifier

string

Required. IntegrationIdentifier is the identifier of the integration.
environmentIdentifier

string

Required. EnvironmentIdentifier is the identifier of the environment.
instanceName

string

Required. InstanceName is the name of the instance.
instanceDescription

string

Optional. InstanceDescription is the description of the instance.
isConfigured

boolean

Optional. IsConfigured indicates if the instance is configured.
isRemote

boolean

Optional. IsRemote indicates if the instance is remote.
isSystemDefault

boolean

Optional. IsSystemDefault indicates if the instance is a system default.

ApiPendingStepInstanceDataModel

ApiPendingStepInstanceDataModel represents a pending step instance.

JSON representation 
{
  "casePriority": enum (CasePriorityValue),
  "alertPriority": enum (CasePriorityValue),
  "pendingStepTimeUnixTimeInMs": string,
  "pendingStepExpirationTimeUnixTimeInMs": string,
  "caseTitle": string,
  "alertName": string,
  "messageToAssignee": string,
  "slaExpiration": {
    object (LegacyPlaybookApiSlaExpiration)
  }
}
Fields
casePriority

enum (CasePriorityValue)

Optional. CasePriority is the priority of the case.
alertPriority

enum (CasePriorityValue)

Optional. AlertPriority is the priority of the alert.
pendingStepTimeUnixTimeInMs

string (int64 format)

Required. PendingStepTimeUnixTimeInMs is the time when the step became pending. Represents DateTime PendingStepTimeUnixTimeInMs as unix time
pendingStepExpirationTimeUnixTimeInMs

string (int64 format)

Optional. PendingStepExpirationTimeUnixTimeInMs is the expiration time of the pending step. Represents DateTime PendingStepExpirationTimeUnixTimeInMs as unix time
caseTitle

string

Optional. CaseTitle is the title of the case.
alertName

string

Optional. AlertName is the name of the alert.
messageToAssignee

string

Optional. MessageToAssignee is the message to the assignee.
slaExpiration

object (LegacyPlaybookApiSlaExpiration)

Required. SlaExpiration is the SLA expiration information.

CasePriorityValue

CasePriorityValue represents the priority of a case.

Enums
CASE_PRIORITY_VALUE_UNSPECIFIED The priority is unspecified.
UNCHANGED The priority is unchanged.
LOW The priority is low.
MEDIUM The priority is medium.
HIGH The priority is high.
CRITICAL The priority is critical.
INFORMATIVE The priority is informational.

LegacyPlaybookApiSlaExpiration

LegacyPlaybookApiSlaExpiration represents SLA expiration information.

JSON representation 
{
  "slaExpirationTime": string,
  "criticalExpirationTime": string,
  "expirationStatus": enum (SlaExpirationStatusValue)
}
Fields
slaExpirationTime

string (int64 format)

Optional. SlaExpirationTime is the SLA expiration time. Represents DateTime SlaExpirationTime as unix time
criticalExpirationTime

string (int64 format)

Optional. CriticalExpirationTime is the critical expiration time. Represents DateTime CriticalExpirationTime as unix time
expirationStatus

enum (SlaExpirationStatusValue)

Required. ExpirationStatus is the expiration status.

SlaExpirationStatusValue

SlaExpirationStatusValue represents the status of a SLA expiration.

Enums
SLA_EXPIRATION_STATUS_VALUE_UNSPECIFIED The SLA expiration status is unspecified.
PASSED_DUE The SLA expiration status is passed due.
OPEN_SLA The SLA expiration status is open.
NO_SLA The SLA expiration status is no SLA.
CRITICAL_EXPIRED The SLA expiration status is critical expired.
PAUSED The SLA expiration status is expired.