Enviance Workflow API
The Workflow API from Enviance — 18 operation(s) for workflow.
OpenAPI Specification
swagger: '2.0'
info:
version: Platform.v2026.2.0.0.20260708
title: Rest Activity Workflow API
description: EMS Rest API
contact:
name: Cority
email: support@cority.com
url: https://cority.com
tags:
- name: Workflow
paths:
/ver2/WorkflowService.svc/workflows:
post:
tags:
- Workflow
description: "\n\n\nenvianceSdk.workflows.createWorkflows\r\n```\r\n[\r\n [\r\n {\r\n \"workflowTypeName\": \"workflow Type Name\",\r\n \"name\": \"workflow name 1\",\r\n \"uniqueId\": \"uniqueId - 0000-1-1\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"dueDate\": \"2013-02-07T00:00:00\",\r\n \"comment\": \"my comment\",\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n \"Folder1Document1.txt\",\r\n \"Folder1Document2.txt\"\r\n ]\r\n },\r\n {\r\n \"workflowTypeName\": \"workflow Type Name\",\r\n \"name\": \"workflow name 2\",\r\n \"uniqueId\": \"uniqueId - 0000-1-2\",\r\n \"dueDate\": \"2013-02-07T00:00:00\",\r\n \"comment\": \"my comment\",\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n \"Folder1Document1.txt\",\r\n \"Folder1Document2.txt\"\r\n ]\r\n }\r\n ],\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.createWorkflows21\r\n```\r\n[\r\n [\r\n {\r\n \"workflowTypeName\": \"workflow Type Name\",\r\n \"name\": \"workflow name 1\",\r\n \"uniqueId\": \"uniqueId - 0000-1-1\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"dueDate\": \"2013-02-07T00:00:00\",\r\n \"comment\": \"my comment\",\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n {\r\n \"documentIdOrPath\": \"Folder1Document1.txt\"\r\n },\r\n {\r\n \"documentIdOrPath\": \"Folder1Document2.txt\",\r\n \"customFieldIdOrName\": \"udf-textbox-numeric\"\r\n }\r\n ]\r\n },\r\n {\r\n \"workflowTypeName\": \"workflow Type Name\",\r\n \"name\": \"workflow name 2\",\r\n \"uniqueId\": \"uniqueId - 0000-1-2\",\r\n \"dueDate\": \"2013-02-07T00:00:00\",\r\n \"comment\": \"my comment\",\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n {\r\n \"documentIdOrPath\": \"Folder1Document1.txt\"\r\n },\r\n {\r\n \"documentIdOrPath\": \"Folder1Document2.txt\",\r\n \"customFieldIdOrName\": \"udf-textbox-numeric\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.createWorkflow\r\n```\r\n[\r\n {\r\n \"workflowTypeName\": \"workflow Type Name\",\r\n \"name\": \"workflow name 1\",\r\n \"uniqueId\": \"uniqueId - 0000-1-1\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"dueDate\": \"2013-02-07T00:00:00\",\r\n \"comment\": \"my comment\",\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n \"Folder1Document1.txt\",\r\n \"Folder1Document2.txt\"\r\n ]\r\n },\r\n null,\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.createWorkflowExt\r\n```\r\n[\r\n {\r\n \"workflowInfo\": {\r\n \"workflowTypeName\": \"workflow Type Name\",\r\n \"name\": \"workflow name 1\",\r\n \"uniqueId\": \"uniqueId - 0000-1-1\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"dueDate\": \"2013-02-07T00:00:00\",\r\n \"comment\": \"my comment\",\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n \"Folder1Document1.txt\",\r\n \"Folder1Document2.txt\"\r\n ]\r\n },\r\n \"initStepInfo\": null,\r\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE59F\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.createWorkflow21\r\n```\r\n[\r\n {\r\n \"workflowTypeName\": \"workflow Type Name\",\r\n \"name\": \"workflow name 1\",\r\n \"uniqueId\": \"uniqueId - 0000-1-1\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"dueDate\": \"2013-02-07T00:00:00\",\r\n \"comment\": \"my comment\",\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n {\r\n \"documentIdOrPath\": \"Folder1Document1.txt\"\r\n },\r\n {\r\n \"documentIdOrPath\": \"Folder1Document2.txt\",\r\n \"customFieldIdOrName\": \"udf-textbox-numeric\"\r\n }\r\n ]\r\n },\r\n null,\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.createWorkflow21Ext\r\n```\r\n[\r\n {\r\n \"workflowInfo\": {\r\n \"workflowTypeName\": \"workflow Type Name\",\r\n \"name\": \"workflow name 1\",\r\n \"uniqueId\": \"uniqueId - 0000-1-1\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"dueDate\": \"2013-02-07T00:00:00\",\r\n \"comment\": \"my comment\",\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n {\r\n \"documentIdOrPath\": \"Folder1Document1.txt\"\r\n },\r\n {\r\n \"documentIdOrPath\": \"Folder1Document2.txt\",\r\n \"customFieldIdOrName\": \"udf-textbox-numeric\"\r\n }\r\n ]\r\n },\r\n \"initStepInfo\": null,\r\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE59F\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.createWorkflowType\r\n```\r\n[\r\n {\r\n \"name\": \"Workflow Type\",\r\n \"workflowSteps\": [\r\n {\r\n \"name\": \"Step1\",\r\n \"status\": \"Step1\",\r\n \"formTemplate\": {\r\n \"name\": \"FT-1\"\r\n },\r\n \"assignedRole\": \"R-1\",\r\n \"stepActions\": [\r\n {\r\n \"name\": \"Go to Step2\",\r\n \"destinationStep\": {\r\n \"name\": \"Step2\"\r\n },\r\n \"allowedRoles\": [\r\n \"R-1\"\r\n ]\r\n },\r\n {\r\n \"name\": \"Go to Step3\",\r\n \"destinationStep\": {\r\n \"name\": \"Step3\"\r\n },\r\n \"allowedRoles\": [\r\n \"R-3\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"Step2\",\r\n \"status\": \"Step2\",\r\n \"formTemplate\": {\r\n \"name\": \"FT-2\"\r\n },\r\n \"assignedRole\": \"R-2\",\r\n \"stepActions\": [\r\n {\r\n \"name\": \"Go to Step3\",\r\n \"destinationStep\": {\r\n \"name\": \"Step3\"\r\n },\r\n \"allowedRoles\": [\r\n \"R-2\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"Step3\",\r\n \"status\": \"Step3\",\r\n \"formTemplate\": {\r\n \"name\": \"FT-3\"\r\n },\r\n \"assignedRole\": \"R-3\",\r\n \"stepActions\": [\r\n {\r\n \"name\": \"Go to Step1\",\r\n \"destinationStep\": {\r\n \"name\": \"Step1\"\r\n },\r\n \"allowedRoles\": [\r\n \"R-1\",\r\n \"R-2\",\r\n \"R-3\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"localFields\": [\r\n \"Calculated Numeric\"\r\n ],\r\n \"workflowPermissions\": [\r\n {\r\n \"role\": \"R-1\",\r\n \"flags\": [\r\n \"FullAccess\",\r\n \"AllFormFieldAccess\"\r\n ]\r\n },\r\n {\r\n \"role\": \"R-2\",\r\n \"flags\": [\r\n \"ViewAllFormFields\",\r\n \"SetWorkflowID\",\r\n \"Close\",\r\n \"Reopen\",\r\n \"Delete\",\r\n \"Rename\",\r\n \"Assign\",\r\n \"Schedule\"\r\n ]\r\n },\r\n {\r\n \"role\": \"R-3\",\r\n \"flags\": [\r\n \"OverrideAllFormFields\",\r\n \"Open\",\r\n \"Report\",\r\n \"SetWorkflowID\",\r\n \"CompleteUnderlyingTask\",\r\n \"ViewUnderlyingTask\"\r\n ]\r\n }\r\n ],\r\n \"stepPermissions\": [\r\n {\r\n \"role\": \"R-1\",\r\n \"steps\": [\r\n {\r\n \"step\": \"Step1\",\r\n \"allGlobal\": \"Edit\",\r\n \"allLocal\": \"View\"\r\n },\r\n {\r\n \"step\": \"Step2\",\r\n \"allGlobal\": \"View\",\r\n \"allLocal\": \"Edit\"\r\n },\r\n {\r\n \"step\": \"Step3\",\r\n \"allGlobal\": \"Override\",\r\n \"allLocal\": \"Override\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.createWorkflowRole\r\n```\r\n[\r\n {\r\n \"name\": \"WorkflowRole1\",\r\n \"description\": \"Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo\",\r\n \"defaultMembers\": {\r\n \"userIdsOrNames\": [\r\n \"user1\"\r\n ],\r\n \"groupIdsOrNames\": [\r\n \"group1\"\r\n ]\r\n }\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.createWorkflowRoleAsync\r\n```\r\n[\r\n {\r\n \"name\": \"WorkflowRole1\",\r\n \"description\": \"Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo\",\r\n \"defaultMembers\": {\r\n \"userIdsOrNames\": [\r\n \"user1\"\r\n ],\r\n \"groupIdsOrNames\": [\r\n \"group1\"\r\n ]\r\n }\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n\n"
operationId: Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.CreateWorkflow
consumes:
- application/json
- application/xml
produces:
- application/json
- application/xml
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
type: string
- name: CreateWorkflowWrapper
in: body
required: true
schema:
$ref: '#/definitions/CreateWorkflow'
responses:
default:
description: not available
schema:
type: string
format: guid
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}:
get:
tags:
- Workflow
description: "\n\n\nenvianceSdk.workflows.getWorkflow\r\n```\r\n[\r\n \"B5E7E7A4-D294-4D7C-ABC9-008EDBE97346\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.getWorkflow21\r\n```\r\n[\r\n \"B5E7E7A4-D294-4D7C-ABC9-008EDBE97346\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.getWorkflowStep\r\n```\r\n[\r\n \"B5E7E7A4-D294-4D7C-ABC9-008EDBE97346\",\r\n \"Step1\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.getWorkflowStepBulk\r\n```\r\n[\r\n [\r\n {\r\n \"workflowIdOrUniqueId\": \"10ec54b9-a8b0-45a6-a9d7-7a0c0c962725\",\r\n \"stepIdsOrNames\": [\r\n \"WFStep1\"\r\n ]\r\n },\r\n {\r\n \"workflowIdOrUniqueId\": \"2017.03.23.11.2F39C8EC9325\",\r\n \"stepIdsOrNames\": [\r\n \"337989bf-832e-4e1f-8034-3b4327d52542\"\r\n ]\r\n }\r\n ],\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.getWorkflowCurrentStep\r\n```\r\n[\r\n \"B5E7E7A4-D294-4D7C-ABC9-008EDBE97346\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.getWorkflowCurrentStepBulk\r\n```\r\n[\r\n [\r\n \"10ec54b9-a8b0-45a6-a9d7-7a0c0c962725\",\r\n \"2017.03.23.11.2F39C8EC9325\"\r\n ],\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.getWorkflowType\r\n```\r\n[\r\n \"workflowTypeIdOrName\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.getWorkflowTypeVersion\r\n```\r\n[\r\n \"workflowTypeIdOrName\",\r\n \"versionNumber\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.getWorkflowRole\r\n```\r\n[\r\n \"276067c5-1316-433d-9943-86475ed8fed4\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n\n"
operationId: Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetWorkflow
consumes:
- application/json
- application/xml
produces:
- application/json
- application/xml
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
type: string
- name: workflowIdOrUniqueId
in: path
required: true
type: string
responses:
default:
description: not available
schema:
$ref: '#/definitions/Enviance.RestServices.Ver2.Workflows.WorkflowInfo'
patch:
tags:
- Workflow
description: "\n\n\nenvianceSdk.workflows.updateWorkflowStep\r\n```\r\n[\r\n \"22cf40b5-b001-47ce-8853-020dc9e9aa8e\",\r\n \"Oleg FT Step1\",\r\n {\r\n \"comment\": \"my comment\",\r\n \"transition\": {\r\n \"dueDate\": \"2013-02-15T00:00:00\",\r\n \"stepActionName\": \"Oleg FT Step1 Action1\",\r\n \"assignTo\": [\r\n {\r\n \"userIdOrName\": \"oleg\"\r\n },\r\n {\r\n \"userIdOrName\": \"vitek\"\r\n },\r\n {\r\n \"groupIdOrName\": \"Administrators\"\r\n },\r\n {\r\n \"groupIdOrName\": \"BL Group\"\r\n }\r\n ]\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"Oleg FT 1 = dt date\",\r\n \"values\": [\r\n \"2013-02-01T00:00:00\"\r\n ]\r\n },\r\n {\r\n \"name\": \"Oleg FT 1 = url\",\r\n \"urlItems\": [\r\n {\r\n \"label\": \"may label\",\r\n \"url\": \"http://mail.ru\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"oleg FT 1 = num ddl linked 2\",\r\n \"values\": [\r\n \"100\",\r\n \"100\"\r\n ]\r\n },\r\n {\r\n \"name\": \"oleg FT 1 = text multi\",\r\n \"values\": [\r\n \"val1\",\r\n \"val3\"\r\n ]\r\n }\r\n ]\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflowStepExt\r\n```\r\n[\r\n {\r\n \"workflowIdOrUniqueId\": \"22cf40b5-b001-47ce-8853-020dc9e9aa8e\",\r\n \"stepIdOrName\": \"Oleg FT Step1\",\r\n \"stepInfo\": {\r\n \"comment\": \"my comment\",\r\n \"transition\": {\r\n \"dueDate\": \"2013-02-15T00:00:00\",\r\n \"stepActionName\": \"Oleg FT Step1 Action1\",\r\n \"assignTo\": [\r\n {\r\n \"userIdOrName\": \"oleg\"\r\n },\r\n {\r\n \"userIdOrName\": \"vitek\"\r\n },\r\n {\r\n \"groupIdOrName\": \"Administrators\"\r\n },\r\n {\r\n \"groupIdOrName\": \"BL Group\"\r\n }\r\n ]\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"Oleg FT 1 = dt date\",\r\n \"values\": [\r\n \"2013-02-01T00:00:00\"\r\n ]\r\n },\r\n {\r\n \"name\": \"Oleg FT 1 = url\",\r\n \"urlItems\": [\r\n {\r\n \"label\": \"may label\",\r\n \"url\": \"http://mail.ru\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"oleg FT 1 = num ddl linked 2\",\r\n \"values\": [\r\n \"100\",\r\n \"100\"\r\n ]\r\n },\r\n {\r\n \"name\": \"oleg FT 1 = text multi\",\r\n \"values\": [\r\n \"val1\",\r\n \"val3\"\r\n ]\r\n }\r\n ]\r\n },\r\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE59E\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflowCurrentStep\r\n```\r\n[\r\n \"22cf40b5-b001-47ce-8853-020dc9e9aa8e\",\r\n {\r\n \"comment\": \"my comment\",\r\n \"transition\": {\r\n \"dueDate\": \"2013-02-15T00:00:00\",\r\n \"stepActionName\": \"Oleg FT Step1 Action1\",\r\n \"assignTo\": [\r\n {\r\n \"userIdOrName\": \"oleg\"\r\n },\r\n {\r\n \"userIdOrName\": \"vitek\"\r\n },\r\n {\r\n \"groupIdOrName\": \"Administrators\"\r\n },\r\n {\r\n \"groupIdOrName\": \"BL Group\"\r\n }\r\n ]\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"Oleg FT 1 = dt date\",\r\n \"values\": [\r\n \"2013-02-01T00:00:00\"\r\n ]\r\n },\r\n {\r\n \"name\": \"Oleg FT 1 = url\",\r\n \"urlItems\": [\r\n {\r\n \"label\": \"may label\",\r\n \"url\": \"http://mail.ru\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"oleg FT 1 = num ddl linked 2\",\r\n \"values\": [\r\n \"100\",\r\n \"100\"\r\n ]\r\n },\r\n {\r\n \"name\": \"oleg FT 1 = text multi\",\r\n \"values\": [\r\n \"val1\",\r\n \"val3\"\r\n ]\r\n }\r\n ]\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflowCurrentStepExt\r\n```\r\n[\r\n {\r\n \"workflowIdOrUniqueId\": \"a4f13c99-5c2c-46dc-bbff-4aea388ef3ca\",\r\n \"stepInfo\": {\r\n \"comment\": \"my comment\",\r\n \"transition\": {\r\n \"stepActionName\": \"go to step 2\",\r\n \"assignTo\": [\r\n {\r\n \"userIdOrName\": \"oleg\"\r\n },\r\n {\r\n \"userIdOrName\": \"vitek\"\r\n },\r\n {\r\n \"groupIdOrName\": \"Administrators\"\r\n },\r\n {\r\n \"groupIdOrName\": \"BL Group\"\r\n }\r\n ]\r\n },\r\n \"fields\": [\r\n {\r\n \"name\": \"Date\",\r\n \"values\": [\r\n \"2013-02-01T00:00:00\"\r\n ]\r\n },\r\n {\r\n \"name\": \"CitationHyperlink\",\r\n \"urlItems\": [\r\n {\r\n \"label\": \"may label\",\r\n \"url\": \"http://test.com\"\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"NumberDDL linked\",\r\n \"values\": [\r\n \"1.23456E-05\",\r\n \"1.23456E-05\"\r\n ]\r\n },\r\n {\r\n \"name\": \"Text(MSLB)\",\r\n \"values\": [\r\n \"test1\",\r\n \"test2\"\r\n ]\r\n }\r\n ]\r\n },\r\n \"clientRequestId\": \"19AA5290-15F2-451B-9EF3-4494F66FE59F\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflow\r\n```\r\n[\r\n \"5bfdbd05-225f-40ee-bff1-2efe18a75375\",\r\n {\r\n \"dueDate\": \"2012-09-19T18:00:00\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"name\": \"test\",\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n \"/Folder/Folder/Doc.txt\"\r\n ]\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflowExt\r\n```\r\n[\r\n {\r\n \"workflowIdOrUniqueId\": \"5bfdbd05-225f-40ee-bff1-2efe18a75375\",\r\n \"workflowInfo\": {\r\n \"dueDate\": \"2012-09-19T18:00:00\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"name\": \"test\",\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n \"/Folder/Folder/Doc.txt\"\r\n ]\r\n },\r\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE59E\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflow21\r\n```\r\n[\r\n \"5bfdbd05-225f-40ee-bff1-2efe18a75375\",\r\n {\r\n \"dueDate\": \"2012-09-19T18:00:00\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"name\": \"test\",\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n {\r\n \"documentIdOrPath\": \"Folder1Document1.txt\"\r\n },\r\n {\r\n \"documentIdOrPath\": \"Folder1Document2.txt\",\r\n \"customFieldIdOrName\": \"udf-textbox-numeric\"\r\n }\r\n ]\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflow21Ext\r\n```\r\n[\r\n {\r\n \"workflowIdOrUniqueId\": \"5bfdbd05-225f-40ee-bff1-2efe18a75375\",\r\n \"workflowInfo\": {\r\n \"dueDate\": \"2012-09-19T18:00:00\",\r\n \"parentWorkflowSourceCustomField\": {\r\n \"id\": null,\r\n \"name\": \"UDF name\"\r\n },\r\n \"name\": \"test\",\r\n \"objects\": [\r\n \"/Generation - 1/NE TV\"\r\n ],\r\n \"documents\": [\r\n {\r\n \"documentIdOrPath\": \"Folder1Document1.txt\"\r\n },\r\n {\r\n \"documentIdOrPath\": \"Folder1Document2.txt\",\r\n \"customFieldIdOrName\": \"udf-textbox-numeric\"\r\n }\r\n ]\r\n },\r\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE49F\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflows\r\n```\r\n[\r\n [\r\n {\r\n \"workflowIdOrUniqueId\": \"2022.01.24.02.37D8CC867814\",\r\n \"dueDate\": \"2021-01-24T04:00:00\",\r\n \"name\": \"ryWIbulk-1-rename\",\r\n \"assignedTo\": [\r\n {\r\n \"userIdOrName\": \"yuromanova\"\r\n },\r\n {\r\n \"groupIdOrName\": \"TESTGroup\"\r\n }\r\n ],\r\n \"objects\": [\r\n \"/-- div\"\r\n ],\r\n \"calendars\": [\r\n \"My\",\r\n \"Object\",\r\n \"System\"\r\n ],\r\n \"comment\": \"commentstest\",\r\n \"documents\": [\r\n \"/RY Folder WF/RY Folder 2/eql.txt\"\r\n ],\r\n \"step\": {\r\n \"fields\": [\r\n {\r\n \"name\": \"GX2BooleanCB\",\r\n \"values\": [\r\n \"true\"\r\n ]\r\n },\r\n {\r\n \"name\": \"GX2NumberTextBox\",\r\n \"values\": [\r\n \"0\"\r\n ]\r\n }\r\n ]\r\n }\r\n },\r\n {\r\n \"workflowIdOrUniqueId\": \"2022.01.24.02.37D8CC867815\",\r\n \"dueDate\": \"2021-01-24T04:00:00\",\r\n \"name\": \"ryWIbulk-2-rename\",\r\n \"assignedTo\": [\r\n {\r\n \"userIdOrName\": \"yuromanova\"\r\n }\r\n ],\r\n \"objects\": [\r\n \"/-- div\"\r\n ],\r\n \"step\": {\r\n \"fields\": [\r\n {\r\n \"name\": \"GX2BooleanCB\",\r\n \"values\": [\r\n \"true\"\r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n ],\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflowType\r\n```\r\n[\r\n \"Workflow Type\",\r\n {\r\n \"name\": \"Workflow Type updated\",\r\n \"description\": \"Workflow Type from preconditions should be updated successfully.\",\r\n \"shouldCreateNewVersion\": \"true\",\r\n \"versionComments\": \"New Comment for version\",\r\n \"idGenScheme\": \"{Day}.{Hour}.{AlphaID}\",\r\n \"workflowSteps\": [\r\n {\r\n \"name\": \"Step1\",\r\n \"status\": \"Step 1 Status \",\r\n \"formTemplate\": {\r\n \"name\": \"FT-1\"\r\n },\r\n \"assignedRole\": \"R-1\"\r\n }\r\n ],\r\n \"workflowPermissions\": [\r\n {\r\n \"role\": \"R-1\",\r\n \"flags\": [\r\n \"FullAccess\",\r\n \"AllFormFieldAccess\"\r\n ]\r\n }\r\n ]\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.updateWorkflowTypeInfo\r\n```\r\n[\r\n \"workflowTypeIdOrName\",\r\n \"newName\",\r\n \"{Year}.{Month}.{Day}.{Hour}.{AlphaID}\",\r\n \"description example\",\r\n \"true\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.partialUpdateWorkflowType\r\n```\r\n[\r\n \"WT test\",\r\n {\r\n \"description\": \"Workflow 1\",\r\n \"shouldCreateNewVersion\": \"false\",\r\n \"versionComments\": \"Version 3\",\r\n \"idGenScheme\": \"{Year}.{Month}.{Day}.{Hour}.{AlphaID}\",\r\n \"workflowSteps\": [\r\n {\r\n \"name\": \"Step1\",\r\n \"status\": \"Open\",\r\n \"associatedFormTemplate\": {\r\n \"name\": \"FT-1\"\r\n },\r\n \"assignedRole\": \"R-1\",\r\n \"stepActions\": [\r\n {\r\n \"name\": \"go to step 2\",\r\n \"destinationStep\": \"Step2\",\r\n \"allowedRoles\": [\r\n \"R-1\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"name\": \"Step2\",\r\n \"status\": \" In progress\",\r\n \"associatedFormTemplate\": {\r\n \"name\": \"FT-1\"\r\n },\r\n \"assignedRole\": \"R-1\"\r\n }\r\n ],\r\n \"stepRoles\": [\r\n {\r\n \"name\": \"R-1\",\r\n \"users\": [\r\n {\r\n \"name\": \"primeAdmin\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"workflowPermissions\": [\r\n {\r\n \"role\": \"R-1\",\r\n \"flags\": [\r\n \"ViewAllFormFields\"\r\n ]\r\n }\r\n ],\r\n \"policies\": [\r\n {\r\n \"name\": \"Pol-1\"\r\n }\r\n ]\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n[\"7bd06df1-041b-4d1e-8091-1e74f7dd7219\",{\"name\":\"WorkflowRole1update\"\"description\": \"Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo\",\"defaultMembers\": {\"userIdsOrNames\": [\"User1\"],\"groupIdsOrNames\": [\"group1\"]},\"onsuccess\",\"onerror\"][\"7bd06df1-041b-4d1e-8091-1e74f7dd7219\",{\"name\":\"WorkflowRole1update\"\"description\": \"Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo\",\"defaultMembers\": {\"userIdsOrNames\": [\"User1\"],\"groupIdsOrNames\": [\"group1\"]},\"onsuccess\",\"onerror\"]\n"
operationId: Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.UpdateWorkflow
consumes:
- application/json
- application/xml
produces:
- application/json
- application/xml
parameters:
- name: EnvApi-Systemid
in: header
description: Specify specific system to run instead of Home
type: string
- name: EnvApi-Packageid
in: header
description: (optional) Clients application/package ID
type: string
- name: EnvApi-Udf-DateTime-Iso-In-CustomFields
in: header
description: Udfs of DateTime should use Iso
type: string
default: 'true'
- name: EnvApi-Udf-DateTime-ReadInUserTz
in: header
description: (obsolete) Udfs of DateTime type whould be in ReadInUserTz
type: string
- name: EnvApi-Udf-Value-Invariant
in: header
description: (optional) Udfs - Force Non-Localized (invariant) values
type: string
- name: EnvApi-Localization-All
in: header
description: (optional) Extend objects with User-given Localizations
type: string
- name: x-client-request-id
in: header
description: (optional) Client ID for double submit prevention
type: string
- name: workflowIdOrUniqueId
in: path
required: true
type: string
- name: UpdateWorkflowWrapper
in: body
required: true
schema:
$ref: '#/definitions/UpdateWorkflow'
responses:
default:
description: not available
delete:
tags:
- Workflow
description: "\n\n\nenvianceSdk.workflows.deleteWorkflow\r\n```\r\n[\r\n \"eccd2310-9b5f-440b-bf0d-91f9803d036b\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.deleteWorkflowExt\r\n```\r\n[\r\n {\r\n \"workflowIdOrUniqueId\": \"eccd2310-9b5f-440b-bf0d-91f9803d036b\",\r\n \"clientRequestId\": \"64AA5290-15F2-451B-9EF3-4494F66FE59E\"\r\n },\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.deleteWorkflows\r\n```\r\n[\r\n [\r\n \"wfid1\",\r\n \"wfid2\"\r\n ],\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.deleteWorkflowType\r\n```\r\n[\r\n \"workflowTypeIdOrName\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.deleteWorkflowTypeBulk\r\n```\r\n[\r\n [\r\n \"workflowTypeIdOrName1\",\r\n \"workflowTypeIdOrName2\",\r\n \"workflowTypeIdOrName3\"\r\n ],\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.deleteWorkflowRole\r\n```\r\n[\r\n \"276067c5-1316-433d-9943-86475ed8fed4\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\nenvianceSdk.workflows.deleteWorkflowRoleAsync\r\n```\r\n[\r\n \"276067c5-1316-433d-9943-86475ed8fed4\",\r\n \"onsuccess\",\r\n \"onerror\"\r\n]\r\n```\r\n\n"
operationId: Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.DeleteWorkflow
consumes:
- application/json
- application/xml
produces:
- application/json
- application/xml
parameters:
# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/enviance/refs/heads/main/openapi/enviance-workflow-api-openapi.yml