WorkflowApiDTO

Description

Model to describe a Workflow

Required Parameters

discoveredBy
  • description: Target that discovered this workflow

  • reference: TargetApiDTO

type
  • type: string

  • description: The type of this workflow

  • enum: ['UCSD', 'ACTION_SCRIPT', 'SERVICENOW', 'ACTIONSTREAM_KAFKA', 'WEBHOOK']

Optional Parameters

uuid
  • type: string

displayName
  • type: string

  • description: A user readable name of the api object. Cannot be blank. The UTF-8 encoding must be at most 255 bytes.

className
  • type: string

description
  • type: string

  • description: Description of the workflow

entityType
  • type: string

  • description: Type of the entity associated

actionType
  • type: string

  • description: Type of the action associated

parameters
  • type: array

  • description: Input parameters for the workflow

scriptPath
  • type: string

  • description: Full path to workflow script (e.g. path to an ActionScript executable

actionPhase
  • type: string

  • description: Action Phase to which workflow applies

timeLimitSeconds
  • type: integer

  • format: int64

  • description: Time limit for workflow execution, in seconds

typeSpecificDetails
  • description: The information about this workflow that is specific to its type.

  • reference: WorkflowAspect

creationTime
  • type: string

  • description: The creationTime is the time in ISO-8601 format when the workflow was originally created.

lastModifiedTime
  • type: string

  • description: The lastModifiedTime is the time in ISO-8601 format when the workflow was last modified.