dataset

Add a DataSet

post/dataset

Request

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

Request body application/x-www-form-urlencoded

dataSetstring required

The DataSet Name

descriptionstring

A description of this DataSet

codestring

A code for this DataSet

isRemoteinteger required

Is this a remote DataSet?

isRealTimeinteger required

Is this a real time DataSet?

dataConnectorSourcestring required

Source of the data connector

methodstring

The Request Method GET or POST

uristring

The URI, without query parameters

postDatastring

query parameter encoded data to add to the request

authenticationstring

HTTP Authentication method None|Basic|Digest

usernamestring

HTTP Authentication User Name

passwordstring

HTTP Authentication Password

customHeadersstring

Comma separated string of custom HTTP headers

userAgentstring

Custom user Agent value

refreshRateinteger

How often in seconds should this remote DataSet be refreshed

clearRateinteger

How often in seconds should this remote DataSet be truncated

truncateOnEmptyinteger

Should the DataSet data be truncated even if no new data is pulled from the source?

runsAfterinteger

An optional dataSetId which should be run before this Remote DataSet

dataRootstring

The root of the data in the Remote source which is used as the base for all remote columns

summarizestring

Should the data be aggregated? None|Summarize|Count

summarizeFieldstring

Which field should be used to summarize

sourceIdinteger

For remote DataSet, what type data is it? 1 - json, 2 - csv

ignoreFirstRowinteger

For remote DataSet with sourceId 2 (CSV), should we ignore first row?

rowLimitinteger

For remote DataSet, maximum number of rows this DataSet can hold, if left empty the CMS Setting for DataSet row limit will be used.

limitPolicystring

For remote DataSet, what should happen when the DataSet row limit is reached? stop, fifo or truncate

csvSeparatorstring

Separator that should be used when using Remote DataSets with CSV source, comma will be used by default.

dataConnectorScriptstring

If isRealTime then provide a script to connect to the data source

folderIdinteger

Folder ID to which this object should be assigned to

Response

successful operation

dataSetIdinteger

The dataSetId

dataSetstring

The dataSet Name

descriptionstring

The dataSet description

userIdinteger

The userId of the User that owns this DataSet

lastDataEditinteger

Timestamp indicating the date/time this DataSet was edited last

ownerstring

The user name of the User that owns this DataSet

groupsWithPermissionsstring

A comma separated list of Groups/Users that have permission to this DataSet

groupsWithPermissionsListstring[]

An array of Groups/Users that have permission to this DataSet

codestring

A code for this Data Set

isLookupinteger

Flag to indicate whether this DataSet is a lookup table

isRemoteinteger

Flag to indicate whether this DataSet is Remote

isRealTimeinteger

Flag to indicate whether this DataSet is Real time

dataConnectorSourcestring

Indicates the source of the data connector. Requires the Real time flag. Can be null, user-defined, or a connector.

methodstring

Method to fetch the Data, can be GET or POST

uristring

URI to call to fetch Data from. Replacements are {{DATE}}, {{TIME}} and, in case this is a sequencial used DataSet, {{COL.NAME}} where NAME is a ColumnName from the underlying DataSet.

postDatastring

Data to send as POST-Data to the remote host with the same Replacements as in the URI.

authenticationstring

Authentication method, can be none, digest, basic

usernamestring

Username to authenticate with

passwordstring

Corresponding password

customHeadersstring

Comma separated string of custom HTTP headers

userAgentstring

Custom User agent

refreshRateinteger

Time in seconds this DataSet should fetch new Datas from the remote host

clearRateinteger

Time in seconds when this Dataset should be cleared. If here is a lower value than in RefreshRate it will be cleared when the data is refreshed

truncateOnEmptyinteger

Flag whether to truncate DataSet data if no new data is pulled from remote source

runsAfterinteger

DataSetID of the DataSet which should be fetched and present before the Data from this DataSet are fetched

lastSyncinteger

Last Synchronisation Timestamp

lastClearinteger

Last Clear Timestamp

dataRootstring

Root-Element form JSON where the data are stored in

summarizestring

Optional function to use for summarize or count unique fields in a remote request

summarizeFieldstring

JSON-Element below the Root-Element on which the consolidation should be applied on

sourceIdinteger

The source id for remote dataSet, 1 - JSON, 2 - CSV

ignoreFirstRowinteger

A flag whether to ignore the first row, for CSV source remote dataSet

rowLimitinteger

Soft limit on number of rows per DataSet, if left empty the global DataSet row limit will be used.

limitPolicystring

Type of action that should be taken on next remote DataSet sync - stop, fifo or truncate

csvSeparatorstring

Custom separator for CSV source, comma will be used by default

folderIdinteger

The id of the Folder this DataSet belongs to

permissionsFolderIdinteger

The id of the Folder responsible for providing permissions for this DataSet

Changes

    • info

      added the optional property to the response with the status

    • breaking

      added required request body

    • info

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