Jump to

• Request
• Response

Create a REST template handler

post

/ords/_/db-api/stable/ords/rest/handlers/

Creates a REST template handler.

Request

Supported Media Types

• application/json

Body ()

Root Schema : schema

Type: object

Show Source

• comments(optional): string
  Comment text.
• items_per_page(optional): integer
  The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: NULL (defers to the resource module setting).
• method(optional): string
  The HTTP method to which this handler will respond. Valid values: GET, POST, PUT, DELETE.
• mimes_allowed(optional): string
  Comma-separated list of MIME types that the handler will accept. Applies to PUT and POST only.
• run_mode(optional): 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.
• source: string
  The source implementation for the selected HTTP method.
• source_type(optional): string
  The HTTP request method for this handler. Valid values: source_type_collection_feed, source_type_collection_item, source_type_media, source_type_plsql, source_type_query || source_type_csv_query, source_type_query_one_row, source_type_feed, path/to/feed/{id}.
• template_id: integer
  ID of the template the handler belongs to.

{
    "type":"object",
    "required":[
        "template_id",
        "source"
    ],
    "properties":{
        "template_id":{
            "type":"integer",
            "description":"ID of the template the handler belongs to."
        },
        "source":{
            "type":"string",
            "description":"The source implementation for the selected HTTP method."
        },
        "source_type":{
            "type":"string",
            "description":"The HTTP request method for this handler. Valid values: source_type_collection_feed, source_type_collection_item, source_type_media, source_type_plsql, source_type_query || source_type_csv_query, source_type_query_one_row, source_type_feed, path/to/feed/{id}."
        },
        "method":{
            "type":"string",
            "description":"The HTTP method to which this handler will respond. Valid values: GET, POST, PUT, DELETE."
        },
        "items_per_page":{
            "type":"integer",
            "description":"The default pagination for a resource handler HTTP operation GET method, that is, the number of rows to return on each page of a JSON format result set based on a database query. Default: NULL (defers to the resource module setting)."
        },
        "mimes_allowed":{
            "type":"string",
            "description":"Comma-separated list of MIME types that the handler will accept. Applies to PUT and POST only."
        },
        "comments":{
            "type":"string",
            "description":"Comment 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 REST template handler that has been successfully created.

Body ()

Root Schema : ResourceItem

Type: object

Additional Properties Allowed: true

Show Source

• links(optional): array links

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

• href: string
• rel: string

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

400 Response

No template specified or No source parameter provided or Invalid Source Type.

404 Response

Template does not exis

409 Response

Handler already exists.

Back to Top