Difference between revisions of "Data Reporting Template Web Services"
(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...") |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:WebService]] | [[Category:WebService]] | ||
| − | + | [[Category:How_To]] | |
| − | + | = Create Reporting Template = | |
| − | |||
Submit the file to the Fusion Registry SDMX POST web service, the syntax is as follows: | Submit the file to the Fusion Registry SDMX POST web service, the syntax is as follows: | ||
GET | GET | ||
ws/public/reporttemplate/provider/create/{agencyId}/{templateId}/{version}/{providerAgencyId}/{providerId} | 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. | The following web service will list all the Reporting Templates for the authenticated user. | ||
ws/public/reporttemplate/provider/templates | ws/public/reporttemplate/provider/templates | ||
| Line 16: | Line 16: | ||
] | ] | ||
| − | + | = Retrieve Worksheet Passwords = | |
Returns only passwords for Agency or Sub Agencies if not admin | Returns only passwords for Agency or Sub Agencies if not admin | ||
ws/secure/settings/reporttemplate/retrievePasswords | ws/secure/settings/reporttemplate/retrievePasswords | ||
| − | + | = Update Worksheet Passwords = | |
Admin/Agency | Admin/Agency | ||
Updates only the passwords sent in, can only save passwords for their agency | Updates only the passwords sent in, can only save passwords for their agency | ||
| Line 30: | Line 30: | ||
} | } | ||
| − | + | = Retrieve Observation Limit = | |
ws/secure/settings/reporttemplate/getObsLimit | ws/secure/settings/reporttemplate/getObsLimit | ||
| − | + | = Set Observation Limit = | |
ws/secure/settings/reporttemplate/setObsLimit | 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: | 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) | a) Admin (can create a excel workbook for any report template / data provider) | ||
| Line 43: | Line 43: | ||
ws/secure/settings/reporttemplate/setSecurityDisabled | ws/secure/settings/reporttemplate/setSecurityDisabled | ||
| − | + | = Check if Security is Disabled = | |
Purpose: | Purpose: | ||
ws/secure/settings/reporttemplate/isSecurityDisabled | ws/secure/settings/reporttemplate/isSecurityDisabled | ||
Latest revision as of 03:56, 10 September 2023
Contents
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
