Jump to

• Request
• Response

Get All Columns for New Displays

get

/api/event/Displays/readAllColumns

Gets all the columns for new displays.

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 all the columns for new displays.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventDisplayReadAllColumns"
                    }
                }
            }
        }
    ]
}

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 all the columns for new displays.
• 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 all the columns for new displays.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventDisplayReadAllColumns"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of all the columns for new displays.

Show Source

• Array of: object eventDisplayReadAllColumns

{
    "description":"The list of all the columns for new displays.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventDisplayReadAllColumns"
    }
}

Nested Schema : eventDisplayReadAllColumns

Type: object

Show Source

• DisplayColumns: object DisplayColumns
  Object of Columns and Orders

{
    "type":"object",
    "properties":{
        "DisplayColumns":{
            "$ref":"#/components/schemas/eventDisplayRead/properties/DisplayColumns"
        }
    }
}

Nested Schema : DisplayColumns

Type: object

Object of Columns and Orders

Show Source

• Columns: array Columns
  Lists of all the fields available within the Events database.
• Order: string
  SQL sort by clause specifying which fields are sorted in which direction.

  Example: [Public to All Users and Groups]

{
    "description":"Object of Columns and Orders",
    "type":"object",
    "properties":{
        "Order":{
            "description":"SQL sort by clause specifying which fields are sorted in which direction.",
            "type":"string",
            "example":"[Public to All Users and Groups]"
        },
        "Columns":{
            "description":"Lists of all the fields available within the Events database.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventDisplayReadColumn"
            }
        }
    }
}

Nested Schema : Columns

Type: array

Lists of all the fields available within the Events database.

Show Source

• Array of: object eventDisplayReadColumn

{
    "description":"Lists of all the fields available within the Events database.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventDisplayReadColumn"
    }
}

Nested Schema : eventDisplayReadColumn

Type: object

Show Source

• ColumnAlign: string
  Column content alignment, ex. Left, Center or Right

  Example: Left
• ColumnField: boolean
  Field name in the Events table

  Example: false
• ColumnName: string
  Custom name specified for the Field

  Example: EventID
• ColumnType: string
  Type in which content is rendered

  Example: Number
• ColumnWidth: number
  Column width when the event list is displayed

  Example: 100
• Editable: boolean
  Checkbox to indicate the field can be edited in the expanded event in the event list.

  Example: true
• Filterable: boolean
  Checkbox to indicate the field can be filtered when filtering the event list.

  Example: true
• Sortable: boolean
  Checkbox to indicate the field can be sorted when sorting the event list.

  Example: true
• Visible: boolean
  Checkbox to indicate the field will be visible when the event list is displayed.

  Example: false

{
    "type":"object",
    "properties":{
        "Visible":{
            "description":"Checkbox to indicate the field will be visible when the event list is displayed.",
            "type":"boolean",
            "example":false
        },
        "ColumnField":{
            "description":"Field name in the Events table",
            "type":"boolean",
            "example":"false"
        },
        "ColumnName":{
            "description":"Custom name specified for the Field",
            "type":"string",
            "example":"EventID"
        },
        "ColumnWidth":{
            "description":"Column width when the event list is displayed",
            "type":"number",
            "example":"100"
        },
        "ColumnAlign":{
            "description":"Column content alignment, ex. Left, Center or Right",
            "type":"string",
            "example":"Left"
        },
        "ColumnType":{
            "description":"Type in which content is rendered",
            "type":"string",
            "example":"Number"
        },
        "Editable":{
            "description":"Checkbox to indicate the field can be edited in the expanded event in the event list.",
            "type":"boolean",
            "example":true
        },
        "Filterable":{
            "description":"Checkbox to indicate the field can be filtered when filtering the event list.",
            "type":"boolean",
            "example":true
        },
        "Sortable":{
            "description":"Checkbox to indicate the field can be sorted when sorting the event list.",
            "type":"boolean",
            "example":true
        }
    }
}

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