Mapping Assistant API
Mapping Assistant REST API
Version: 1.5.0
BasePath:/v1
European Commision (represented by Eurostat) 2017 All rights reserved
http://opensource.org/licenses/EUPL-1.1
Access
[ Jump to Models ]
Table of Contents
Up
post /dataset/plugin/{sid}/{id}
Extract the SQL Query from the dataset extra data (datasetPluginSidIdPost)
Note this POST will return the result.
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Request body
Body Parameter — A dataset object
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The dataset with the SQL Query generated
DataSet
default
Unexpected error
Error
Up
post /ddb/column/{sid}/{id}
Execute the query and get the dataset columns given a storeId, the entityId of a DDB Connection Setting and a SQL Query (ddbColumnSidIdPost)
Note this POST will return the result.
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Request body
Body Parameter — Search/Query request
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The test results from testing the dissemination database connection
default
Unexpected error
Error
Up
post /ddb/data/{sid}/{id}
Execute a SQL Query against the Dissemination database (ddbDataSidIdPost)
Note this POST will return the result. Alternative we would have to store the query somewhere at server side.
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Request body
Body Parameter — Search/Query request
Query parameters
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"columns" : [ "aeiou" ],
"total_rows" : 6,
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"page" : 0,
"rows" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The test results from testing the dissemination database connection
QueryResult
default
Unexpected error
Error
Up
get /ddb/data/{sid}/{id}/table/{tableId}/{field}
Get specific the table and/or view data from the Dissemination database (ddbDataSidIdTableTableIdFieldGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
tableId (required)
Path Parameter — The resource unique identifier format: id
field (required)
Path Parameter — The field name format: id
Query parameters
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"columns" : [ "aeiou" ],
"total_rows" : 6,
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"page" : 0,
"rows" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The table or view
QueryResult
default
Unexpected error
Error
Up
get /ddb/data/{sid}/{id}/table/{tableId}
Get specific the table and/or view data from the Dissemination database (ddbDataSidIdTableTableIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
tableId (required)
Path Parameter — The resource unique identifier format: id
Query parameters
columns (optional)
Query Parameter — The columns/components separated by comma
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"columns" : [ "aeiou" ],
"total_rows" : 6,
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"page" : 0,
"rows" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The table or view
QueryResult
default
Unexpected error
Error
Up
get /ddb/status/{sid}/{id}
Test the Dissemination database connection (ddbStatusSidIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
{
"errorMessage" : { },
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"status" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The test results from testing the dissemination database connection
ActionResult
default
Unexpected error
Error
Up
get /ddb/table/{sid}/{id}
Get the tables and views from the Dissemination database (ddbTableSidIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The list of tables
default
Unexpected error
Error
Up
get /ddb/table/{sid}/{id}/{tableId}
Get specific the table and/or view definition from the Dissemination database (ddbTableSidIdTableIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
tableId (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The table or view
Table
default
Unexpected error
Error
Up
get /dataset/data/{sid}/{id}
Query dataset (datasetDataSidIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Query parameters
columns (optional)
Query Parameter — The columns/components separated by comma
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"columns" : [ "" ],
"total_rows" : 6,
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"page" : 0,
"rows" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of datasets
DataSetQueryResult
default
Unexpected error
Error
Up
get /dataset/sql_column/{sid}/{id}
Generate dataset columns from an existing dataset. It wont save the dataset columns just retrieve them (datasetSqlColumnSidIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of DataSetColumn
default
Unexpected error
Error
Up
post /dataflow/version/{sid}/{agencyId}/{id}/{sourceVersion}/{targetVersion}
Upgrade dataflow using the provided SDMX structural metadata (dataflowVersionSidAgencyIdIdSourceVersionTargetVersionPost)
Import selected artefacts
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
agencyId (required)
Path Parameter — The SDMX resource maintainable agency ID format: id
id (required)
Path Parameter — The resource unique identifier format: id
sourceVersion (required)
Path Parameter — Source version version string
targetVersion (required)
Path Parameter — target version version string
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — A JSON representing the query request
Query parameters
registryId (optional)
Query Parameter — The id of the registry as it is in the DB format: id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Resource created
default
Unexpected error
Error
Up
post /entity/{sid}/{entity}/{id}
Copy Entity (entitySidEntityIdPost)
Copy Entity
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
entity (required)
Path Parameter — The entity type
id (required)
Path Parameter — The resource unique identifier format: id
Query parameters
copyParents (optional)
Query Parameter — Whether to create a copy of the parents as well
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Resource created
default
Unexpected error
Error
Up
post /entity/{sid}/{entity}/{id}/{targetSid}
Copy Entity from source store to target store (entitySidEntityIdTargetSidPost)
Copy Entity
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
entity (required)
Path Parameter — The entity type
id (required)
Path Parameter — The resource unique identifier format: id
targetSid (required)
Path Parameter — The Target Mapping Assistant Store identifier format: id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Resource created
default
Unexpected error
Error
Up
post /entity/{sid}/{entity}
Add new Entity (entitySidEntityPost)
Add a new Entity
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
entity (required)
Path Parameter — The entity type
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
mappingAssistantJson
Message (required)
Body Parameter — A Mapping Assistant specific Message
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Resource created
default
Unexpected error
Error
Get the log of a current process (logIdGet)
Path parameters
id (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The log of the current process
Log
303
Requested completed
default
Unexpected error
Error
get the plugin information with the specified id (pluginsIdGet)
Path parameters
id (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The plugin information with the specified id
Plugin
default
Unexpected error
Error
Up
get /plugins/{id}/template/connection
get the connection template for a connection plugin with the specificed ID (pluginsIdTemplateConnectionGet)
Path parameters
id (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The empty connection settings
ConnectionSettings
default
Unexpected error
Error
Up
post /registry/{sid}/{registryId}/{structureType}
Import artefacts (registrySidRegistryIdStructureTypePost)
Import selected artefacts
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
registryId (required)
Path Parameter — The id of the registry as it is in the DB format: id
structureType (required)
Path Parameter — The type of the structure requested
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — A JSON representing the query request
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Resource created
default
Unexpected error
Error
Get all available mapping stores (storeGet)
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array with all Mapping Assistant store ids
default
Unexpected error
Error
Create a new setting for a mapping assistant store (storePost)
Request body
Body Parameter — Mapping Asssistant connection settings message to create or replace
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Resource created
409
A connection setting with the same id already exists
default
Unexpected error
Error
Get a zip file containing all SDMX artefacts and Mapping Assistant entities (storeSidAllGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Return type
File
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
A zip file containing all the entities and SDMX artefacts
File
default
Unexpected error
Error
POST a zip file containing the SDMX and entities (storeSidAllPost)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Represents a file. Any kind of file. The consumes identifies the type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
202
Requested accepted and is being processed
default
Unexpected error
Error
Up
post /store/{sid}/all/{targetSid}
COPY the whole Mapping Assistant DB including the SDMX and entities to the target sid (storeSidAllTargetSidPost)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
targetSid (required)
Path Parameter — The Target Mapping Assistant Store identifier format: id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
202
Requested accepted and is being processed
default
Unexpected error
Error
Up
get /store/{sid}/entity/all
Get an XML file containing all Mapping Assistant entities (storeSidEntityAllGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Return type
File
Example data
Content-Type: application/xml
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An XML file containing all the entities
File
default
Unexpected error
Error
Up
post /store/{sid}/entity/all
POST a xml file containing entities (storeSidEntityAllPost)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Represents a file. Any kind of file. The consumes identifies the type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
202
Requested accepted and is being processed
default
Unexpected error
Error
Get Mapping Assistant store settting with the specified ID (storeSidGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Connection settings for the store
MappingAssistantStore
default
Unexpected error
Error
Up
get /store/{sid}/languages
Get the all languages used by SDMX artefacts inside a mapping store (storeSidLanguagesGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Return type
Example data
Content-Type: application/json
{
"codes" : [ "aeiou" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array with all language codes available.
Languages
default
Unexpected error
Error
Replace an existing setting for a mapping assistant store (storeSidPut)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Request body
Body Parameter — Mapping Asssistant connection settings message to create or replace
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Store replaced
404
A connection setting with this ID doesn't exist
default
Unexpected error
Error
Up
get /store/{sid}/status
Get Mapping Assistant store status (storeSidStatusGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Return type
Example data
Content-Type: application/json
{
"errorMessage" : { },
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"status" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Connection settings for the store
ActionResult
default
Unexpected error
Error
Up
post /store/{sid}/status
Initialize the Mapping Store (storeSidStatusPost)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Request body
Body Parameter — Command to initialize the mapping store DB
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
202
Requested accepted and is being processed
default
Unexpected error
Error
Up
get /store/{sid}/version
Get Mapping Assistant Store version (storeSidVersionGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Return type
Example data
Content-Type: application/json
{
"version" : "aeiou"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Connection settings for the store
Version
default
Unexpected error
Error
Up
post /store/{sid}/version
Upgrade version (storeSidVersionPost)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Request body
Body Parameter — A version string
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
202
Requested accepted and is being processed
default
Unexpected error
Error
Up
delete /entity/{sid}/{entity}/{id}
Delete an entity (entitySidEntityIdDelete)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
entity (required)
Path Parameter — The entity type
id (required)
Path Parameter — The resource unique identifier format: id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
entity deleted
default
Unexpected error
Error
Retrieve the actions for all users (actionSidGet)
Provides a method getting the user actions
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
Query parameters
entityId (optional)
Query Parameter — The entity Id
entity (optional)
Query Parameter — The entity type
startDate (optional)
Query Parameter — The start time
endDate (optional)
Query Parameter — The end time
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The user actions
default
Unexpected error
Error
Up
get /action/{sid}/{userName}
Retrieve the actions for all users (actionSidUserNameGet)
Provides a method getting the user actions
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
userName (required)
Path Parameter — The user name format: id
Query parameters
entityId (optional)
Query Parameter — The entity Id
entity (optional)
Query Parameter — The entity type
startDate (optional)
Query Parameter — The start time
endDate (optional)
Query Parameter — The end time
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The user actions
default
Unexpected error
Error
Up
get /ddb/data/{sid}/{id}/table/{tableId}/{field}
Get specific the table and/or view data from the Dissemination database (ddbDataSidIdTableTableIdFieldGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
tableId (required)
Path Parameter — The resource unique identifier format: id
field (required)
Path Parameter — The field name format: id
Query parameters
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"columns" : [ "aeiou" ],
"total_rows" : 6,
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"page" : 0,
"rows" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The table or view
QueryResult
default
Unexpected error
Error
Up
get /ddb/data/{sid}/{id}/table/{tableId}
Get specific the table and/or view data from the Dissemination database (ddbDataSidIdTableTableIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
tableId (required)
Path Parameter — The resource unique identifier format: id
Query parameters
columns (optional)
Query Parameter — The columns/components separated by comma
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"columns" : [ "aeiou" ],
"total_rows" : 6,
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"page" : 0,
"rows" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The table or view
QueryResult
default
Unexpected error
Error
Up
get /ddb/status/{sid}/{id}
Test the Dissemination database connection (ddbStatusSidIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
{
"errorMessage" : { },
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"status" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The test results from testing the dissemination database connection
ActionResult
default
Unexpected error
Error
Up
get /ddb/table/{sid}/{id}
Get the tables and views from the Dissemination database (ddbTableSidIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The list of tables
default
Unexpected error
Error
Up
get /ddb/table/{sid}/{id}/{tableId}
Get specific the table and/or view definition from the Dissemination database (ddbTableSidIdTableIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
tableId (required)
Path Parameter — The resource unique identifier format: id
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The table or view
Table
default
Unexpected error
Error
Up
get /entity/{sid}/{entity}
Retrieve the entities (entitySidEntityGet)
Provides generic methods to retrieve entity IDs
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
entity (required)
Path Parameter — The entity type
Query parameters
parents (optional)
Query Parameter — The parent or parents of a resource, separated by comma
parentType (optional)
Query Parameter — The type of the SDMX structure resource
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
the message containing the entities
default
Unexpected error
Error
Up
get /entity/{sid}/{entity}/{id}
Retrieve the entities (entitySidEntityIdGet)
Provides generic methods to retrieve entities optionally with their references
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
entity (required)
Path Parameter — The entity type
id (required)
Path Parameter — The resource unique identifier format: id
Query parameters
references (optional)
Query Parameter — whether to retrieve references
detail (optional)
Query Parameter — whether to return full detais
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"entities" : {
"otf" : { },
"headerTemplates" : { },
"registry" : { },
"datasets" : { },
"genericmappings" : { },
"ddbconnections" : { },
"local_codes" : [ "" ],
"mappingsets" : { },
"description_source" : [ "" ],
"transcodingRules" : [ "" ],
"user" : [ "" ],
"dataset_column" : { },
"transcodings" : { }
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
the message containing the entities and optionally their references
Message
default
Unexpected error
Error
Get all available plugins (pluginsGet)
Query parameters
type (optional)
Query Parameter — filter by plugin type
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of all plugins, optionally filtered by type
default
Unexpected error
Error
Up
get /registry/{sid}/{registryId}/{structureType}
Retrieve the artefacts as stubs (registrySidRegistryIdStructureTypeGet)
Provides a method of getting a structure type as stubs
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
registryId (required)
Path Parameter — The id of the registry as it is in the DB format: id
structureType (required)
Path Parameter — The type of the structure requested
Query parameters
references (optional)
Query Parameter — whether to retrieve references
detail (optional)
Query Parameter — whether to return full detais
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"entities" : {
"otf" : { },
"headerTemplates" : { },
"registry" : { },
"datasets" : { },
"genericmappings" : { },
"ddbconnections" : { },
"local_codes" : [ "" ],
"mappingsets" : { },
"description_source" : [ "" ],
"transcodingRules" : [ "" ],
"user" : [ "" ],
"dataset_column" : { },
"transcodings" : { }
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
the message containing the stubs
Message
default
Unexpected error
Error
Up
get /mappingset/data/{sid}/{id}
Query Mapped Data (mappingsetDataSidIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Query parameters
columns (optional)
Query Parameter — The columns/components separated by comma
criteria (optional)
Query Parameter — The criteria separated by comma
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"columns" : [ "aeiou" ],
"total_rows" : 6,
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"page" : 0,
"rows" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The query result
QueryResult
default
Unexpected error
Error
Up
get /mappingset/validationerrors/{sid}/{id}
Query Mapped Data (mappingsetValidationerrorsSidIdGet)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Query parameters
columns (optional)
Query Parameter — The columns/components separated by comma
criteria (optional)
Query Parameter — The criteria separated by comma
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"errorMessage" : { },
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"status" : "success"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The query result
ActionResult
default
Unexpected error
Error
Up
patch /entity/{sid}/{entity}/{id}
Patch an entity (entitySidEntityIdPatch)
Patch an entity, in other words update it using the JSON PATCH (RFC 6902)
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
entity (required)
Path Parameter — The entity type
id (required)
Path Parameter — The resource unique identifier format: id
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/json-patch+json
Request body
Body Parameter — A JSON Patch message. See RFC 6902
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Changes applied successfully
400
Malformed patch document.
404
resource not found
409
Conflicting state or modification
415
Unsupported patch document
422
Unprocessable request
default
Unexpected error
Error
Get all available plugins (pluginsGet)
Query parameters
type (optional)
Query Parameter — filter by plugin type
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of all plugins, optionally filtered by type
default
Unexpected error
Error
Up
post /dataset/plugin/{sid}/{id}
Extract the SQL Query from the dataset extra data (datasetPluginSidIdPost)
Note this POST will return the result.
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Request body
Body Parameter — A dataset object
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The dataset with the SQL Query generated
DataSet
default
Unexpected error
Error
Up
post /ddb/column/{sid}/{id}
Execute the query and get the dataset columns given a storeId, the entityId of a DDB Connection Setting and a SQL Query (ddbColumnSidIdPost)
Note this POST will return the result.
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Request body
Body Parameter — Search/Query request
Return type
Example data
Content-Type: application/json
[ "" ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The test results from testing the dissemination database connection
default
Unexpected error
Error
Up
post /ddb/data/{sid}/{id}
Execute a SQL Query against the Dissemination database (ddbDataSidIdPost)
Note this POST will return the result. Alternative we would have to store the query somewhere at server side.
Path parameters
sid (required)
Path Parameter — The Mapping Assistant Store identifier format: id
id (required)
Path Parameter — The resource unique identifier format: id
Request body
Body Parameter — Search/Query request
Query parameters
limit (optional)
Query Parameter — max records to return format: int32
page (optional)
Query Parameter — the page to retrieve format: int32
Return type
Example data
Content-Type: application/json
{
"columns" : [ "aeiou" ],
"total_rows" : 6,
"links" : [ {
"rel" : "self",
"href" : "http://example.com/aeiou",
"type" : "aeiou",
"title" : "aeiou",
"info" : {
"name" : "aeiou",
"description" : "aeiou",
"entityId" : "aeiou",
"details" : {
"key" : "aeiou"
}
}
} ],
"page" : 0,
"rows" : [ "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
The test results from testing the dissemination database connection
QueryResult
default
Unexpected error
Error
[ Jump to Methods ]
Table of Contents
ActionResult - Component - ConnectionParameterObject - ConnectionParameters - ConnectionSettings - Contact - DDBConnection - DDBConnectionMap - DataSet - DataSetColumn - DataSetColumnMap - DataSetMap - DataSetQueryResult - DescriptionSource - Entities - EntityInformation - Error - Field - HeaderTemplate - HeaderTemplateMap - Initialize - Languages - Link - Log - LogEntry - Mapping - MappingAssistantStore - MappingMap - MappingSet - MappingSetMap - Message - OTF - OTFMap - Party - PatchDocument - PatchRequest - PeriodTimeTranscodingEntry - Permissions - Plugin - Query - QueryResult - Registry - RegistryMap - RegistryQuery - Row - RowNameable - SimpleEntityInformation - Table - TextType - TimeTranscoding - TimeTranscodingEntry - Transcoding - TranscodingMap - TranscodingRule - TranscodingScript - User - Version - identifiable -
The result of action
status (optional)
success
error
errorMessage (optional)
links (optional)
A SDMX Component -or- a fixed concept outside a DSD. Note this is Nameable because it may carry as a component the concepts name.
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
id (optional)
String The ID that should be visible to the user.This is the SDMX identifier format: id
type (optional)
Dimension
MeasureDimension
TimeDimension
DataAttribute
PrimaryMeasure
CrossSectionalMeasure
NotComponent
A parameter object for Connections
links (optional)
type (optional)
enum
number
boolean
string
password
value (optional)
allowedValues (optional)
defaultValue (optional)
required (optional)
advanced (optional)
The set of advance parameters provided by the driver of a database vendor
Represents the connection configuration to a Database/Store
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
type (optional)
String The database vendor code
subtype (optional)
properties (optional)
name (optional)
department (optional)
role (optional)
email (optional)
additionalProperties (optional)
Represents the connection configuration to a Dissemination Database
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
type (optional)
String The database vendor code
subtype (optional)
properties (optional)
decription (optional)
permissions (optional)
Represents a Mapping Assistant DataSet object. Such objects store the query to a Dissemination database
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
connection (optional)
query (optional)
extra_data (optional)
String Query editor plugin specific extra information, e.g. DATASET.XML_QUERY in Mapping Store. This might need to be encoded
editorType (optional)
permissions (optional)
A DataSet column
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
last_updated (optional)
isMapped (optional)
no
yes
yes_and_transcoded
Represents a (partial) tabular result of a query. Local codes may have description
page (optional)
total_rows (optional)
columns (optional)
links (optional)
rows (optional)
The description source of the values of a DataSet Column
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
table (optional)
String The name of the table containing the descriptions
relation_field (optional)
String The name of the field which can joined with the dataset column in the SQL Query
description_field (optional)
String The name of the field that contains the description text
A collection of entities
mappingsets (optional)
datasets (optional)
ddbconnections (optional)
transcodings (optional)
genericmappings (optional)
headerTemplates (optional)
registry (optional)
dataset_column (optional)
transcodingRules (optional)
local_codes (optional)
description_source (optional)
user (optional)
otf (optional)
Entity information
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
code (optional)
Integer Provides a code number for the error message. Code numbers are defined in the SDMX 2.1 Web Services Guidelines. format: int32
message (optional)
String Provides the error message. Error messages are fully customizable by the service providers and should provide enough detail to ease understanding the reasons of the error.
A table field
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
type (optional)
A SDMX Header template used for data transmission
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
dataSetAgencyId (optional)
String The DataSet Agency ID format: agency
source (optional)
test (optional)
Boolean Indicates whether the message is for test purposes or not. False for normal messages
sender (optional)
receiver (optional)
initialize (optional)
Boolean initialize the mapping store
The list of available languages (SDMX wise)
A HATEOAS link implementation based on SDMX-JSON implementation
rel (optional)
self
parent
dataset
ddb
dataflow
datastructure
localdata
data
categoryscheme
sdmx_code
codelist
local_code
transcoding
transcoding_rule
next
previous
time_transcoding
header
href (optional)
String A complete URL that uniquely defines the resource format: url
type (optional)
String A hint about the type of representation returned by the link
title (optional)
String A human-friendly description of the target link.
info (optional)
Log of a process
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
entries (optional)
Represents a single log entry
level (optional)
info
debug
warning
error
timestamp (optional)
message (optional)
Represents a mapping between a component and a dataset column
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
component (optional)
dataset_column (optional)
constant_value (optional)
type (optional)
defaultValue (optional)
String The default value to use when there is no transcoding or the the DDB returns a null/empty value. In other words this is mapped to empty/null values.
Settings for Mapping Assistant Store
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
type (optional)
String The database vendor code
subtype (optional)
properties (optional)
db_name (optional)
status (optional)
String The current status of the store.
OK
NeedsUpgrade
ErrorsFound
NotInitialized
version (optional)
String The version of the store format: version
Represents a Mapping Set with its mappings. The parent points to the dataflow
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
dataset (optional)
The Mapping Assistant JSON Message. It can contain all objects of a Mapping Store
Contains the definition of a On The Fly DSD
Information about a party receiving or transmiting a message
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
id (optional)
contact (optional)
A JSONPatch document as defined by RFC 6902
op
String The operation to be performed
add
remove
replace
move
copy
test
path
value (optional)
Object The value to be used within the operations.
from (optional)
String A string containing a JSON Pointer value.
This holds the start position, the length and column of a period and the rules
column (optional)
start (optional)
Integer The start position of the year or period
length (optional)
Integer The length of the year or period
rules (optional)
Dataflow / Category permissions. URN is the key
Plugin metadata information
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
type (optional)
dataset
db_vendor
Represents either a table or a SQL query which is send by the client
Represents a (partial) tabular result of a query.
page (optional)
total_rows (optional)
columns (optional)
links (optional)
rows (optional)
Contains the details of a Registry connection
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
password (optional)
technology (optional)
url (optional)
username (optional)
agencyId (optional)
version (optional)
id (optional)
represents a single data row
Represents a row of codes with name/description
Basic entity information
entityId (optional)
name (optional)
description (optional)
details (optional)
A table from the DDB
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
type (optional)
table
view
fields (optional)
Represents a localised text with its language code which acts as key to this map
Represents the Time Transcoding for a specific Frequency
frequency (optional)
A
M
Q
S
W
date_column (optional)
year (optional)
period (optional)
is_date_time (optional)
Boolean A value indicating whether this time transcoding date_column points to a column of date time/timestamp field
This holds the start position, the length and column of a year and/or period
column (optional)
start (optional)
Integer The start position of the year or period
length (optional)
Integer The length of the year or period
Represents a Coded/Time Transcoding
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
expression (optional)
script (optional)
time_transcoding (optional)
Represents a Coded Transcoding
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
code (optional)
local_codes
uncodedValue (optional)
String The value used only when mapping uncoded components
Represents a Transcoding script
name (optional)
String The script name that it appears in the GUI
content (optional)
Contains the details about a user
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
password (optional)
roles (optional)
permissions (optional)
An SDMX identifiable object
entityId (optional)
name (optional)
description (optional)
details (optional)
parentId (optional)
Links (optional)
id (optional)
String The ID that should be visible to the user.This is the SDMX identifier format: id