From f57f0d6023514f6f4678461c3f08448bcff78e7a Mon Sep 17 00:00:00 2001 From: Andrew Brazzatti Date: Tue, 3 Oct 2023 23:59:16 +1030 Subject: [PATCH] Added export api documentation --- views/default/default/apidocsapib.ejs | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/views/default/default/apidocsapib.ejs b/views/default/default/apidocsapib.ejs index e5e720e9c1..d43a27adc4 100644 --- a/views/default/default/apidocsapib.ejs +++ b/views/default/default/apidocsapib.ejs @@ -278,8 +278,6 @@ The ReDBox Portal API provides authorized access to manage functions. - message: Failed to list attachments, please check server logs. - - ## Record Permission Actions [/<%= branding %>/<%= portal %>/api/records/permissions] ### Give users edit access to record [POST /<%= branding %>/<%= portal %>/api/records/permissions/edit/{oid}] @@ -494,6 +492,17 @@ The ReDBox Portal API provides authorized access to manage functions. + Response 200 (application/json) + Attributes (CreateRecordAuthorization, fixed-type) +## Export Actions [/<%= branding %>/<%= portal %>/api/export] + +### Export record data [POST /<%= branding %>/<%= portal %>/api/export/record/download/{format}{?recType,before,after}] ++ Parameters + + format: `json` (string, required) - The format of the export. Valid values are 'json' or 'csv' + + recType: `rdmp` (string) - The type of record to export + + before: `2023-06-30T00:00:00Z` (string) - Show records updated before the date (ISO 8601 format) + + after: `2022-07-01T00:00:00Z` (string) - Show records updated after the date (ISO 8601 format) + ++ Response 200 + # Group Search ## Search Actions [/<%= branding %>/<%= portal %>/api/search]