Schemas Properties and Sample Code

The schemas section of an adapter definition document typically contains the properties listed here and has the following sample structure.

Properties

Property Description
type

Type of schema. The Rapid Adapter Builder platform supports the following schema types:

  • array
  • object
  • string
  • boolean
  • number
  • integer
title

Title of the schema. Use this property to display a name for a field on the user interface in Oracle Integration.

description

Description of the schema. Use this property to describe a field on the user interface in Oracle Integration.

format

Format of a schema. A supplement of type field and supports only binary format. Converts into binary type in Oracle Integration.

required

Indicates that the schema field is required. The asterisk symbol denotes all the required fields on the user interface.

items

Sub-schemas of a schema and is of type array.

Sample Code

"schemas": {
  "Task": {
    "title": "Task",
    "type": "object",
    "required": [
      "title"
    ],
    "properties": {
      "kind": {
        "type": "string",
        "title": "Kind"
      },
      "id": {
        "type": "string",
        "title": "Id"
      }
    }
  },
  "createTaskInput": {
    "type": "object",
    "properties": {
      "headers": {
        "type": "object",
        "properties": {
          "x-group-id": {
            "type": "string"
          }
        }
      },
      "parameters": {
        "type": "object",
        "properties": {
          "tasklist": {
            "type": "string"
          }
        }
      },
      "body": {
        "$ref": "#/schemas/Task"
      }
    }
  },
  "createTaskOutput": {
    "type": "object",
    "properties": {
      "headers": {
        "type": "object",
        "properties": {
          "x-transaction-id": {
            "type": "string"
          }
        }
      },
      "body": {
        "$ref": "#/schemas/Task"
      }
    }
  }
}