Core APIs

Consommer la couche de services de FlowerDocs Core

FlowerDocs Core expose un ensemble de services afin de faciliter son intégration avec des applications tierces. Ces services peuvent être consommés de différentes manières qui sont décrites dans les sections suivantes.



Consulter le blog pour des exemples concrets d’utilisation.

Core Services

Services Java

WS SOAP

Client Java Web services

Operation

Réagissez aux événements

Afin de créer un document, le service DocumentWSService expose une opération create

POST /core/services/document

	<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:doc="http://flower.com/docs/ws/api/document" 
	xmlns:doc1="http://flower.com/docs/domain/document"
	xmlns:com="http://flower.com/docs/domain/component"
	xmlns:com1="http://flower.com/docs/domain/common" 
	xmlns:acl="http://flower.com/docs/domain/acl" 
	xmlns:file="http://flower.com/docs/domain/file" 
	xmlns:flower="flower" >
	   <soapenv:Header>
	    <flower:token>{{token}}</flower:token>
	   </soapenv:Header>
	   <soapenv:Body>
	      <doc:createRequest>
	         <doc1:Document category="DOCUMENT" name="Mon document">
	            <com:data>
	               <com:classId>GEC_Courrier</com:classId>
	            </com:data>
	             <com:Tags>
	               <com:tags name="GEC_AdresseDestinataire">
	                  <com:value>destinataire@gmail.com</com:value>
	               </com:tags>
	            </com:Tags>
	            <doc1:files>
	              <file:Name>FileName</file:Name>
	              <file:Content>cid:200566171966</file:Content>
	            </doc1:files>
	         </doc1:Document>
	      </doc:createRequest>
	   </soapenv:Body>
	</soapenv:Envelope>


Le service /core/services/documentMTOM fournit les mêmes opérations et supporte le MTOM pour le transfert des contenus. L’utilisation de ce service est recommandée pour la création de document avec des contenus de taille conséquente.

Les requêtes de recherche permettent de rechercher des composants stockés dans FlowerDocs en fonction de différents critères. Ces requêtes de recherche sont composées de la façon suivante :

Les différentes clauses

Clause Select

La selectClause permet de définir les champs à remonter. Elle est constituée d’une liste de valeurs fields.

Clauses Filter

Les filterClauses permettent de définir des filtres à appliquer sur la recherche. Une filterClause est composée de la façon suivante :

  • criteria : les critères de ce filtre
  • filterClauses : les sous-filtres

Une clause Filter va pouvoir en contenir une ou plusieurs autres afin de pouvoir effectuer des requêtes complexes avec des opérateurs logiques ET et OU. Pour cela, il existe deux types de clause Filter :

  • AndClause : Clause ET, un opérateur logique ET est appliqué entre ses critères et ses sous-clauses
  • OrClause : Clause OU, un opérateur logique OU est appliqué entre ses critères et ses sous-clauses

Clauses Order

Les orderClauses permettent de définir l’ordre dans lequel les résultats seront remontés. Elles sont composées de la façon suivante :

  • name : le nom du critère sur lequel trier
  • type : le type du critère
  • ascending : tri par ordre croissant ou non

Pagination des résultats

  • start : Définit le début de la page de recherche
  • max : Définit le nombre maximum de résultats à retourner

Exemples

Les exemples ci-dessous indiquent comment effectuer une recherche de document ayant un nom contenant la chaîne de caractères facture.

Ces différents exemples peuvent être adaptés pour chaque catégorie de composant.

Tous
DAO

Tous
Consommer les services