Data Reporting Template Web Services - Revision history

Vmurrell at 10:18, 12 November 2025

2025-11-12T10:18:07Z

Vmurrell at 11:56, 10 September 2023

2023-09-10T11:56:02Z

Mnelson: /* Report Template Web Services */

2020-03-02T14:17:51Z

‎Report Template Web Services

Mnelson: Created page with "Category:WebService = Report Template Web Services = All these operations are available from the web user interface of the Fusion Registry, which use the same web services..."

2020-03-02T14:17:04Z

Created page with "Category:WebService = Report Template Web Services = All these operations are available from the web user interface of the Fusion Registry, which use the same web services..."

New page

[[Category:WebService]]
= Report Template Web Services =
All these operations are available from the web user interface of the Fusion Registry, which use the same web services as listed below.
== Create Reporting Template ==
Submit the file to the Fusion Registry SDMX POST web service, the syntax is as follows:
GET
ws/public/reporttemplate/provider/create/{agencyId}/{templateId}/{version}/{providerAgencyId}/{providerId}
== List Reporting Templates ==
The following web service will list all the Reporting Templates for the authenticated user.
ws/public/reporttemplate/provider/templates
[
{
"urn" : "templateurn",
"providers" : ["urn1", "urn2"]
}
]

== Retrieve Worksheet Passwords ==
Returns only passwords for Agency or Sub Agencies if not admin
ws/secure/settings/reporttemplate/retrievePasswords

== Update Worksheet Passwords ==
Admin/Agency
Updates only the passwords sent in, can only save passwords for their agency
ws/secure/settings/reporttemplate/updatePasswords
{
"BIS" : "password",
"BIS.DISS" : "password",
"ECB" : "password"
}

== Retrieve Observation Limit ==
ws/secure/settings/reporttemplate/getObsLimit

== Set Observation Limit ==
ws/secure/settings/reporttemplate/setObsLimit

== Remove Security ==
Allows any user to create a excel workbook for any report template / data provider. When this is false, the user must authenticate, and must be either:
a) Admin (can create a excel workbook for any report template / data provider)
b) Agency (can create any workbook they own)
c) Data Provider (can create any workbook relevant to them)
ws/secure/settings/reporttemplate/setSecurityDisabled

== Check if Security is Disabled ==
Purpose:
ws/secure/settings/reporttemplate/isSecurityDisabled

@@ Line 1: / Line 1: @@
 [[Category:WebService]]
 = Create Reporting Template =
 Submit the file to the Fusion Registry SDMX POST web service, the syntax is as follows:

@@ Line 1: / Line 1: @@
 [[Category:WebService]]
-= Report Template Web Services =
+= Create Reporting Template =
 Submit the file to the Fusion Registry SDMX POST web service, the syntax is as follows:
 GET
 ws/public/reporttemplate/provider/create/{agencyId}/{templateId}/{version}/{providerAgencyId}/{providerId}
-== List Reporting Templates ==
 The following web service will list all the Reporting Templates for the authenticated user.
 ws/public/reporttemplate/provider/templates
@@ Line 16: / Line 15: @@
+   ]
-== Retrieve Worksheet Passwords ==
+= Retrieve Worksheet Passwords =
 Returns only passwords for Agency or Sub Agencies if not admin
 ws/secure/settings/reporttemplate/retrievePasswords
-== Update Worksheet Passwords ==
+= Update Worksheet Passwords =
 Admin/Agency
 Updates only the passwords sent in, can only save passwords for their agency
@@ Line 30: / Line 29: @@
+	 }
-== Retrieve Observation Limit ==
+= Retrieve Observation Limit =
 ws/secure/settings/reporttemplate/getObsLimit
-== Set Observation Limit ==
+= Set Observation Limit =
 ws/secure/settings/reporttemplate/setObsLimit
-== Remove Security ==
+= Remove Security =
 Allows any user to create a excel workbook for any report template / data provider.  When this is false, the user must authenticate, and must be either:
 a)	Admin (can create a excel workbook for any report template / data provider)
@@ Line 43: / Line 42: @@
 ws/secure/settings/reporttemplate/setSecurityDisabled
-== Check if Security is Disabled ==
+= Check if Security is Disabled =
 Purpose:
 ws/secure/settings/reporttemplate/isSecurityDisabled