List Roles of all registered Workflows
get
/content/management/api/v1.1/workflowRoles
List registered Workflow Roles.
Request
Query Parameters
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
100
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby
-
offset(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the start index of the result.Default Value:
0
-
orderBy(optional): string
This parameter is used to control order of results. The value of this query parameter follow the format of fieldName:[asc/desc]. asc stands for ascending order desc stands for descending order, default order is asc.Default Value:
name:asc
-
totalResults(optional): boolean
This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : WorkflowRoles
Type:
object
WorkflowRoles
Show Source
-
applicationName(optional):
string
Application Name of the Workflow.
-
createdBy(optional):
string
createdBy user of the Repository.
-
createdDate(optional):
object date
date
-
displayName(optional):
string
Display name of the role.
-
externalRoleId(optional):
string
External role id coming from source. This is a required property.
-
id(optional):
string
id of the Workflow role generated in OCE. It is a required property.
-
links(optional):
array links
Links
-
name(optional):
string
Role name of a Workflow.
-
source(optional):
string
Source
-
updatedBy(optional):
string
updatedBy user of the Repository.
-
updatedDate(optional):
object date
date
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
304 Response
Not modified.
400 Response
Bad request.
500 Response
Internal server error.