API Consultation / Modification REST
  • 20 Jun 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

API Consultation / Modification REST

  • Dark
    Light
  • PDF

The content is currently unavailable in English. You are viewing the default French version.
Article summary

Important
L'API REST V1 est maintenant considérée obsolète et sera retirée à tout moment après le 30 juin 2025, sans préavis supplémentaire. Constellio se réserve le droit de maintenir l'API après le 30 juin 2025, mais nous souhaitons encourager les clients à utiliser les API plus à jour de Constellio, comme l'API REST V2 qui contient toutes les mêmes fonctionnalités. Tout nouveau développement sera fait à partir des nouvelles APIs, et seuls les correctifs de sécurité seront maintenus pour l'API REST V1, et ce jusqu'au 30 juin 2025 .


Disponible suivant le standard OpenAPI.

Consulter la documentation de référence : https://api.constellio.com/ 

URL présigné

L'API REST fonctionne avec des URLs présignés. C'est-à-dire qu'il faut d'abord générer un URL avec le service /urls (ex. http://host:port/constellio/rest/v1/urls )

Par exemple avant de faire un DOCUMENT /get :

https://{{host}}/constellio/rest/v1/urls?serviceKey={{serviceKey}}&token={{token}}&schemaType=DOCUMENT&method=GET&expiration=3600&id={{id}}

{{host}} : hôte et port pour la connexion

{{serviceKey}} : clé de service pour l'utilisateur

{{token}} : jeton pour l'utilisateur

{{id}} : id du document à récupérer

L'appel de service retourne un URL avec une signature (il ne peut donc être modifié):

http://hote:port/constellio/rest/v1/documents?id={{id}}&serviceKey={{serviceKey}}&method=GET&date=20200101T000000-0000&expiration=3600&signature=0_LMldPZjZW9WdFM_gBwWZ51SFYuDK-SKM7ZZBx8pkg 

Cet URL est ensuite utilisable pour lancer un appel pour récupérer un document, avec la réponse suivante (en exemple) : 

{
    "id""00000007007",
    "folderId""00000007006",
    "type"null,
    "content": {
        "version""1.0",
        "versionType""MAJOR",
        "filename""test.pdf",
        "hash""IrJfzJX6LjqtyTB88rC-QwOboZU="
    },
    "title""test.pdf",
    "keywords": [],
    "author""Administrator",
    "subject"null,
    "organization"null,
    "directAces": [],
    "inheritedAces": [],
    "extendedAttributes": []
}


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.