{ "openapi": "3.0.1", "info": { "title": "globalAPI", "version": "1.0" }, "paths": { "/api/Chorus/deposerPdfAsync": { "get": { "tags": [ "Chorus" ], "summary": "Method deposerPdfAsync()\r\nDépose un Pdf sur Chorus", "responses": { "200": { "description": "OK" } } } }, "/api/Chorus/Completer": { "get": { "tags": [ "Chorus" ], "summary": "Method Completer()\r\nComplète une facture sur chorus", "responses": { "200": { "description": "OK" } } } }, "/api/Chorus/soumettre": { "get": { "tags": [ "Chorus" ], "summary": "Method Soumettre()\r\nSoumet une facture depuis Chorus", "responses": { "200": { "description": "OK" } } } }, "/api/Chorus/StatutsFacturesVisibles": { "get": { "tags": [ "Chorus" ], "summary": "Method StatutsFacturesVisibles()\r\nRécupère les statuts des factures visibles", "responses": { "200": { "description": "OK" } } } }, "/api/Congres/ConvertAndSendMandat": { "post": { "tags": [ "Congres" ], "summary": "Récupère un document \"xlsx\" depuis DocuWare puis le converti en \"csv\" et le renvoi sur un \"ftp\".", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "DocumentID", "in": "query", "description": "Identifiant du document", "schema": { "type": "integer", "format": "int32" } }, { "name": "FileCabinetID", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Congres/VerifierDateReception": { "post": { "tags": [ "Congres" ], "summary": "Vérification de la date de réception.", "requestBody": { "description": "Document à stocker", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoDocument" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InfoDocument" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InfoDocument" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/CourrierV1/CreerCourrierReponse": { "post": { "tags": [ "CourrierV1" ], "summary": "Création d'un courrier de réponse", "parameters": [ { "name": "DWDocIDSource", "in": "query", "description": "Source Document ID", "schema": { "type": "string" } }, { "name": "RegistreCible", "in": "query", "description": "Registre courrier cible", "schema": { "type": "string" } }, { "name": "FluxCible", "in": "query", "description": "Type de flux A,D,I", "schema": { "type": "string" }, "example": "[A,D,I]" }, { "name": "TypeCible", "in": "query", "description": "Type de courrier cible", "schema": { "type": "string" }, "example": "Arrivé" }, { "name": "ModeleCible", "in": "query", "description": "Modèle de fusion du courrier cible", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "ReferenceCible", "in": "query", "description": "Référence du courrier cible", "schema": { "type": "string" } }, { "name": "PrioriteCible", "in": "query", "description": "Priorité du courrier cible", "schema": { "type": "string" } }, { "name": "ConfidentialiteCible", "in": "query", "description": "Confidentialité du courrier cible", "schema": { "type": "string" } }, { "name": "ReferenceRecommandeCible", "in": "query", "description": "Référence du recommandé du courrier cible", "schema": { "type": "string" } }, { "name": "DialogueDeStockageCible", "in": "query", "description": "Nom du dialogue de stockage du courrier cible", "schema": { "type": "string" }, "example": "Dialogue de stockage par défaut" }, { "name": "EmetteurCible", "in": "query", "description": "Émetteur du courrier cible", "schema": { "type": "string" }, "example": "admin" }, { "name": "UserConnecte", "in": "query", "description": "Utilisateur", "schema": { "type": "string" }, "example": "admin" }, { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CourrierV1/FusionnerCourrier": { "post": { "tags": [ "CourrierV1" ], "summary": "Fusion des courriers (v1)", "parameters": [ { "name": "DWDocIDSource", "in": "query", "description": "Identifiant du document source", "schema": { "type": "string" } }, { "name": "ModeleCible", "in": "query", "description": "Modèle de fusion du courrier cible", "schema": { "type": "string" } }, { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (sous forme de GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CourrierV1/MiseAJourTableaux": { "post": { "tags": [ "CourrierV1" ], "summary": "Mise à jour des tableaux", "parameters": [ { "name": "DWDocID", "in": "query", "description": "Source Document ID", "schema": { "type": "string" }, "example": "10" }, { "name": "UserConnecte", "in": "query", "description": "Utilisateur connecté", "schema": { "type": "string" }, "example": "admin" }, { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CourrierV1/TamponInstructions": { "post": { "tags": [ "CourrierV1" ], "summary": "TamponInstructions", "parameters": [ { "name": "DWDocID", "in": "query", "description": "Source Document ID", "schema": { "type": "string" }, "example": "10" }, { "name": "UserConnecte", "in": "query", "description": "Utilisateur connecté", "schema": { "type": "string" }, "example": "admin" }, { "name": "ServiceDiffuseur", "in": "query", "description": "???", "schema": { "type": "string" } }, { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CourrierV1/ModeleDiffusions": { "post": { "tags": [ "CourrierV1" ], "summary": "Modèle de diffusions", "parameters": [ { "name": "DWDocID", "in": "query", "description": "Source Document ID", "schema": { "type": "string" }, "example": "10" }, { "name": "UserConnecte", "in": "query", "description": "Utilisateur connecté", "schema": { "type": "string" }, "example": "admin" }, { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/CourrierV1/DeleteSections": { "post": { "tags": [ "CourrierV1" ], "summary": "Method DeleteSections()", "parameters": [ { "name": "DWDocIDSource", "in": "query", "description": "Source Document ID", "schema": { "type": "string" }, "example": "10" }, { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/StampOnDoc": { "put": { "tags": [ "DocuWare" ], "summary": "Apposition d'un tampon sur un document.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "NomTampon", "in": "query", "description": "Nom du tampon (ex : \"stamp1\")", "schema": { "type": "string" } }, { "name": "PositionTampon", "in": "query", "description": "Position du tampon (ex: \"[Auto,Fixe]\")", "schema": { "type": "string" } }, { "name": "DWDocID", "in": "query", "description": "Identifiant du document", "schema": { "type": "string" } }, { "name": "NomArmoire", "in": "query", "description": "Nom de l'armoire dans DocuWare", "schema": { "type": "string" } }, { "name": "BDDSearch", "in": "query", "description": "Paramètre obsolète, ne pas remplir !", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } }, { "name": "autoPos", "in": "query", "description": "Calcul automatique de la position du tampon", "schema": { "type": "boolean", "default": false } }, { "name": "recherche", "in": "query", "description": "Phrase à rechercher sur le document pour définir la position du tampon (ex : \"Signature,\")", "schema": { "type": "string", "default": "NOTFOUND" } }, { "name": "xMove", "in": "query", "description": "Déplacement supplémentaire du tampon après calcul automatique", "schema": { "type": "string", "default": "800" } }, { "name": "yMove", "in": "query", "description": "Déplacement supplémentaire du tampon après calcul automatique", "schema": { "type": "string", "default": "0" } }, { "name": "pageNb", "in": "query", "description": "Page sur laquelle déposer le tampon", "schema": { "type": "string", "default": "1" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/ExportD41": { "get": { "tags": [ "DocuWare" ], "summary": "Génère un fichier \"csv\" contenant les tâches liées aux Facture/ESD/EASD", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "FileCabinetID", "in": "query", "description": "GUID de l'armoire documents", "schema": { "type": "string" } }, { "name": "FileCabinetD41ID", "in": "query", "description": "GUID de l'armoire où déposer le fichier \"csv\"", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Borne inférieure (ex : 2024-01-01)", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "Borne supérieure (ex : 2024-01-11)", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/DDECCahierDeTransmission": { "get": { "tags": [ "DocuWare" ], "summary": "Génération des cahier de transmission au format \"xls\" puis enregistrement dans DocuWare.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "NumRegistre", "in": "query", "description": "Numéro de registre (ex : \"2024-1\")", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/RecapitulatifDDEC": { "get": { "tags": [ "DocuWare" ], "summary": "Génération d'un courriel contenant un récapitulatif des tâches en attente", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "FileCabinetID", "in": "query", "description": "GUID de l'armoire ?", "schema": { "type": "string" } }, { "name": "DialogID", "in": "query", "description": "GUID de la boîte de dialogue de l'armoire ?", "schema": { "type": "string" } }, { "name": "FCParametreID", "in": "query", "description": "GUID de l'armoire paramètre", "schema": { "type": "string" } }, { "name": "DialogParametreID", "in": "query", "description": "GUID de la boîte de dialogue de l'armoire paramètre", "schema": { "type": "string" } }, { "name": "hebdo", "in": "query", "description": "Définit s'il s'agit du récapitulatif hebdomadaire ou non", "schema": { "type": "boolean" } }, { "name": "IsTest", "in": "query", "description": "Définit si c'est un test ou non (n'enverra pas de mail au client)", "schema": { "type": "boolean" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/stampOnBasket": { "get": { "tags": [ "DocuWare" ], "summary": "Dépose un tampon sur les documents du bac en paramètre", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "FileCabinetID", "in": "query", "description": "GUID du BAC (commence par \"b_\")", "schema": { "type": "string" } }, { "name": "stampID", "in": "query", "description": "GUID du tampon", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/autorisationPrelevement": { "get": { "tags": [ "DocuWare" ], "summary": "Génère un fichier zip et un fichier texte puis enregistre le tout dans DocuWare.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string", "default": "Anset" } }, { "name": "ArmoireDocument", "in": "query", "description": "GUID de l'armoire \"Document\"", "schema": { "type": "string", "default": "4b6010c6-70ae-43a8-bd90-ae170595182d" } }, { "name": "ArmoireClient", "in": "query", "description": "GUID de l'armoire \"Client\"", "schema": { "type": "string", "default": "b9623966-b606-4ed0-a463-937fd0b5f0a8" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/autorisationPrelevementEnvoiFtp": { "get": { "tags": [ "DocuWare" ], "summary": "Génère un fichier zip et un fichier texte puis enregistre le tout dans DocuWare.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string", "default": "Anset" } }, { "name": "ArmoireDocument", "in": "query", "description": "GUID de l'armoire \"Document\"", "schema": { "type": "string", "default": "4b6010c6-70ae-43a8-bd90-ae170595182d" } }, { "name": "Url", "in": "query", "description": "Url du ftp", "schema": { "type": "string", "default": "" } }, { "name": "Login", "in": "query", "description": "Login du ftp", "schema": { "type": "string", "default": "" } }, { "name": "Password", "in": "query", "description": "Mot de passe du ftp", "schema": { "type": "string", "default": "" } }, { "name": "repertoireSFTP", "in": "query", "description": "Repertoire du ftp", "schema": { "type": "string", "default": "" } }, { "name": "DocID", "in": "query", "description": "Id du document à transférer", "schema": { "type": "string", "default": "" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/copieDoc": { "get": { "tags": [ "DocuWare" ], "summary": "Copie de documents entre deux DocuWare", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client cible", "schema": { "type": "string" } }, { "name": "fileCabinetIdCible", "in": "query", "description": "GUID de l'armoire cible", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (au format GUID)", "schema": { "type": "string" } }, { "name": "DocuWareSource", "in": "query", "description": "Adresse HTTP du serveur DocuWare source", "schema": { "type": "string" } }, { "name": "UserSource", "in": "query", "description": "Nom de l'utilisateur source", "schema": { "type": "string" } }, { "name": "PasswordSource", "in": "query", "description": "Mot de passe de l'utilisateur source", "schema": { "type": "string" } }, { "name": "OrganisationSource", "in": "query", "description": "Nom de l'organisation source", "schema": { "type": "string" } }, { "name": "fileCabinetIdSource", "in": "query", "description": "GUID de l'armoire source", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/getDocumentPdf": { "get": { "tags": [ "DocuWare" ], "summary": "Récupération d'un document DocuWare au format PDF.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetId", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "DWDocID", "in": "query", "description": "Identifiant du document", "schema": { "type": "string" } }, { "name": "BDDSearch", "in": "query", "description": "Nom de la boîte de dialogue de recherche", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/duplicateDocOnKeyWord": { "get": { "tags": [ "DocuWare" ], "summary": "???", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetId", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "DocID", "in": "query", "description": "Identifiant du document", "schema": { "type": "string" } }, { "name": "Demandeurs", "in": "query", "description": "Par exemple : \"admin\"", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/StatOpenTask": { "get": { "tags": [ "DocuWare" ], "summary": "???", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/courrierV1VersV2": { "get": { "tags": [ "DocuWare" ], "summary": "Transfert des courrier de l'armoire V1 vers l'armoire v2", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetV1Id", "in": "query", "description": "GUID de l'armoire V1", "schema": { "type": "string" } }, { "name": "fileCabinetV2Id", "in": "query", "description": "GUID de l'armoire v2", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/reportingUsageClient": { "get": { "tags": [ "DocuWare" ], "summary": "Génère le fichier de statistique client.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "FCAbonnementID", "in": "query", "description": "GUID de l'armoire abonnement", "schema": { "type": "string" } }, { "name": "FCStatID", "in": "query", "description": "GUID de l'armoire statistique", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client (GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/NettoyerArmoire": { "delete": { "tags": [ "DocuWare" ], "summary": "Suppression avec filtre dans une armoire.", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "ID_Armoire", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "ChampFiltre", "in": "query", "description": "Champ de l'armoire à filtrer (ex : \"WF_ACTION\")", "schema": { "type": "string", "default": "WF_ACTION" } }, { "name": "ValeurFiltre", "in": "query", "description": "Valeur du filtre à appliquer (ex : \"Reprise V1\")", "schema": { "type": "string", "default": "Reprise V1" } }, { "name": "BoiteDialogue", "in": "query", "description": "Nom de la boîte de dialogue (ex: recherche par défaut)", "schema": { "type": "string", "default": "Boîte de dialogue de recherche par défaut" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/RemplacerTexte": { "put": { "tags": [ "DocuWare" ], "summary": "Remplacement d'une chaîne de caractères par une autre dans un index DocuWare.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (format GUID)", "schema": { "type": "string" } }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire DocuWare", "schema": { "type": "string" } }, { "name": "nomIndex", "in": "query", "description": "Nom de l'index dans l'armoire", "schema": { "type": "string" } }, { "name": "recherche", "in": "query", "description": "Chaîne de caractère à rechercher pour remplacement", "schema": { "type": "string" } }, { "name": "remplacement", "in": "query", "description": "Chaîne de caractère à mettre en remplacement", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/TesterAdresse": { "get": { "tags": [ "DocuWare" ], "summary": "Vérifie l'existence de deux URL.", "parameters": [ { "name": "ancienneURL", "in": "query", "description": "", "schema": { "type": "string", "default": "https://visual-office.docuware.cloud" } }, { "name": "nouvelleURL", "in": "query", "description": "", "schema": { "type": "string", "default": "https://lademat.docuware.cloud" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/InitMysql": { "post": { "tags": [ "DocuWare" ], "summary": "Récupère les abonnements et initialise la base de donnée.", "parameters": [ { "name": "API_KEY", "in": "query", "description": "", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/CreateOrUpdateAbonnementMysql": { "post": { "tags": [ "DocuWare" ], "summary": "Crée ou update l'abonnement dans mysql.", "parameters": [ { "name": "DWDocID", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/RenommerDocument": { "post": { "tags": [ "DocuWare" ], "summary": "Renommage d'un document en fonction de ses index.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire", "schema": { "type": "string" } }, { "name": "idDocument", "in": "query", "description": "Identifiant du document", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (sous forme de GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/RenommerArmoire": { "post": { "tags": [ "DocuWare" ], "summary": "Renommage d'une armoire en fonction des index des documents.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (sous forme de GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/SearchAndFillIndexes": { "post": { "tags": [ "DocuWare" ], "summary": "Recherche des occurences correspondant à une regex et renvoi un liste de résultat.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "guid", "in": "query", "description": "uid de l'armoire", "schema": { "type": "string" } }, { "name": "idDocument", "in": "query", "description": "Identifiant du document", "schema": { "type": "string" } }, { "name": "regex", "in": "query", "description": "regex permettant de retrouver les indexes dans le documents", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (sous forme de GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/DocuWare/zipAndUpload": { "post": { "tags": [ "DocuWare" ], "summary": "Zip les documents et upload le zip.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "guid", "in": "query", "description": "guid de l'armoire", "schema": { "type": "string" } }, { "name": "dialogId", "in": "query", "description": "guid de la boîte de dialogue", "schema": { "type": "string" } }, { "name": "idsDocuments", "in": "query", "description": "Identifiants des document", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (sous forme de GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Dolibarr/EnvoiFacture": { "post": { "tags": [ "Dolibarr" ], "summary": "Envoi d'une facture depuis DocuWare vers Dolibarr.", "description": "Anciens paramètres : \r\n\n- BDDClient (Nom de la boîte de dialogue de recherche dans l'armoire client)\n- demo (Indique s'il s'agit d'un test de développement)", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "FileCabinetID", "in": "query", "description": "GUID de l'armoire \"Factures\"", "schema": { "type": "string" } }, { "name": "DocumentID", "in": "query", "description": "Identifiant de la facture à envoyer", "schema": { "type": "integer", "format": "int32" } }, { "name": "ClientID", "in": "query", "description": "Nom du client dans l'armoire \"Clients\" (BRICK)", "schema": { "type": "string" } }, { "name": "FileCabinetClientID", "in": "query", "description": "GUID de l'armoire \"Clients\"", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/FusionAndPrint/CreateFileFromIndexes": { "post": { "tags": [ "FusionAndPrint" ], "summary": "Methode CreateFileFromIndexes()\r\nCréé un enregistrement dans l'armoire définie d'un client à partir des indexes en parametres(indexes)", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire où stocker le document fusionné", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomDialogStockage", "in": "query", "description": "Nom de la boite de dialog de stockage", "schema": { "type": "string" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "indexes", "in": "query", "description": "chaine contenant les indexes à remplir et leurs valeurs", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/FusionAndPrint/CreateFileAndDocFromIndexes": { "post": { "tags": [ "FusionAndPrint" ], "summary": "Methode CreateFileAndDocFromIndexes()\r\nCréé un enregistrement dans l'armoire définie d'un client à partir des indexes en parametres(indexes)\r\nFusionne et attache un document à l'enregistrement suivant le modèle défini", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire où stocker le document fusionné", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "nomModele", "in": "query", "description": "Nom du modèle utilisé pour la fusion", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "indexes", "in": "query", "description": "Chaine contenant les indexes à remplir et leurs valeurs", "schema": { "type": "string" } }, { "name": "nomDialogStockage", "in": "query", "description": "Nom de la boite de dialog de stockage", "schema": { "type": "string" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "typeFusion", "in": "query", "description": "Word ou PDF pour le type de fusion", "schema": { "type": "string" }, "example": "[Word,PDF]" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/FusionAndPrint/CreateAndAttachDocFromFile": { "post": { "tags": [ "FusionAndPrint" ], "summary": "Methode CreateAndAttachDocFromFile()\r\nFusionne et attache un document à l'enregistrement suivant le modèle défini à partir de l'id de l'enregistrement", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client pour accéder au fichier xml de connexion", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire où stocker le document fusionné", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "nomBDDRecherche", "in": "query", "description": "Nom de la boite de dialogue de recherche de l'armoire", "schema": { "type": "string" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "nomModele", "in": "query", "description": "Nom du modèle utilisé pour la fusion", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "idDocSource", "in": "query", "description": "Identifiant de l'enregistrement à fusionner", "schema": { "type": "string" }, "example": "10" }, { "name": "typeFusion", "in": "query", "description": "Word ou PDF pour le type de fusion", "schema": { "type": "string" }, "example": "[Word,PDF]" }, { "name": "Replace", "in": "query", "description": "Optionnel. Null=>Ajout du document après les existants - 0=>Remplace tous les documents existants - n=>Remplace le document en position n", "schema": { "type": "string" }, "example": "[,0,1,2,...]" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string", "default": "" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/FusionAndPrint/CreateFileFromIndexesAndDocFromChampsValeurs": { "post": { "tags": [ "FusionAndPrint" ], "summary": "Methode CreateFileFromIndexesAndDocFromChampsValeurs()\r\nCréé un enregistrement dans l'armoire définie d'un client à partir des indexes en parametres(indexes)\r\nFusionne et attache un document à l'enregistrement suivant le modèle défini et une liste de champ de fusion(ChampsValeurs)", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire où stocker le document fusionné", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "nomModele", "in": "query", "description": "Nom du modèle utilisé pour la fusion", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "indexes", "in": "query", "description": "Chaine contenant les indexes à remplir et leurs valeurs", "schema": { "type": "string" } }, { "name": "ChampsValeurs", "in": "query", "description": "Chaine contenant les Champs de fusion à remplir et leurs valeurs", "schema": { "type": "string" } }, { "name": "nomDialogStockage", "in": "query", "description": "Nom de la boite de dialog de stockage", "schema": { "type": "string" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "typeFusion", "in": "query", "description": "Word ou PDF pour le type de fusion", "schema": { "type": "string" }, "example": "[Word,PDF]" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/FusionAndPrint/CreateAndAttachDocFromChampsValeurs": { "post": { "tags": [ "FusionAndPrint" ], "summary": "Méthode CreateAndAttachDocFromChampsValeurs()\r\nFusionne et attache un document à l'enregistrement à partir d'un modèle défini et d'une liste champsValeurs", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire où stocker le document fusionné", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "nomModele", "in": "query", "description": "Nom du modèle utilisé pour la fusion", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "idDocSource", "in": "query", "description": "Identifiant de l'enregistrement à fusionner", "schema": { "type": "string" }, "example": "10" }, { "name": "champsValeurs", "in": "query", "description": "Chaîne contenant les Champs de fusion à remplir et leurs valeurs", "schema": { "type": "string" } }, { "name": "nomDialogRecherche", "in": "query", "description": "Nom de la BDD de recherche de l'armoire", "schema": { "type": "string", "default": "Boîte de dialogue de recherche par défaut" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "nomDialogStockage", "in": "query", "description": "Nom de la BDD de stockage de l'armoire", "schema": { "type": "string", "default": "Boîte de dialogue de stockage par défaut" }, "example": "Boîte de stockage par défaut" }, { "name": "typeFusion", "in": "query", "description": "Word ou PDF pour le type de fusion", "schema": { "type": "string", "default": "PDF" }, "example": "[Word,PDF]" }, { "name": "Replace", "in": "query", "description": "Optionnel. Null=>Ajout du document après les existants - 0=>Remplace tous les documents existants - n=>Remplace le document en position n", "schema": { "type": "string" }, "example": "[,0,1,2,...]" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string", "default": "" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/FusionAndPrint/PrintDoc": { "get": { "tags": [ "FusionAndPrint" ], "summary": "Methode PrintDoc()\r\nLance l'impression d'un document (ou tous)", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire où est stocké le document à imprimer", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "dialogSearch", "in": "query", "description": "Nom de la boite de dialog de recherche", "schema": { "type": "string" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "idDocSource", "in": "query", "description": "Identifiant de l'enregistrement source", "schema": { "type": "string" }, "example": "10" }, { "name": "nomImprimante", "in": "query", "description": "Nom de l'imprimante à utiliser", "schema": { "type": "string" }, "example": "Imprimante 1" }, { "name": "numDoc", "in": "query", "description": "Numéro du document à imprimer, par défaut on imprime tous les documents", "schema": { "type": "string" }, "example": "1" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string", "default": "" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/FusionAndPrint/DeplacerSection": { "put": { "tags": [ "FusionAndPrint" ], "summary": "Déplacement d'une section de document via plusieurs étapes :\r\n\n- télécharger la section en local\n- pousser une copie à la fin du document\n- supprimer la section original sur DocuWare", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "armoireGUID", "in": "query", "description": "Identifiant de l'armoire sous forme de GUID", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" }, { "name": "numeroPiece", "in": "query", "description": "Numéro de pièce (N° Facture tires)", "schema": { "type": "string" }, "example": "1" }, { "name": "numeroSection", "in": "query", "description": "Numéro de la section à déplacer", "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "boiteDialogueGUID", "in": "query", "description": "Identifiant de la boîte de dialogue sous forme de GUID", "schema": { "type": "string" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/GoSign/InsertEnvelope": { "post": { "tags": [ "GoSign" ], "summary": "Envoi d'une enveloppe à GoSign pour signature.", "responses": { "200": { "description": "OK" } } } }, "/api/GoSign/GetEnvelope": { "get": { "tags": [ "GoSign" ], "summary": "Récupération d'une enveloppe sur DocuSign", "parameters": [ { "name": "idEnveloppe", "in": "query", "description": "Identifiant de l'enveloppe à récupérer", "schema": { "type": "string" } }, { "name": "avecContenu", "in": "query", "description": "Indique s'il faut récupérer le contenu de l'enveloppe (Byte)", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/api/GoSign/GetEnvelopeStatus": { "get": { "tags": [ "GoSign" ], "summary": "Récupération du statut d'une enveloppe.", "parameters": [ { "name": "idEnveloppe", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/GoSign/DeleteEnvelope": { "post": { "tags": [ "GoSign" ], "summary": "Demande de suppression d'une enveloppe", "parameters": [ { "name": "idEnveloppe", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/HelloWorld/HelloWorld": { "get": { "tags": [ "HelloWorld" ], "summary": "Méthode de test, se connecte à DocuWare pour dire bonjour.", "description": "Informations complémentaires : \r\n\nLa nom du client et l'API_KEY sont contenus dans l'armoire `Abonnement` du DocuWare `visual-office`.\nLe `GUID` est un identifiant unique composé de 36 caractères, on a par exemple : 8c72bf81-a7ff-484b-8aba-6e3c03b0b02a.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (sous forme de GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Marina/splitKeywordFacture": { "get": { "tags": [ "Marina" ], "summary": "Récupère la liste des facture en chaîne de caractère et la réinsère dans un index de type mot-clé.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "DocID", "in": "query", "description": "Identifiant du document", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Marina/ExportSage": { "post": { "tags": [ "Marina" ], "summary": "Récupère certains index d'un document et les envoi vers Sage.", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "DocumentId", "in": "query", "description": "Identifiant du document à exporter vers Sage", "schema": { "type": "integer", "format": "int32" } }, { "name": "fileCabinetId", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Marina/ExportJournals": { "post": { "tags": [ "Marina" ], "summary": "Récupère certains index d'un document et les envoi vers Sage.", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetId", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Marina/ExportFinancialAccounts": { "post": { "tags": [ "Marina" ], "summary": "Récupère les comptes clients et génère un fichier csv.", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetId", "in": "query", "description": "Id de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Millesime/ConnecteurMillesime": { "get": { "tags": [ "Millesime" ], "summary": "Récupération des factures depuis Oracle BFC et mise à jour dans DocuWare.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Millesime/TestConnexionOracleBoucle": { "get": { "tags": [ "Millesime" ], "summary": "Test de la connexion à Oracle (en boucle).", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (GUID)", "schema": { "type": "string" } }, { "name": "nbBoucle", "in": "query", "description": "Nombre de boucles (ex : 10)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Millesime/TestConnexionOracle": { "get": { "tags": [ "Millesime" ], "summary": "Test de la connexion à Oracle.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ModelesAndPrint/FusionModeleFromIndexes": { "put": { "tags": [ "ModelesAndPrint" ], "summary": "Methode FusionModeleFromIndexes()\r\nCréé un enregistrement dans l'armoire définie d'un client à partir des indexes en parametres(indexes)\r\nFusionne et attache un document à l'enregistrement suivant le modèle défini", "parameters": [ { "name": "nomClient", "in": "query", "description": "nom du client pour accéder au fichier xml de connexion", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomArmoire", "in": "query", "description": "nom de l'armoire où stocker le document fusionné", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "nomModele", "in": "query", "description": "nom du modèle utilisé pour la fusion", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "indexes", "in": "query", "description": "chaine contenant les indexes à remplir et leurs valeurs", "schema": { "type": "string" } }, { "name": "nomDialogStockage", "in": "query", "description": "nom de la boite de dialog de stockage", "schema": { "type": "string" }, "example": "Boîte de dialogue par défaut" }, { "name": "typeFusion", "in": "query", "description": "Word ou PDF pour le type de fusion", "schema": { "type": "string" }, "example": "[Word,PDF]" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/ModelesAndPrint/FusionModeleFromDoc": { "put": { "tags": [ "ModelesAndPrint" ], "summary": "Methode FusionModeleFromDoc()\r\nFusionne et attache un document à l'enregistrement suivant le modèle défini à partir de l'id de l'enregistrement", "parameters": [ { "name": "nomClient", "in": "query", "description": "nom du client pour accéder au fichier xml de connexion", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomArmoire", "in": "query", "description": "nom de l'armoire où stocker le document fusionné", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "nomModele", "in": "query", "description": "nom du modèle utilisé pour la fusion", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "idDocSource", "in": "query", "description": "identifiant de l'enregistrement à fusionner", "schema": { "type": "string" }, "example": "10" }, { "name": "typeFusion", "in": "query", "description": "Word ou PDF pour le type de fusion", "schema": { "type": "string" }, "example": "[Word,PDF]" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/ModelesAndPrint/FusionModeleFromIndexesEtChamps": { "put": { "tags": [ "ModelesAndPrint" ], "summary": "Methode FusionModeleFromIndexes()\r\nCréé un enregistrement dans l'armoire définie d'un client à partir des indexes en parametres(indexes)\r\nFusionne et attache un document à l'enregistrement suivant le modèle défini", "parameters": [ { "name": "nomClient", "in": "query", "description": "nom du client pour accéder au fichier xml de connexion", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomArmoire", "in": "query", "description": "nom de l'armoire où stocker le document fusionné", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "nomModele", "in": "query", "description": "nom du modèle utilisé pour la fusion", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "indexes", "in": "query", "description": "chaine contenant les indexes à remplir et leurs valeurs", "schema": { "type": "string" } }, { "name": "ChampsValeurs", "in": "query", "description": "chaine contenant les Champs de fusion à remplir et leurs valeurs", "schema": { "type": "string" } }, { "name": "nomDialogStockage", "in": "query", "description": "nom de la boite de dialog de stockage", "schema": { "type": "string" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "typeFusion", "in": "query", "description": "Word ou PDF pour le type de fusion", "schema": { "type": "string" }, "example": "[Word,PDF]" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/ModelesAndPrint/PrintDoc": { "get": { "tags": [ "ModelesAndPrint" ], "summary": "Methode PrintDoc()\r\nLance l'impression d'un document (ou tous)", "parameters": [ { "name": "nomClient", "in": "query", "description": "nom du client pour accéder au fichier xml de connexion", "schema": { "type": "string" }, "example": "Demo" }, { "name": "nomArmoire", "in": "query", "description": "nom de l'armoire où est stocké le document à imprimer", "schema": { "type": "string" }, "example": "Courriers" }, { "name": "dialogSearch", "in": "query", "description": "nom de la boite de dialog de recherche", "schema": { "type": "string" }, "example": "Boîte de dialogue de recherche par défaut" }, { "name": "idDocSource", "in": "query", "description": "identifiant de l'enregistrement source", "schema": { "type": "string" }, "example": "10" }, { "name": "nomImprimante", "in": "query", "description": "nom de l'imprimante à utiliser", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" }, { "name": "numDoc", "in": "query", "description": "numéro du document à imprimer, par défaut on imprime tous les documents", "schema": { "type": "string" }, "example": "10" } ], "responses": { "200": { "description": "OK" } } } }, "/api/OCRE/MettreAJourStatut": { "post": { "tags": [ "OCRE" ], "summary": "???", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'identification du client (GUID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Omnikles/createActe": { "get": { "tags": [ "Omnikles" ], "summary": "Création d'un Acte dans OMNIKLES depuis un document provenant de DocuWare.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "FileCabinetId", "in": "query", "description": "GUID de l'armoire 'Courriers'", "schema": { "type": "string" } }, { "name": "DWDocID", "in": "query", "description": "Identifiant du document source", "schema": { "type": "string" } }, { "name": "BDDSearch", "in": "query", "description": "Nom de la boîte de dialogue de recherche", "schema": { "type": "string", "default": "Boîte de dialogue de recherche par défaut" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Omnikles/getClassification": { "get": { "tags": [ "Omnikles" ], "summary": "Récupération de la classification et écriture dans DocuWare.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetClassificationId", "in": "query", "description": "GUID de l'armoire 'Classification'", "schema": { "type": "string" } }, { "name": "fileCabinetNaturesId", "in": "query", "description": "GUID de l'armoire 'Natures'", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Omnikles/retrieveRemoteAR": { "get": { "tags": [ "Omnikles" ], "summary": "Récupération d'un AR depuis OMNIKLES et mise à jour statut.", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "FileCabinetId", "in": "query", "description": "GUID de l'armoire 'Courriers'", "schema": { "type": "string" } }, { "name": "DWDocID", "in": "query", "description": "Identifiant du document source", "schema": { "type": "string" } }, { "name": "BDDSearch", "in": "query", "description": "Nom de la boîte de dialogue de recherche", "schema": { "type": "string", "default": "Boîte de dialogue de recherche par défaut" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/OPT/AjoutPiecesJointes": { "post": { "tags": [ "OPT" ], "summary": "Ajoute une pièce jointe au document", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "idOA", "in": "query", "description": "Identifiant OA", "schema": { "type": "string" }, "example": "10" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/OPT/SuppressionPiecesJointes": { "delete": { "tags": [ "OPT" ], "summary": "Methode SuppressionPiecesJointes()", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "idOA", "in": "query", "description": "Identifiant OA", "schema": { "type": "string" } }, { "name": "numeroPJ", "in": "query", "description": "Numéro de pièce jointe", "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/OPT/CheckAmountFactures": { "get": { "tags": [ "OPT" ], "summary": "Methode CheckAmountFactures()\r\nCheck les montants et retourne un rapport csv", "parameters": [ { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/Poc/CleanCabinet": { "delete": { "tags": [ "Poc" ], "summary": "Créé un enregistrement dans l'armoire définie d'un client à partir des index en paramètres.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetId", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Poc/AddStamp": { "post": { "tags": [ "Poc" ], "summary": "Ajoute un tampon sur le documentId au position locationX et locationY ?", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "requestBody": { "description": "Dictionnaire de valeurs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentValues" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentValues" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentValues" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/Poc/TestLog": { "get": { "tags": [ "Poc" ], "summary": "Test de connection au DocuWare client et d'écriture des logs", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Poc/createFileCabinet": { "get": { "tags": [ "Poc" ], "summary": "Création d'une armoire dans DocuWare !!! Ne fonctionne pas encore !!!", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Poc/TestDocuSignAuth": { "get": { "tags": [ "Poc" ], "summary": "Test d'écriture dans DocuSign !!! TODO !!!", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Poc/workFlows": { "get": { "tags": [ "Poc" ], "summary": "???", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Poc/checkAccess": { "get": { "tags": [ "Poc" ], "summary": "Vérifie que l'armoire abonnement est accessible par l'API et envoi un mail dans le cas contraire", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetAbonnementId", "in": "query", "description": "GUID de l'armoire \"Abonnement\"", "schema": { "type": "string" } }, { "name": "fileCabinetLogsId", "in": "query", "description": "GUID de l'armoire \"Log\"", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Poc/testDecimal": { "get": { "tags": [ "Poc" ], "summary": "???", "parameters": [ { "name": "MONTANT_DEVISE_ORIGINE", "in": "query", "description": "???", "schema": { "type": "number", "format": "double", "default": -25763486400 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Poc/countDocFromSelectionList": { "get": { "tags": [ "Poc" ], "summary": "Compte le nombre de document d'une armoire depuis une liste de selection", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire", "schema": { "type": "string" } }, { "name": "listID", "in": "query", "description": "GUID de la liste de sélection", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SAE/Archiver": { "post": { "tags": [ "SAE" ], "summary": "Envoi d'un fichier ZIP dans le répertoire de dépôt des archives (avec CSV et SHA de retour).", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "jetonClient", "in": "query", "description": "Jeton d'authentification du client (GUID)", "schema": { "type": "string" } }, { "name": "nomArmoire", "in": "query", "description": "Nom de l'armoire source", "schema": { "type": "string" } }, { "name": "adresseSFTP", "in": "query", "description": "Adresse du serveur SFTP", "schema": { "type": "string" } }, { "name": "utilisateurSFTP", "in": "query", "description": "Utilisateur SFTP", "schema": { "type": "string" } }, { "name": "passeSFTP", "in": "query", "description": "Mot de passe SFTP", "schema": { "type": "string" } }, { "name": "repertoireSFTP", "in": "query", "description": "Répertoire de stockage sur le SFTP (facultatif)", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SAE/AnalyserRetour": { "post": { "tags": [ "SAE" ], "summary": "Recherche sur le SFTP des fichiers de retour à analyser.", "parameters": [ { "name": "nomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "jetonClient", "in": "query", "description": "Jeton d'authentification du client (GUID)", "schema": { "type": "string" } }, { "name": "idJournal", "in": "query", "description": "Identifiant du journal", "schema": { "type": "string" } }, { "name": "adresseSFTP", "in": "query", "description": "Adresse du serveur SFTP", "schema": { "type": "string" } }, { "name": "utilisateurSFTP", "in": "query", "description": "Utilisateur SFTP", "schema": { "type": "string" } }, { "name": "passeSFTP", "in": "query", "description": "Mot de passe SFTP", "schema": { "type": "string" } }, { "name": "repertoireSFTP", "in": "query", "description": "Répertoire de stockage sur le SFTP (facultatif)", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SAE/VerifierDocumentSAE": { "post": { "tags": [ "SAE" ], "summary": "Vérification de la compatibilité entre la famille (typologie) et le type de documents.", "requestBody": { "description": "Document à stocker", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoDocument" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InfoDocument" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InfoDocument" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/Sage/ExportSage": { "post": { "tags": [ "Sage" ], "summary": "Récupère certains index d'un document et les envoi vers Sage.", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "DocumentId", "in": "query", "description": "Identifiant du document à exporter vers Sage", "schema": { "type": "integer", "format": "int32" } }, { "name": "fileCabinetId", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Sage/ExportJournals": { "post": { "tags": [ "Sage" ], "summary": "Récupère certains index d'un document et les envoi vers Sage.", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetId", "in": "query", "description": "GUID de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Sage/ExportFinancialAccounts": { "post": { "tags": [ "Sage" ], "summary": "Récupère les comptes clients et génère un fichier csv.", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "fileCabinetId", "in": "query", "description": "Id de l'armoire", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Jeton d'authentification du client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/SMS/Retour": { "post": { "tags": [ "SMS" ], "summary": "Methode Retour()\r\nTraitement du retour de l'api SMS", "parameters": [ { "name": "Body", "in": "query", "description": "Contenu du SMS", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WidoSign/createPackage": { "post": { "tags": [ "WidoSign" ], "summary": "Création du package dans widosign", "parameters": [ { "name": "packageName", "in": "query", "description": "", "schema": { "type": "string" }, "example": "Package 1" }, { "name": "initiatorEmail", "in": "query", "description": "", "schema": { "type": "string" }, "example": "jbernardini@lademat.nc" } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/WidoSign/addDocumentToPackage": { "put": { "tags": [ "WidoSign" ], "summary": "Ajout d'un document à un package existant dans WidoSign", "parameters": [ { "name": "packageId", "in": "query", "description": "", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" }, { "name": "fileName", "in": "query", "description": "", "schema": { "type": "string" }, "example": "MonFichier.pdf" }, { "name": "filePath", "in": "query", "description": "", "schema": { "type": "string" }, "example": "temp/MonFichier.pdf" } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/WS_DW_Courrier/CreerCourrierReponse": { "post": { "tags": [ "WS_DW_Courrier" ], "summary": "Créer un réponse à un courrier", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "FileCabinetID", "in": "query", "description": "GUID de l'armoire \"Courriers\"", "schema": { "type": "string" } }, { "name": "DWDocIDSource", "in": "query", "description": "Identifiant du document source", "schema": { "type": "string" } }, { "name": "RegistreCible", "in": "query", "description": "Registre courrier cible", "schema": { "type": "string" } }, { "name": "FluxCible", "in": "query", "description": "Type de flux (ex : [A,D,I])", "schema": { "type": "string" } }, { "name": "TypeCible", "in": "query", "description": "Type de courrier cible", "schema": { "type": "string" }, "example": "Type_1" }, { "name": "ModeleCible", "in": "query", "description": "Modèle de fusion du courrier cible", "schema": { "type": "string" } }, { "name": "TypeFusion", "in": "query", "description": "Type de Fusion : 'doc' pour fichier word, 'eml' pour Email", "schema": { "type": "string" }, "example": "[doc,eml]" }, { "name": "MailUnique", "in": "query", "description": "Pour le type de fusion eml, 'true' pour un seul mail avec les destinataires en cc OU false pour un mail par destinataire", "schema": { "type": "boolean" } }, { "name": "ReferenceCible", "in": "query", "description": "Référence du courrier cible", "schema": { "type": "string" } }, { "name": "PrioriteCible", "in": "query", "description": "Priorité du courrier cible", "schema": { "type": "string" }, "example": "1" }, { "name": "ConfidentialiteCible", "in": "query", "description": "Confidentialité du courrier cible", "schema": { "type": "string" } }, { "name": "ReferenceRecommandeCible", "in": "query", "description": "Référence du recommandé du courrier cible", "schema": { "type": "string" } }, { "name": "DialogueDeStockageCible", "in": "query", "description": "Nom du dialogue de stockage du courrier cible", "schema": { "type": "string" }, "example": "Boîte de stockage par défaut" }, { "name": "EmetteurCible", "in": "query", "description": "Emetteur du courrier cible", "schema": { "type": "string" } }, { "name": "UserConnecte", "in": "query", "description": "Utilisateur connecté", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/FusionnerCourrier": { "put": { "tags": [ "WS_DW_Courrier" ], "summary": "Methode FusionnerCourrier", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "FileCabinetID", "in": "query", "description": "ID de l'armoire 'Courriers'", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" }, { "name": "DWDocIDSource", "in": "query", "description": "ID du document source", "schema": { "type": "string" }, "example": "10" }, { "name": "ModeleCible", "in": "query", "description": "Modèle de fusion du courrier cible", "schema": { "type": "string" }, "example": "Lettre" }, { "name": "TypeFusion", "in": "query", "description": "Type de Fusion : 'doc' pour fichier word, 'eml' pour Email", "schema": { "type": "string" }, "example": "[doc,eml]" }, { "name": "MailUnique", "in": "query", "description": "Pour le type de fusion eml, 'true' pour un seul mail avec les destinataires en cc OU false pour un mail par destinataire", "schema": { "type": "boolean" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/RepriseHistoKeyWord": { "put": { "tags": [ "WS_DW_Courrier" ], "summary": "Methode RepriseHistoKeyWord", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string", "default": "" }, "example": "Demo" }, { "name": "FileCabinetID", "in": "query", "description": "ID de l'armoire 'Courriers'", "schema": { "type": "string", "default": "" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string", "default": "" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/MiseAJourTableaux": { "put": { "tags": [ "WS_DW_Courrier" ], "summary": "Mise à jour des tableaux", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string", "default": "" } }, { "name": "FileCabinetID", "in": "query", "description": "GUID de l'armoire \"Courriers\"", "schema": { "type": "string", "default": "" } }, { "name": "DWDocIDSource", "in": "query", "description": "Identifiant du document source", "schema": { "type": "string", "default": "" } }, { "name": "UserConnecte", "in": "query", "description": "Utilisateur connecté", "schema": { "type": "string", "default": "" }, "example": "admin" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du DocuWare lademat.nc", "schema": { "type": "string", "default": "" } }, { "name": "fixedStamp", "in": "query", "description": "Position fixe ou non tu tampon", "schema": { "type": "boolean", "default": false } }, { "name": "X", "in": "query", "description": "Position X du tampon", "schema": { "type": "integer", "format": "int32", "default": 450 }, "example": 35 }, { "name": "Y", "in": "query", "description": "Position Y du tampon", "schema": { "type": "integer", "format": "int32", "default": 20 }, "example": 105 }, { "name": "noStamp", "in": "query", "description": "Ne pas poser de tampon", "schema": { "type": "boolean", "default": false } }, { "name": "PageNb", "in": "query", "description": "Numéro de page", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "SectionNb", "in": "query", "description": "Numéro de section", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/SetNumeroChrono": { "put": { "tags": [ "WS_DW_Courrier" ], "summary": "Methode SetNumeroChrono", "parameters": [ { "name": "CustomerID", "in": "query", "description": "nom du client pour la connexion", "schema": { "type": "string" }, "example": "Demo" }, { "name": "DWDocIDSource", "in": "query", "description": "Id du document source", "schema": { "type": "string" }, "example": "10" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/SetReference": { "put": { "tags": [ "WS_DW_Courrier" ], "summary": "Methode SetReference", "parameters": [ { "name": "CustomerID", "in": "query", "description": "nom du client pour la connexion", "schema": { "type": "string" }, "example": "Demo" }, { "name": "DWDocIDSource", "in": "query", "description": "Id du document source", "schema": { "type": "string" }, "example": "10" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/GetIISDirectory": { "get": { "tags": [ "WS_DW_Courrier" ], "summary": "Methode GetIISDirectory", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/WS_DW_Courrier/Worflows": { "get": { "tags": [ "WS_DW_Courrier" ], "summary": "- Récupère les données du tableau mis en paramètres\r\n- Tri par action et type d'entité des destinataires\r\n- Maj des index (déclencheurs de workflows) WF_Action, WF_User, WF_Role, WF_Groupe, WF_Liste dans le document source", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "DWDocIDSource", "in": "query", "description": "ID du document source", "schema": { "type": "string" }, "example": "10" }, { "name": "nomTable", "in": "query", "description": "Nom du tableau source", "schema": { "type": "string" }, "example": "Destinataire" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/StampsOnDoc": { "put": { "tags": [ "WS_DW_Courrier" ], "summary": "Methode StampsOnDoc()\r\n Affiche un tampon sur le document:\r\n - Liste des destinataires par action", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "DWDocIDSource", "in": "query", "description": "ID du document source", "schema": { "type": "string" }, "example": "10" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/SetActionDate": { "put": { "tags": [ "WS_DW_Courrier" ], "summary": "Methode SetActionDate()\r\n Inscrit la date de réalisation de l'action dans la colonne FAIT LE: du tableau diffusion", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "DWDocIDSource", "in": "query", "description": "ID du document source", "schema": { "type": "string" }, "example": "10" }, { "name": "idLigne", "in": "query", "description": "ID de la ligne du tableau de fiffusion", "schema": { "type": "string" }, "example": "1" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/WS_DW_Courrier/parametreToDiffusion": { "put": { "tags": [ "WS_DW_Courrier" ], "summary": "Methode SetActionDate()\r\n Inscrit la date de réalisation de l'action dans la colonne FAIT LE: du tableau diffusion", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "DWDocIDSource", "in": "query", "description": "ID du document source", "schema": { "type": "string" }, "example": "10" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK" } } } }, "/api/WSAnset/WS_AnSet": { "post": { "tags": [ "WSAnset" ], "summary": "Methode WS_CreationClientBenHur()\r\n ???", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "Company", "in": "query", "description": "Nom de la société", "schema": { "type": "string" }, "example": "LadematNC" }, { "name": "DossierClient", "in": "query", "description": "Dossier client ...", "schema": { "type": "string" }, "example": "10" }, { "name": "Nom", "in": "query", "description": "Nom ...", "schema": { "type": "string" }, "example": "Bernardini" }, { "name": "Prenom", "in": "query", "description": "Prénom ...", "schema": { "type": "string" }, "example": "Julie" }, { "name": "Gestionnaire", "in": "query", "description": "", "schema": { "type": "string" }, "example": "jbernardini" }, { "name": "Mail", "in": "query", "description": "Adresse mail cible", "schema": { "type": "string" }, "example": "jbernardini@lademat.nc" }, { "name": "RIBBanque", "in": "query", "description": "", "schema": { "type": "string" }, "example": "12345" }, { "name": "RIBGuichet", "in": "query", "description": "", "schema": { "type": "string" }, "example": "00300" }, { "name": "RIBCompte", "in": "query", "description": "", "schema": { "type": "string" }, "example": "09876543210" }, { "name": "RIBCle", "in": "query", "description": "", "schema": { "type": "string" }, "example": "19" }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/WSAnset/WS_AnSet_Contrat": { "post": { "tags": [ "WSAnset" ], "summary": "Methode WS_AnSet_Contrat()\r\n ???", "parameters": [ { "name": "NomClient", "in": "query", "description": "Nom du client", "schema": { "type": "string" }, "example": "Demo" }, { "name": "Societe", "in": "query", "description": "Nom de la société", "schema": { "type": "string" }, "example": "LadematNC" }, { "name": "DossierClient", "in": "query", "description": "Dossier client", "schema": { "type": "string" }, "example": "10" }, { "name": "NumeroContrat", "in": "query", "description": "Numéro de contrat", "schema": { "type": "string" }, "example": "5" }, { "name": "NumeroAvenant", "in": "query", "description": "Numéro d'avenant", "schema": { "type": "string" }, "example": "6" }, { "name": "CodeProduit", "in": "query", "description": "Code produit", "schema": { "type": "string" }, "example": "301" }, { "name": "Immatriculation", "in": "query", "description": "Immatriculation", "schema": { "type": "string" }, "example": "65486" }, { "name": "Statut", "in": "query", "description": "Statut du contrat", "schema": { "type": "string" }, "example": "EnCours" }, { "name": "DN", "in": "query", "description": "DN", "schema": { "type": "string" }, "example": "10" }, { "name": "FormuleSante", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Yousign/UploadFileForSignature": { "post": { "tags": [ "Yousign" ], "summary": "Method UploadFileForSignature()\r\nInitialise un signatureRequest\r\nAjoute un signataire\r\nAjoute un fichier\r\nActive la signatureRequest", "parameters": [ { "name": "CustomerID", "in": "query", "description": "Nom du client", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email du signataire", "schema": { "type": "string" } }, { "name": "nom", "in": "query", "description": "Nom du signataire", "schema": { "type": "string" } }, { "name": "prenom", "in": "query", "description": "Prénom du signataire", "schema": { "type": "string" } }, { "name": "DocumentID", "in": "query", "description": "Id du document dans docuware", "schema": { "type": "integer", "format": "int32" } }, { "name": "FileCabinetID", "in": "query", "description": "Uid du filecabinet dans docuware", "schema": { "type": "string" } }, { "name": "API_KEY", "in": "query", "description": "Clés API disponible dans l'armoire ABONNEMENT du docuware lademat.nc", "schema": { "type": "string" }, "example": "8c72bf81-a7ff-484b-8aba-6e3c03b0b02a" }, { "name": "x", "in": "query", "description": "Position x de la signature sur le document", "schema": { "type": "integer", "format": "int32", "default": 100 }, "example": 100 }, { "name": "y", "in": "query", "description": "Position y de la signature sur le document", "schema": { "type": "integer", "format": "int32", "default": 100 }, "example": 100 }, { "name": "page", "in": "query", "description": "Page du document ou doit être aposée la signature", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "DocumentValues": { "type": "object", "properties": { "values": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Dictionnaire de valeur", "nullable": true }, "invoiceLines": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "Liste de factures", "nullable": true }, "stampFields": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Objet Tampon", "nullable": true } }, "additionalProperties": false, "description": "Class représentant l'objet DocumentValues" }, "InfoChamp": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Nom du champ", "nullable": true }, "itemElementName": { "type": "string", "description": "Type du champ", "nullable": true }, "item": { "description": "Contenu du champ", "nullable": true } }, "additionalProperties": false, "description": "Structure du champ" }, "InfoDocument": { "type": "object", "properties": { "timeStamp": { "type": "string", "description": "DateHeure de la requête de validation", "format": "date-time" }, "userName": { "type": "string", "description": "Utilisateur DocuWare qui a fait la requête de validation", "nullable": true }, "organizationName": { "type": "string", "description": "Nom de l'organisation contenant le dialogue", "nullable": true }, "fileCabinetGuid": { "type": "string", "description": "GUID de l'armoire contenant le dialogue", "nullable": true }, "dialogGuid": { "type": "string", "description": "GUID de la boîte de dialogue qui fait la validation", "nullable": true }, "dialogType": { "type": "string", "description": "Type de la boîte de dialogue : \"_InfoDialog\" (modifier index) ou \"_Store\" (stockage)", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/InfoChamp" }, "description": "Liste des champs du documents", "nullable": true } }, "additionalProperties": false, "description": "Structure du document" } } } }