Rest API v2

Rest API v2

La version 2 du rest api a été conçue pour permettre un accès aux données sans l'utilisation des urls signés.

Recherche avancée

La version 2 du Rest API permet  de faire des recherches avec facettes. Elle est accessible en faisant un POST /records. Pour le moment, il n'est pas possible de faire une recherche avec des conditions logiques.

La requête supporte un paramètre de query filterMode qui est un Enum qui contient deux valeurs possibles pour le moment. Soit SUMMARY et ALL. Ce paramètre permet de filtrer les métadonnées retournées avec chaque résultat de recherche. Avec SUMMARY, seules les métadonnées sommaires sont retournées pour chaque résultat de recherche.

La requête supporte les paramètres suivants dans le body:

• collection
  • • Obligatoire
    • Collection sur laquelle est effectuée la recherche
• schemaTypes
  • • Optionnel 
    • Liste de schema types sur laquelle est effectuée la recherche
• sorting
  • • Optionnel
    • Liste de métadonnées pour trier les résultats de la recherche. Pour chaque métadonnée, on peut spécifier si c'est ascendant ou pas.
• facetMode

  ---

  • • Optionnel
    • Enum indiquant le mode utilisé par les facettes
      • • NONE : non utilisé (valeur de défaut)
        • CONSTELLIO : utilise les facettes de défaut de Constellio
        • SPECIFIC : utilise une ou des facettes spécifiques
• facetValueIds
  • • Optionnel 
    • Liste des facettes utilisées
• expression
  • • Optionnel
    • Expression texte pour filtrer les résultats de recherche
• rowsStart
  • • Optionnel
    • Peut être utilisé pour récupérer les résultats en paging. Indique le rang de départ pour le curseur.
• rowsLimit
  • • Optionnel
    • Peut être utilisé pour récupérer les résultats en paging. Indique le nombre maximum de résultats à retourner.
• requireWriteAccess
  • • Optionnel
    • Utilisé pour retourner seulement les résultats dont l'utilisateur possède un droit en écriture.

      ---

Exemple POSTMAN

Voici un export de plusieurs exemples postman pour tester le Rest API v2 :