Validate Event V1

POST 
/events/v1/validate

Validate a single event, return validation result and the event json will be posted to Kafka

Request

Header Parameters

x-rh-client-addr any

IP Address hint

application/json

Body

required

event_uuid uuidrequired

Unique Event ID for this instance of the event

event_name Event Name (string)required

Possible values: non-empty and <= 128 characters

Type of event to process this as.

event_timestamp date-timerequired

Time the event was triggered

event_params objectrequired

Event specific parameters

custom_data

object

Event custom data

property name* string

user_id

object

User who submitted the event

anyOf

MOD1

string

Possible values: non-empty and <= 128 characters

session_id

object

Session ID to associate the event with

anyOf

MOD1

string

Possible values: non-empty and <= 128 characters

correlation_id

object

Correlation ID to associate the event with

anyOf

MOD1

string

Possible values: non-empty and <= 128 characters

client_ip

object

Client IP associated with the event

anyOf

MOD1

string

Possible values: non-empty and <= 128 characters

Responses

200

Successful Response

application/json

Schema

Schema

success Success (boolean)required

Is event data valid against JsonSchema?

error_code

object

Validation error code

anyOf

MOD1

string

context

object

Detailed validation error context

anyOf

MOD1

string

output_event

object

Event json string that will be sent to Kafka topic

anyOf

MOD1

string

Example (from schema)

{
  "success": true,
  "error_code": "string",
  "context": "string",
  "output_event": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...