Skip to content

Commit

Permalink
Added export api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Brazzatti committed Oct 3, 2023
1 parent 2a56d68 commit f57f0d6
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions views/default/default/apidocsapib.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -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}]
Expand Down Expand Up @@ -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]
Expand Down

0 comments on commit f57f0d6

Please sign in to comment.