Rest API v2

Rest API v2

Version 2 of the rest api was designed to allow access to data without the use of signed urls.

Advanced search

Version 2 of the Rest API allows  faceted searches. It is accessible by making a POST /records. At the moment, it is not possible to search with logical conditions.

The query supports a filterMode query parameter which is an Enum that contains two possible values at the moment. Let SUMMARY and ALL. Use this parameter to filter the metadata returned with each search result. With SUMMARY, only summary metadata is returned for each search result.

The query supports the following parameters in the body:

• collection
  • • Obligatory
    • The collection searched on
• schemaTypes
  • • Optional 
    • List of schema types on which the search is performed
• Sorting
  • • Optional
    • A list of metadata to sort search results. For each metadata, we can specify if it is bottom-up or not.
• facetMode

  ---

  • • Optional
    • Enum indicating the mode used by the facets
      • • NONE: Not used (default value)
        • CONSTELLIO: uses Constellio defect facets
        • SPECIFIC: uses one or more specific facets
• facetValueIds
  • • Optional 
    • List of facets used
• expression
  • • Optional
    • Text expression to filter search results
• rowsStart
  • • Optional
    • Can be used to retrieve results in paging. Specifies the starting rank for the cursor.
• rowsLimit
  • • Optional
    • Can be used to retrieve results in paging. Specifies the maximum number of results to return.
• requireWriteAccess
  • • Optional
    • Used to return only results for which the user has write permission.

      ---

POSTMAN example

Here is an export of several postman examples to test the Rest API v2: