Edit DataSet
Changed onEdit a DataSet
Request
- Base URL/api (relative, and the document was published on a file host, not at the API’s origin)
- URL/api/dataset/{dataSetId}
- Authnone declared
Path parameters
The DataSet ID
Request body application/x-www-form-urlencoded
The DataSet Name
A description of this DataSet
A code for this DataSet
Is this a remote DataSet?
Is this a real time DataSet?
Source of the data connector
The Request Method GET or POST
The URI, without query parameters
query parameter encoded data to add to the request
HTTP Authentication method None|Basic|Digest
HTTP Authentication User Name
HTTP Authentication Password
Comma separated string of custom HTTP headers
Custom user Agent value
How often in seconds should this remote DataSet be refreshed
How often in seconds should this remote DataSet be truncated
Should the DataSet data be truncated even if no new data is pulled from the source?
An optional dataSetId which should be run before this Remote DataSet
The root of the data in the Remote source which is used as the base for all remote columns
Should the data be aggregated? None|Summarize|Count
Which field should be used to summarize
For remote DataSet, what type data is it? 1 - json, 2 - csv
For remote DataSet with sourceId 2 (CSV), should we ignore first row?
For remote DataSet, maximum number of rows this DataSet can hold, if left empty the CMS Setting for DataSet row limit will be used.
For remote DataSet, what should happen when the DataSet row limit is reached? stop, fifo or truncate
Separator that should be used when using Remote DataSets with CSV source, comma will be used by default.
If isRealTime then provide a script to connect to the data source
Folder ID to which this object should be assigned to
Response
successful operation
The dataSetId
The dataSet Name
The dataSet description
The userId of the User that owns this DataSet
Timestamp indicating the date/time this DataSet was edited last
The user name of the User that owns this DataSet
A comma separated list of Groups/Users that have permission to this DataSet
An array of Groups/Users that have permission to this DataSet
A code for this Data Set
Flag to indicate whether this DataSet is a lookup table
Flag to indicate whether this DataSet is Remote
Flag to indicate whether this DataSet is Real time
Indicates the source of the data connector. Requires the Real time flag. Can be null, user-defined, or a connector.
Method to fetch the Data, can be GET or POST
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.
Data to send as POST-Data to the remote host with the same Replacements as in the URI.
Authentication method, can be none, digest, basic
Username to authenticate with
Corresponding password
Comma separated string of custom HTTP headers
Custom User agent
Time in seconds this DataSet should fetch new Datas from the remote host
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
Flag whether to truncate DataSet data if no new data is pulled from remote source
DataSetID of the DataSet which should be fetched and present before the Data from this DataSet are fetched
Last Synchronisation Timestamp
Last Clear Timestamp
Root-Element form JSON where the data are stored in
Optional function to use for summarize or count unique fields in a remote request
JSON-Element below the Root-Element on which the consolidation should be applied on
The source id for remote dataSet, 1 - JSON, 2 - CSV
A flag whether to ignore the first row, for CSV source remote dataSet
Soft limit on number of rows per DataSet, if left empty the global DataSet row limit will be used.
Type of action that should be taken on next remote DataSet sync - stop, fifo or truncate
Custom separator for CSV source, comma will be used by default
The id of the Folder this DataSet belongs to
The id of the Folder responsible for providing permissions for this DataSet
Changes
- info
added the optional property
to the response with the status
- info
- breaking
added required request body
- info
added the media type
application/jsonfor the response with the status
- breaking