> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/produit/multigest/connecteurs/connecteur-cmis/reference-services.md).

# Référence des services

Liste des services web CMIS exposés par le connecteur MG Connect : paramètres, valeurs de retour et spécificités Multigest.

Multigest implémente la norme CMIS 1.1 côté serveur en exposant des WebServices SOAP et Rest. Cette page détaille, catégorie par catégorie, les services disponibles, leurs paramètres, leur valeur de retour et les spécificités propres à Multigest. Pour l'installation et le paramétrage du connecteur, voir [Installation](https://documentation.efalia.com/produit/multigest/connecteurs/connecteur-cmis/installation.md).

Les services web sont répartis en 9 catégories. Certaines ne sont pas implémentées par Multigest : services de gestion d'alias de document, services de relation entre les objets, services de stratégie et services de contrôle d'accès.

## Architecture et arborescence

5 services liés à l'architecture du système et à son arborescence.

### getRepositories

Retourne la liste des armoires présentes.

* **Paramètre** : aucun
* **Retour** : la liste des armoires (`repositoryId` et `repositoryName`)

### getRepositoryInfo

Retourne les données relatives à une armoire passée en paramètre.

* **Paramètre** : `repositoryId` (l'identifiant de l'armoire)
* **Retour** : la liste des propriétés d'une armoire (`repositoryId`, `repositoryName`, `repositoryDescription`, `cmisVersionSupported`, `rootFolderId`, `capabilities`)
* **Spécificité Multigest** : les armoires et les bannettes sont retournées sur le même schéma. Le `repositoryId` d'une armoire est préfixé par un « A », celui d'une bannette par un « B ».

### getTypeChildren

Retourne les types d'objets définis pour l'armoire.

* **Paramètres** : `repositoryId` ; `typeId` (facultatif — l'identifiant du type d'objet recherché) ; `includePropertyDefinitions` (facultatif — ajoute les définitions pour chaque type) ; `maxItems` (facultatif — pagination) ; `skipCount` (facultatif — pagination)
* **Retour** : tableau des objets retournés, `hasMoreItems` (booléen), `numItems` (quantité d'éléments)
* **Spécificité Multigest** : l'élément `numItems` est toujours retourné.

### getTypeDescendants

Retourne la liste des types d'objets présents dans l'armoire définie ainsi que, récursivement, tout ceux contenus dans les dossiers présents.

* **Paramètres** : `repositoryId` ; `typeId` (facultatif) ; `depth` (facultatif — nombre de niveaux à explorer, `-1` pour tous les niveaux)
* **Retour** : la liste des types contenus dans le dossier défini
* **Spécificité Multigest** : le paramètre facultatif `includePropertyDefinitions` n'est pas pris en charge.

### getTypeDefinition

Retourne la définition du type d'objet demandé.

* **Paramètres** : `repositoryId` ; `typeId` (l'identifiant du type d'objet recherché)
* **Retour** : objet regroupant toutes les propriétés

## Navigation

6 services liés à la navigation.

### getChildren

Retourne la liste des objets présents dans le dossier défini.

* **Paramètres** : `repositoryId` ; `folderId` ; `maxItems` (facultatif) ; `skipCount` (facultatif)
* **Retour** : tableau des objets retournés, `hasMoreItems`, `numItems`
* **Spécificité Multigest** : les paramètres facultatifs `orderBy`, `filter`, `includeRelationships`, `renditionFilter`, `includeAllowableActions`, `includePathSegment` ne sont pas pris en charge.

{% hint style="info" %}
**Algorithme.** Le service vérifie les paramètres puis parcourt chaque objet de type `MgUserArmoire` (les armoires) : les objets `MgDossier` (dossiers GED), `MgDossierTravail` (dossiers de travail), `MgFolder` (sous-dossiers ou sous-sous-dossiers) et `MgDoc` (documents) sont pris en compte. Pour chaque objet `MgUserBannette` (les bannettes), tous les objets rencontrés sont pris en compte.
{% endhint %}

### getDescendants

Retourne la liste des objets présents dans le dossier défini ainsi que, récursivement, tout ceux contenus dans les dossiers présents.

* **Paramètres** : `repositoryId` ; `folderId` ; `depth` (facultatif — nombre de niveaux à explorer, `-1` pour tous les niveaux)
* **Retour** : la liste des types contenus dans le dossier défini
* **Spécificité Multigest** : les paramètres facultatifs `filter`, `includeRelationships`, `renditionFilter`, `includeAllowableActions`, `includePathSegment` ne sont pas pris en charge.

### getFolderTree

Retourne l'arborescence des dossiers présente sous le dossier défini.

* **Paramètres** : `repositoryId` ; `folderId` ; `depth` (facultatif) ; `skipCount` (facultatif) ; `filter` (facultatif — filtre sur les propriétés à retourner)
* **Retour** : la liste des objets contenus dans le dossier défini
* **Spécificité Multigest** : les paramètres facultatifs `includeRelationships`, `renditionFilter`, `includeAllowableActions`, `includePathSegment` ne sont pas pris en charge.

Le même algorithme que `getChildren` s'applique : parcours des types `MgDossier`, `MgDossierTravail`, `MgFolder`, `MgDoc` pour chaque armoire, et de tous les objets pour chaque bannette.

### getFolderParent

Retourne le dossier parent du dossier défini.

* **Paramètres** : `repositoryId` ; `folderId` ; `filter` (facultatif)
* **Retour** : objet contenant les propriétés du dossier parent

### getObjectParent

Retourne le ou les dossiers parents de l'objet défini. Cet objet ne peut être un dossier, mais un alias.

* **Paramètres** : `repositoryId` ; `objectId` ; `filter` (facultatif) ; `includeRelativePathSegment` (facultatif — ajout ou non du chemin relatif)
* **Retour** : objet contenant les propriétés du dossier parent
* **Spécificité Multigest** : les paramètres facultatifs `includeRelationships`, `renditionFilter`, `includeAllowableActions` ne sont pas pris en charge.

### getCheckedOutDocs

**Fonction non implémentée.** Devrait retourner la liste des documents auxquels l'utilisateur a accès.

## Actions sur les dossiers et les documents

17 services liés aux actions sur les dossiers et les documents.

### createDocument

Ajoute un document via un type défini dans le dossier demandé ou à la racine de l'armoire.

* **Paramètres** : `repositoryId` ; `properties` ; `folderId` (facultatif — si absent, le document est déposé à la racine de l'armoire) ; `contentStream` (facultatif — le contenu du document)
* **Retour** : l'identifiant du document créé, avec son extension
* **Spécificité Multigest** : les paramètres facultatifs `versioningState`, `policies`, `addAces`, `removeAces` ne sont pas pris en charge.

{% hint style="info" %}
**Algorithme.** Pour un dépôt de type `MgUserArmoire` (une armoire) : vérification des droits d'import, vérification de l'arborescence, ajout du document dans la base Multigest, copie du fichier s'il est transmis en paramètre, intégration des métadonnées associées. Pour un dépôt de type `MgUserBannette` (une bannette) : vérification des droits d'import, ajout du document dans la base Multigest, copie du fichier s'il est transmis en paramètre.
{% endhint %}

### createDocumentFromSource

**Fonction non implémentée.** Devrait ajouter un document en copiant simplement un autre document déjà existant.

### createFolder

Ajoute un dossier dans l'arborescence de l'armoire et/ou du dossier défini.

* **Paramètres** : `repositoryId` ; `properties` ; `folderId` (l'identifiant du dossier dans lequel placer le dossier)
* **Retour** : l'identifiant du dossier créé, avec une propriété d'extension nulle
* **Spécificité Multigest** : les paramètres facultatifs `policies`, `addAces`, `removeAces` ne sont pas pris en charge.

{% hint style="info" %}
**Algorithme.** Vérification des paramètres ; si le dossier est à la racine d'une armoire, le `folderId` devient celui de l'armoire ; si le dossier est déjà un sous-sous-dossier, l'action est interrompue ; si le dépôt est une bannette, l'action est interrompue ; création du dossier.
{% endhint %}

### createRelationship

**Fonction non implémentée.** Devrait créer un objet de mise en relation.

### createPolicy

**Fonction non implémentée.** Devrait ajouter des règles de stratégie d'action sur un dépôt.

### getAllowableActions

**Fonction non implémentée.** Devrait retourner la liste des actions autorisées pour un objet.

### getObject

Retourne le détail des propriétés d'un objet.

{% hint style="warning" %}
Cette fonction est un alias de `getObjectByPath`.
{% endhint %}

* **Paramètres** : `repositoryId` ; `objectId` ; `includeAllowableActions` (facultatif — ajoute les actions autorisées)
* **Retour** : tableau à 2 éléments — `properties` (propriétés de l'objet) et `allowableActions` (actions autorisées, toutes forcées à `true`)
* **Spécificité Multigest** : les paramètres facultatifs `filter`, `includeRelationships`, `renditionFilter`, `includePolicyIds`, `includeACL` ne sont pas pris en charge.

### getProperties

Retourne le détail des propriétés d'un objet.

{% hint style="warning" %}
Cette fonction est un alias de `getObjectByPath`.
{% endhint %}

* **Paramètres** : `repositoryId` ; `objectId`
* **Retour** : tableau à 2 éléments — `properties` et `allowableActions` (toutes forcées à `true`)
* **Spécificité Multigest** : le paramètre facultatif `filter` n'est pas pris en charge.

### getObjectByPath

Retourne le détail des propriétés d'un objet.

* **Paramètres** : `repositoryId` ; `path` (chemin vers l'objet) ; `includeAllowableActions` (facultatif)
* **Retour** : tableau à 2 éléments — `properties` et `allowableActions`
* **Spécificité Multigest** : les paramètres facultatifs `filter`, `includeRelationships`, `renditionFilter`, `includePolicyIds`, `includeACL` ne sont pas pris en charge.

{% hint style="info" %}
**Algorithme.** Vérification des paramètres et du chemin. Si le dépôt est une armoire : analyse de l'arborescence, détection des dossiers de travail, identification de l'objet à traiter. Si le dépôt est une bannette, le document est identifié directement.
{% endhint %}

### getContentStream

Retourne le flux de données du contenu d'un document.

* **Paramètres** : `repositoryId` ; `objectId`
* **Retour** : flux de données
* **Spécificité Multigest** : le paramètre facultatif `streamId` n'est pas pris en charge.

### getRenditions

**Fonction non implémentée.** Devrait retourner la liste des rendus associés à l'objet défini (seuls les attributs de rendus seraient retournés, pas le flux).

### updateProperties

Met à jour les propriétés d'un objet.

* **Paramètres** : `repositoryId` ; `objectId` ; `properties` (tableau des propriétés)
* **Retour** : tableau à 2 éléments — `objectId` et `changeToken` (valeur vide, non pris en charge)
* **Spécificité Multigest** : le paramètre facultatif `changeToken` n'est pas pris en charge.

{% hint style="info" %}
**Algorithme.** Vérification des paramètres et des droits d'édition des métadonnées. Si le dépôt est une bannette, une alerte indique que l'opération est interdite. Si le dépôt est une armoire : analyse du dossier dans l'arborescence, recherche de la fiche de métadonnées, mise à jour des propriétés.
{% endhint %}

### moveObject

**Fonction non implémentée.** Devrait déplacer un alias.

### deleteObject

Supprime un objet.

* **Paramètres** : `repositoryId` ; `objectId` (l'identifiant de l'objet à supprimer)
* **Retour** : aucun
* **Spécificité Multigest** : le paramètre facultatif `allVersions` n'est pas pris en charge.

{% hint style="info" %}
**Algorithme.** Vérification des paramètres. Si le dépôt est une bannette, aucune implémentation n'est réalisée. Si le dépôt est une armoire, sont pris en compte : le dossier GED, le dossier de travail seulement s'il est vide, le sous-dossier ou sous-sous-dossier, le document. Suppression de l'objet identifié.
{% endhint %}

### deleteTree

**Fonction non implémentée.** Devrait supprimer un objet ainsi que tous les éléments de son arborescence.

### setContentStream

Injecte le flux de contenu du document référencé par l'objet.

* **Paramètres** : `repositoryId` ; `objectId` ; `contentStream` (le flux de données représentant le document)
* **Retour** : tableau à 2 éléments — `objectId` et `changeToken`
* **Spécificité Multigest** : les paramètres facultatifs `overwriteFlag`, `changeToken` ne sont pas pris en charge.

{% hint style="info" %}
**Algorithme.** Vérification des paramètres et de l'arborescence. Si le dépôt est une armoire : recherche du fichier concerné, comparaison du type de fichier (ils doivent être identiques), injection du nouveau contenu. Si le dépôt est une bannette, le nouveau contenu est injecté directement.
{% endhint %}

### deleteContentStream

**Fonction non implémentée.** Devrait supprimer le flux de données d'un document.

## Alias de documents

2 services liés à la navigation, **aucun n'est implémenté**.

### addObjectToFolder

**Fonction non implémentée.** Devrait ajouter un alias dans un dossier.

### removeObjectFromFolder

**Fonction non implémentée.** Devrait supprimer un alias dans un dossier.

## Recherche

2 services liés à la recherche. Voir aussi [Recherche](https://documentation.efalia.com/produit/multigest/connecteurs/connecteur-cmis/recherche.md) pour la syntaxe des requêtes.

### query

Lance une recherche par requête sur les objets définis comme requêtables d'un dépôt.

* **Paramètres** : `repositoryId` ; `statement` (requête de recherche) ; `maxItems` (facultatif) ; `skipCount` (facultatif)
* **Retour** : tableau à 3 éléments — `object` (les objets trouvés), `numItems` (nombre total de résultats), `hasMoreItems` (booléen)
* **Spécificité Multigest** : l'élément `numItems` est toujours retourné. Les paramètres facultatifs `searchAllVersions`, `includeRelationships`, `renditionFilter`, `includeAllowableActions` ne sont pas pris en charge.

{% hint style="info" %}
**Fonctions implémentées.** La clause WHERE de la recherche SQL supporte `CONTAINS` et `IN_TREE`, mais pas `IN`, `ANY`, `SCORE`, ni `IN_FOLDER`.
{% endhint %}

{% hint style="info" %}
**Caractéristiques.** Les algorithmes de recherche utilisent les métadonnées dossier comme les métadonnées document. Si une ou plusieurs métadonnées dossier sont identifiées, elles servent de filtre : les métadonnées document ne sont recherchées que sur les documents contenus dans les dossiers filtrés. Tous les documents stockés en GED peuvent être ciblés par la recherche.
{% endhint %}

### getContentChanges

**Fonction non implémentée.** Devrait retourner la liste des contenus modifiés. Cette fonction est destinée aux moteurs de recherche et donc peu pertinente pour Multigest.

## Gestion des versions

6 services liés à la gestion des versions.

### checkOut

Crée une version de travail privée du document.

* **Paramètres** : `repositoryId` ; `objectId`
* **Retour** : tableau à 3 éléments — `objectId`, `contentCopied` (booléen, valeur `true`), `extension` (valeur de l'extension du fichier)
* **Spécificité Multigest** : l'élément `extension` est ajouté au retour.

{% hint style="info" %}
**Algorithme.** Vérification des paramètres. Si le dépôt est une armoire : recherche du fichier concerné, copie. Si le dépôt est une bannette, le fichier est copié directement.
{% endhint %}

### cancelCheckOut

**Fonction non implémentée.** Devrait annuler l'effet d'un check-out (la copie privée serait supprimée).

### checkIn

Ré-injecte une version privée du document dans le document original.

* **Paramètres** : `repositoryId` ; `objectId` ; `properties` (facultatif — tableau des propriétés à appliquer lors du check-in) ; `contentStream` (facultatif — le contenu à enregistrer lors du check-in)
* **Retour** : tableau à 2 éléments — `objectId` et `extension`
* **Spécificité Multigest** : l'élément `extension` est ajouté par rapport au modèle CMIS. Les paramètres facultatifs `checkinComment`, `policies`, `addACEs`, `removeACEs` ne sont pas pris en charge.

{% hint style="info" %}
**Algorithme.** Vérification des paramètres. Si le dépôt est une armoire : recherche du fichier concerné, écrasement de la copie courante par la copie privée, ajout d'une version. Si le dépôt est une bannette, la copie privée remplace directement la version courante.
{% endhint %}

### getObjectOfLatestVersion

**Fonction non implémentée.** Devrait retourner la dernière version d'un objet.

### getPropertiesOfLatestVersion

**Fonction non implémentée.** Devrait retourner les propriétés de la dernière version d'un objet.

### getAllVersions

**Fonction non implémentée.** Devrait retourner la liste de toutes les versions d'un document, ordonnée anté-chronologiquement.

## Relations entre les objets

1 service, **non implémenté**.

### getObjectRelationships

**Fonction non implémentée.** Devrait retourner les objets de mise en relation.

## Stratégies

3 services liés aux stratégies, **aucun n'est implémenté**.

### applyPolicy

**Fonction non implémentée.** Devrait appliquer une stratégie sur un objet.

### removePolicy

**Fonction non implémentée.** Devrait supprimer une stratégie sur un dossier.

### getAppliedPolicies

**Fonction non implémentée.** Devrait retourner la liste des stratégies appliquées sur un objet.

## Contrôles d'accès

2 services liés aux contrôles d'accès, **aucun n'est implémenté**.

### getACL

**Fonction non implémentée.** Devrait retourner les contrôles d'accès actuellement appliqués sur un objet.

### applyACL

**Fonction non implémentée.** Devrait ajouter ou supprimer un contrôle d'accès sur un objet.

## Console de test CMIS Workbench

La fondation Apache Chemistry met à disposition un outil particulièrement utile pour tester une connexion CMIS côté client : **CMIS Workbench**. Il permet de se connecter à un serveur Multigest et de lancer des opérations similaires à celles générées par les applications clientes, sans développement préalable.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-16bca934c934f2f1debfb97a97328678a8c16b38%2Fconnecteur-cmis-workbench-01-connexion.webp?alt=media" alt="Fenêtre de connexion CMIS Workbench : URL du service (http://mgtest.efalia.com/Interconnexion/cmis/cmisservice.php), binding Web Services, authentification Standard"><figcaption><p>Connexion à un serveur Multigest depuis CMIS Workbench</p></figcaption></figure>

Après connexion (URL du service, identifiants), l'outil se présente comme un navigateur : il permet de parcourir les armoires et bannettes, de consulter le détail des propriétés d'un objet (`Properties`), de lancer des requêtes (`Query`), et d'inspecter les objets retournés — utile notamment pour retrouver la valeur exacte d'une métadonnée comme `MgTypeDoc`.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-1ebbfeeef5913850e50b6c60b356659445e421ba%2Fconnecteur-cmis-workbench-02-navigation.webp?alt=media" alt="CMIS Workbench : navigation dans une armoire Multigest, liste des dossiers cmis:folder et détail de l&#x27;onglet Object pour le dossier sélectionné"><figcaption><p>Navigation dans une armoire et consultation d'un objet</p></figcaption></figure>

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-c09af7ead4b64d60d370f736da3e0b4151492018%2Fconnecteur-cmis-workbench-03-proprietes.webp?alt=media" alt="CMIS Workbench, onglet Properties : liste des propriétés CMIS et Multigest (mdata:) d&#x27;un document, avec leur type et leur valeur"><figcaption><p>Détail des propriétés (onglet Properties) d'un document</p></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.efalia.com/produit/multigest/connecteurs/connecteur-cmis/reference-services.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
