DocumentaciónAide

Créer et suivre des dossiers par API

Les requêtes pour créer un dossier, ajouter des réponses, consulter son statut, télécharger des pièces jointes et répondre à l'enquête depuis votre système.

Sur cette page

Avec l'URL pour créer des dossiers d'un canal, votre serveur crée et suit des dossiers dans l'espace. Toutes les requêtes sont signées : lisez Signer les requêtes.

Sur cette page, {URL} désigne l'URL du canal, par exemple https://api-itsm.argunis.com/api/public/cases/v1/AbC….

Créer un dossier

POST {URL}/cases avec ce corps JSON :

{
  "externalId": "7c1e0b9a-4f1d-4a51-9a3e-2d5b8f0c1a22",
  "subject": "No puedo exportar el reporte mensual",
  "description": "Al presionar Exportar aparece un error.",
  "kind": "incident",
  "urgency": 2,
  "impact": 2,
  "category": "Reportes",
  "requester": { "email": "ana@cliente.cl", "name": "Ana Pérez", "phone": "+56 9 1234 5678" },
  "company": { "name": "Cliente SpA", "taxId": "76.123.456-7" },
  "context": { "pantalla": "/reportes/mensual", "version": "4.2.1", "navegador": "Chrome 141" },
  "attachments": [{ "filename": "error.png", "contentType": "image/png", "dataBase64": "iVBORw0KGgo…" }]
}

Champ

Obligatoire

Usage

externalId

oui

L'identifiant du dossier dans votre système (jusqu'à 100 caractères : lettres, chiffres et . _ : -). Si vous répétez un externalId, Elion ITSM répond avec le dossier existant au lieu d'en créer un autre.

subject

oui

Objet, de 3 à 200 caractères.

description

non

Détail, jusqu'à 20 000 caractères.

kind

non

incident (quelque chose ne fonctionne pas) ou request (une question ou une demande). S'il manque, celui du canal.

urgency, impact

non

1 haute, 2 moyenne, 3 basse. S'ils manquent, ceux du canal.

category

non

Nom d'une catégorie de l'espace. S'il ne correspond pas, celle du canal.

requester

oui

E-mail et nom de la personne qui demande de l'aide. Le téléphone est facultatif.

company

non

Entreprise du demandeur : nom et RUT.

context

non

Jusqu'à 20 données texte utiles à l'équipe (écran, version, navigateur). Elles sont ajoutées à la fin de la description.

attachments

non

Jusqu'à 5 fichiers de 5 Mo chacun, en base64. Les mêmes types que dans les tickets sont acceptés.

Réponses :

Code

Signification

201

Dossier créé. Contient { "case": … }.

200

Un dossier avec cet externalId existait déjà ; contient ce dossier.

400

Un champ n'est pas valide ; error.details indique lequel.

403

Le demandeur n'est pas autorisé par le canal.

Générez l'externalId avant l'envoi et conservez-le. Si le réseau échoue, réessayez avec le même externalId et un nouveau webhook-id : le dossier n'est jamais dupliqué.

Le dossier que renvoie Elion ITSM

{
  "case": {
    "number": "INC-000123",
    "externalId": "7c1e0b9a-4f1d-4a51-9a3e-2d5b8f0c1a22",
    "subject": "No puedo exportar el reporte mensual",
    "state": "in_progress",
    "stateLabel": "En revisión",
    "waitingOn": "team",
    "priority": "P3",
    "createdAt": "2026-10-13T14:02:11.000Z",
    "updatedAt": "2026-10-13T14:20:45.000Z",
    "resolvedAt": null,
    "closedAt": null,
    "resolution": null,
    "assignee": { "name": "Carla Soto" },
    "csatPending": false,
    "publicMessages": [
      { "id": "981", "side": "agent", "author": "Carla Soto", "body": "Hola Ana, ¿qué formato elegiste?", "at": "2026-10-13T14:20:45.000Z", "attachments": [] }
    ]
  }
}
  • stateLabel est déjà rédigé pour le demandeur : Recibida, En revisión, Esperando tu respuesta, Resuelta, Cerrada, Cancelada.

  • waitingOn indique qui doit agir : team (l'équipe), requester (le demandeur) ou null si c'est terminé.

  • publicMessages ne contient que la conversation avec le demandeur, les 200 derniers messages. Jamais les notes internes de l'équipe.

  • body est du texte brut : affichez-le comme du texte, pas comme du HTML.

Consulter un dossier

GET {URL}/cases/{ref}, où {ref} est le numéro (INC-000123) ou votre externalId. Répond { "case": … }. Ne trouve que les dossiers créés par ce canal.

Répondre

POST {URL}/cases/{ref}/replies :

{ "body": "Elegí PDF.", "author": { "email": "ana@cliente.cl", "name": "Ana Pérez" }, "attachments": [] }

Cela compte comme une réponse du demandeur : si l'équipe l'avait mis en attente de sa réponse, le dossier repasse En cours, et s'il était Résolu, il est rouvert. Un dossier Clôturé répond 409 : il faut en créer un nouveau.

Télécharger une pièce jointe

GET {URL}/cases/{ref}/attachments/{id}, avec l'id fourni dans publicMessages. Ne fournit que les pièces jointes de la conversation publique du dossier.

Répondre à l'enquête

Quand csatPending vaut true, POST {URL}/cases/{ref}/csat :

{ "score": 5, "comment": "Rápido y claro." }

score va de 1 à 5. S'il n'y a pas d'enquête en attente, répond 409.

Voir aussi

Rechercher dans Elion ITSM

Saisissez au moins 2 caractères pour rechercher dans Elion ITSM.

↑↓ naviguer · Enter ouvrir · Esc fermer