Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languageen

Data sets

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

GETLists attribute values by given data set ID and attribute code.
POST Attribute Value Image

/api/dataSets/:id/attributes/:code/:value/image

POSTEdits 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/:exidGETReturns 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/dataGETRetrieves data set data for desired data set specified by ID.
POST Data Set Data/api/dataSets/:id/dataPOSTUpdates existing row or inserts new row in data set specified by ID.
PATCH Data Set Data/api/dataSets/:id/dataPATCHUpdates existing rows in a data set specified by ID that match on given parameters.
POST Data Set Data Replace/api/dataSets/:id/replacePOSTDeletes 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/customMembersGETLists custom members for the given data set ID and attribute code.
GET Custom Member Detail/api/dataSets/:id/attributes/:code/customMembers/:cmidGETShows detailed information about the custom members with the specified ID.
POST Create Custom Member/api/dataSets/:id/attributes/:code/customMembers/createPOSTCreate a new custom member for given data set ID and attribute code.
POST Edit Custom Member/api/dataSets/:id/attributes/:code/customMembers/:cmidPOSTEdits an existing custom member for given data set ID and attribute code.

DELETE Custom Member

/api/dataSets/:id/attributes/:code/customMembers/:cmidDELETEDeletes custom member with the specified ID.

POST Validate Custom Member Formula

/api/dataSets/formula/validatePOSTValidates the formula of a custom member.
GET Subsets/api/dataSets/:id/attributes/:code/subsetsGETLists subsets for the given data set ID and attribute code.
GET Subset Detail/api/dataSets/:id/attributes/:code/subsets/:sidGETReturns detailed information about the subset for the given data set ID and attribute code.

POST Create Subset

/api/dataSets/:id/attributes/:code/subsets/createPOSTCreate a new subset for given data set ID and attribute code.
POST EDIT Subset/api/dataSets/:id/attributes/:code/subsets/:sidPOSTEdits the subset for given data set ID and attribute code.

DELETE Subset

/api/dataSets/:id/attributes/:code/subsets/:sidDELETEDeletes the subset with the specified ID.
GET Subset Value/api/dataSets/:id/attributes/:code/subsets/:sid/value/:svidGETReturns 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/addValuePOSTAdds 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/:svidPOSTEdits the subset value for given data set ID, attribute code and subset.
DELETE Subset Value/api/dataSets/:id/attributes/:code/subsets/:sid/value/:svidDELETEDeletes 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/moveUpPOSTChanges 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/moveDownPOSTChanges the order of values in the subset. Moves the subset value down one level for given data set ID, attribute code and subset.


...