-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Nishu Goel
committed
Jun 12, 2024
1 parent
111d633
commit f148c13
Showing
10 changed files
with
1,088 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,323 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "epilot-workflow_workflow_definition Data Source - terraform-provider-epilot-workflow" | ||
| subcategory: "" | ||
| description: |- | ||
| WorkflowDefinition DataSource | ||
| --- | ||
|
|
||
| # epilot-workflow_workflow_definition (Data Source) | ||
|
|
||
| WorkflowDefinition DataSource | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| data "epilot-workflow_workflow_definition" "my_workflowdefinition" { | ||
| id = "7hj28a" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `id` (String) Short uuid (length 8) to identify the Workflow Definition. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `assigned_to` (List of String) | ||
| - `closing_reasons` (Attributes List) (see [below for nested schema](#nestedatt--closing_reasons)) | ||
| - `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](#nestedatt--dynamic_due_date)) | ||
| - `enable_ecp_workflow` (Boolean) Indicates whether this workflow is available for End Customer Portal or not. By default it's not. | ||
| - `flow` (Attributes List) (see [below for nested schema](#nestedatt--flow)) | ||
| - `last_update_time` (String) ISO String Date & Time | ||
| - `name` (String) | ||
| - `update_entity_attributes` (Attributes List) (see [below for nested schema](#nestedatt--update_entity_attributes)) | ||
| - `user_ids` (List of Number) This field is deprecated. Please use assignedTo | ||
|
|
||
| <a id="nestedatt--closing_reasons"></a> | ||
| ### Nested Schema for `closing_reasons` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--dynamic_due_date"></a> | ||
| ### Nested Schema for `dynamic_due_date` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `action_type_condition` (String) must be one of ["WORKFLOW_STARTED", "STEP_CLOSED"] | ||
| - `number_of_units` (Number) | ||
| - `step_id` (String) | ||
| - `time_period` (String) must be one of ["days", "weeks", "months"] | ||
|
|
||
|
|
||
| <a id="nestedatt--flow"></a> | ||
| ### Nested Schema for `flow` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `section` (Attributes) A group of Steps that define the progress of the Workflow (see [below for nested schema](#nestedatt--flow--section)) | ||
| - `step` (Attributes) Action that needs to be done in a Workflow (see [below for nested schema](#nestedatt--flow--step)) | ||
|
|
||
| <a id="nestedatt--flow--section"></a> | ||
| ### Nested Schema for `flow.section` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (String) | ||
| - `name` (String) | ||
| - `order` (Number) | ||
| - `steps` (Attributes List) (see [below for nested schema](#nestedatt--flow--section--steps)) | ||
| - `type` (String) must be one of ["STEP", "SECTION"] | ||
|
|
||
| <a id="nestedatt--flow--section--steps"></a> | ||
| ### Nested Schema for `flow.section.steps` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `assigned_to` (List of String) | ||
| - `automation_config` (Attributes) (see [below for nested schema](#nestedatt--flow--section--steps--automation_config)) | ||
| - `description` (Attributes) Longer information regarding Task (see [below for nested schema](#nestedatt--flow--section--steps--description)) | ||
| - `due_date` (String) | ||
| - `dynamic_due_date` (Attributes) set a Duedate for a step then a specific (see [below for nested schema](#nestedatt--flow--section--steps--dynamic_due_date)) | ||
| - `ecp` (Attributes) Details regarding ECP for the workflow step (see [below for nested schema](#nestedatt--flow--section--steps--ecp)) | ||
| - `execution_type` (String) must be one of ["MANUAL", "AUTOMATION"] | ||
| - `id` (String) | ||
| - `installer` (Attributes) Details regarding ECP for the workflow step (see [below for nested schema](#nestedatt--flow--section--steps--installer)) | ||
| - `journey` (Attributes) (see [below for nested schema](#nestedatt--flow--section--steps--journey)) | ||
| - `name` (String) | ||
| - `order` (Number) | ||
| - `requirements` (Attributes List) requirements that need to be fulfilled in order to enable the step execution (see [below for nested schema](#nestedatt--flow--section--steps--requirements)) | ||
| - `type` (String) must be one of ["STEP", "SECTION"] | ||
| - `user_ids` (List of Number) This field is deprecated. Please use assignedTo | ||
|
|
||
| <a id="nestedatt--flow--section--steps--automation_config"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `flow_id` (String) Id of the configured automation to run | ||
|
|
||
|
|
||
| <a id="nestedatt--flow--section--steps--description"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `enabled` (Boolean) | ||
| - `value` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--flow--section--steps--dynamic_due_date"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `action_type_condition` (String) must be one of ["WORKFLOW_STARTED", "STEP_CLOSED"] | ||
| - `number_of_units` (Number) | ||
| - `step_id` (String) | ||
| - `time_period` (String) must be one of ["days", "weeks", "months"] | ||
|
|
||
|
|
||
| <a id="nestedatt--flow--section--steps--ecp"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `description` (String) | ||
| - `enabled` (Boolean) | ||
| - `journey` (Attributes) (see [below for nested schema](#nestedatt--flow--section--steps--user_ids--journey)) | ||
| - `label` (String) | ||
|
|
||
| <a id="nestedatt--flow--section--steps--user_ids--journey"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids.journey` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (String) | ||
| - `journey_id` (String) | ||
| - `name` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--flow--section--steps--installer"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `description` (String) | ||
| - `enabled` (Boolean) | ||
| - `journey` (Attributes) (see [below for nested schema](#nestedatt--flow--section--steps--user_ids--journey)) | ||
| - `label` (String) | ||
|
|
||
| <a id="nestedatt--flow--section--steps--user_ids--journey"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids.journey` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (String) | ||
| - `journey_id` (String) | ||
| - `name` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--flow--section--steps--journey"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (String) | ||
| - `journey_id` (String) | ||
| - `name` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--flow--section--steps--requirements"></a> | ||
| ### Nested Schema for `flow.section.steps.user_ids` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `condition` (String) must be one of ["CLOSED"] | ||
| - `definition_id` (String) | ||
| - `type` (String) must be one of ["STEP", "SECTION"] | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--flow--step"></a> | ||
| ### Nested Schema for `flow.step` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `assigned_to` (List of String) | ||
| - `automation_config` (Attributes) (see [below for nested schema](#nestedatt--flow--step--automation_config)) | ||
| - `description` (Attributes) Longer information regarding Task (see [below for nested schema](#nestedatt--flow--step--description)) | ||
| - `due_date` (String) | ||
| - `dynamic_due_date` (Attributes) set a Duedate for a step then a specific (see [below for nested schema](#nestedatt--flow--step--dynamic_due_date)) | ||
| - `ecp` (Attributes) Details regarding ECP for the workflow step (see [below for nested schema](#nestedatt--flow--step--ecp)) | ||
| - `execution_type` (String) must be one of ["MANUAL", "AUTOMATION"] | ||
| - `id` (String) | ||
| - `installer` (Attributes) Details regarding ECP for the workflow step (see [below for nested schema](#nestedatt--flow--step--installer)) | ||
| - `journey` (Attributes) (see [below for nested schema](#nestedatt--flow--step--journey)) | ||
| - `name` (String) | ||
| - `order` (Number) | ||
| - `requirements` (Attributes List) requirements that need to be fulfilled in order to enable the step execution (see [below for nested schema](#nestedatt--flow--step--requirements)) | ||
| - `type` (String) must be one of ["STEP", "SECTION"] | ||
| - `user_ids` (List of Number) This field is deprecated. Please use assignedTo | ||
|
|
||
| <a id="nestedatt--flow--step--automation_config"></a> | ||
| ### Nested Schema for `flow.step.automation_config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `flow_id` (String) Id of the configured automation to run | ||
|
|
||
|
|
||
| <a id="nestedatt--flow--step--description"></a> | ||
| ### Nested Schema for `flow.step.description` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `enabled` (Boolean) | ||
| - `value` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--flow--step--dynamic_due_date"></a> | ||
| ### Nested Schema for `flow.step.dynamic_due_date` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `action_type_condition` (String) must be one of ["WORKFLOW_STARTED", "STEP_CLOSED"] | ||
| - `number_of_units` (Number) | ||
| - `step_id` (String) | ||
| - `time_period` (String) must be one of ["days", "weeks", "months"] | ||
|
|
||
|
|
||
| <a id="nestedatt--flow--step--ecp"></a> | ||
| ### Nested Schema for `flow.step.ecp` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `description` (String) | ||
| - `enabled` (Boolean) | ||
| - `journey` (Attributes) (see [below for nested schema](#nestedatt--flow--step--ecp--journey)) | ||
| - `label` (String) | ||
|
|
||
| <a id="nestedatt--flow--step--ecp--journey"></a> | ||
| ### Nested Schema for `flow.step.ecp.label` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (String) | ||
| - `journey_id` (String) | ||
| - `name` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--flow--step--installer"></a> | ||
| ### Nested Schema for `flow.step.installer` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `description` (String) | ||
| - `enabled` (Boolean) | ||
| - `journey` (Attributes) (see [below for nested schema](#nestedatt--flow--step--installer--journey)) | ||
| - `label` (String) | ||
|
|
||
| <a id="nestedatt--flow--step--installer--journey"></a> | ||
| ### Nested Schema for `flow.step.installer.label` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (String) | ||
| - `journey_id` (String) | ||
| - `name` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--flow--step--journey"></a> | ||
| ### Nested Schema for `flow.step.journey` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `id` (String) | ||
| - `journey_id` (String) | ||
| - `name` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--flow--step--requirements"></a> | ||
| ### Nested Schema for `flow.step.requirements` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `condition` (String) must be one of ["CLOSED"] | ||
| - `definition_id` (String) | ||
| - `type` (String) must be one of ["STEP", "SECTION"] | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--update_entity_attributes"></a> | ||
| ### Nested Schema for `update_entity_attributes` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `source` (String) must be one of ["workflow_status", "current_section", "current_step"] | ||
| - `target` (Attributes) (see [below for nested schema](#nestedatt--update_entity_attributes--target)) | ||
|
|
||
| <a id="nestedatt--update_entity_attributes--target"></a> | ||
| ### Nested Schema for `update_entity_attributes.target` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `entity_attribute` (String) | ||
| - `entity_schema` (String) | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.