Documentation de demarches-simplifiees.fr
  • Généralités
  • Présentation
  • Cible
  • Démarrage
  • Cas d'usage
  • Tutoriels et vidéos
    • Tutoriel usager
    • Tutoriel « expert invité »
    • Tutoriel instructeur
    • Tutoriel administrateur
    • Les bonnes pratiques lors de la création d'une démarche
    • Vidéo : la sécurité de demarches-simplifiees.fr
    • Vidéo : le cadre juridique
    • Vidéo : la relation usager
    • Intégration du bouton « Mon avis »
  • Nouveautés
    • Pour les administrateurs
    • Pour les instructeurs
    • Pour les usagers
  • Expérimentations
    • Type de champ expression régulière
    • Chorus
  • Nos démarches
    • Démarches modèles à dupliquer
    • Démarches relatives au permis de conduire
    • Démarches relatives aux transporteurs
    • Démarches relatives au secteur du transport public de tourisme (T3P) - Taxis et VTC
    • Démarches relatives aux étrangers résidant en France
    • Démarches relatives aux inscriptions scolaires (inscription, restauration, centres de loisirs)
    • Démarches relatives aux médailles d'honneur
    • Démarches relatives aux Tribunal judiciaire de Lille
  • Conditions Générales d'Utilisation
  • Conditions générales d'utilisation : usagers
  • Politique de confidentialité
  • Mentions légales
  • API GraphQL
    • Automatisation : obligations des utilisateurs publics
    • Introduction technique
    • Accréditation
    • Le playground / Premiers pas
    • Point d'entrée et Schema GraphQL
    • Jeton d'authentification
      • Problèmes fréquents
    • Les queries
      • getDemarche
      • getDossier
      • getGroupeInstructeur
      • getDemarcheDescriptor
    • Les mutations
      • Modifier l'état d'un dossier
      • Envoyer un message
      • Ajouter ou supprimer un label
    • Pagination
    • Gestion des Erreurs
    • Cas d'usages / exemple d'implémentation
      • Client de démo en JS
      • Autentification
      • Récupérer un dossier
      • Pagination – Synchroniser une démarche à faible volumétrie (polling simple)
      • Pagination – Récupérer tous les dossiers d'une démarche
      • Pagination – Synchroniser une démarche à forte volumétrie (synchronisation)
      • Télécharger les fichiers uploadés par un usager sur son dossier
      • Envoyer un message avec une PJ
      • Accepter un dossier et y joindre un justificatif (une PJ)
      • Lister les Id des instructeurs
  • Pour aller plus loin
    • Cartographie
    • API de préremplissage
    • Aspects techniques et juridiques
    • Exports de données
    • Exports et Macros
    • Routage des dossiers
    • Webinaires
    • Horodatage
    • Archivage longue durée des démarches
    • Le conditionnel
    • Eligibilité des dossiers
    • Export personnalisé
  • Communiqués de presse
  • Expiration et suppression des dossiers
Propulsé par GitBook
Sur cette page
  • Ajouter un label
  • Supprimer un label
Exporter en PDF
  1. API GraphQL
  2. Les mutations

Ajouter ou supprimer un label

PrécédentEnvoyer un messageSuivantPagination

Dernière mise à jour il y a 3 mois

Les instructeurs peuvent ajouter (ou modifier) des labels à un dossier, qui agissent comme une sorte d’étiquette personnalisée. La liste des labels disponibles est au préalable définie dans l'interface l'administrateur (pas encore par API), ainsi que l’ordre dans lequel ils sont retournés.

Par défaut 5 labels sont créés : Urgent, À examiner, À relancer, Complet, À signer. Laissez libre court à votre imagination pour organiser l’instruction: Prêt pour la commission, Validé par la hiérarchie, …

L’API permet d’associer ou supprimer un label à un dossier. Récupérez d'abord sur la démarche.

Il n’y a pas de limite sur le nombre de labels par dossier, mais dans l’interface Démarches Simplifiées il n’est généralement pas pratique d’en afficher plus de 5 ou 6 par dossier.

Query

Ajouter un label

mutation dossierAjouterLabel($input: DossierAjouterLabelInput!) {
	dossierAjouterLabel(input: $input) {
		dossier {
			id
			labels {
				id
				name
				color
			}
		}
		label {
			name
		}
		errors {
			message
		}
	}
}

Variables

{
  "query": <query>,
  "operationName": "dossierAjouterLabel",
  "variables": {
    "input": {
      "dossierId": "UHJvY4VkdXKlLTI5NTgw",
      "labelId": "TGFiZWwtMzA0MzQw"
    }
  }
}

L’attribut color est un string parmi quelques noms de couleurs disponibles dans le Design Système de l'État. Il sera peut-être inutile dans le contexte de votre utilisation de l'API.

Supprimer un label

Query

mutation dossierSupprimerLabel($input: DossierSupprimerLabelInput!) {
	dossierSupprimerLabel(input: $input) {
		dossier {
			id
			labels { # Le ou les labels restant sur le dossier
				id
				name
				color
			}
		}
		label {
			name # Le label supprimé
		}
		errors {
			message
		}
	}
}

Variables

{
  "query": <query>,
  "operationName": "dossierSupprimerLabel",
  "variables": {
    "input": {
      "dossierId": "UHJvY4VkdXKlLTI5NTgw",
      "labelId": "TGFiZWwtMzA0MzQw"
    }
  }
}

la liste des identifiants de labels disponibles