Oracle APEX Parameters API

openapi: 3.1.0
info:
  title: Oracle REST Data Services (ORDS) REST AutoREST Parameters API
  description: REST API for managing Oracle REST Data Services (ORDS) RESTful service definitions including modules, templates, handlers, privileges, roles, OAuth clients, and AutoREST-enabled objects. ORDS provides a mid-tier Java application that maps HTTP requests to database transactions, enabling RESTful access to Oracle Database resources. This specification covers the ORDS REST Services Management endpoints available through the Database API stable interface.
  version: '25.4'
  contact:
    name: Oracle APEX Support
    url: https://apex.oracle.com/community
    email: apex-info_us@oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/downloads/licenses/distribution-license.html
servers:
- url: https://{host}:{port}/ords/_/db-api/stable
  description: ORDS Database API stable endpoint
  variables:
    host:
      default: localhost
      description: Hostname of the ORDS instance
    port:
      default: '8443'
      description: Port number for the ORDS instance
- url: https://{host}/ords/_/db-api/stable
  description: ORDS Database API stable endpoint (default port)
  variables:
    host:
      default: example.com
      description: Hostname of the ORDS instance
security:
- basicAuth: []
- oauth2: []
tags:
- name: Parameters
  description: REST handler parameter management. Parameters define input bindings for handlers.
paths:
  /ords/rest/parameters/:
    get:
      operationId: listParameters
      summary: Get all REST handler parameters
      description: Retrieves a paginated list of all REST handler parameters defined in the current schema.
      tags:
      - Parameters
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: Paginated list of REST handler parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsCollection'
    post:
      operationId: createParameter
      summary: Create a REST handler parameter
      description: Creates a new parameter binding for a REST template handler, defining how request parameters map to handler source bind variables.
      tags:
      - Parameters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParameterCreate'
      responses:
        '201':
          description: REST handler parameter created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceItem'
        '400':
          description: Missing required parameters
        '404':
          description: Handler does not exist
  /ords/rest/parameters/{id}:
    get:
      operationId: getParameter
      summary: Get a REST handler parameter
      description: Retrieves details of a specific REST handler parameter by its identifier.
      tags:
      - Parameters
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: REST handler parameter details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceItem'
        '404':
          description: Parameter not found
    put:
      operationId: updateParameter
      summary: Update a REST handler parameter
      description: Updates an existing REST handler parameter binding.
      tags:
      - Parameters
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParameterCreate'
      responses:
        '200':
          description: REST handler parameter updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceItem'
        '404':
          description: Parameter not found
    delete:
      operationId: deleteParameter
      summary: Delete a REST handler parameter
      description: Deletes a specific REST handler parameter.
      tags:
      - Parameters
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: REST handler parameter deleted successfully
        '404':
          description: Parameter not found
components:
  parameters:
    offset:
      name: offset
      in: query
      required: false
      description: The index of the first item to return (0-based). Default is 0.
      schema:
        type: integer
        default: 0
        minimum: 0
    resourceId:
      name: id
      in: path
      required: true
      description: Unique identifier of the resource
      schema:
        type: integer
    limit:
      name: limit
      in: query
      required: false
      description: Maximum number of items to return per page. Default is 25.
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 500
  schemas:
    ParameterCreate:
      type: object
      description: Request body for creating or updating a REST handler parameter binding
      required:
      - handler_id
      - name
      - bind_variable_name
      - source_type
      - access_method
      properties:
        handler_id:
          type: integer
          description: ID of the parent REST handler
        name:
          type: string
          description: Name of the parameter as it appears in the request
        bind_variable_name:
          type: string
          description: Name of the bind variable in the handler source code
        source_type:
          type: string
          description: Source of the parameter value
          enum:
          - HEADER
          - RESPONSE
          - URI
        access_method:
          type: string
          description: How the parameter is accessed
          enum:
          - IN
          - OUT
          - INOUT
        comments:
          type: string
          description: Descriptive comment for the parameter
    LinkRelation:
      type: object
      description: HATEOAS link relation describing a related resource or action
      required:
      - rel
      - href
      properties:
        rel:
          type: string
          description: Link relationship type (e.g., self, describedby, edit, collection)
        href:
          type: string
          description: URI of the related resource
    ResourceItem:
      type: object
      description: A single resource item with HATEOAS navigation links. Additional properties are included depending on the resource type.
      additionalProperties: true
      properties:
        links:
          type: array
          description: HATEOAS links for the resource
          items:
            $ref: '#/components/schemas/LinkRelation'
    ItemsCollection:
      type: object
      description: Paginated collection of resource items following the ORDS standard collection format
      properties:
        count:
          type: integer
          description: Total number of records in the current response page
        hasMore:
          type: boolean
          description: Indicates whether additional pages of results are available
        limit:
          type: integer
          description: The page size limit applied by the server
        offset:
          type: integer
          description: The starting index of items in this page
        items:
          type: array
          description: Array of resource items in this page
          items:
            $ref: '#/components/schemas/ResourceItem'
        links:
          type: array
          description: Pagination navigation links (first, next, prev, last)
          items:
            $ref: '#/components/schemas/LinkRelation'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using ORDS-enabled database schema credentials
    oauth2:
      type: oauth2
      description: OAuth 2.0 authorization using ORDS OAuth client credentials or authorization code flow
      flows:
        clientCredentials:
          tokenUrl: /ords/{schema}/oauth/token
          scopes: {}
        authorizationCode:
          authorizationUrl: /ords/{schema}/oauth/auth
          tokenUrl: /ords/{schema}/oauth/token
          scopes: {}