Difference between revisions of "Portal Web Services"

From Fusion Registry Wiki
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...")
 
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{toclimit|limit=1}}
 
[[Category:WebService]]
 
[[Category:WebService]]
 +
[[Category:Data Portal]]
 
= Overview =
 
= 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.
 
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.
  
−
= REST Entry Point =
+
= List Endpoint Types =
  
 
== Request ==
 
== Request ==
Line 24: Line 26:
 
     "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 ==
 +
[
 +
    {
 +
    "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.  The dataflows are obtained directly from the endpoint of the 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).  For example retrieve a Dataflow (by URN) from an ECB web service will get the Dataflow and all descendants (Data Structure, Concept Scheme, Codelist).  These are not saved to the Registry, they are returned for local analysis.
 +
 +
{| 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 Definitions =
 +
 +
== Request ==
 +
List all the data jobs that have been defined in the system
 +
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/data/job</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 ==
 +
  [
 +
    {
 +
      "Id": "BSI",
 +
      "Connection": "ECB",
 +
      "Flow": "urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=ECB:BSI(1.0)",
 +
      "DataSource": "IN_MEMORY",
 +
      "ValidationLevel": 0
 +
    },...
 +
  ]
 +
 +
= Manual Sync Data Job =
 +
 +
== Request ==
 +
Manual run of a data job (sync) based on the ID of the Job definition.
 +
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/data/sync/{job 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 ==
 +
The [[Audit_Web_Services#Audited_System_Events|audit ID]] that can be used to track the progress (or alternatively use the data transaction history)
 +
 +
  {
 +
    "AuditId": "ec600603-8cf1-461b-9293-2f2751150013"
 +
  }
 +
 +
= 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"
 +
|+ Query Parameters
 +
|-
 +
! Parameter !! Required !! Description
 +
|-
 +
| dateFrom || no ||  date from in ISO-8601 format
 +
|-
 +
| dateTo || no || date to in ISO-8601 format
 +
|-
 +
| max || no || 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 Definitions =
 +
 +
== Request ==
 +
List all the structure jobs that have been defined in the system
 +
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/structure/job</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 ==
 +
  [
 +
    {
 +
      "Id": "ECB_CONCEPTS",
 +
      "Connection": "ECB",
 +
      "StructureType": "ConceptScheme",
 +
      "URN": "urn:sdmx:org.sdmx.infomodel.conceptscheme.ConceptScheme=*:*(*)"
 +
    },...
 +
  ]
 +
 +
= Manual Sync Structure Job =
 +
 +
== Request ==
 +
Manual run of a structure job (sync) based on the ID of the Job definition.
 +
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b>|| <b> /ws/secure/portal/structure/sync/{job 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 ==
 +
The audit ID that can be used to track the progress (or alternatively use the data transaction history)
 +
 +
  {
 +
    "AuditId": "ec600603-8cf1-461b-9293-2f2751150013"
 +
  }
 +
 +
 +
= 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"
 +
    },...
 
   ]
 
   ]

Latest revision as of 22:16, 10 September 2023

Template:Toclimit

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. The dataflows are obtained directly from the endpoint of the 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). For example retrieve a Dataflow (by URN) from an ECB web service will get the Dataflow and all descendants (Data Structure, Concept Scheme, Codelist). These are not saved to the Registry, they are returned for local analysis.

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 Definitions

Request

List all the data jobs that have been defined in the system

Entry Point /ws/secure/portal/data/job
Access Restricted to Portal Manager
Http Method GET

Response

 [
   {
     "Id": "BSI",
     "Connection": "ECB",
     "Flow": "urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=ECB:BSI(1.0)",
     "DataSource": "IN_MEMORY",
     "ValidationLevel": 0
   },...
 ]

Manual Sync Data Job

Request

Manual run of a data job (sync) based on the ID of the Job definition.

Entry Point /ws/secure/portal/data/sync/{job id}
Access Restricted to Portal Manager
Http Method GET


Response

The audit ID that can be used to track the progress (or alternatively use the data transaction history) 

 {
   "AuditId": "ec600603-8cf1-461b-9293-2f2751150013"
 }

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


Query Parameters
Parameter Required Description
dateFrom no date from in ISO-8601 format
dateTo no date to in ISO-8601 format
max no 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 Definitions

Request

List all the structure jobs that have been defined in the system

Entry Point /ws/secure/portal/structure/job
Access Restricted to Portal Manager
Http Method GET

Response

 [
   {
     "Id": "ECB_CONCEPTS",
     "Connection": "ECB",
     "StructureType": "ConceptScheme",
     "URN": "urn:sdmx:org.sdmx.infomodel.conceptscheme.ConceptScheme=*:*(*)"
   },...
 ]

Manual Sync Structure Job

Request

Manual run of a structure job (sync) based on the ID of the Job definition.

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


Response

The audit ID that can be used to track the progress (or alternatively use the data transaction history) 

 {
   "AuditId": "ec600603-8cf1-461b-9293-2f2751150013"
 }


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=6004"