Introduction Guide de l'utilisateur Guide administrateur fonctionnel Guide administrateur technique Installation Prérequis pour Maarch Parapheur Breaking Change Exploitation Architecture technique Description du modèle de données Description des webservices Configurations Documents Utilisateurs Historique

History

Récupération de l'historique d'un document

Route

GET /rest/documents/{id}/history
Url
Valeur Type Obligatoire Description
id string Oui Identifiant (int) du document
mode string Non Format du fichier retourné. Valeurs possibles : json ou xml. Valeur par défaut : json

Retour

Code Http Type Description
200 array Historique du document
200 flux Historique du document dans un fichier xml
400 array Message d'erreur
403 array Document hors périmètre
Données

Si mode = json

Valeur Type Description
code string Code du message: OK ou KO
user array Informations concernant l'utilisateur ayant fait l'action
date date Date de l'action
type string Type d'action effectuée
message string Message de l'action
data array Informations complémentaires concernant l'action
document array Informations concernant le document (seulement pour une action de validation d'un signataire)

Si mode = xml

Valeur Type Description
Flux flux Historique du document dans un fichier xml
Exemple
{
  "history": [
    {
      "code": "OK",
      "type": "CREATION",
      "user": {
        "id": 2,
        "email": "ccornillac@maarch.com",
        "firstname": "Clovis",
        "lastname": "CORNILLAC",
        "ip": "10.2.3.4"
      },
      "date": "19-03-2020 15:50",
      "message": "Pièce jointe ajoutée : summarySheet.pdf",
      "data": {
        "mainDocumentId": 250
      }
    },
    {
      "code": "OK",
      "type": "CREATION",
      "user": {
        "id": 2,
        "email": "ccornillac@maarch.com",
        "firstname": "Clovis",
        "lastname": "CORNILLAC",
        "ip": "10.2.3.4"
      },
      "date": "19-03-2020 15:50",
      "message": "Document ajouté : fsdfdssdsd",
      "data": []
    },
    {
      "code": "OK",
      "type": "VIEW",
      "user": {
        "id": 1,
        "email": "jjane@maarch.com",
        "firstname": "Jenny",
        "lastname": "JANE",
        "ip": "10.2.3.5"
      },
      "date": "24-03-2020 12:56",
      "message": "Document consulté : fsdfdssdsd",
      "data": []
    },
    {
      "code": "OK",
      "type": "ACTION",
      "user": {
        "id": 1,
        "email": "jjane@maarch.com",
        "firstname": "Jenny",
        "lastname": "JANE",
        "ip": "10.2.3.5"
      },
      "date": "24-03-2020 12:56",
      "message": "Action effectuée : VAL",
      "data": {
        "actionId": 1,
        "mode": "sign"
      },
      "document": {
        "filename": "0013_1634265441.pdf",
        "fingerprint": "9e697268b30a00da4347be2a24150d08308eb59d9309b47c8e437957d6ccb0df6de3daf5c5ec19e714f03e707a8a891574144b8a09b43a9398b55edb49b3ca5c",
        "mimeType": "application/pdf",
        "certificate": "subject=C = FR, ST = France, L = Nanterre, O = Maarch, OU = Maarch, CN = Maarch Parapheur, emailAddress = info@maarch.org\n\nissuer=C = FR, ST = France, L = Nanterre, O = Maarch, OU = Maarch, CN = Maarch Parapheur, emailAddress = info@maarch.org\n\n-----BEGIN CERTIFICATE-----\nMIIDpTCCAo0CFACXbEZoY0QvFPRAiprffUC/0KHVMA0GCSqGSIb3DQEBCwUAMIGO\nMQswCQYDVQQGEwJGUjEPMA0GA1UECAwGRnJhbmNlMREwDwYDVQQHDAhOYW50ZXJy\nZTEPMA0GA1UECgwGTWFhcmNoMQ8wDQYDVQQLDAZNYWFyY2gxGTAXBgNVBAMMEE1h\nYXJjaCBQYXJhcGhldXIxHjAcBgkqhkiG9w0BCQEWD2luZm9AbWFhcmNoLm9yZzAe\nFw0xOTA0MjUxNTUzMTBaFw0yOTA0MjIxNTUzMTBaMIGOMQswCQYDVQQGEwJGUjEP\nMA0GA1UECAwGRnJhbmNlMREwDwYDVQQHDAhOYW50ZXJyZTEPMA0GA1UECgwGTWFh\ncmNoMQ8wDQYDVQQLDAZNYWFyY2gxGTAXBgNVBAMMEE1hYXJjaCBQYXJhcGhldXIx\nHjAcBgkqhkiG9w0BCQEWD2luZm9AbWFhcmNoLm9yZzCCASIwDQYJKoZIhvcNAQEB\nBQADggEPADCCAQoCggEBAL3Xh43uVEaCpEdWWZ2RsmDyEuyqTArGX78JiAgcCvKW\nHt38KekplCXM3hi0JswV4Y2FQAjm5nIDilsNzoEBsJQ7LYb+hzwWhd6VZLDWIDWo\n0e7BwypobSyNKq9amc9NYeo305YH57mSWxZ5bXMY0zi0hOhK2gxptBPOxa+MSbh6\n2tv43/IrAwaVWaqJxWmSz98K4qRUmFaYZgaxDf8Ei6IzGYrIExxwCJVnktBmmoQj\ncqkecLMts1ZNgxbyJt1hvDN/2OhRX619ELQZO+P4BtS5x1QWvjtvLTEtET4RBAen\nsrs95kj98AJd2bxV+h0t5EhiLGYJtXFDmDGjIAk2+qUCAwEAATANBgkqhkiG9w0B\nAQsFAAOCAQEAeiWPQ1iWqT9YQYOXEcLOwSpXjXi/9FD8+2uMf3mEIHC0yhutI7lZ\nnLNJSYrCaS90HukOHdwdbvF877sd/1XK5fTgl74gASMHrSQNb5McW4zcIrkCT9Qt\nY/C9wgtYQ6GDcyo6PGfNO53j3RbWUdwlpozDtya45YN7zhv6aE190qSwQdZosQcg\nlLeOkTAz6E+e4bHhb/UHfxUQJZRqG7vF+eSon+DePnotlq0XWVLcE633T2ClJ4AV\nc6bFWemUYL8lBNIag99gifmv8tEoiUWDJ+Uag7rFPk2i9WEynnC3ClIUGctpsgdY\nvwGtPCqZDhv+XKX+ukMYvvAHhnRUcDS7XA==\n-----END CERTIFICATE-----\n\n"
      }
    }
  ]
}

Récupération du faisceau de preuve

Route

GET /rest/documents/{id}/proof
Url
Valeur Type Obligatoire Description
id string Oui Identifiant (int) du document
mode string Non Format du fichier retourné. Valeurs possibles : base64 ou stream. Valeur par défaut : base64
onlyProof boolean Non Indique si on souhaite seulement le faisceau de preuve ou le dossier complet. Valeur par défaut : false

Retour

Code Http Type Description
200 Faisceau de preuve ou dossier complet, retourné en base64 ou dans un flux
400 array Message d'erreur
403 array Document hors périmètre

Si onlyProof = true, seul le faisceau de preuve est retourné (si signature eidas, format pdf. Sinon xml)
Si onlyProof = false, le dossier complet est retourné dans une archive zip (document signé, pièce jointe, annotation)

Données

Si mode = base64

Valeur Type Description
encodedDocument base64 Document encodé en base64

Si mode = stream

Valeur Type Description
Flux flux Flux
Exemple
{
    "encodedDocument": "JVBERi0x..."
}

results matching ""

    No results matching ""