getStepsFromWorkflow static method
Future<PcoCollection<PcoPeopleWorkflowStep> >
getStepsFromWorkflow(
- String workflowId,
- {PcoPeopleWorkflowStepQuery? query,
- bool getAll = false,
- bool includeDefaultAssignee = false}
Will get a PcoCollection
of PcoPeopleWorkflowStep objects (expecting one)
using a path like this: /people/v2/workflows/$workflowId/steps
Getting a PcoCollection
is useful even when retrieving a single object
because it contains error data and helper functions.
Additional options may be specified by using the query
argument, but some
query options are also available as boolean flags in this function call too.
Implementation
static Future<PcoCollection<PcoPeopleWorkflowStep>> getStepsFromWorkflow(
String workflowId, {
PcoPeopleWorkflowStepQuery? query,
bool getAll = false,
bool includeDefaultAssignee = false,
}) async {
query ??= PcoPeopleWorkflowStepQuery();
if (getAll) query.getAll = true;
if (includeDefaultAssignee) query.include.add('default_assignee');
var url = '/people/v2/workflows/$workflowId/steps';
return PcoCollection.fromApiCall<PcoPeopleWorkflowStep>(url,
query: query, apiVersion: kApiVersion);
}