Jump to

• Request
• Response

Get All Fields from the Events Table

get

/api/event/MetaEvents/readFields

This method is deprecated. Use API/event/Events/readFields.

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/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of fields.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "Field":{
                                "type":"string",
                                "example":"EventID"
                            },
                            "Type":{
                                "type":"string",
                                "example":"bigint unsigned"
                            },
                            "Default":{
                                "oneOf":[
                                    {
                                        "type":"string"
                                    },
                                    {
                                        "type":"integer"
                                    },
                                    {
                                        "type":"boolean"
                                    },
                                    {
                                        "type":"number"
                                    }
                                ],
                                "nullable":true,
                                "example":"0"
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The list of fields.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of fields.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Field":{
                        "type":"string",
                        "example":"EventID"
                    },
                    "Type":{
                        "type":"string",
                        "example":"bigint unsigned"
                    },
                    "Default":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"integer"
                            },
                            {
                                "type":"boolean"
                            },
                            {
                                "type":"number"
                            }
                        ],
                        "nullable":true,
                        "example":"0"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: array

The list of fields.

Show Source

• Array of: object items

{
    "description":"The list of fields.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Field":{
                "type":"string",
                "example":"EventID"
            },
            "Type":{
                "type":"string",
                "example":"bigint unsigned"
            },
            "Default":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"integer"
                    },
                    {
                        "type":"boolean"
                    },
                    {
                        "type":"number"
                    }
                ],
                "nullable":true,
                "example":"0"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Default: Default
• Field: string
  Example: EventID
• Type: string
  Example: bigint unsigned

{
    "type":"object",
    "properties":{
        "Field":{
            "type":"string",
            "example":"EventID"
        },
        "Type":{
            "type":"string",
            "example":"bigint unsigned"
        },
        "Default":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"integer"
                },
                {
                    "type":"boolean"
                },
                {
                    "type":"number"
                }
            ],
            "nullable":true,
            "example":"0"
        }
    }
}

Nested Schema : Default

Match One Schema

Show Source

• string
• integer
• boolean
• number

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"integer"
        },
        {
            "type":"boolean"
        },
        {
            "type":"number"
        }
    ],
    "nullable":true,
    "example":"0"
}

Example:

0

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top