Retrieves a list of active workflow teams. Depending on the query string parameters, the result includes one or both filtered results: role user information for each workflow item or workflow items to which the current user is assigned.
URL Parameters
Name
Type
Description
objecttype
string
Required
Specify the workflow object type to retrieve or use (@all to retrieve all workflow object types.
assignee
string
If assignee=@current, this resource retrieves workflow teams that the current user is assigned to.
extra
string
If extra=roleusers, then each item in the response includes role user information as a collection.
Responses
Status
Name
Type
Description
200
Response contains a list of workflow teams.
count
string
Number of records retrieved
page
string
Current page number
pageSize
string
Number of records on each page
objectType
string
Workflow type
Items
array
List of workflow items
Items.id
string
Workflow Id
Items.objectType
string
Workflow object type
Items.name
string
Workflow name
Items.description
string
Description of the workflow
Items.roleUsers
array
List of role users
Items.roleUsers.id
string
Unique Id for the association between role and users
Items.roleUsers.TeamId
string
Team Id the role user is associated with
Items.roleUsers.roleDefinitionId
string
Role definition Id
Items.roleUsers.roleDefinitionName
string
Role definition name
Items.roleUsers.employeeId
string
Id of the user assigned to the role
Items.roleUsers.employeeName
string
Name of the user assigned to the role
Items.roleUsers.roleId
string
Id of the role
404
404 Not Found
message
string
No workflow teams found for workflow object type: [workflowObjectType]