Jump to

• Request
• Response

List Dynamic Process Roles

get

/ic/api/process/v1/dp-roles

Get a list of dynamic process roles.

Request

Supported Media Types

• application/json

Query Parameters

• displayName(optional): string
  Filter by process role display name.
• firstResult(optional): integer
  Pagination of results. Specifies the index of the first result to return.

  Default Value: -1
• group(optional): array
  Collection Format: multi

  Group name

  • [0]: string

  {
      "in":"query",
      "name":"group",
      "description":"Group name",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi"
  }

• maxResults(optional): integer
  Pagination of results. Specifies the maximum number of results to return. Returns fewer results if there are no more results left.

  Default Value: -1
• processDefinitionId(optional): string
  Filter by process definition ID. Exact match. Used in combination with processInstanceId.
• processInstanceId(optional): string
  Filter by process instance ID. Exact match. Used in combination with processDefinitionId.
• scopeType(optional): array
  Collection Format: multi

  Filter by process role scopeType.

  • [0]: string
    Allowed Values: [ "GLOBAL", "DEFINITION", "INSTANCE" ]

  {
      "in":"query",
      "name":"scopeType",
      "description":"Filter by process role scopeType.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string",
          "enum":[
              "GLOBAL",
              "DEFINITION",
              "INSTANCE"
          ]
      },
      "collectionFormat":"multi"
  }

• type(optional): string
  Type of role

  Default Value: all
• userId(optional): string
  User id

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : ProcessRoles

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object ProcessRoles-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessRole"
                    }
                }
            }
        }
    ]
}

Nested Schema : CommonModel

Type: object

Discriminator: links

Show Source

• links(optional): array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ProcessRoles-allOf[1]

Type: object

Show Source

• items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProcessRole"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ProcessRole

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProcessRole"
    }
}

Nested Schema : ProcessRole

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object ProcessRole-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the process role."
                },
                "displayName":{
                    "type":"string",
                    "description":"The display name of the process role"
                },
                "overriddenRoleId":{
                    "type":"string",
                    "description":"The ID of the definition or global scope role overriden by this role"
                },
                "scopes":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "scopeType":{
                    "$ref":"#/definitions/ProcessRoleScopeType"
                }
            }
        }
    ]
}

Nested Schema : ProcessRole-allOf[1]

Type: object

Show Source

• displayName(optional): string
  The display name of the process role
• id(optional): string
  The ID of the process role.
• overriddenRoleId(optional): string
  The ID of the definition or global scope role overriden by this role
• scopes(optional): array scopes
• scopeType(optional): string
  Allowed Values: [ "GLOBAL", "DEFINITION", "INSTANCE" ]

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the process role."
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the process role"
        },
        "overriddenRoleId":{
            "type":"string",
            "description":"The ID of the definition or global scope role overriden by this role"
        },
        "scopes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "scopeType":{
            "$ref":"#/definitions/ProcessRoleScopeType"
        }
    }
}

Nested Schema : scopes

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Returned if some of the query parameters are not valid.

401 Response

Unauthorized.

403 Response

Forbidden.

500 Response

Internal Server Error.

Back to Top