Oracle Greetings API

openapi: 3.2.0
info:
  description: Use the Usage Proxy API to list Oracle Support Rewards, view related detailed usage information, and manage users who redeem rewards. For more information, see [Oracle Support Rewards Overview](/iaas/Content/Billing/Concepts/supportrewardsoverview.htm).
  title: Usage Proxy Greetings API
  version: '20190111'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/923c4c9e7faf08854042f276c1ca058bf5c0d7901ddbf9c52717a1816a0e8d82.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Usage Proxy API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/923c4c9e7faf08854042f276c1ca058bf5c0d7901ddbf9c52717a1816a0e8d82.yaml
    what: the harvested document for Usage Proxy API
servers:
- url: https://127.0.0.1/20190111
tags:
- name: greetings
paths:
  /greeting/{greetingId}:
    get:
      description: 'Gets a warm greeting from your template application.

        '
      operationId: GetGreeting
      parameters:
      - $ref: '#/components/parameters/GreetingIdPathParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestFields'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Successful operation

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Greeting'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get a warm greeting by id from the SAPI app.
      tags:
      - greetings
  /greetings:
    get:
      description: 'Collection API where you can get a warm greeting by ID from the SAPI application, and other collection parameters that are available.

        '
      operationId: ListGreetings
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Successful operation

            '
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/GreetingSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of Greetings
      tags:
      - greetings
components:
  parameters:
    CompartmentIdQueryParam:
      description: The OCID of the root compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationTokenQueryParam:
      description: 'The value of the ''opc-next-page'' response header from the previous "List" call.

        '
      in: query
      name: page
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 512
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can provide one sort order (''sortOrder'').

        '
      in: query
      name: sortBy
      required: false
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - ORDERNUMBER
        - TIMEINVOICING
    GreetingIdPathParam:
      description: 'Greeting ID to return.

        '
      in: path
      name: greetingId
      required: true
      schema:
        type: integer
    PaginationLimitQueryParam:
      description: 'The maximum number of items to return in a paginated "List" call. Default: (`50`)


        Example: ''500''

        '
      in: query
      name: limit
      required: false
      x-default-description: 500
      schema:
        type: integer
        maximum: 1000
        minimum: 1
    OpcRequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      required: false
      x-default-description: 'null'
      schema:
        type: string
    RequestFields:
      description: "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return only the information \n(fields) required by the client. In this mechanism, the client\nsends the required field names as the query parameters for\nan API to the server, and the server trims down the default\nresponse content by removing the fields that are not required\nby the client. The parameter controls which fields to\nreturn and should be a query string parameter called \"fields\" of\nan array type, provide the values as enums, and use collectionFormat.\n"
      in: query
      name: fields
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
        default: []
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (''ASC'') or descending (''DESC'').

        '
      in: query
      name: sortOrder
      required: false
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - ASC
        - DESC
  schemas:
    GreetingSummary:
      description: 'Greeting summary.

        '
      properties:
        language:
          description: 'Language of the greeting.

            '
          type: string
        message:
          description: "Greeting content.  \n"
          type: string
      type: object
    Error:
      description: Error object model.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
      type: object
    Greeting:
      description: 'Greeting object model.

        '
      properties:
        id:
          description: 'Greeting ID, which is a unique value.

            '
          format: int64
          type: integer
        language:
          description: 'Language of the greeting.

            '
          type: string
        message:
          description: 'Greeting content.

            '
          type: string
        timeCreated:
          description: 'Created time, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
      required:
      - id
      - message
      type: object
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If

            you need to contact Oracle about a particular request,

            please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
x-oracle-package: com.oracle.pic.usage