Jump to

• Request
• Response

Get Members of a Process Role

get

/content/management/api/v1.1/workflowRoles/{id}/members

Get Members of Process Roles.

Request

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : WorkflowRoleMembers

Type: object

WorkflowRoleMembers

Show Source

• links(optional): array links
  Links
• members(optional): array members
  Members of the Workflow role.

{
    "type":"object",
    "properties":{
        "members":{
            "type":"array",
            "description":"Members of the Workflow role.",
            "items":{
                "$ref":"#/definitions/Members."
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowRoleMembers"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : members

Type: array

Members of the Workflow role.

Show Source

• Array of: object Members.
  Members

{
    "type":"array",
    "description":"Members of the Workflow role.",
    "items":{
        "$ref":"#/definitions/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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

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.

{
    "type":"object",
    "properties":{
        "memberId":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"Member type.",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "description":"Group type",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    },
    "description":"Members"
}

304 Response

Not modified.

400 Response

Bad request.

404 Response

Not found.

500 Response

Internal server error.

Back to Top