Add members to Process role
post
/content/management/api/v1.1/workflowRoles/{id}/members
Add Members to Process Role using given payload.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
id represents the unique id generated in OCE for workflow Role
Query Parameters
-
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
Header Parameters
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
Adds Member to Process Role with the given information in the payload. The fields id, createdBy, createdDate, updatedBy, updatedDate and links will be ignored even if given in the payload.
Root Schema : WorkflowRoleMembers
Type:
object
WorkflowRoleMembers
Show Source
-
links(optional):
array links
Links
-
members(optional):
array members
Members of the Workflow role.
Nested Schema : members
Type:
array
Members of the Workflow role.
Show Source
-
Array of:
object Members.
Members
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.
Nested Schema : Members.
Type:
object
Members
Show Source
-
groupType(optional):
string
Allowed Values:
[ "CEC", "IDP" ]
Group type -
memberId(optional):
string
id of a member. It is a required property in the get response and put request whereas it is not required in the post request.
-
memberType(optional):
string
Allowed Values:
[ "user", "group" ]
Member type.
Response
Supported Media Types
- application/json
201 Response
Created.
Root Schema : WorkflowRoleMembersWithFailureDetails
Type:
object
WorkflowRoleMembersWithFailureDetails
Show Source
-
failedMembers(optional):
array failedMembers
List of failed members while adding them to a role
-
links(optional):
array links
Links
-
members(optional):
array members
Members of the Workflow role.
Nested Schema : failedMembers
Type:
array
List of failed members while adding them to a role
Show Source
-
Array of:
object FailedUserId
FailedUserId
Nested Schema : members
Type:
array
Members of the Workflow role.
Show Source
-
Array of:
object Members.
Members
Nested Schema : FailedUserId
Type:
object
FailedUserId
Show Source
-
groupType(optional):
string
Allowed Values:
[ "CEC", "IDP" ]
-
message(optional):
string
failure message.
-
name(optional):
string
-
type(optional):
string
Allowed Values:
[ "user", "group" ]
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.
Nested Schema : Members.
Type:
object
Members
Show Source
-
groupType(optional):
string
Allowed Values:
[ "CEC", "IDP" ]
Group type -
memberId(optional):
string
id of a member. It is a required property in the get response and put request whereas it is not required in the post request.
-
memberType(optional):
string
Allowed Values:
[ "user", "group" ]
Member type.
400 Response
Bad request.
404 Response
Not found.
500 Response
Internal server error.