Dataset
DataSets
Search this users DataSets
Filter by DataSet Id
Filter by DataSet Name
Filter by DataSet Code
Filter by real time
Filter by user Id
Embed related data such as columns
Filter by Folder ID
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
GET /api/dataset HTTP/1.1
Accept: */*
successful operation
[
{
"dataSetId": 1,
"dataSet": "text",
"description": "text",
"userId": 1,
"lastDataEdit": 1,
"owner": "text",
"groupsWithPermissions": "text",
"code": "text",
"isLookup": 1,
"isRemote": 1,
"isRealTime": 1,
"dataConnectorSource": "text",
"method": "text",
"uri": "text",
"postData": "text",
"authentication": "text",
"username": "text",
"password": "text",
"customHeaders": "text",
"userAgent": "text",
"refreshRate": 1,
"clearRate": 1,
"truncateOnEmpty": 1,
"runsAfter": 1,
"lastSync": 1,
"lastClear": 1,
"dataRoot": "text",
"summarize": "text",
"summarizeField": "text",
"sourceId": 1,
"ignoreFirstRow": 1,
"rowLimit": 1,
"limitPolicy": "text",
"csvSeparator": "text",
"folderId": 1,
"permissionsFolderId": 1
}
]Add a DataSet
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
successful operation
POST /api/dataset HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 514
"dataSet='text'&description='text'&code='text'&isRemote=1&isRealTime=1&dataConnectorSource='text'&method='text'&uri='text'&postData='text'&authentication='text'&username='text'&password='text'&customHeaders='text'&userAgent='text'&refreshRate=1&clearRate=1&truncateOnEmpty=1&runsAfter=1&dataRoot='text'&summarize='text'&summarizeField='text'&sourceId=1&ignoreFirstRow=1&rowLimit=1&limitPolicy='text'&csvSeparator='text'&dataConnectorScript='text'&folderId=1"successful operation
{
"dataSetId": 1,
"dataSet": "text",
"description": "text",
"userId": 1,
"lastDataEdit": 1,
"owner": "text",
"groupsWithPermissions": "text",
"code": "text",
"isLookup": 1,
"isRemote": 1,
"isRealTime": 1,
"dataConnectorSource": "text",
"method": "text",
"uri": "text",
"postData": "text",
"authentication": "text",
"username": "text",
"password": "text",
"customHeaders": "text",
"userAgent": "text",
"refreshRate": 1,
"clearRate": 1,
"truncateOnEmpty": 1,
"runsAfter": 1,
"lastSync": 1,
"lastClear": 1,
"dataRoot": "text",
"summarize": "text",
"summarizeField": "text",
"sourceId": 1,
"ignoreFirstRow": 1,
"rowLimit": 1,
"limitPolicy": "text",
"csvSeparator": "text",
"folderId": 1,
"permissionsFolderId": 1
}Get the DataSet object specified by the provided datasetId
Numeric ID of the DataSet to get
successful operation
Class DataSet
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
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
GET /api/dataset/{id} HTTP/1.1
Accept: */*
successful operation
{
"dataSetId": 1,
"dataSet": "text",
"description": "text",
"userId": 1,
"lastDataEdit": 1,
"owner": "text",
"groupsWithPermissions": "text",
"code": "text",
"isLookup": 1,
"isRemote": 1,
"isRealTime": 1,
"dataConnectorSource": "text",
"method": "text",
"uri": "text",
"postData": "text",
"authentication": "text",
"username": "text",
"password": "text",
"customHeaders": "text",
"userAgent": "text",
"refreshRate": 1,
"clearRate": 1,
"truncateOnEmpty": 1,
"runsAfter": 1,
"lastSync": 1,
"lastClear": 1,
"dataRoot": "text",
"summarize": "text",
"summarizeField": "text",
"sourceId": 1,
"ignoreFirstRow": 1,
"rowLimit": 1,
"limitPolicy": "text",
"csvSeparator": "text",
"folderId": 1,
"permissionsFolderId": 1
}Edit a DataSet
The DataSet ID
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
successful operation
Class DataSet
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
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
PUT /api/dataset/{dataSetId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 514
"dataSet='text'&description='text'&code='text'&isRemote=1&isRealTime=1&dataConnectorSource='text'&method='text'&uri='text'&postData='text'&authentication='text'&username='text'&password='text'&customHeaders='text'&userAgent='text'&refreshRate=1&clearRate=1&truncateOnEmpty=1&runsAfter=1&dataRoot='text'&summarize='text'&summarizeField='text'&sourceId=1&ignoreFirstRow=1&rowLimit=1&limitPolicy='text'&csvSeparator='text'&dataConnectorScript='text'&folderId=1"successful operation
{
"dataSetId": 1,
"dataSet": "text",
"description": "text",
"userId": 1,
"lastDataEdit": 1,
"owner": "text",
"groupsWithPermissions": "text",
"code": "text",
"isLookup": 1,
"isRemote": 1,
"isRealTime": 1,
"dataConnectorSource": "text",
"method": "text",
"uri": "text",
"postData": "text",
"authentication": "text",
"username": "text",
"password": "text",
"customHeaders": "text",
"userAgent": "text",
"refreshRate": 1,
"clearRate": 1,
"truncateOnEmpty": 1,
"runsAfter": 1,
"lastSync": 1,
"lastClear": 1,
"dataRoot": "text",
"summarize": "text",
"summarizeField": "text",
"sourceId": 1,
"ignoreFirstRow": 1,
"rowLimit": 1,
"limitPolicy": "text",
"csvSeparator": "text",
"folderId": 1,
"permissionsFolderId": 1
}Edit a DataSet Data Connector
The DataSet ID
If isRealTime then provide a script to connect to the data source
successful operation
Class DataSet
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
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
PUT /api/dataset/dataConnector/{dataSetId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 30
"dataConnectorScript='text'"successful operation
{
"dataSetId": 1,
"dataSet": "text",
"description": "text",
"userId": 1,
"lastDataEdit": 1,
"owner": "text",
"groupsWithPermissions": "text",
"code": "text",
"isLookup": 1,
"isRemote": 1,
"isRealTime": 1,
"dataConnectorSource": "text",
"method": "text",
"uri": "text",
"postData": "text",
"authentication": "text",
"username": "text",
"password": "text",
"customHeaders": "text",
"userAgent": "text",
"refreshRate": 1,
"clearRate": 1,
"truncateOnEmpty": 1,
"runsAfter": 1,
"lastSync": 1,
"lastClear": 1,
"dataRoot": "text",
"summarize": "text",
"summarizeField": "text",
"sourceId": 1,
"ignoreFirstRow": 1,
"rowLimit": 1,
"limitPolicy": "text",
"csvSeparator": "text",
"folderId": 1,
"permissionsFolderId": 1
}Copy a DataSet
The DataSet ID
The DataSet Name
A description of this DataSet
A code for this DataSet
Flag whether to copy all the row data from the original dataSet
successful operation
Class DataSet
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
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
POST /api/dataset/copy/{dataSetId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 66
"dataSet='text'&description='text'&code='text'©Rows=1"successful operation
{
"dataSetId": 1,
"dataSet": "text",
"description": "text",
"userId": 1,
"lastDataEdit": 1,
"owner": "text",
"groupsWithPermissions": "text",
"code": "text",
"isLookup": 1,
"isRemote": 1,
"isRealTime": 1,
"dataConnectorSource": "text",
"method": "text",
"uri": "text",
"postData": "text",
"authentication": "text",
"username": "text",
"password": "text",
"customHeaders": "text",
"userAgent": "text",
"refreshRate": 1,
"clearRate": 1,
"truncateOnEmpty": 1,
"runsAfter": 1,
"lastSync": 1,
"lastClear": 1,
"dataRoot": "text",
"summarize": "text",
"summarizeField": "text",
"sourceId": 1,
"ignoreFirstRow": 1,
"rowLimit": 1,
"limitPolicy": "text",
"csvSeparator": "text",
"folderId": 1,
"permissionsFolderId": 1
}Import a CSV into a DataSet
The DataSet ID to import into.
The file
You need to provide dataSetColumnId after csvImport_, to know your dataSet columns Ids, you will need to use the GET /dataset/{dataSetId}/column call first. The value of this parameter is the index of the column in your csv file, where the first column is 1
flag (0,1) Set to 1 to erase all content in the dataSet and overwrite it with new content in this import
flag (0,1), Set to 1 to Ignore first row, useful if the CSV file has headings
successful operation
No content
POST /api/dataset/import/{dataSetId} HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 83
{
"files": "binary",
"csvImport_{dataSetColumnId}": 1,
"overwrite": 1,
"ignorefirstrow": 1
}successful operation
No content
Import JSON into a DataSet
The DataSet ID to import into.
Schema for importing JSON data into a DataSet
A name of the unique column
Flag True or False, whether to truncate existing data on import
successful operation
No content
POST /api/dataset/importjson/{dataSetId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"uniqueKeys": [
"text"
],
"truncate": true,
"rows": [
{
"ANY_ADDITIONAL_PROPERTY": "text"
}
]
}successful operation
No content
Search Columns for DataSet
The DataSet ID
Filter by DataSet ColumnID
Filter by column heading
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
GET /api/dataset/{dataSetId}/column HTTP/1.1
Accept: */*
successful operation
[
{
"dataSetColumnId": 1,
"dataSetId": 1,
"heading": "text",
"dataTypeId": 1,
"dataSetColumnTypeId": 1,
"listContent": "text",
"columnOrder": 1,
"formula": "text",
"dataType": "text",
"remoteField": "text",
"showFilter": "text",
"showSort": "text",
"dataSetColumnType": "text",
"tooltip": "text",
"isRequired": 1,
"dateFormat": "text"
}
]Add a Column to a DataSet
The DataSet ID
The heading for the Column
A comma separated list of content for drop downs
The display order for this column
The data type ID for this column
The column type for this column
MySQL SELECT syntax formula for this Column if the column type is formula
JSON-String to select Data from the Remote DataSet
Flag indicating whether this column should present a filter on DataEntry
Flag indicating whether this column should allow sorting on DataEntry
Help text that should be displayed when entering data for this Column.
Flag indicating whether value must be provided for this Column.
PHP date format for the dates in the source of the remote DataSet
successful operation
POST /api/dataset/{dataSetId}/column HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 207
"heading='text'&listContent='text'&columnOrder=1&dataTypeId=1&dataSetColumnTypeId=1&formula='text'&remoteField='text'&showFilter=1&showSort=1&tooltip=1&isRequired=1&dateFormat='text'"successful operation
{
"dataSetColumnId": 1,
"dataSetId": 1,
"heading": "text",
"dataTypeId": 1,
"dataSetColumnTypeId": 1,
"listContent": "text",
"columnOrder": 1,
"formula": "text",
"dataType": "text",
"remoteField": "text",
"showFilter": "text",
"showSort": "text",
"dataSetColumnType": "text",
"tooltip": "text",
"isRequired": 1,
"dateFormat": "text"
}Get the DataSet column object specified by the provided datasetId and columnId
Numeric ID of the DataSet to get
Numeric ID of the DataSet column to get
successful operation
Class DataSetColumn
The ID of this DataSetColumn
The ID of the DataSet that this Column belongs to
The Column Heading
The ID of the DataType for this Column
The ID of the ColumnType for this Column
Comma separated list of valid content for drop down columns
The order this column should be displayed
A MySQL formula for this column
The data type for this Column
The data field of the remote DataSet as a JSON-String
Does this column show a filter on the data entry page?
Does this column allow a sorting on the data entry page?
The column type for this Column
Help text that should be displayed when entering data for this Column.
Flag indicating whether value must be provided for this Column.
Date format of dates in the source for remote DataSet.
GET /api/dataset/{id}/column/{colId} HTTP/1.1
Accept: */*
successful operation
{
"dataSetColumnId": 1,
"dataSetId": 1,
"heading": "text",
"dataTypeId": 1,
"dataSetColumnTypeId": 1,
"listContent": "text",
"columnOrder": 1,
"formula": "text",
"dataType": "text",
"remoteField": "text",
"showFilter": "text",
"showSort": "text",
"dataSetColumnType": "text",
"tooltip": "text",
"isRequired": 1,
"dateFormat": "text"
}Edit a Column to a DataSet
The DataSet ID
The Column ID
The heading for the Column
A comma separated list of content for drop downs
The display order for this column
The data type ID for this column
The column type for this column
MySQL SELECT syntax formula for this Column if the column type is formula
JSON-String to select Data from the Remote DataSet
Flag indicating whether this column should present a filter on DataEntry
Flag indicating whether this column should allow sorting on DataEntry
Help text that should be displayed when entering data for this Column.
Flag indicating whether value must be provided for this Column.
PHP date format for the dates in the source of the remote DataSet
successful operation
PUT /api/dataset/{dataSetId}/column/{dataSetColumnId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 207
"heading='text'&listContent='text'&columnOrder=1&dataTypeId=1&dataSetColumnTypeId=1&formula='text'&remoteField='text'&showFilter=1&showSort=1&tooltip=1&isRequired=1&dateFormat='text'"successful operation
{
"dataSetColumnId": 1,
"dataSetId": 1,
"heading": "text",
"dataTypeId": 1,
"dataSetColumnTypeId": 1,
"listContent": "text",
"columnOrder": 1,
"formula": "text",
"dataType": "text",
"remoteField": "text",
"showFilter": "text",
"showSort": "text",
"dataSetColumnType": "text",
"tooltip": "text",
"isRequired": 1,
"dateFormat": "text"
}Delete DataSet Column
The DataSet ID
The Column ID
successful operation
No content
DELETE /api/dataset/{dataSetId}/column/{dataSetColumnId} HTTP/1.1
Accept: */*
successful operation
No content
Get Data for DataSet
The DataSet ID
Filter by dataset data column
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
GET /api/dataset/data/{dataSetId} HTTP/1.1
Accept: */*
successful operation
No content
Add a row of Data to a DataSet
The DataSet ID
Parameter for each dataSetColumnId in the DataSet
successful operation
POST /api/dataset/data/{dataSetId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 29
"dataSetColumnId_ID='text'"successful operation
No content
Edit a row of Data to a DataSet
The DataSet ID
The Row ID of the Data to Edit
Parameter for each dataSetColumnId in the DataSet
successful operation
No content
PUT /api/dataset/data/{dataSetId}/{rowId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 29
"dataSetColumnId_ID='text'"successful operation
No content
Delete a row of Data to a DataSet
The DataSet ID
The Row ID of the Data to Delete
successful operation
No content
DELETE /api/dataset/data/{dataSetId}/{rowId} HTTP/1.1
Accept: */*
successful operation
No content
Search RSSs for DataSet
The DataSet ID
Filter by RSS title
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
GET /api/dataset/{dataSetId}/rss HTTP/1.1
Accept: */*
successful operation
[]Add a RSS to a DataSet
The DataSet ID
The title for the RSS
The author for the RSS
The columnId to be used as each item summary
The columnId to be used as each item content
The columnId to be used as each item published date
successful operation
Class DataSetRss
POST /api/dataset/{dataSetId}/rss HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 98
"title='text'&author='text'&summaryColumnId=1&contentColumnId=1&publishedDateColumnId=1"successful operation
No content
Get the DataSet RSS object specified by the provided datasetId and rssId
Numeric ID of the DataSet to get
Numeric ID of the DataSet RSS to get
successful operation
Class DataSetRss
GET /api/dataset/{id}/rss/{rssId}} HTTP/1.1
Accept: */*
successful operation
No content
Edit DataSet Rss Feed
The DataSet ID
The RSS ID
The title for the RSS
The author for the RSS
The rssId to be used as each item summary
The columnId to be used as each item content
The columnId to be used as each item published date
Regenerate the PSK?
successful operation
No content
PUT /api/dataset/{dataSetId}/rss/{rssId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 116
"title='text'&author='text'&summaryColumnId=1&contentColumnId=1&publishedDateColumnId=1®eneratePsk=1"successful operation
No content
Last updated
Was this helpful?