Resource | URL | Method | Overview |
|---|
GET Data Sets | /api/dataSets | GET | Lists all data sets available to the user. |
GET Data Set Detail | /api/dataSets/:id | GET | Shows detailed information about the data set with the specified ID. |
| GET Attribute Values | /api/dataSets/:id/attributes/:code/values | GET | Lists attribute values by given data set ID and attribute code. |
| POST Attribute Value Image | /api/dataSets/:id/attributes/:code/:value/image | POST | Edits image in appearance settings for given data set ID, attribute code and attribute value. |
GET Data Sources | /api/dataSets/:id/dataSources | GET | Lists all data sources related to the data set with the specified ID. |
GET Data Source Executions | /api/dataSets/dataSources/:id/executions | GET | Lists all data source executions specified by data source ID. |
| GET Data Source Execution Result | /api/dataSets/dataSources/:id/executions/:exid | GET | Returns detailed information about the data source execution. |
POST Schedule Execution | /api/dataSets/dataSources/:id/schedule | POST | Schedule execution for data source specified by ID. |
| GET Data Set Data | /api/dataSets/:id/data | GET | Retrieves data set data for desired data set specified by ID. |
| POST Data Set Data | /api/dataSets/:id/data | POST | Updates existing row or inserts new row in data set specified by ID. |
| PATCH Data Set Data | /api/dataSets/:id/data | PATCH | Updates existing rows in a data set specified by ID that match on given parameters. |
| POST Data Set Data Replace | /api/dataSets/:id/replace | POST | Deletes data based on a filter and then updates existing row or inserts new row in data set specified by ID. |
| GET Custom Members | /api/dataSets/:id/attributes/:code/customMembers | GET | Lists custom members for the given data set ID and attribute code. |
| GET Custom Member Detail | /api/dataSets/:id/attributes/:code/customMembers/:cmid | GET | Shows detailed information about the custom members with the specified ID. |
| POST Create Custom Member | /api/dataSets/:id/attributes/:code/customMembers/create | POST | Create a new custom member for given data set ID and attribute code. |
| POST Edit Custom Member | /api/dataSets/:id/attributes/:code/customMembers/:cmid | POST | Edits an existing custom member for given data set ID and attribute code. |
DELETE Custom Member | /api/dataSets/:id/attributes/:code/customMembers/:cmid | DELETE | Deletes custom member with the specified ID. |
POST Validate Custom Member Formula | /api/dataSets/formula/validate | POST | Validates the formula of a custom member. |
| GET Subsets | /api/dataSets/:id/attributes/:code/subsets | GET | Lists subsets for the given data set ID and attribute code. |
| GET Subset Detail | /api/dataSets/:id/attributes/:code/subsets/:sid | GET | Returns detailed information about the subset for the given data set ID and attribute code. |
POST Create Subset | /api/dataSets/:id/attributes/:code/subsets/create | POST | Create a new subset for given data set ID and attribute code. |
| POST EDIT Subset | /api/dataSets/:id/attributes/:code/subsets/:sid | POST | Edits the subset for given data set ID and attribute code. |
DELETE Subset | /api/dataSets/:id/attributes/:code/subsets/:sid | DELETE | Deletes the subset with the specified ID. |
| GET Subset Value | /api/dataSets/:id/attributes/:code/subsets/:sid/value/:svid | GET | Returns detailed information about the selected subset value for the given data set ID, attribute code and subset ID. |
POST Add Subset Value | /api/dataSets/:id/attributes/:code/subsets/:sid/addValue | POST | Adds a new subset value for given data set ID, attribute code and subset. |
POST Edit Subset Value | /api/dataSets/:id/attributes/:code/subsets/:sid/value/:svid | POST | Edits the subset value for given data set ID, attribute code and subset. |
| DELETE Subset Value | /api/dataSets/:id/attributes/:code/subsets/:sid/value/:svid | DELETE | Deletes the subset value for given data set ID, attribute code and subset. |
POST Move Subset Value Up | /api/dataSets/:id/attributes/:code/subsets/:sid/value/:svid/moveUp | POST | Changes the order of values in the subset. Moves the subset value up one level for given data set ID, attribute code and subset. |
| POST Move Subset Value Down | /api/dataSets/:id/attributes/:code/subsets/:sid/value/:svid/moveDown | POST | Changes the order of values in the subset. Moves the subset value down one level for given data set ID, attribute code and subset. |