Workflow

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",
  "onerror"
]

envianceSdk.workflows.getWorkflowStep

[
  "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346",
  "Step1",
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.getWorkflowStepBulk

[
  [
    {
      "workflowIdOrUniqueId": "10ec54b9-a8b0-45a6-a9d7-7a0c0c962725",
      "stepIdsOrNames": [
        "WFStep1"
      ]
    },
    {
      "workflowIdOrUniqueId": "2017.03.23.11.2F39C8EC9325",
      "stepIdsOrNames": [
        "337989bf-832e-4e1f-8034-3b4327d52542"
      ]
    }
  ],
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.getWorkflowCurrentStep

[
  "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346",
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.getWorkflowCurrentStepBulk

[
  [
    "10ec54b9-a8b0-45a6-a9d7-7a0c0c962725",
    "2017.03.23.11.2F39C8EC9325"
  ],
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.getWorkflowType

[
  "workflowTypeIdOrName",
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.getWorkflowTypeVersion

[
  "workflowTypeIdOrName",
  "versionNumber",
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.getWorkflowRole

[
  "276067c5-1316-433d-9943-86475ed8fed4",
  "onsuccess",
  "onerror"
]

Request

Base URL
https://api.enviance.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/enviance/apis/restapi/docs/ver2/WorkflowService.svc/workflows/:workflowIdOrUniqueId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workflowIdOrUniqueIdstring required

Headers

EnvApi-Systemidstring

Specify specific system to run instead of Home

EnvApi-Packageidstring

(optional) Clients application/package ID

EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring

Udfs of DateTime should use Iso

EnvApi-Udf-DateTime-ReadInUserTzstring

(obsolete) Udfs of DateTime type whould be in ReadInUserTz

EnvApi-Udf-Value-Invariantstring

(optional) Udfs - Force Non-Localized (invariant) values

EnvApi-Localization-Allstring

(optional) Extend objects with User-given Localizations

x-client-request-idstring

(optional) Client ID for double submit prevention

Response

not available

idstring guid

uniqueIdstring

namestring

workflowTypeNamestring

parentUniqueIdstring guid

dueDatestring date-time

statusstring

creatorstring

createdstring date-time

lastRunstring date-time

assignedBystring

objectsstring[]

documentsstring[]

calendarsstring[]

commentstring

closeDatestring date-time

jsonDataobject

Changes

No recorded changes to this operation across all 1 revision of this API.