dataset

Add a Column to a DataSet

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

Request body application/x-www-form-urlencoded

headingstring required

The heading for the Column

listContentstring

A comma separated list of content for drop downs

columnOrderinteger required

The display order for this column

dataTypeIdinteger required

The data type ID for this column

dataSetColumnTypeIdinteger required

The column type for this column

formulastring

MySQL SELECT syntax formula for this Column if the column type is formula

remoteFieldstring

JSON-String to select Data from the Remote DataSet

showFilterinteger required

Flag indicating whether this column should present a filter on DataEntry

showSortinteger required

Flag indicating whether this column should allow sorting on DataEntry

tooltipinteger

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

isRequiredinteger

Flag indicating whether value must be provided for this Column.

dateFormatstring

PHP date format for the dates in the source of the remote DataSet

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

    • breaking

      added required request body

    • info

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

    • breaking

      removed the request body

    • breaking

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