Jump to

• Request
• Response

Create a New Dynamic Process Role

post

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

Create a new dynamic process role.

Request

Supported Media Types

• application/json

Body ()

Dynamic process role to create.

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

Type: object

Discriminator: links

Show Source

• links: array links

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

Nested Schema : ProcessRole-allOf[1]

Type: object

Show Source

• displayName: string
  The display name of the process role
• id: string
  The ID of the process role.
• overriddenRoleId: string
  The ID of the definition or global scope role overriden by this role
• scopes: array scopes
• scopeType: 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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation.

Body ()

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

Type: object

Discriminator: links

Show Source

• links: array links

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

Nested Schema : ProcessRole-allOf[1]

Type: object

Show Source

• displayName: string
  The display name of the process role
• id: string
  The ID of the process role.
• overriddenRoleId: string
  The ID of the definition or global scope role overriden by this role
• scopes: array scopes
• scopeType: 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

The request is not valid. Duplicate role ID or the specified overriddenRoleId is not valid.

401 Response

Unauthorized.

403 Response

The user does not have permissions to create the dynamic process role.

500 Response

Internal Server Error.

Back to Top