Jump to

• Request
• Response

Get details of a given role

get

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

List details of given role.

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 : 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow role generated in OCE. It is a required property."
        },
        "source":{
            "type":"string",
            "description":"Source"
        },
        "externalRoleId":{
            "type":"string",
            "description":"External role id coming from source. This is a required property."
        },
        "name":{
            "type":"string",
            "description":"Role name of a Workflow."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the role."
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name of the Workflow."
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the Repository."
        },
        "createdDate":{
            "description":"date and time Repository createdDate.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the Repository."
        },
        "updatedDate":{
            "description":"date and time Repository updatedDate.",
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowRoles"
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

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 : 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."
}

304 Response

Not modified.

400 Response

Bad request.

404 Response

Not found.

500 Response

Internal server error.

Back to Top