From 686d82a13ee75f1902b2fcc233638215532064e6 Mon Sep 17 00:00:00 2001 From: ci-build Date: Fri, 11 Aug 2023 02:02:16 +0000 Subject: [PATCH] [ci skip] Updating documents --- additional-documentation/rest-api.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/additional-documentation/rest-api.html b/additional-documentation/rest-api.html index 9ee732767e..00d160d8c3 100644 --- a/additional-documentation/rest-api.html +++ b/additional-documentation/rest-api.html @@ -1030,8 +1030,8 @@ "records" ], "additionalProperties": false -}

User Management

User Management Actions

List users in the system
GET/default/rdmp/api/users{?searchBy,query,start,rows}

Example URI

GET https://demo.redboxresearchdata.com.au/default/rdmp/api/users?searchBy=type&query=local&start=0&rows=10
URI Parameters
HideShow
start
number (optional) Default: 0 Example: 0

The index number for the first value to return from the result set.

-
rows
number (optional) Default: 10 Example: 10

The number of records to return in the request

+}

User Management

User Management Actions

List users in the system
GET/default/rdmp/api/users{?searchBy,query,page,pageSize}

Example URI

GET https://demo.redboxresearchdata.com.au/default/rdmp/api/users?searchBy=type&query=local&page=1&pageSize=10
URI Parameters
HideShow
page
number (optional) Default: 1 Example: 1

The page index of the result set to show.

+
pageSize
number (optional) Default: 10 Example: 10

The number of records to return in a page

searchBy
string (optional) Example: type

The attribute to search by. e.g. email

query
string (optional) Example: local

The value to query. Only exact matches.

Request
HideShow
Headers
Authorization: Bearer abcabcab-abca-abca-abca-abcabcabcabc
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
@@ -1608,7 +1608,7 @@
   "additionalProperties": false
 }

Search Mint records

This endpoint is an authenticated wrapper to Apache solr’s search endpoint and supports all the basic common query parameters.

Search
GET/mint/api/v1.1/search{?q}

Example URI

GET https://demo.redboxresearchdata.com.au/mint/api/v1.1/search?q=query
URI Parameters
HideShow
q
string (required) Example: query

The search string to query the index.

-
Request
HideShow
Headers
Authorization: Bearer abcabcab-abca-abca-abca-abcabcabcabc
Response  200
HideShow
Headers
Content-Type: application/json

Generated by aglio on 04 Aug 2023