Data Manager APIs

Authentication

Authentication to use DataManager APIs:
POST: {Adaptation URL}/api/token
Parameter Required Description
username Yes Username for the authentication.
password Yes Password for the authentication.

INPUT:
{Adaptation URL}/api/token
OUTPUT:

Get IUS Data and Maps

Returns data for given IUSs, Areas, Time Periods, Sources:
GET: {Adaptation URL}/api/data/ius={IGId,UGId,SGId}/tp={time period}/src={source name}/area={area ID}/db={database ID}/data={true or false}/map={true or false}
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
ius Yes Indicator, Unit and Subgroup GIDs comma separated. Allowed multiple IUSs separator by '{~}'.
tp No Time Period. Options are 'MRD'=>Most Recent data, 'TS'=>Time Series Data or 'Time Periods'. Allowed multiple time periods separated by '{~}'
area No Area ID whose data is required. Allowed multiple area IDs seprated by '{~}'
areaLevel No Area level. 'Level Form' and 'Level To' separated by underscore (_) for example 1_4
src No Source name whose data is required. Allowed multiple sources separated by '{~}'
db Yes Database connection ID.
lang No Database language code
callback No Cross domain (JSONP) handling '?callback={dynamic string}'.
data No true/false if require data.
map No true/false if require maps for given area.
getChildren No yes/no if require first subnational maps for a given area.
INPUT:
{Adaptation URL}/api/data/ius=POP_SIZE,NUM,TOT{~}POP_SIZE,NUM,M/src=/area=IND{~}ZMB/tp=MRD/lang=en/getChildren=no/map=false/db=207

OUTPUT:
Node 'master', contains master information such as area id, area name IUS name.
Node 'data', contains data as 'IUS GID' -> 'Time peirod' -> 'Area Id'
Each Area Id contains data in array as 'Data Value', 'Source Name' and 'Time Period'

INPUT:
{Adaptation URL}/api/data/ius=POP_SIZE,NUM,TOT{~}POP_SIZE,NUM,M/src=/area=IND{~}ZMB/tp=MRD/lang=en/getChildren=no/map=true/db=207

OUTPUT:
If map is true, then API will return maps in geoJSON format along with data for given areas.
See below output screen, API returns maps for India and Zambia.
If data is not required, pass 'data=false' in query string.

Get Area List

Returns list of area level and areas:
GET: {Adaptation URL}/api/area/area={true/false}/level={true/false}/areaID={Area IDs}/areaLevel=n_n/db={database ID}
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
area No true/false if require area list. Default is true
level No true/false if require area level list. Default is true
areaID No Comma separated Area IDs if need specific areas
areaLevel No Filter area list by area level {from level}_{to level}. If need children of an area, provide areaID.
db No Database connection ID.
keyword No Search on area id, area name and area gid.
lang No Database language code
callback No Cross domain (JSONP) handling '?callback={dynamic string}'.
INPUT:
{Adaptation URL}/api/area/area=true/level=true/db=207/areaLevel=4/lang=en

OUTPUT:
Node 'level', contains all Areas levels available in database.
Node 'area', contains list of area based on given parameter

Manage IUS

Manages information of Indicator, Unit, Subgroup Vals and IUS. If only indicator's information is provided, then indicator will be managed.
If a combination of Indicator and unit is encountered, the Indicator and Unit will be managed and so on.
As complete information of indicator, unit and subgroup val is provided, the IUS is managed.
POST: {Adaptation URL}/api/ius/save
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
action no add or update or delete or add/update. Default is add
dbId yes Database id is required
lang No Database language code. If not provided, the default language in the database will be the default langugae
indicator[name] no Indicator name
indicator[gid] no Indicator Gid
indicator[highIsGood] no Whether highIsGood. 0 if no and 1 otherwise
indicator[dataType] no The kind of data to be added. options - TEXT, ENUM, NUM
indicator[short_name] no Short name for indicator
indicator[icGids][0] no Indicator Classification gid - To make relationship with a new IUS (in the ic_ius table)
indicator[dataValidation][min] no minimum value of data to be added (only when data type -> NUM)
indicator[dataValidation][max] no Maximum value of data to be added (only when data type -> NUM)
indicator[dataValidation][enumAttrs][0][attr] no Attribute of enum (only when data type -> ENUM)
indicator[dataValidation][enumAttrs][0][val] no Value of enum (only when data type -> ENUM)
unit[gid] no Unit gid
unit[name] no Unit name
subgroupVal[0][gid] no Subgroup Val Gid - if not found it will use dimensions data
subgroupVal[0][icGids][0] no give icGid here if needed for specific IUS. (Would overwrite if provided in indicator)
subgroupVal[0][isDefault] no true if we want default subgroup and false otherwise
subgroupVal[0][dimension][0][sgName] no Subgroup name
subgroupVal[0][dimension][0][sgGid] no Subgroup gid
subgroupVal[0][dimension][0][sgtName] no Subgroup Type Name
subgroupVal[0][dimension][0][sgtGid] no Subgroup Type Gid
OUTPUT:

Message is displayed in whether indicator, unit or subgroup is added or updated.
In case the indicator, unit or subgroupval is not found, the IUS shall not be updated
We can add/update indicator, unit, subgroup and subgroup val independently

Data Entry API

Adds/updates the data provided the data is complete
In case of Indicator, unit and subgroup val, if the gid is not found, it will search records using the name
Apart from data, this API can make changes to Footnotes, Source and Timperiod alone
POST: {Adaptation URL}/api/dataentry
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
action no add or update or delete or add/update. Default is add
dbId yes Database id is required
lang No Database language code. If not provided, the default language in the database will be the default langugae
data[0][iName] no Indicator name
data[0][iGid] no Indicator Gid
data[0][uName] no Unit name
data[0][uGid] no Unit Gid
data[0][data][0][sgName] no Subgroup val name
data[0][data][0][sgGid] no Subgroup Val Gid
data[0][data][0][tp] no Timeperiod
data[0][data][0][aId] no AreaId
data[0][data][0][dv] no Data value
data[0][data][0][src] no source name
data[0][data][0][fn] no Footnote name
OUTPUT:

Message is displayed telling the number of records imported.
Also informs whether there was some issue and also cites reason for the issue.
If footnote is not found/provided we use the footnote with footnote_nid=-1.
We can add multiple data values.

Add Language tables in database API

This API adds language tables as the language code and name are provided
POST: {Adaptation URL}/api/addlangdb
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
langs[0][langCode] yes Database language code
langs[0][langName] yes Database language name
OUTPUT:

Message is displayed telling the language codes used to create those language's tables .
we will add languages tables only if language codes do not exist in the database .

Copy Database API

This API copies database using the database id of the host database
POST: {Adaptation URL}/api/copydb
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
langs[0] no Database language codes. If provided, only tables for the provided langs will be created
databaseName no The new database name
tableStructure[0] no the tables that are to be avoided
OUTPUT:

Message is displayed telling the database clone has been created .

Delete language tables API

This API deletes languages tables using the database id of the host database
POST: {Adaptation URL}/api/dellangdb
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
langs[0] yes Database language codes. If found in the host database, only then the language tables shall be deleted
OUTPUT:

Message is displayed stating the codes for which the tables are deleted .

Truncate tables API

This API truncates data from the tables with exceptions(if provided)
POST: {Adaptation URL}/api/truncatedb
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
tables no It can be either "all" or an array of tables. If it is an array of table, then only the provided tables shall be truncated and if it is 'all' then all the tables shall be truncated unless exceptions provided in the ignoreTables
ignoreTables[0] no Includes the table names(an array) that need to be ignored while truncating when tables='all'
OUTPUT:

Message is displayed stating that tables are truncated depending upon your inputs.

Save/Delete Area API

This API saves/deleted area details from the area table
POST: {Adaptation URL}/api/area/save
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
action no add or update or delete or add/update. Default is add
lang no Database language code. If not provided, the default language in the database will be the default langugae
areaArr[0]['pid'] no Parent Area ID. If not provided, the parent area id will be the areaID of the area at the root level
areaArr[0]['aid'] yes Area ID
areaArr[0]['aname'] no Area Name
areaArr[0]['agid'] no Area gid. If not provided, the gid will be an auto generated value
areaArr[0]['alevel'] no Area level. If not provided, the area level will be equal to (level of the parent area) + 1
areaArr[0]['shortName'] no Area short name. If not provided,it will simple be avoided
areaArr[0]['latitude'] no Area latitude. If not provided,it will be ignored
areaArr[0]['longitude'] no Area longitude. If not provided,it will be ignored
OUTPUT:

Message is displayed stating that area is saved.

Save/Delete IC API

This API saves/deleted IC details from the IndicatorClassifications table
POST: {Adaptation URL}/api/ic/save
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
action no add or update or delete or add/update. Default is add
lang no Database language code. If not provided, the default language in the database will be the default langugae
ic[0]['icType'] yes IC Type, e.g., SC,SR,TH,etc
ic[0]['parentGid'] no Parent IC Gid. If not provided, it will be -1 (root)
ic[0]['name'] yes ic_name that needs to be added/updated
ic[0]['gid'] no IC gid. If not provided, the gid will be an auto generated value
OUTPUT:

Message is displayed stating that IC is saved/deleted.

De-Register/Delete Database

This API De-Register/delete database detail from database connection table of application database
POST: {Adaptation URL}/api/deletedb
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
hardDelete yes hardDelete is required. This will will be given true or false. true will delete the database from database connection and false will make the flag true which means its soft deleted

Get Database Detail

This API get database detail from database connection table of application database
POST: {Adaptation URL}/api/getDatabaseDetail
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required

Get Ic types Detail

This API get IC detail from table of selected database
POST: {Adaptation URL}/api/ictypes
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required

Get Ic List

This API get IC list from table of selected database
GET: {Adaptation URL}/api/ic
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
icType no Multiple ic type should be comma separated.
icorder no 'alphabatic' or 'database'.
sort no 'ASC' or 'DESC'.

OUTPUT:
Classification list output list will look like as below.
See below output screen.

Get Indicator Detail

This API get Indicator detail from table of selected database
POST: {Adaptation URL}/api/ind
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
iGid no Indicator gid. To search for multiple gids, enter with comma separated.
keyword no Search indicator by indicator name, indicator gid, short name and keywords.
icGid no Search indicator by indicator classification GID.
isMetadata no Search indicator by metadata availability. Allowed true/false
enableIcInfo no true/false if you want IC information with the list of indicator
indorder no 'alphabatic' or 'database'
sort no 'asc' or 'desc'

Get Unit Detail

This API get Unit detail from table of selected database
POST: {Adaptation URL}/api/unit
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
uGid no Unit gid. To search for multiple gids, enter with comma separated.
keyword no Search unit by unit name, unit gid.

Get SUb Group Val Detail

This API get SUb Group Val detail from table of selected database
POST: {Adaptation URL}/api/sgVal
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required

Get Source Detail

This API get source detail from table of selected database
POST: {Adaptation URL}/api/source
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required

Get Subgroup Detail

This API get subgroup master list from table of selected database
GET: {Adaptation URL}/api/sg
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
sGid no Subgroup gid array list is optional
sgDimGid no Subgroup dimension type gid. In case of multiple dimension type gid, it should be comma separated.

Get IC IUS Detail

This API get ic ius detail from table of selected database
GET: {Adaptation URL}/api/icius
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
iGid no Indicator gids array list is optional
uGid no Unit gids array list is optional
sGid no Subgroup gids array list is optional
icGid no Indicator classification gids array list is optional
icType no Indicator classification type array list is optional

Get Time period Detail

This Time period detail from table of selected database
POST: {Adaptation URL}/api/timeperiod
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required

Get indicator's meta data Detail

This meta data detail from table of selected database
POST: {Adaptation URL}/api/metadata
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
metaType yes metaType field is required and its value should be 'Ind'
iGid no Indicator Gid is meta type is 'Ind'
catorder no 'alphabatic' or 'database'
sort no 'asc' or 'desc'

Save user

Add a user
POST: {Adaptation URL}/api/saveusr
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
usrArr[0]['username'] yes username
usrArr[0]['name'] no name
usrArr[0]['roleAction'] no role action should be entered (add/remove)
usrArr[0]['email'] no email information
usrArr[0]['roles'][0] yes roles information (ADMIN/TEMPLATE/...etc)
usrArr[0]['status'] no status info (0/1)

Get IUS validations

Get IUS validation information from table of selected database
POST: {Adaptation URL}/api/iusvalid
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
iGid no Indicator gid with comma separated
uGid no Unit gid with comma separated
sGid] no Subgroup gid with comma separated
iusType no Validation type NUM/TEXT/ENUM

Save Timeperiod

Save timeperiod detail in the table of selected database
POST: {Adaptation URL}/api/timeperiod/save
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
tp yes List of timeperiods. Each timeperiod should be separated by {~}

Save Source

Save source detail in the table of selected database
POST: {Adaptation URL}/api/source/save
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
src yes List of source. Each source should be separated by {~}

Get dimension type

Get dimension types from the table of selected database
GET: {Adaptation URL}/api/dimensiontype?dbId={database ID}&keyword={search keyword}
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
keyword no Search on subgroup type name and subgroup type gid

OUTPUT:
If input keyword is given then output will search on subgroup type name and subgroup type gid.
See below output screen.

Get dimension detail

Get dimension detail from the table of selected database
GET: {Adaptation URL}/api/dimension/sGid={subgroup type gids}/dbId={database ID}
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
sGid no Comma separated sGid if need specific subgroup type

Get IUS detail

Get IUS detail from the table of selected database
GET: {Adaptation URL}/api/ius/iGid={indicator gids}/uGid={unit gids}/sGid={subgroup val gids}/icGid={subgroup val gids}/dbId={database ID}
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
iGid no Comma separated iGid if need specific indicator
uGid no Comma separated uGid if need specific unit
sGid no Comma separated sGid if need specific subgroup val
icGid no Comma separated icGid if need specific classification
orderBy no asc or desc
icType no Classification type such as SC, TH, GL etc.
sortBy no Field name for the sorting i.e. IND.Indicator_Name

Save db Metadata

Save db Metadata in the table of selected database
POST: {Adaptation URL}/api/dbmetadata
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required

Delete Indicator

Delete Indicator from the table of selected database
POST: {Adaptation URL}/api/delete/indicator
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
iGid yes Comma separated iGid to delete indicators

Delete Unit

Delete Unit from the table of selected database
POST: {Adaptation URL}/api/delete/unit
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
iGid yes Comma separated uGid to delete Units

Delete Subgroup Val

Delete subgroup val from the table of selected database
POST: {Adaptation URL}/api/delete/subgroupval
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
sGid yes Comma separated sGid to delete subgroup val

Delete Subgroup

Delete subgroup from the table of selected database
POST: {Adaptation URL}/api/delete/subgroup
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
sGid yes Comma separated sGid to delete subgroup

Add Language

Add language in the table of selected database
POST: {Adaptation URL}/api/createLang
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
createLangArr[toLangCode] yes Language code
createLangArr[toLangName] yes Language name

Remove Language

Remove language from the table of selected database
POST: {Adaptation URL}/api/removeLang
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
createLangArr[toLangCode][0] yes Language code
createLangArr[toLangCode][1] no Enter more language code if you want multiple language code

Save Indicator API

This API saves indicator details
POST: {Adaptation URL}/api/saveInd
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
multicase no Multicase is Optional true/false
indArr[0]['iName'] yes Indicator name
indArr[0]['iGid'] no Indicator gid is Optional
indArr[0]['highIsGood'] no High is good

Save Unit API

This API saves unit details
POST: {Adaptation URL}/api/saveUnit
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
multicase no Multicase is Optional. (true/false)
unitArr[0]['uName'] yes Unit name
unitArr[0]['uGid'] no Unit gid is optional

Save Dimension type API

This API saves Dimension type details
POST: {Adaptation URL}/api/saveSgType
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
sgDimTypedata[0]['Name'] yes Dimension type name
sgDimTypedata[0]['typeGid'] yes Dimension type gid

Save Dimension value API

This API saves Dimension value details
POST: {Adaptation URL}/api/saveSg
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
sgDimData[0]['typeGid'] yes Dimension type gid
sgDimData[0]['gId'] yes Dimension val gid
sgDimData[0]['val'] yes Dimension value/td>
sgDimData[0]['sOrder'] no order no

Save Subgroup val API

This API saves subgroup val details
POST: {Adaptation URL}/api/saveSgVal
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
sgValData[0][dimension][0][dvName] yes Dimension value name (ie. Rural)
sgValData[0][dimension][0][dvGid] yes Dimension value gid
sgValData[0][dimension][0][typeGid] yes Dimension type gid (ie. Location)
sgValData[0][dimension][1][dvName] yes Dimension value name (ie. Male)
sgValData[0][dimension][1][dvGid] yes Dimension value gid
sgValData[0][dimension][1][typeGid] yes Dimension type gid (ie. Sex)
sgValData[0][sName] yes Subgroup val name (combination of dimension value=> Rural Male)
sgValData[0][sGid] no Subgroup val gid is optional

Get registered database list API

This API get all registerd database list
POST: {Adaptation URL}/api/databaseList
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required
filterKeys[dbHost][0] no Filter key for database host
filterKeys[dbHost][1] no Filter key for database host

Get DB Metadata API

API to get database metadata
GET: {Adaptation URL}/api/database/metadata
Parameter Required Description
Authorization (Header) Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5NTUsImV4cCI6MTU3NjI0NTcyMH0.9LHTBPeqjii4NGMWelvusSUU4YrZH1AFAP5O7YcjM6I
dbId yes Database id is required