Difference between revisions of "Transaction Web Service"
(→Overview) |
(→Querying for a specific URN) |
||
| Line 60: | Line 60: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| − | |style="background-color:#eaecf0"|<b>Entry Point</b> || style="min-width:500px;" | <b>/ws/registry/tx/ | + | |style="background-color:#eaecf0"|<b>Entry Point</b> || style="min-width:500px;" | <b>/ws/registry/tx/history</b> |
|- | |- | ||
|style="background-color:#eaecf0"|<b>Access</b> || <span style='color:green'><b>Public</b></span> | |style="background-color:#eaecf0"|<b>Access</b> || <span style='color:green'><b>Public</b></span> | ||
Revision as of 02:59, 4 February 2021
Contents
Overview
The Transaction Web Service provides access to all the structural metadata content of the Fusion Registry (including any content that has been subsequently deleted). A Transaction is the submission of a structure, group of structures or data registration.
Querying and Searching All Transactions
| Entry Point | /ws/registry/tx/searchTransactions |
| Access | Public |
| Http Method | GET |
| Response Format | application/json |
| Response Statuses | 200 - Submission Accepted |
HTTP Query Parameters
If no parameters are supplied all transactions known to the Registry will be returned. If any of the filters applied below result in no results an empty JSON response (HTTP 200) is returned.
| Request Parameter | Required | Purpose |
|---|---|---|
| action | No | Filters the response to only include Transaction for the specified action. Legal values are Append, Replace, FullReplace and Delete. |
| dateFrom | No | Filters the response to only include Transactions from the specified time. The value must be specified as the epoch time in milliseconds (e.g. 1609459200000 is the start of the year 2021). |
| dateTo | No | Filters the response to only include Transactions up to the specified time. The value must be specified as the epoch time in milliseconds (e.g. 1609459200000 is the start of the year 2021). |
| max | No | Limits the returned response to only containing at most the specified value. |
| orderDesc | No | The default output is that Transactions are returned in a descending order (most recent first). Supplying false to this parameter reverses the order. |
| user | No | Filters the response to only include Transactions for the specified user. |
Querying for all URNs
Writes a JSON Array of all the maintainable URNs (both current and deleted) in the Registry.
| Entry Point | /ws/registry/tx/getAllUrns |
| Access | Public |
| Http Method | GET |
| Response Format | application/json |
| Response Statuses | 200 - Submission Accepted |
Querying for a specific URN
To obtain information regarding who made changes to a particular structure, the following Web Service can be used. It provides the user id (and date, transaction id and action) of who last modified the maintainable with the given URN.
| Entry Point | /ws/registry/tx/history |
| Access | Public |
| Http Method | GET |
| Response Format | application/json |
| Response Statuses | 200 - Submission Accepted 500 - Illegal URN |
HTTP Query Parameters
| Request Parameter | Required | Purpose |
|---|---|---|
| urn | Yes | The URN of the structure to investigate. |
Querying for a specific Transaction
With a specific Transaction ID, to obtain the view of the structure
| Entry Point | /ws/registry/tx/transactions |
| Access | Public |
| Http Method | GET |
| Response Format | application/json SDMX |
| Response Statuses | 200 - Submission Accepted 500 - Illegal URN |
HTTP Query Parameters
| Request Parameter | Required | Purpose |
|---|---|---|
| urn | Yes | The URN of the structure to investigate. |
| format | No | A structure format. Default output is SDMX-ML 2.1. Other options include sdmx-json, fusion-json, sdmx-edi. |
