workflows library

The v4 workflows family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/workflows.dart' as workflows;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

Workflow

One entry of a WorkflowList's data.

WorkflowCreatedBy

A Workflow's created_by.

WorkflowCurrentVersion

A Workflow's current_version.

WorkflowLastUpdatedBy

A Workflow's last_updated_by.

WorkflowList

One page of what getWorkflows lists, under data.

WorkflowMilestone

One entry of a WorkflowMilestoneList's data.

WorkflowMilestoneActivityDefinition

A WorkflowMilestone's activity_definition.

WorkflowMilestoneDetail

A WorkflowMilestone's workflow.

WorkflowMilestoneList

One page of what getWorkflowMilestones lists, under data.

WorkflowMilestoneView

One milestone definition, under workflow_milestone: what getWorkflowMilestone answers, the same fields as a listed one.

WorkflowMilestoneWorkflow

A WorkflowMilestone's workflow.

WorkflowMilestoneWorkflowVersion

A WorkflowMilestone's workflow_version.

WorkflowsResource

The workflows endpoints with client already applied.

WorkflowsUrls

WorkflowView

One workflow, under workflow: what getWorkflow answers, and the create and the update, which answer the same record.

Functions

createWorkflow(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<WorkflowView>>

POST /api/{api_version}/workflows

createWorkflowComponentCcMilestone(ExsitedClient client, Object ccId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/workflow/component/{cc_id}/milestone

deleteMilestone(ExsitedClient client, Object milestoneUuid, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/milestones/{milestone_uuid}

deleteWorkflow(ExsitedClient client, Object workflowId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/workflows/{workflow_id}

getWorkflow(ExsitedClient client, Object workflowId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<WorkflowView>>

GET /api/{api_version}/workflows/{workflow_id}

getWorkflowComponentCcInstanceCcMilestone(ExsitedClient client, Object componentUuid, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/workflow/component/{component_uuid}/{component_object_id}/milestone

getWorkflowComponentHistory(ExsitedClient client, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/workflow/component/{component_object_id}/history

getWorkflowCustomComponentHistory(ExsitedClient client, Object componentUuid, Object objectCode, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/workflows/custom_components/{component_uuid}/{object_code}/history

getWorkflowCustomComponentMilestone(ExsitedClient client, Object componentUuid, Object objectCode, Object milestoneId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/workflows/custom_components/{component_uuid}/{object_code}/milestones/{milestone_id}

getWorkflowCustomComponentMilestones(ExsitedClient client, Object componentUuid, Object objectCode, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/workflows/custom_components/{component_uuid}/{object_code}/milestones

getWorkflowMilestone(ExsitedClient client, Object workflowId, Object milestoneId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<WorkflowMilestoneView>>

GET /api/{api_version}/workflows/{workflow_id}/milestones/{milestone_id}

getWorkflowMilestones(ExsitedClient client, Object workflowUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<WorkflowMilestoneList>>

GET /api/{api_version}/workflows/{workflow_uuid}/milestones

getWorkflows(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<WorkflowList>>

GET /api/{api_version}/workflows

getWorkflowStage(ExsitedClient client, Object workflowId, Object stageId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/workflows/{workflow_id}/stages/{stage_id}

getWorkflowStages(ExsitedClient client, Object workflowId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/workflows/{workflow_id}/stages

updateWorkflow(ExsitedClient client, Object workflowId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<WorkflowView>>

PATCH /api/{api_version}/workflows/{workflow_id}

updateWorkflowComponentById(ExsitedClient client, Object ccId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

PATCH /api/{api_version}/workflow/component/{cc_id}