XIxibosignage
dataset

Search Columns

Changed on

Search Columns for DataSet

get/dataset/{dataSetId}/column

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/dataset/{dataSetId}/column
  • Auth
    none declared

Path parameters

dataSetIdinteger required

The DataSet ID

Query parameters

dataSetColumnIdinteger

Filter by DataSet ColumnID

headingstring

Filter by column heading

sortBy'heading' | 'dataType' | 'dataSetColumnType' | 'listContent' | 'tooltip' | 'columnOrder' | 'isRequired'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

dataSetColumnIdinteger

The ID of this DataSetColumn

dataSetIdinteger

The ID of the DataSet that this Column belongs to

headingstring

The Column Heading

dataTypeIdinteger

The ID of the DataType for this Column

dataSetColumnTypeIdinteger

The ID of the ColumnType for this Column

listContentstring

Comma separated list of valid content for drop down columns

columnOrderinteger

The order this column should be displayed

formulastring

A MySQL formula for this column

dataTypestring

The data type for this Column

remoteFieldstring

The data field of the remote DataSet as a JSON-String

showFilterstring

Does this column show a filter on the data entry page?

showSortstring

Does this column allow a sorting on the data entry page?

dataSetColumnTypestring

The column type for this Column

tooltipstring

Help text that should be displayed when entering data for this Column.

isRequiredinteger

Flag indicating whether value must be provided for this Column.

dateFormatstring

Date format of dates in the source for remote DataSet.

Changes

  • fe497e811c7fRevision changes
    • info

      added the new optional query request parameter heading

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir

  • 41c04de98ec5Revision changes
    • info

      added the media type application/json for the response with the status