Audit Web Service - Revision history

Vmurrell: /* Download the Logs event for an Audit event */

2021-03-27T10:28:45Z

‎Download the Logs event for an Audit event

Vmurrell: /* Download the Logs event for a Transaction */

2021-03-27T10:28:12Z

‎Download the Logs event for a Transaction

Vmurrell: /* Query the Audit event for a Transaction */

2021-03-27T10:27:35Z

‎Query the Audit event for a Transaction

Vmurrell: /* Overview */

2021-03-27T10:27:18Z

‎Overview

Glenn at 16:41, 18 March 2021

2021-03-18T16:41:24Z

Glenn: Glenn moved page Audit Web Services to Audit Web Service without leaving a redirect

2021-03-18T14:59:19Z

Glenn moved page Audit Web Services to Audit Web Service without leaving a redirect

Glenn: Glenn moved page Audit REST API to Audit Web Services without leaving a redirect

2021-03-18T14:58:39Z

Glenn moved page Audit REST API to Audit Web Services without leaving a redirect

Glenn at 14:58, 18 March 2021

2021-03-18T14:58:01Z

Vmurrell: Vmurrell moved page Audit REST API - FMR to Audit REST API

2020-11-04T17:34:23Z

Vmurrell moved page Audit REST API - FMR to Audit REST API

Vmurrell: Created page with "Category:FMR_REST_API_Reference To be written."

2020-09-10T17:07:42Z

Created page with "Category:FMR_REST_API_Reference To be written."

New page

[[Category:FMR_REST_API_Reference]]

To be written.

@@ Line 89: / Line 89: @@
 = Download the Logs event for an Audit event =
-This web service is used to obtain a the log events for a transaction (a transaction is where the Fusion Registry updates either structural metadata, or a data registration).
+This web service is used to obtain a the log events for a transaction (a transaction is where the Registry updates structural metadata).
 {| class="wikitable"
 |-

@@ Line 65: / Line 65: @@
 = Download the Logs event for a Transaction =
-This web service is used to obtain a the log events for a transaction (a transaction is where the Fusion Registry updates either structural metadata, or a data registration).
+This web service is used to obtain a the log events for a transaction (a transaction is where the Registry updates structural metadata).
 {| class="wikitable"
 |-
@@ Line 87: / Line 87: @@
 |style="background-color:#eaecf0"|<b>txId</b> || The transaction ID (see the [[RSS_Feed|RSS]] feed)
 |}
 = Download the Logs event for an Audit event =

@@ Line 41: / Line 41: @@
 = Query the Audit event for a Transaction =
-This web service is used to obtain a specific audit event for a transaction (a transaction is where the Fusion Registry updates either structural metadata, or a data registration).
+This web service is used to obtain a specific audit event for a transaction (a transaction is where the Registry updates either structural metadata, or a data registration).
 {| class="wikitable"
 |-

@@ Line 1: / Line 1: @@
 [[Category:FMR_REST_API_Reference]]
 = Overview =
-The Audit web service can be used to query for audited events in the Fusion Registry
+The Audit web service can be used to query for audited events in the Fusion Metadata Registry
 = Querying Audits =

@@ Line 1: / Line 1: @@
 [[Category:FMR_REST_API_Reference]]
 = Overview =
 The Audit web service can be used to query for audited events in the Fusion Registry

← Older revision	Revision as of 14:59, 18 March 2021
(No difference)

← Older revision	Revision as of 14:58, 18 March 2021
(No difference)

← Older revision		Revision as of 14:58, 18 March 2021
Line 1:		Line 1:
	[[Category:FMR_REST_API_Reference]]		[[Category:FMR_REST_API_Reference]]

−	To be ~~written~~.	+	[[Category:WebService]]
		+	= Overview =
		+	The Audit web service can be used to query for audited events in the Fusion Registry
		+
		+	= Querying Audits =
		+
		+	Returns a JSON Array of all of the structures in the Registry, filterable by parameter.
		+
		+	{\| class="wikitable"
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Entry Point</b> \|\| style="min-width:500px;" \| <b> /ws/secure/audit/searchAudits</b>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Access</b> \|\| <span style='color:red'><b>Restricted (Agency and Admin users only)</b></span>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Http Method</b> \|\| GET
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Response Format</b> \|\| application/json (array of objects) see [[#Audit JSON]]
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Response Statuses</b> \|\| <p><b>200</b> - Query Ok<p>
		+	\|}
		+
		+	=== HTTP Query Parameters ===
		+	If no parameters are supplied the last 500 audited events are returned
		+
		+	{\| class="wikitable"
		+	\|-
		+	!\| Request Parameter \|\| Purpose
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>dateFrom</b> \|\| The earliest audit event to return. The value must be specified as the epoch time in milliseconds (e.g. 1609459200000 is the start of the year 2021).
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>dateTo</b> \|\| The latest audit event to return. The value must be specified as the epoch time in milliseconds (e.g. 1609459200000 is the start of the year 2021).
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>max</b> \|\| The maximum number of audits to return, must be a positive integer, the default is 500 if not specified
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>type</b> \|\| The category of audit: <ol><li>Structure Query</li><li>Structure Submission</li><li>Data Query</li></ol>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>orderDesc</b> \|\| true to order by time descending order, false to order ascending. The default output is that Transactions are returned in a descending order (most recent first)
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>user</b> \|\| username of the user that caused the audit event
		+	\|}
		+
		+	= Query the Audit event for a Transaction =
		+	This web service is used to obtain a specific audit event for a transaction (a transaction is where the Fusion Registry updates either structural metadata, or a data registration).
		+	{\| class="wikitable"
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Entry Point</b> \|\| style="min-width:500px;" \| <b> /ws/secure/audit/getDetailsByTransactionId</b>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Access</b> \|\| <span style='color:red'><b>Restricted (Agency and Admin users only)</b></span>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Http Method</b> \|\| GET
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Response Format</b> \|\| application/json see [[#Audit JSON]]
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Response Statuses</b> \|\| <p><b>200</b> - Query Ok<p>
		+	\|}
		+
		+	=== HTTP Query Parameters ===
		+
		+	{\| class="wikitable"
		+	\|-
		+	!\| Request Parameter \|\| Purpose
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>txId</b> \|\| The transaction ID (see the [[RSS_Feed\|RSS]] feed)
		+	\|}
		+
		+	= Download the Logs event for a Transaction =
		+	This web service is used to obtain a the log events for a transaction (a transaction is where the Fusion Registry updates either structural metadata, or a data registration).
		+	{\| class="wikitable"
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Entry Point</b> \|\| style="min-width:500px;" \| <b> /ws/secure/audit/downloadLogsForTransaction</b>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Access</b> \|\| <span style='color:red'><b>Restricted (Agency and Admin users only)</b></span>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Http Method</b> \|\| GET
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Response Format</b> \|\| application/octet-stream
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Response Statuses</b> \|\| <p><b>200</b> - Query Ok<p>
		+	\|}
		+
		+	=== HTTP Query Parameters ===
		+
		+	{\| class="wikitable"
		+	\|-
		+	!\| Request Parameter \|\| Purpose
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>txId</b> \|\| The transaction ID (see the [[RSS_Feed\|RSS]] feed)
		+	\|}
		+
		+
		+	= Download the Logs event for an Audit event =
		+	This web service is used to obtain a the log events for a transaction (a transaction is where the Fusion Registry updates either structural metadata, or a data registration).
		+	{\| class="wikitable"
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Entry Point</b> \|\| style="min-width:500px;" \| <b> /ws/secure/audit/downloadLogsForAudit</b>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Access</b> \|\| <span style='color:red'><b>Restricted (Agency and Admin users only)</b></span>
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Http Method</b> \|\| GET
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Response Format</b> \|\| application/octet-stream
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>Response Statuses</b> \|\| <p><b>200</b> - Query Ok<p>
		+	\|}
		+
		+	=== HTTP Query Parameters ===
		+
		+	{\| class="wikitable"
		+	\|-
		+	!\| Request Parameter \|\| Purpose
		+	\|-
		+	\|style="background-color:#eaecf0"\|<b>uid</b> \|\| The unique audit Id (UID) see [[#Audit_JSON]]
		+	\|}
		+
		+	= Audit JSON =
		+	Each audit event is output a JSON Object which contains the following information
		+
		+	{
		+	"UID": "52731504-0273-4f5c-a9e6-bb64bfd27574",
		+	"Type": "Data Query",
		+	"ServerName": "yourserver.com",
		+	"VMID": "12b597ceb123456:1c12c34:123bc3bfe61:-8000",
		+	"MachineId": "ip-11-2-3-44internal/11.2.3.44",
		+	"ServerContext": "/FusionRegistry",
		+	"ServletPath": "/ws/public/sdmxapi/rest",
		+	"ServerPort": 443,
		+	"PathInfo": "/data/WB,WDI_POVERTY,1.0",
		+	"Parameters": "format=sdmx-json",
		+	"Protocol": "HTTP/1.1",
		+	"AcceptHeaders": "application/json, text/javascript, /; q=0.01",
		+	"AcceptLanguage": "en",
		+	"SubmissionMethod": "GET",
		+	"HttpResponseStatus": 200,
		+	"RequestTime": 1615821933116,
		+	"Duration": 6,
		+	"Username": "anonymous",
		+	"RequestIP": "111.222.33.44",
		+	"ProductVersion": "10.6.6",
		+	"UserAgent": "Chrome/89.0.4389.82 Safari/537.36",
		+	"BrowserName": "Chrome",
		+	"BrowserVersion": "89",
		+	"OS": "Windows 10"
		+	}

← Older revision	Revision as of 17:34, 4 November 2020
(No difference)