Sign in
dataset

Search Columns

Search Columns for DataSet

get/dataset/{dataSetId}/column

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

Changed in 3 of the 52 revisions of this API.14

  • fe497e811c7f3See the full diff
    • ○

      added the new optional query request parameter heading

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sortBy

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sortDir

      new-optional-request-parameter

  • 41c04de98ec51See the full diff
    • ○

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

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8e12753951041See the full diff
    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog