Audit admin API Resource

HDC WS for audit operations.

GET /api/admin/audit/activity/json

Get list of administrative operations.

Request Parameters
name type description constraints
filter query  
limit query long
sortField query  
start query long
Response Body
media type data type description
application/json object (JSON) JSON with list of administrative operations.

Example of response:

{"total":1,"list":[{"invokerId":1,"userId":10,"activityType":3,"name":"stonoga3","userFullName":"stonoga3","email":"stonoga3@abc.pl","activityTexts":["stonoga3","stonoga3x"],"activityIdentifiers":[],"invokerName":"admin","invokerFullName":"Administrator","invokerEmail":"dada@abc.pl","operationDate":"2020-03-04T15:46:28.860286Z"}]}

Example

Request
GET /api/admin/audit/activity/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/admin/audit/activity/report

Get list of administrative operations in form of Excel report

Request Parameters
name type description constraints
filter query  
limit query long
sortField query  
start query long
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON) JSON with list of administrative operations.

Example of response:

{"total":1,"list":[{"invokerId":1,"userId":10,"activityType":3,"name":"stonoga3","userFullName":"stonoga3","email":"stonoga3@abc.pl","activityTexts":["stonoga3","stonoga3x"],"activityIdentifiers":[],"invokerName":"admin","invokerFullName":"Administrator","invokerEmail":"dada@abc.pl","operationDate":"2020-03-04T15:46:28.860286Z"}]}

Example

Request
GET /api/admin/audit/activity/report
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /api/admin/audit/objects/json

Get list of object operations.

Request Parameters
name type description constraints
filter query  
limit query long
sortField query  
start query long
Response Body
media type data type description
application/json object (JSON) JSON with list of administrative operations.

Example of response:

{"total":1,"list":[{"invokerId":1,"userId":10,"activityType":3,"name":"stonoga3","userFullName":"stonoga3","email":"stonoga3@abc.pl","activityTexts":["stonoga3","stonoga3x"],"activityIdentifiers":[],"invokerName":"admin","invokerFullName":"Administrator","invokerEmail":"dada@abc.pl","operationDate":"2020-03-04T15:46:28.860286Z"}]}

Example

Request
GET /api/admin/audit/objects/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/admin/audit/objects/report

Get objects audit in form of Excel report

Request Parameters
name type description
filter query
sortField query
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON) json response with information about started process

Example

Request
GET /api/admin/audit/objects/report
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

POST /api/admin/audit/objects/{classId}

Get list of changed objects of specified class within given date range (change date or publish date).

Optional filters:

fields - only objects changed on specified fields will be returned,

users - only objects changed by given users will be returned.

Example of request:

{ "fields": ["fi2space_areabra", "fi2space_class"], "from":"2016-03-18T12:57:32.858211+02:00", "to":"2017-03-18T12:57:32.858211+02:00", "users":[20, 10, 4], "publishedMode":true }

Request Parameters
name type description constraints
classId path The unique identifier of object class for returned objects. long
limit query Defines the number of objects returned in a single call. long
offset query Defines the offset for returned objects long
Request Body
media type data type
application/json HdcObjectAuditModelTO (JSON)
Response Body
media type data type description
application/json object (JSON) JSON Response with history of objects grouped by hdid.

Example of response:

{ "history":[ { "history":[...], "userId":20, "userFullName":"olo", "sourceName": "Sapsjudaren2_corrupted_taf_cal", "sourceId": 42, "date":"2016-08-10T16:39:09.036+02:00", "versionId":1115, "version":{ "parentVersionId":"105", "versionId":"1115", "versionName":"olgt", "versionDescription":"revision: ea41ab2a-ed06-45c9-a221-a37655610765", "owner":"olo", "ownerFullName":"olo", "creationDate": "2016-12-06T08:32:26.894991Z", "publishDate": "2016-12-06T08:43:26.894991Z", "isSealed":true }, "metadata":{...}, "contentType":0, "contentId":0, "subType":0, "operationId":"i", "objectId":"48380", "classId":"108" }, {...}, {...}, {...}, {...} ], "total":120, "metadata":{

}, "contentType":0, "contentId":0, "subType":0 }

Example

Request
POST /api/admin/audit/objects/{classId}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /api/admin/audit/objects/{classId}/report

Request Parameters
name type description constraints
classId path long
limit query long
offset query long
Request Body
media type data type
application/json HdcObjectAuditModelTO (JSON)
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON)

Example

Request
POST /api/admin/audit/objects/{classId}/report
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

GET /api/admin/audit/activity/details/{userId}/{date}

Get list of login specific data.

Request Parameters
name type description constraints
date path - date time of specific activity  
userId path - id of user who performed specific activity long
Response Body
media type data type description
application/json object (JSON) JSON with login specific information that the requested activity occurred during.

Example of response:

{"geoIp":"{\"ip\":\"127.0.0.1\",\"country_code\":\"\",\"country_name\":\"\",\"region_code\":\"\",\"region_name\":\"\",\"city\":\"\",\"zip_code\":\"\",\"time_zone\":\"\",\"latitude\":0.0,\"longitude\":0.0,\"metro_code\":0}","userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.132 Safari/537.36","ip":"127.0.0.1","date":"2020-03-17T11:18:27.411185Z","userId":100}

Example

Request
GET /api/admin/audit/activity/details/{userId}/{date}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...