Jump to

• Request
• Response

Create an ORDS privilege

post

/ords/rest/privileges/

Creates an ORDS privilege.

Request

There are no request parameters for this operation.

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.
• 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":[
        "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."
        },
        "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 privilege that has been successfully created.

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.

404 Response

A module or A module name does not existname does not exist.

409 Response

A privilege with that name already exists.

Back to Top