Jump to

• Request
• Response

Update an ORDS role

put

/ords/rest/roles/{id}

Updates an ORDS role.

Request

Path Parameters

• id(required): integer
  ID for specific ORDS role.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• id(required): number
  Specify the ORDS role given the ID to update.
• role_name(required): string
  New role_name for the ORDS role module.
• run_mode: string
  Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution.

{
    "type":"object",
    "required":[
        "id",
        "role_name"
    ],
    "properties":{
        "id":{
            "type":"number",
            "description":"Specify the ORDS role given the ID to update."
        },
        "role_name":{
            "type":"string",
            "description":"New role_name for the ORDS role module."
        },
        "run_mode":{
            "type":"string",
            "description":"Its value can be 'codePreview', which would make the endpoint respond with the code the backend would have executed. When the parameter is not provided, the endpoint will respond with the results of the operation execution."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Details of the ORDS role that has been successfully updated.

Body ()

Root Schema : ResourceItem

Type: object

Additional Properties Allowed: true

Show Source

• links: array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

400 Response

No role_name parameter provided.

403 Response

You do not have the permission to update this role.

404 Response

Role not found.

Back to Top