Jump to

• Request
• Response

Get Event Types

get

/events/schemas

Gets the event types from the BRM data dictionary

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The list of event types is returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object eventTypeSpec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EventTypeSpec"
    }
}

Nested Schema : eventTypeSpec

Type: object

Show Source

• extension: object extension
  The extended attributes.
• fields: array fields
  The list of fields that belong to the event type.
• type(required): string
  The BRM event type, for example: /event/billing/payment/cash.

{
    "required":[
        "type"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "type":{
            "type":"string",
            "description":"The BRM event type, for example: /event/billing/payment/cash."
        },
        "fields":{
            "type":"array",
            "description":"The list of fields that belong to the event type.",
            "items":{
                "$ref":"#/components/schemas/EventTypeField"
            }
        }
    },
    "xml":{
        "name":"eventTypeSpec",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : fields

Type: array

The list of fields that belong to the event type.

Show Source

• Array of: object EventTypeField
  The list of fields that belong to the event type.

{
    "type":"array",
    "description":"The list of fields that belong to the event type.",
    "items":{
        "$ref":"#/components/schemas/EventTypeField"
    }
}

Nested Schema : EventTypeField

Type: object

The list of fields that belong to the event type.

Show Source

• dataType: integer (int32)
  The event field data type. Allowed Values:

  • 1 (Integer)
  • 3 (Enumeration)
  • 5 (Buffer)
  • 6 (String)
  • 7 (POID)
  • 8 (Timestamp)
  • 9 (Array)
  • 10 (Binary String)
  • 12 (Substruct)
  • 14 (Decimal)
• fieldName(required): string
  The BRM field name.
• fields: array fields
  Nested field metadata for ARRAY or SUBSTRUCT fields.
• isRequired: boolean
  Indicates whether the field is required.

{
    "required":[
        "fieldName"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The BRM field name."
        },
        "isRequired":{
            "type":"boolean",
            "description":"Indicates whether the field is required."
        },
        "dataType":{
            "type":"integer",
            "description":"The event field data type. Allowed Values: <ul><li><b>1</b> (Integer)</li><li><b>3</b> (Enumeration)</li><li><b>5</b> (Buffer)</li><li><b>6</b> (String)</li><li><b>7</b> (POID)</li><li><b>8</b> (Timestamp)</li><li><b>9</b> (Array)</li><li><b>10</b> (Binary String)</li><li><b>12</b> (Substruct)</li><li><b>14</b> (Decimal)</li></ul>",
            "format":"int32"
        },
        "fields":{
            "type":"array",
            "description":"Nested field metadata for ARRAY or SUBSTRUCT fields.",
            "items":{
                "$ref":"#/components/schemas/EventTypeField"
            }
        }
    },
    "description":"The list of fields that belong to the event type."
}

Nested Schema : fields

Type: array

Nested field metadata for ARRAY or SUBSTRUCT fields.

Show Source

• Array of: object EventTypeField
  The list of fields that belong to the event type.

{
    "type":"array",
    "description":"Nested field metadata for ARRAY or SUBSTRUCT fields.",
    "items":{
        "$ref":"#/components/schemas/EventTypeField"
    }
}

500 Response

An internal server error occurred.

Back to Top