Jump to

• Request
• Response

Update an ORDS privilege

put

/ords/rest/privileges/{id}

Updates an ORDS privilege.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• comments: string
  Comments text.
• description: string
  ORDS privilege description text.
• label: string
  ORDS privilege label.
• modules: string
  String of an ORDS modules list separated by the null char.
• name(required): string
  Name of the ORDS privilege
• patterns: string
  String of an ORDS patterns list separated by the null char.
• roles: string
  String of an ORDS roles list separated by the null char.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the ORDS privilege"
        },
        "label":{
            "type":"string",
            "description":"ORDS privilege label."
        },
        "description":{
            "type":"string",
            "description":"ORDS privilege description text."
        },
        "roles":{
            "type":"string",
            "description":"String of an ORDS roles list separated by the null char."
        },
        "patterns":{
            "type":"string",
            "description":"String of an ORDS patterns list separated by the null char."
        },
        "modules":{
            "type":"string",
            "description":"String of an ORDS modules list separated by the null char."
        },
        "comments":{
            "type":"string",
            "description":"Comments text."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Details of the ORDS privilege 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 name parameter provided or Length parameter is too long or Privilege name already exists.

403 Response

You do not have permission to update this privilege.

404 Response

A privilege or role name or module name o does not existname does not exist.

Back to Top