Introduction Glossaire Guide utilisateur
Guide administrateur fonctionnel Guide administrateur technique Prérequis pour Maarch Courrier Installation Script de migration 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 Pièces jointes Bannettes Contacts Entités Export et fiche de liaison Groupes Notes Courriers Utilisateurs Types de courrier

Export

Route

PUT /rest/resourcesList/exports

Paramètres

Body
Valeur Type Obligatoire valeur par défaut Description
format string Oui Format ("csv" ou "pdf")
delimiter string Oui (si format csv) Délimitation ("," ";" "TAB")
data array Oui Données à exporter
resources array Oui Courriers à exporter

Dans le tableau data peuvent se trouver 2 types de données, les colonnes se trouvant dans la table res_letterbox ainsi que des valeurs qui seront formatées dites "fonctions".
Les valeurs "fonctions" disponibles sont :

Valeur Description
getStatus libellé du status
getPriority libellé de la priorité
getCopies liste des personnes en copie de la liste de diffusion
getDetailLink lien vers la fiche détaillé
getCategory libellé de la catégorie
getInitiatorEntity libellé de l'entité initiatrice
getDestinationEntity libellé de l'entité traitante
getDestinationEntityType Type de l'entité traitante
getSenders liste des expéditeurs du courrier
getRecipients liste des destinataires du courrier
getTypist libellé du rédacteur du courrier
getAssignee libellé de l'attributaire de la liste de diffusion
getFolder liste des dossiers du courrier
getParentFolder liste des dossiers parents des dossiers du courrier
getTags liste des mots-clés du courrier
getSignatories liste des signataires
getSignatureDates liste des dates de signatures
getDepartment liste des départements des expéditeurs du courrier
getAcknowledgementSendDate liste des dates d'envois des accusés de réception
getRetentionFrozen Indique si la DUC est gélée
getBinding Indique si le courrier est engageant/non engagean/non défini
getVisaCircuit Circuit de visa du courrier
getOpinionCircuit Circuit d'avis du courrier
Exemple
{
    "format" : "csv",
    "delimiter" : ",",
    "resources" : [101, 123, 231],
    "data" : [
        {
            "isFunction" : true,
            "value" : "getStatus"
        },
        {
            "isFunction" : true,
            "value" : "getPriority"
        },
        {
            "isFunction" : false,
            "value" : "subject"
        }
    ]
}

Retour

Code Http Type Description Exemple
200 array Fichier exporté
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' => '...']

Génération des fiches de liaisons des courriers

Route

POST /rest/resourcesList/summarySheets

Paramètres

Body
Valeur Type Obligatoire Description
units array Non Identifiants des parties à exporter
resources array Oui Identifiants des documents

Pour la valeur units, les donnés sont :

Valeur Type Obligatoire Description
unit string Oui Identifiant de la partie à exporter. La liste des identifiants disponible est visible dans l'exemple
label array Oui Libellé du chapitre dans la fiche de liaison. Cela est modifiable selon vous souhait
Exemple

Génération de la fiche de liaison pour deux courriers, contenant tous les chapitres :

{
    "units":[
        {"unit":"qrcode","label":""},
        {"unit":"primaryInformations","label":"Informations pricipales"},
        {"unit":"senderRecipientInformations","label":"Informations de destination"},
        {"unit":"secondaryInformations","label":"Informations secondaires"},
        {"unit":"diffusionList","label":"Liste de diffusion"},
        {"unit":"opinionWorkflow","label":"Circuit d'avis"},
        {"unit":"visaWorkflow","label":"Circuit de visa"},
        {"unit":"notes","label":"Annotation(s)"},
        {"unit":"trafficRecords", "label": "Module de circulation"},
        {"unit":"freeField","label":"Commentaire(s)"}],
    "resources":[2350,2351]
}

Retour

Code Http Type Description Exemple
200 base64 Fiche de liaison encodée en base64 JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCA....
403 array Un paramètre est mal renseigné, ou le document est en dehors du périmètre ['errors' => 'Resources out of perimeter']

results matching ""

    No results matching ""