Skip to content

workflow_definition.md

Latest commit

 

History

History
145 lines (114 loc) · 4.27 KB

workflow_definition.md

File metadata and controls

145 lines (114 loc) · 4.27 KB
page_title epilot-workflow_workflow_definition Resource - terraform-provider-epilot-workflow
subcategory
description WorkflowDefinition Resource

epilot-workflow_workflow_definition (Resource)

WorkflowDefinition Resource

Example Usage

resource "epilot-workflow_workflow_definition" "my_workflowdefinition" {
  assigned_to = [
    "..."
  ]
  closing_reasons = [
    {
      id = "x739cew"
    }
  ]
  creation_time = "2021-04-27T12:01:13.000Z"
  description   = "...my_description..."
  due_date      = "2021-04-27T12:00:00.000Z"
  dynamic_due_date = {
    action_type_condition = "PHASE_FINISHED"
    number_of_units       = 0.36
    phase_id              = "...my_phase_id..."
    step_id               = "...my_step_id..."
    time_period           = "days"
  }
  enable_ecp_workflow = false
  enabled             = false
  flow                = "{ \"see\": \"documentation\" }"
  id                  = "...my_id..."
  last_update_time    = "2021-04-27T12:01:13.000Z"
  manifest = [
    "..."
  ]
  name                            = "...my_name..."
  single_closing_reason_selection = false
  taxonomies = [
    "..."
  ]
  update_entity_attributes = [
    {
      source = "current_step"
      target = {
        entity_attribute = "my_status"
        entity_schema    = "opportunity"
      }
    }
  ]
  user_ids = [
    5.93
  ]
}

Schema

Required

  • flow (String) Parsed as JSON.
  • name (String)

Optional

  • assigned_to (List of String)
  • closing_reasons (Attributes List) (see below for nested schema)
  • creation_time (String) ISO String Date & Time
  • description (String)
  • due_date (String)
  • dynamic_due_date (Attributes) set a Duedate for a step then a specific (see below for nested schema)
  • enable_ecp_workflow (Boolean) Indicates whether this workflow is available for End Customer Portal or not. By default it's not.
  • enabled (Boolean) Whether the workflow is enabled or not. Default: true
  • last_update_time (String) ISO String Date & Time
  • manifest (List of String) The manifest IDs associated with this workflow
  • single_closing_reason_selection (Boolean) Whether only a single closing reason can be selected
  • taxonomies (List of String) Taxonomy ids that are associated with this workflow and used for filtering
  • update_entity_attributes (Attributes List) (see below for nested schema)
  • user_ids (List of Number, Deprecated) This field is deprecated. Please use assignedTo

Read-Only

  • id (String) The ID of this resource.

Nested Schema for closing_reasons

Optional:

  • id (String) Not Null

Nested Schema for dynamic_due_date

Optional:

  • action_type_condition (String) Not Null; must be one of ["WORKFLOW_STARTED", "STEP_CLOSED", "PHASE_FINISHED"]
  • number_of_units (Number) Not Null
  • phase_id (String)
  • step_id (String)
  • time_period (String) Not Null; must be one of ["minutes", "hours", "days", "weeks", "months"]

Nested Schema for update_entity_attributes

Optional:

  • source (String) Not Null; must be one of ["workflow_status", "current_section", "current_step"]
  • target (Attributes) Not Null (see below for nested schema)

Nested Schema for update_entity_attributes.target

Optional:

  • entity_attribute (String) Not Null
  • entity_schema (String) Not Null

Import

Import is supported using the following syntax:

In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

import {
  to = epilot-workflow_workflow_definition.my_epilot-workflow_workflow_definition
  id = "..."
}

The terraform import command can be used, for example:

terraform import epilot-workflow_workflow_definition.my_epilot-workflow_workflow_definition "..."