Introduction Glossaire Guide utilisateur
Guide administrateur fonctionnel Guide administrateur technique Prérequis pour Maarch Courrier Installation Breaking Change Exploitation Mise en oeuvre de docker Architecture technique Architecture du produit Architecture d'un projet type Description du modèle de données Description des webservices Bannettes Contacts Courriers Entités Export et fiche de liaison Groupes Notes Dossiers Pièces jointes Recherche Types de courrier Utilisateurs

Création d'un groupe

Route

POST /rest/groups

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
group_id string Oui Identifiant
group_desc string Oui Nom du groupe
security array Oui Sécurité du groupe
Exemple
{
    "group_id" : "admin",
    "group_desc" : "Administrateurs",
    "security" : {
        "where_clause" : "1=1",
        "maarch_comment" : "une description "
    }
}

Retour

Code Http Type Description Exemple
200 array Le groupe a bien été créé ['group' => 21]
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Modification d'un groupe

Route

PUT /rest/groups/{id}

Le paramètre id de la route représente l'identifiant technique (usergroups.id) du groupe à modifier

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
description string Oui Nom du groupe
security array Oui Sécurité du groupe
Exemple
{
    "description" : "Administrateurs",
    "security" : {
        "where_clause" : "1=1",
        "maarch_comment" : "une description "
    }
}

Retour

Code Http Type Description Exemple
200 array Le groupe a bien été modifié ['success' => 'success']
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Suppression d'un groupe

Route

DELETE /rest/groups/{id}

Le paramètre id de la route représente l'identifiant technique (usergroups.id) du groupe à supprimer

Retour

Code Http Type Description Exemple
200 array La modification a bien été prise en compte
400 array Un paramètre obligatoire est manquant ['errors' => 'Bad Request']
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']

Liste des groupes

Route

GET /rest/groups

Retour

Code Http Type Description Exemple
200 array liste des groupes ["groups" => [] ]
403 array Droits insuffisants pour cette action ['errors' => 'Service forbidden']
500 array Une erreur s'est produite ['errors' => '...']
Exemple
{
    "groups":[
        {
            "group_id": "ADMINISTRATEUR",
            "group_desc": "Admin. fonctionnel",
            "id": 6,
            "can_index": true,
            "indexation_parameters": "{\"actions\": [\"718\"], \"entities\": [\"1\"], \"keywords\": [\"MY_ENTITIES\"]}",
            "users": [
                {
                    "user_id": "bboule",
                    "firstname": "Bruno",
                    "lastname": "BOULE"
                },
                {...}
            ]
        },
        {...}
    ]
}

results matching ""

    No results matching ""