Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Enviance Workflow API

The Workflow API from Enviance — 18 operation(s) for workflow.

Enviance Workflow API is one of 39 APIs that Enviance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflow. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 26 operations across 18 paths, and defines 40 schemas. It is described by OpenAPI 2.0, at version Platform.v2026.2.0.0.20260708.

Requests are made against the base URL https://api.enviance.com.

26 operations 18 paths 40 schemas 3 DELETE9 GET4 PATCH10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
Platform.v2026.2.0.0.20260708
Base URL
https://api.enviance.com
Authentication
basic, API Key
Contact
Resource Areas
1

Authentication & Security 2

Enviance Workflow API declares 2 security schemes for authenticating requests. It defines a basic scheme (Basic). An API key is passed in the header as Authorization (EnvianceAuth).

  • Basic — Forces authentication with credentials via an api gateway
  • EnvianceAuth — Enviance \ . Obtain SessionId by POST /ver2/AuthenticationService.svc/sessions first

Paths & Operations 26

Across 18 paths, the API surfaces 26 operations — 3 DELETE, 9 GET, 4 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Workflow 26
POST
/ver2/WorkflowService.svc/workflows
envianceSdk.workflows.createWorkflows [ [ { "workflowTypeName": "workflow Type Name", "name": "workflow name 1", "uniqueId": "uniqueId - 0000-1-1", "parentWorkflowSourceCustomField": { "id": null, "n…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.CreateWorkflow 8 params → default
GET
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}
envianceSdk.workflows.getWorkflow [ "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346", "onsuccess", "onerror" ] envianceSdk.workflows.getWorkflow21 [ "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346", "onsuccess", "onerro…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetWorkflow 8 params → default
PATCH
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}
envianceSdk.workflows.updateWorkflowStep [ "22cf40b5-b001-47ce-8853-020dc9e9aa8e", "Oleg FT Step1", { "comment": "my comment", "transition": { "dueDate": "2013-02-15T00:00:00", "stepActionName": "Ole…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.UpdateWorkflow 9 params → default
DELETE
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}
envianceSdk.workflows.deleteWorkflow [ "eccd2310-9b5f-440b-bf0d-91f9803d036b", "onsuccess", "onerror" ] envianceSdk.workflows.deleteWorkflowExt [ { "workflowIdOrUniqueId": "eccd2310-9b5f-440b-bf0d-91…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.DeleteWorkflow 8 params → default
GET
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/attachments
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetWorkflowAttachments 8 params → default
POST
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/attachments
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GenerateWorkflowAttachmentUploadUrl 9 params → default
GET
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/attachments/{attachmentId}
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetWorkflowAttachment 9 params → default
DELETE
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/attachments/{attachmentId}
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.DeleteWorkflowAttachment 9 params → default
GET
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/attachments/{attachmentId}/downloadUrl
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GenerateWorkflowAttachmentDownloadUrl 9 params → default
POST
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/children
Executes a Workflow Initiator action on the active Step of an existing Workflow, thereby creating a new child Workflow, and places the child on its Init Step. Information about Form Field values and…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.InitiateChildWorkflow 9 params → default
GET
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}
envianceSdk.workflows.getWorkflowStep [ "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346", "Step1", "onsuccess", "onerror" ] envianceSdk.workflows.getWorkflowStepBulk [ [ { "workflowIdOrUniqueId": "10ec54b9-a8b…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetWorkflowStep 9 params → default
PATCH
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}
Updates one or more values in the Form Fields of an existing Workflow Step. Any Form Fields not specified are left un-modified. A Step Action to invoke may also be specified, which will move (transit…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.UpdateWorkflowStep 10 params → default
GET
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}/users/{userId}
envianceSdk.workflows.resolvePermissions [ "\u003CworkflowIdOrUniqueId\u003E", "\u003CstepIdOrName\u003E", "\u003CuserId\u003E", "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.ResolvePermissions 10 params → default
GET
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/currentstep
envianceSdk.workflows.getWorkflowCurrentStep [ "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346", "onsuccess", "onerror" ] envianceSdk.workflows.getWorkflowCurrentStepBulk [ [ "10ec54b9-a8b0-45a6-a9d7-7a0c0c962…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetWorkflowCurrentStep 8 params → default
PATCH
/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/currentstep
Updates one or more values in the Form Fields of current Workflow Step. Any Form Fields not specified are left un-modified. A Step Action to invoke may also be specified, which will move (transition)…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.UpdateWorkflowCurrentStep 9 params → default
POST
/ver2/WorkflowService.svc/workflows/bulk
envianceSdk.workflows.createWorkflows [ [ { "workflowTypeName": "workflow Type Name", "name": "workflow name 1", "uniqueId": "uniqueId - 0000-1-1", "parentWorkflowSourceCustomField": { "id": null, "n…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.CreateWorkflows 8 params → default
PATCH
/ver2/WorkflowService.svc/workflows/bulk
envianceSdk.workflows.updateWorkflowStep [ "22cf40b5-b001-47ce-8853-020dc9e9aa8e", "Oleg FT Step1", { "comment": "my comment", "transition": { "dueDate": "2013-02-15T00:00:00", "stepActionName": "Ole…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.UpdateWorkflows 8 params → default
DELETE
/ver2/WorkflowService.svc/workflows/bulk
envianceSdk.workflows.deleteWorkflows [ [ "wfid1", "wfid2" ], "onsuccess", "onerror" ]
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.DeleteWorkflows 8 params → default
POST
/ver2/WorkflowService.svc/workflows/bulkold
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.CreateWorkflowsOld 8 params → default
GET
/ver2/WorkflowService.svc/workflows/getuploadexcelresult/{commandLogId}
Get excel file (base64)
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetUploadExcelWorkflowResult 8 params → default
POST
/ver2/WorkflowService.svc/workflows/steps
Gets information about specified Steps of the specified Workflow Steps. Security: Allowed for Users with Manage Workflows right or "Report" permission on the Workflow, or User in "Workflow Managers"…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetWorkflowStepBulk 8 params → default
POST
/ver2/WorkflowService.svc/workflows/steps/currentsteps
Gets information about Current Steps of the specified Workflow Steps. Security: Allowed for Users with Manage Workflows right or "Report" permission on the Workflow, or User in "Workflow Managers" ro…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GetWorkflowCurrentStepBulk 8 params → default
POST
/ver2/WorkflowService.svc/workflows/uploadexcel2commands
Upload excel file (base64)
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.UploadExcel2Workflow 8 params → default
POST
/ver2/WorkflowService.svc/workflowtypes/{workflowTypeIdOrName}/guessPermissions
For a given Workflow Type and optional set of compliance objects, this method returns the permissions for all Roles and their resolved members (users and groups), taking into account Role Overrides.…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GuessPermissions 9 params → default
GET
/ver2/WorkflowService.svc/workflowtypes/{workflowTypeIdOrName}/uniqueIds
Generate UniqueIDs for specific workflow type. SDK API: envianceSdk.workflows.generateUniqueIds(workflowTypeIdOrName, count, onsuccess, onerror) null envianceSdk.workflows.generateUniqueIds [ "Workfl…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GenerateUniqueIDs 9 params → default
POST
/ver2/WorkflowService.svc/workflowtypes/{workflowTypeIdOrName}/users/{userId}/guessPermissions
For a given Workflow Type and user and optional set of compliance objects, this method returns the permissions for the specified user(s), taking into account all Roles with which the users would be a…
Enviance.RestServices.Ver2.Workflows.Impl.WorkflowService.GuessPermissionsByUser 10 params → default

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are Enviance.RestServices.Ver2.Workflows.WorkflowWithStepUpdateInfo (21 properties), Enviance.RestServices.Ver2.Workflows.WorkflowWithStepInfo (20 properties), Enviance.RestServices.Ver2.Workflows.WorkflowInfo (19 properties), Enviance.RestServices.Ver2.Tasks.TaskOccurrenceInfo (12 properties). Each schema is shown below with its type and property counts.

Enviance.Business.Udf.Rest.UrlItem
object
2 properties
UpdateWorkflowCurrentStep
object
1 property
UpdateWorkflow
object
1 property
GuessPermissions
object
1 property
Enviance.RestServices.Ver2.Workflows.WorkflowWithStepUpdateInfo
object
21 properties
Enviance.RestServices.Ver2.Workflows.WorkflowAttachmentUploadUrlInfo
object
11 properties
Enviance.RestServices.Ver2.Workflows.Transition
object
4 properties
Enviance.RestServices.Ver2.Tasks.TaskOccurrenceInfo
object
12 properties
Enviance.Workflow.Business.Engine.ExcelFileInfo
object
3 properties
UploadExcel2Workflow
object
3 properties
Enviance.RestServices.Ver2.Workflows.WorkflowAttachmentDownloadUrlInfo
object
2 properties
Enviance.RestServices.Ver2.Workflows.WorkflowCreateAttachmentInfo
object
5 properties
Enviance.RestServices.Ver2.Workflows.WorkflowWithStepInfo
object
20 properties
InitiateChildWorkflow
object
1 property
Enviance.RestServices.Common.CustomFieldInfo
object
2 properties
DeleteWorkflows
object
1 property
Enviance.RestServices.Ver2.Workflows.WorkflowInfo
object
19 properties
Enviance.RestServices.Ver2.Workflows.ChildWorkflowInitiationInfo
object
4 properties
GenerateWorkflowAttachmentUploadUrl
object
1 property
Enviance.RestServices.Common.AssigneeV2
object
2 properties
Enviance.RestServices.Common.SimpleIdName
object
2 properties
Enviance.RestServices.Ver2.Workflows.WorkflowAttachmentInfo
object
10 properties
UpdateWorkflowStep
object
1 property
UpdateWorkflows
object
1 property
Enviance.RestServices.Ver2.Workflows.WorkflowStepMap
object
2 properties
GuessPermissionsByUser
object
1 property
CreateWorkflowsOld
object
1 property
Enviance.RestServices.Ver2.Workflows.WorkflowStepInfo
object
6 properties
CreateWorkflows
object
1 property
Enviance.RestServices.Ver2.Workflows.WorkflowTypeOptions
object
5 properties
Enviance.RestServices.Ver2.Workflows.WorkflowStepPermissionsInfo
object
6 properties
Enviance.RestServices.Ver2.Workflows.WorkflowRoleInfo
object
6 properties
Enviance.Workflow.Business.Engine.ExecutionContext.WorkflowExecutionResult
object
Enviance.RestServices.Udfs.Property
object
7 properties
Enviance.Workflow.Business.Engine.UploadExcel2Result
object
2 properties
CreateWorkflow
object
2 properties
Enviance.RestServices.Common.SimpleUserDto
object
5 properties
GetWorkflowCurrentStepBulk
object
1 property
Enviance.RestServices.Ver2.Workflows.UserGroup
object
3 properties
GetWorkflowStepBulk
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

enviance-workflow-api-openapi.yml Raw ↑

Other APIs Enviance publishes across the network.

Enviance Activity API
Enviance Authentication API
Enviance BatchRequest API
Enviance Bulk API
Enviance Chemical API
Enviance ChemicalGroup API
Enviance ChemicalList API
Enviance Command API
Enviance Compliance API
Enviance CompliancePermissions API
Enviance CustomField API
Enviance Data API