Jump to

• Request
• Response

Update a REST template handler

put

/ords/rest/handlers/{id}

Updates a REST template handler.

Request

Path Parameters

• id(required): integer
  ID for specific handler.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• comments: string
  Comment text.
• items_per_page: 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(required): string
  The HTTP method to which this handler will respond. Valid values: GET, POST, PUT, DELETE.
• mimes_allowed: string
  Comma-separated list of MIME types that the handler will accept. Applies to PUT and POST only.
• source(required): string
  The source implementation for the selected HTTP method.
• source_type(required): 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}.

{
    "type":"object",
    "required":[
        "source_type",
        "source",
        "method"
    ],
    "properties":{
        "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}."
        },
        "source":{
            "type":"string",
            "description":"The source implementation for the selected HTTP method."
        },
        "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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Details of the REST template handler 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 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