Pièce/documents joints à une écriture et/ou mouvements

Introduction

Les écritures et mouvements peuvent avoir plusieurs types de pièce jointe;

• URL - Lien vers le fichier
• File - Chemin relatif vers un fichier (uniquement pour les archives en .zip)
• Base64 - Fichier au format base64 (uniquement pour l'import)

NOTE

En export le type URL est privilégié

{
  "attachments": {
    "document.pdf": {
      "type": "URL",
      "value": "https://app.myunisoft.fr/api/ged/ged/document/1-gTt2QkfLPABeb6Z/download"
    }
  }
}

Téléchargement de la pièce sur la GED MyUnisoft

Le endpoint GED /document/:id/download permet de télécharger un document. Plusieurs en-têtes HTTP seront retournés :

• Content-Length : La taille du fichier en octets.
• Content-Type : Le type MIME du fichier.
• Content-Disposition : Le nom du fichier au format attachment; filename=$filename.

Interfaces

TypeScript

type Attachment = {
  type: "URL";
  value: string;
} | {
  type: "File";
  value: string;
} | {
  type: "Base64";
  value: string;
};

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "type": "object",
  "required": [],
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "type": {
          "const": "URL"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "const": "File"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "const": "Base64"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "additionalProperties": false
    }
  ]
}

(retour en haut de page)