Difference between revisions of "Portal Web Services"

From Fusion Registry Wiki
Jump to navigation Jump to search
(→‎REST Entry Point)
(→‎Describe Connection)
Line 78: Line 78:
 
|}
 
|}
  
−
== Response Format ==
+
== Response ==
 
  [
 
  [
 
     {
 
     {
Line 87: Line 87:
 
       "api" : ""https://sdw-wsrest.ecb.europa.eu/service/"
 
       "api" : ""https://sdw-wsrest.ecb.europa.eu/service/"
 
     }
 
     }
 +
  ]
 +
 +
= List Dataflows from a Connection =
 +
 +
== Request ==
 +
Bring back all the Dataflows from a Connection.
 +
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/connection/{connection id}/dataflow</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 ==
 +
The response is a SDMX structure file, the format=[format] parameter can be used to change the format.
 +
 +
= Retrieve Structure from a Connection =
 +
 +
== Request ==
 +
Retrieve the structure with the given URN from the endpoint (include all descendants)
 +
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/connection/{connection id}/structure</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 ==
 +
The response is a SDMX structure file, the format=[format] parameter can be used to change the format.
 +
 +
= List Data Job Transactions =
 +
 +
== Request ==
 +
Retrieve the transaction history for data jobs (both manual runs and scheduled runs)
 +
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/data/tx</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
 +
|}
 +
 +
{| class="wikitable"
 +
|-
 +
! Parameter !! Description
 +
|-
 +
| dateFrom || optional - date from in ISO-8601 format
 +
|-
 +
| dateTo || optional - date to in ISO-8601 format
 +
|-
 +
| max || optional - maximum number of results
 +
|}
 +
 +
 +
== Response ==
 +
  [
 +
    {
 +
      "AuditId": "05e6ec87-e40f-459b-a02c-86846cf6ddbf",
 +
      "JobId": "ECB:BKN(1.0)",
 +
      "ProcessStart": 1644831830048,
 +
      "ProcessEnd": 1644831830906,
 +
      "Status": 404,
 +
      "Flow": "urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=ECB:BKN(1.0)",
 +
      "Keys": 0,
 +
      "Obs": 0
 +
    },...
 +
  ]
 +
 +
= List Structure Job Transactions =
 +
 +
== Request ==
 +
Retrieve the transaction history for structure jobs (both manual runs and scheduled runs)
 +
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/structure/tx</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
 +
|}
 +
 +
{| class="wikitable"
 +
|-
 +
! Parameter !! Description
 +
|-
 +
| dateFrom || optional - date from in ISO-8601 format
 +
|-
 +
| dateTo || optional - date to in ISO-8601 format
 +
|-
 +
| max || optional - maximum number of results
 +
|}
 +
 +
 +
== Response ==
 +
The response includes the filters that were defined in the job definition (Structure Type, Id, Version)
 +
  [
 +
    {
 +
      "AuditId": "05e6ec87-e40f-459b-a02c-86846cf6ddbf",
 +
      "JobId": "ECB:BKN(1.0)",
 +
      "ProcessStart": 1644831830048,
 +
      "ProcessEnd": 1644831830906,
 +
      "Status": 404,
 +
      "StructureType": "Dataflow",
 +
      "Id": "EXR"
 +
    },...
 
   ]
 
   ]

Revision as of 08:56, 16 February 2022

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

[
   {
    "ID" : "ECB",
    "Type" : "SDMX_REST_v1",
    "Properties": {
      "updatedAfter" : false,
      "api" : ""https://sdw-wsrest.ecb.europa.eu/service/"
    }
 ]

List Dataflows from a Connection

Request

Bring back all the Dataflows from a Connection.

Entry Point /ws/secure/portal/connection/{connection id}/dataflow
Access Restricted to Portal Manager
Http Method GET

Response

The response is a SDMX structure file, the format=[format] parameter can be used to change the format.

Retrieve Structure from a Connection

Request

Retrieve the structure with the given URN from the endpoint (include all descendants)

Entry Point /ws/secure/portal/connection/{connection id}/structure
Access Restricted to Portal Manager
Http Method GET

Response

The response is a SDMX structure file, the format=[format] parameter can be used to change the format.

List Data Job Transactions

Request

Retrieve the transaction history for data jobs (both manual runs and scheduled runs)

Entry Point /ws/secure/portal/data/tx
Access Restricted to Portal Manager
Http Method GET
Parameter Description
dateFrom optional - date from in ISO-8601 format
dateTo optional - date to in ISO-8601 format
max optional - maximum number of results


Response

 [
   {
     "AuditId": "05e6ec87-e40f-459b-a02c-86846cf6ddbf",
     "JobId": "ECB:BKN(1.0)",
     "ProcessStart": 1644831830048,
     "ProcessEnd": 1644831830906,
     "Status": 404,
     "Flow": "urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=ECB:BKN(1.0)",
     "Keys": 0,
     "Obs": 0
   },...
 ]

List Structure Job Transactions

Request

Retrieve the transaction history for structure jobs (both manual runs and scheduled runs)

Entry Point /ws/secure/portal/structure/tx
Access Restricted to Portal Manager
Http Method GET
Parameter Description
dateFrom optional - date from in ISO-8601 format
dateTo optional - date to in ISO-8601 format
max optional - maximum number of results


Response

The response includes the filters that were defined in the job definition (Structure Type, Id, Version) 

 [
   {
     "AuditId": "05e6ec87-e40f-459b-a02c-86846cf6ddbf",
     "JobId": "ECB:BKN(1.0)",
     "ProcessStart": 1644831830048,
     "ProcessEnd": 1644831830906,
     "Status": 404,
     "StructureType": "Dataflow",
     "Id": "EXR"
   },...
 ]
Retrieved from "https://wiki.sdmxcloud.org/index.php?title=Portal_Web_Services&oldid=4364"