Oracle APEX · Schema

TemplateCreate

Request body for creating a REST module template

APEXCloudDatabaseDevelopment PlatformEnterpriseGenerative AILow-CodeOracleORDSPL/SQLREST APIWeb ApplicationsWorkflow

Properties

Name	Type	Description
module_id	integer	ID of the parent REST module
uri_prefix	string	URI pattern for the template. Supports path parameters using :name syntax and optional parameters using :name? suffix.
priority	integer	Priority for evaluating the template when multiple templates match. 0 is lowest, 9 is highest.
etag_type	string	Type of entity tag generation for cache validation and optimistic locking
etag_query	string	SQL query used to generate the entity tag when etag_type is QUERY
comments	string	Descriptive comment for the template
run_mode	string	Set to 'codePreview' to return the PL/SQL code instead of executing it

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TemplateCreate",
  "title": "TemplateCreate",
  "type": "object",
  "description": "Request body for creating a REST module template",
  "required": [
    "module_id",
    "uri_prefix"
  ],
  "properties": {
    "module_id": {
      "type": "integer",
      "description": "ID of the parent REST module"
    },
    "uri_prefix": {
      "type": "string",
      "description": "URI pattern for the template. Supports path parameters using :name syntax and optional parameters using :name? suffix.",
      "examples": [
        "/objects/:object/:id?",
        "/employees/",
        "/departments/:dept_id"
      ]
    },
    "priority": {
      "type": "integer",
      "description": "Priority for evaluating the template when multiple templates match. 0 is lowest, 9 is highest.",
      "minimum": 0,
      "maximum": 9,
      "default": 0
    },
    "etag_type": {
      "type": "string",
      "description": "Type of entity tag generation for cache validation and optimistic locking",
      "enum": [
        "HASH",
        "QUERY",
        "NONE"
      ]
    },
    "etag_query": {
      "type": "string",
      "description": "SQL query used to generate the entity tag when etag_type is QUERY"
    },
    "comments": {
      "type": "string",
      "description": "Descriptive comment for the template"
    },
    "run_mode": {
      "type": "string",
      "description": "Set to 'codePreview' to return the PL/SQL code instead of executing it",
      "enum": [
        "codePreview"
      ]
    }
  }
}