Difference between revisions of "Portal Web Services"
Jump to navigation
Jump to search
(Created page with "Category:WebService = Overview = The Data Portal Web services are those used by the Fusion Portal User Interface. The web services can be used to automate data and struc...") |
(→REST Entry Point) |
||
| Line 4: | Line 4: | ||
The Data Portal Web services are those used by the Fusion Portal User Interface. The web services can be used to automate data and structure jobs be external applications. | The Data Portal Web services are those used by the Fusion Portal User Interface. The web services can be used to automate data and structure jobs be external applications. | ||
| − | = | + | = List Endpoint Types = |
== Request == | == Request == | ||
| Line 24: | Line 24: | ||
"Name" : "REST API V1", | "Name" : "REST API V1", | ||
"Description" : "Connects to an SDMX REST API which complies with version 1.5.0 of the specification https://github.com/sdmx-twg/sdmx-rest/blob/v1.5.0/v2_1/ws/rest/src/sdmx-rest.yaml", | "Description" : "Connects to an SDMX REST API which complies with version 1.5.0 of the specification https://github.com/sdmx-twg/sdmx-rest/blob/v1.5.0/v2_1/ws/rest/src/sdmx-rest.yaml", | ||
| − | "Properties" : [..], | + | "Properties" : [ |
| + | { | ||
| + | "Id": "api", | ||
| + | "Name": "URL", | ||
| + | "Description": "SDMX REST API which complies with version 1.5.0 of the specification https://github.com/sdmx-twg/sdmx-rest/blob/v1.5.0/v2_1/ws/rest/src/sdmx-rest.yaml", | ||
| + | "Required": true, | ||
| + | "Type": "URL" | ||
| + | }, ... | ||
| + | ], | ||
} | } | ||
| + | ] | ||
| + | |||
| + | |||
| + | = List Connections = | ||
| + | |||
| + | == Request == | ||
| + | List all the user defined endpoint connections. | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/connection</b> | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:red'><b>Restricted to '''Portal Manager'''</b></span> | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Http Method</b>|| GET | ||
| + | |} | ||
| + | |||
| + | == Response Format == | ||
| + | [ | ||
| + | { | ||
| + | "ID" : "ECB", | ||
| + | "Type" : "SDMX_REST_v1" | ||
| + | }, | ||
| + | { | ||
| + | "ID" : "BIS", | ||
| + | "Type" : "SDMX_REST_v1" | ||
| + | } | ||
| + | ] | ||
| + | |||
| + | |||
| + | = Describe Connection = | ||
| + | |||
| + | == Request == | ||
| + | Bring back all the details for a specific connection | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/connection/{connection id}</b> | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Access</b>|| <span style='color:red'><b>Restricted to '''Portal Manager'''</b></span> | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>Http Method</b>|| GET | ||
| + | |} | ||
| + | |||
| + | == Response Format == | ||
| + | [ | ||
| + | { | ||
| + | "ID" : "ECB", | ||
| + | "Type" : "SDMX_REST_v1", | ||
| + | "Properties": { | ||
| + | "updatedAfter" : false, | ||
| + | "api" : ""https://sdw-wsrest.ecb.europa.eu/service/" | ||
| + | } | ||
] | ] | ||
Revision as of 08:42, 16 February 2022
Contents
Overview
The Data Portal Web services are those used by the Fusion Portal User Interface. The web services can be used to automate data and structure jobs be external applications.
List Endpoint Types
Request
List all the supported endpoints. This is used by Fusion Portal to enable the user to select an endpoint type.
| Entry Point | /ws/secure/portal/endpoints |
| Access | Restricted to Portal Manager |
| Http Method | GET |
Response Format
[
{
"ID" : "SDMX_REST_v1",
"Name" : "REST API V1",
"Description" : "Connects to an SDMX REST API which complies with version 1.5.0 of the specification https://github.com/sdmx-twg/sdmx-rest/blob/v1.5.0/v2_1/ws/rest/src/sdmx-rest.yaml",
"Properties" : [
{
"Id": "api",
"Name": "URL",
"Description": "SDMX REST API which complies with version 1.5.0 of the specification https://github.com/sdmx-twg/sdmx-rest/blob/v1.5.0/v2_1/ws/rest/src/sdmx-rest.yaml",
"Required": true,
"Type": "URL"
}, ...
],
}
]
List Connections
Request
List all the user defined endpoint connections.
| Entry Point | /ws/secure/portal/connection |
| Access | Restricted to Portal Manager |
| Http Method | GET |
Response Format
[
{
"ID" : "ECB",
"Type" : "SDMX_REST_v1"
},
{
"ID" : "BIS",
"Type" : "SDMX_REST_v1"
}
]
Describe Connection
Request
Bring back all the details for a specific connection
| Entry Point | /ws/secure/portal/connection/{connection id} |
| Access | Restricted to Portal Manager |
| Http Method | GET |
Response Format
[
{
"ID" : "ECB",
"Type" : "SDMX_REST_v1",
"Properties": {
"updatedAfter" : false,
"api" : ""https://sdw-wsrest.ecb.europa.eu/service/"
}
]
