Difference between revisions of "Transaction Web Service"
Jump to navigation
Jump to search
| Line 13: | Line 13: | ||
|style="background-color:#eaecf0"|<b>Response Format</b> || application/json | |style="background-color:#eaecf0"|<b>Response Format</b> || application/json | ||
|- | |- | ||
| − | |style="background-color:#eaecf0"|<b>Response Statuses</b> || <p><b>200</b> - | + | |style="background-color:#eaecf0"|<b>Response Statuses</b> || <p><b>200</b> - Submission Accepted</p> |
| − | |||
| − | |||
| − | |||
|} | |} | ||
| + | |||
| + | == HTTP Query Parameters == | ||
| + | If no parameters are supplied all transactions known to the Registry will be returned. | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | !| Request Parameter || Required || Purpose | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>max</b> || No || Limits the returned response to only containing at most the specified value. The items returned will be the most recent. | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>dateFrom</b> || No || Filters the | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>dateTo</b> || No || ..... | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>user</b> || No || ..... | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>action</b> || No || ... | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>orderDesc</b> || No || ..... | ||
| + | |- | ||
| + | |style="background-color:#eaecf0"|<b>txtype</b> || No || ..... | ||
| + | |} | ||
| + | |||
| + | |||
| + | "type") String txType, | ||
| + | final @QueryParam("dateFrom") Long dateFromLong, | ||
| + | final @QueryParam("dateTo") Long dateToLong, | ||
| + | final @QueryParam("max") Integer lastN, | ||
| + | final @QueryParam("user") String user, | ||
| + | final @QueryParam("action") String action, | ||
| + | final @QueryParam("orderDesc") Boolean orderDesc, | ||
Revision as of 01:59, 4 February 2021
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.
| 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.
| Request Parameter | Required | Purpose |
|---|---|---|
| max | No | Limits the returned response to only containing at most the specified value. The items returned will be the most recent. |
| dateFrom | No | Filters the |
| dateTo | No | ..... |
| user | No | ..... |
| action | No | ... |
| orderDesc | No | ..... |
| txtype | No | ..... |
"type") String txType,
final @QueryParam("dateFrom") Long dateFromLong,
final @QueryParam("dateTo") Long dateToLong,
final @QueryParam("max") Integer lastN,
final @QueryParam("user") String user,
final @QueryParam("action") String action,
final @QueryParam("orderDesc") Boolean orderDesc,