- JSON representation
- WorkflowStepInstanceTypeValue
- WorkflowStepInstanceStatusValue
- LegacyPlaybookScriptResultEntityData
- ApiActionDefinitionDataModel
- ApiDynamicResultMetadata
- LegacyPlaybookApiActionParameter
- ActionParameterType
- ApiIntegrationInstanceDataModel
- ApiPendingStepInstanceDataModel
- CasePriorityValue
- LegacyPlaybookApiSlaExpiration
- SlaExpirationStatusValue
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 ( |
Fields | |
---|---|
identifier
|
Required. Identifier is the unique identifier of the step. |
originalStepIdentifier
|
Required. OriginalStepIdentifier is the original identifier of the step. |
creationTimeUnixTimeInMs
|
Required. CreationTimeUnixTimeInMs is the creation time of the step. Represents DateTime CreationTimeUnixTimeInMs as unix time |
modificationTimeUnixTimeInMs
|
Required. ModificationTimeUnixTimeInMs is the modification time of the step. Represents DateTime ModificationTimeUnixTimeInMs as unix time |
instanceName
|
Required. InstanceName is the name of the instance. |
name
|
Required. Name is the name of the step. |
integration
|
Required. Integration is the integration of the step. |
description
|
Required. Description is the description of the step. |
actionProvider
|
Required. ActionProvider is the provider of the action. |
actionName
|
Required. ActionName is the name of the action. |
type
|
Required. Type is the type of the step. |
parameters[]
|
Optional. Parameters is a list of parameters for the step. |
workflowIdentifier
|
Required. WorkflowIdentifier is the identifier of the workflow. |
parentWorkflowIdentifier
|
Optional. ParentWorkflowIdentifier is the identifier of the parent workflow. |
workflowInstanceIdentifier
|
Required. WorkflowInstanceIdentifier is the identifier of the workflow instance. |
caseId
|
Required. CaseId is the identifier of the case. |
indicatorIdentifier
|
Optional. IndicatorIdentifier is the identifier of the indicator. |
alertGroupIdentifier
|
Optional. AlertGroupIdentifier is the identifier of the alert group. |
status
|
Required. Status is the status of the step. |
executingUser
|
Optional. ExecutingUser is the user executing the step. |
resultValue
|
Optional. ResultValue is the result value of the step. |
results[]
|
Optional. Results is a list of script results. |
targetEntities[]
|
Optional. TargetEntities is a list of target entities. |
resultEntities[]
|
Optional. ResultEntities is a list of result entities. |
properties
|
Optional. Properties is a map of properties for the step. An object containing a list of |
actionDef
|
Optional. ActionDef is the action definition. |
blockStepId
|
Optional. BlockStepId is the identifier of the block step. |
jsonResultObject
|
Optional. JsonResultObject is the JSON result object. |
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. |
pendingStepProperties
|
Optional. PendingStepProperties is the pending step properties. |
stepInstanceIdentifier
|
Output only. StepInstanceIdentifier is the combined identifier of the step instance. |
loopIteration
|
Optional. LoopIteration is the current loop iteration. |
startLoopStepIdentifier
|
Optional. StartLoopStepIdentifier is the identifier of the start loop step. |
parentWorkflowLoopIteration
|
Optional. ParentWorkflowLoopIteration is the loop iteration of the parent workflow. |
loopName
|
Optional. LoopName is the name of the loop. |
isAutomatic
|
Optional. IsAutomatic indicates if the step is automatic. |
isSkippable
|
Optional. IsSkippable indicates if the step is skippable. |
autoSkipOnFailure
|
Optional. AutoSkipOnFailure indicates if the step should be skipped on failure. |
isDebugMockData
|
Optional. IsDebugMockData indicates if debug mock data is enabled for the step. |
allowedToExecute
|
Optional. AllowedToExecute indicates if the user is allowed to execute the step. |
resultCode
|
Optional. ResultCode is the result code of the step. |
skipComment
|
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
|
Optional. Title is the title of the script result. |
type
|
Optional. Type is the type of the script result. |
csvLines[]
|
Optional. CSVLines is a list of CSV lines. |
attachments
|
Optional. Attachments is a map of attachments. An object containing a list of |
htmls
|
Optional. Htmls is a map of HTML content. An object containing a list of |
links[]
|
Optional. Links is a list of links. |
content
|
Optional. Content is the content of the script result. |
rawJson
|
Optional. RawJson is the raw JSON of the script result. |
entity
|
Optional. Entity is the entity associated with the script result. |
isForEntity
|
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 ( |
Fields | |
---|---|
name
|
Required. Name is the name of the action. |
description
|
Optional. Description is the description of the action. |
script
|
Optional. Script is the script of the action. |
integrationIdentifier
|
Required. IntegrationIdentifier is the identifier of the integration. |
scriptResultName
|
Optional. ScriptResultName is the name of the script result. |
dynamicResultsMetadata[]
|
Optional. DynamicResultsMetadata is a list of dynamic results metadata. |
creator
|
Required. Creator is the creator of the action. |
version
|
Required. Version is the version of the action. |
id
|
Required. Id is the unique identifier of the action. |
parameters[]
|
Optional. Parameters is a list of parameters for the action. |
timeoutSeconds
|
Required. TimeoutSeconds is the timeout for the action in seconds. |
asyncPollingIntervalInSeconds
|
Required. AsyncPollingIntervalInSeconds is the polling interval for async actions in seconds. |
totalIntervalTimeoutForAsyncInSeconds
|
Required. TotalIntervalTimeoutForAsyncInSeconds is the total timeout for async actions in seconds. |
defaultResultValue
|
Optional. DefaultResultValue is the default result value of the action. |
integrationInstances[]
|
Optional. IntegrationInstances is a list of integration instances. |
actionWidgetTemplateIdentifier
|
Optional. ActionWidgetTemplateIdentifier is the identifier of the action widget template. |
isEnabled
|
Optional. IsEnabled indicates if the action is enabled. |
isAsync
|
Optional. IsAsync indicates if the action is asynchronous. |
hasJsonResult
|
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
|
Required. ResultName is the name of the result. |
resultExample
|
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 (
|
Fields | |
---|---|
id
|
Required. Id is the unique identifier of the parameter. |
creationTimeUnixTimeInMs
|
Required. CreationTimeUnixTimeInMs is the creation time of the parameter. Represents DateTime CreationTimeUnixTimeInMs as unix time |
modificationTimeUnixTimeInMs
|
Required. ModificationTimeUnixTimeInMs is the modification time of the parameter. Represents DateTime ModificationTimeUnixTimeInMs as unix time |
customActionId
|
Required. CustomActionId is the identifier of the custom action. |
defaultValue
|
Optional. DefaultValue is the default value of the parameter. |
description
|
Optional. Description is the description of the parameter. |
name
|
Required. Name is the name of the parameter. |
value
|
Optional. Value is the value of the parameter. |
type
|
Required. Type is the type of the parameter. |
optionalValues[]
|
Optional. OptionalValues is a list of optional values for the parameter. |
isMandatory
|
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
|
Required. Identifier is the unique identifier of the integration instance. |
integrationIdentifier
|
Required. IntegrationIdentifier is the identifier of the integration. |
environmentIdentifier
|
Required. EnvironmentIdentifier is the identifier of the environment. |
instanceName
|
Required. InstanceName is the name of the instance. |
instanceDescription
|
Optional. InstanceDescription is the description of the instance. |
isConfigured
|
Optional. IsConfigured indicates if the instance is configured. |
isRemote
|
Optional. IsRemote indicates if the instance is remote. |
isSystemDefault
|
Optional. IsSystemDefault indicates if the instance is a system default. |
ApiPendingStepInstanceDataModel
ApiPendingStepInstanceDataModel represents a pending step instance.
JSON representation |
---|
{ "casePriority" : enum ( |
Fields | |
---|---|
casePriority
|
Optional. CasePriority is the priority of the case. |
alertPriority
|
Optional. AlertPriority is the priority of the alert. |
pendingStepTimeUnixTimeInMs
|
Required. PendingStepTimeUnixTimeInMs is the time when the step became pending. Represents DateTime PendingStepTimeUnixTimeInMs as unix time |
pendingStepExpirationTimeUnixTimeInMs
|
Optional. PendingStepExpirationTimeUnixTimeInMs is the expiration time of the pending step. Represents DateTime PendingStepExpirationTimeUnixTimeInMs as unix time |
caseTitle
|
Optional. CaseTitle is the title of the case. |
alertName
|
Optional. AlertName is the name of the alert. |
slaExpiration
|
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 (
|
Fields | |
---|---|
slaExpirationTime
|
Optional. SlaExpirationTime is the SLA expiration time. Represents DateTime SlaExpirationTime as unix time |
criticalExpirationTime
|
Optional. CriticalExpirationTime is the critical expiration time. Represents DateTime CriticalExpirationTime as unix time |
expirationStatus
|
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. |