WorkflowsResource class

The workflows endpoints with client already applied.

Constructors

WorkflowsResource(ExsitedClient client)

Bind the resource to a client; normally reached via client.workflows.

const

Properties

client → ExsitedClient

The client every call below is made through.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

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

POST /api/{api_version}/workflows

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

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

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

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

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

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

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

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

getWorkflowComponentCcInstanceCcMilestone(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(Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

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

getWorkflowCustomComponentHistory(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(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(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(Object workflowId, Object milestoneId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<WorkflowMilestoneView>>

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

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

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

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

GET /api/{api_version}/workflows

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

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

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

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

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

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

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

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

Operators

operator ==(Object other) → bool

The equality operator.

inherited