GET Workflows/Workflow
Get Workflows
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| WorkflowName |
Filter by WorkflowName |
string |
None. |
| WorkflowIDs |
Filter by WorkflowIDs |
Collection of integer |
None. |
| BusinessUnits |
Filter by BusinessUnits |
Collection of integer |
None. |
| EventType |
Filter by WorkflowEventTypes |
WorkflowEventType |
None. |
| EventTypes |
Filter by WorkflowEventTypes |
Collection of WorkflowEventType |
None. |
| RuleType |
Filter by WorkflowRuleTypes |
WorkflowEventRuleType |
None. |
| RuleTypes |
Filter by WorkflowEventTypes |
Collection of WorkflowEventRuleType |
None. |
| PartialDataType |
Only return partial data to speed up call (results cannot be used for add/update) |
PartialDataType |
None. |
Body Parameters
None.
Response Information
Resource Description
List of WorkflowDTOs
Collection of WorkflowDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkflowID |
Workflow ID |
integer |
None. |
| WorkflowName |
Workflow Name |
string |
None. |
| BusinessUnits |
BusinessUnits |
Collection of integer |
None. |
| Groups |
Groups |
Collection of integer |
None. |
| WorkflowRules |
WorkflowRules |
Collection of WorkflowRuleDTO |
None. |
| WorkflowEventType |
Workflow Event Type |
WorkflowEventType |
None. |
| WorkflowEventRuleType |
Workflow Event Rule Type |
WorkflowEventRuleType |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Date and user that created record |
AuditDataDTO |
None. |
| LastUpdated |
Date and user that last updated record |
AuditDataDTO |
None. |