Various other useful endpoints
1.1.1 GetAuditEventsByDateRange
Enables external API calls to retrieve a complete list of Filer audit events based on configuration and date range. Since Filer purges audit events after a specified retention period, this endpoint is essential for accessing and archiving older audit events before they are deleted, which may be a necessary operation for various data compliance reasons
POST /api/external/auditevent/getauditeventsbydaterange
Example Request Body:
{
"organisationId": 0,
"user": "string",
"configurationId": 0,
"startDate": "2024-12-02T10:49:33.857Z",
"endDate": "2024-12-02T10:49:33.857Z",
}
200 Success
{
"httpStatusCode": 0,
"errors": [
"string"
],
"auditEvents": [
{
"auditEventId": 0,
"auditEventSourceId": 0,
"auditEventSourceDescription": "string",
"auditEventTypeId": 0,
"auditEventTypeDescription": "string",
"description": "string",
"user: "string",
"administrationOperation": true,
"created": "2024-12-02T10:49:33.857Z",
"modified": "2024-12-02T10:49:33.857Z"
}
]
}
400 Bad Request A 400 error will be presented in the status code and errors section
500 Server Error A 500 error will be presented in the status code and errors section
1.1.2 GetConfigurationSettingsById
Retrieves a Filer configuration containing all settings defined through the Filer admin application. This information allows third-party applications to dynamically recreate the associated Filer user interface that can send document to Filer.
GET /api/external/configuration/getconfigurationsettngsbyid/{configurationId}
{
"httpStatusCode": 0,
"errors": [
"string"
],
"name": "string",
"demographicSourceName": "string",
"demographicPrimaryIdentifier": "string",
"lastModified": "2024-12-02T10:49:33.857Z",
"metadata": [
{
"id": 0,
"fieldName": "string",
"internalName": "string",
"dataType": "string",
"sortOrder": 0,
"isDemographic": true,
"created": "2024-12-02T10:49:33.857Z",
"modified": "2024-12-02T10:49:33.857Z"
}
],
"classificationItems": [
{
"id": "string",
"parentId": "string",
"title": "string",
"contentTypeId": "string",
"contentTypeName": "string",
"isDocumentType": true,
"sortOrder": 0,
"created": "2024-12-02T10:49:33.857Z",
"modified": "2024-12-02T10:49:33.857Z"
}
],
"accessTypes": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"created": "2024-12-02T10:49:33.857Z",
"modified": "2024-12-02T10:49:33.857Z"
}
]
}
400 Bad Request A 400 error will be presented in the status code and errors will be returned
500 Server Error A 500 error will be presented in the status code and errors will be returned
1.1.3 UpdateExpiryDates
Sets the external expiry date for a document, specifying when the system should automatically delete the record. This feature enables external systems to define the retention period for documents in Filer.
POST: /api/external/entity/updateexpirydates
Example Request Body:
{
"organisationId": 0,
"user": "string",
"configurationId": 0,
"primaryIdentifier": "string",
"retentionDate": "2024-12-02T10:49:33.857Z"
}
200 Success
{
"httpStatusCode": 0,
"errors": [
"string"
]
}
400 Bad Request A 400 error will be presented in the status code and errors will be returned
500 Server Error A 500 error will be presented in the status code and errors will be returned
1.1.4 DeleteRecordByItemId
Soft deletes a Filer record reference and sends the document to SharePoint recycle bin. The Filer system has a tidy up mechanism so these soft deleted items will be purged after X days from the Filer database
X days = Whatever is specified against your configuration. The default is 90 days, but this can be set higher
POST: /api/external/record/deleterecordbyitemid
Example Request Body:
{
"organisationId": 0,
"user": "string",
"itemId": "string",
"libraryId": "string",
"userEmail": "string"
}
200 Success
{
"httpStatusCode": 0,
"errors": [
"string"
]
}
400 Bad Request A 400 error will be presented in the status code and errors will be returned
500 Server Error A 500 error will be presented in the status code and errors will be returned