ICON__LOGO_THEIA-Surimpresion-1250x500px (1)

THEIA.fr

API – Etiquettes

Menu

1. TagCategory

GET /api/tag_categories

Description :

Récupère un ensemble de données sur les catégories d’étiquettes existantes sur la plateforme. 

Paramètres : 

page (integer) : 1 (Valeur par défaut)

Réponse : 

				
					{
  "hydra:member": [
    {
      "@id": "string", // ID de la route
      "@type": "string", // Type de la route
      "name": "string", // Nom de la catégorie
      "color": "string" // Couleur de la catégorie
    }
  ],
   "hydra:totalItems": 0, // Nombre total d'activité
  "hydra:view": { // Module des pages
    "@id": "string", // ID de la route
    "@type": "string", // Type de la route
    "hydra:first": "string", // Première page
    "hydra:last": "string", // Dernière page
    "hydra:next": "string" // Page suivante
  },
  "hydra:search": { // Module des filtres
    "@type": "string", // Type de la route
    "hydra:template": "string", // Représentation des filtres
    "hydra:variableRepresentation": "string", // Représentation des filtres
    "hydra:mapping": [
      {
        "@type": "string", // Type de la route
        "variable": "string", // Variable de filtre
        "property": "string", // Variable de filtre
        "required": true // État d'utilisation du filtre
      }
    ]
  }
}
				
			
POST /api/tag_categories

Description :

Créer une nouvelle catégorie d’étiquette sur la plateforme.

Paramètres d’entrée : 

Aucune donnée n’est requise.

Corps de la requête :

				
					{
  "name": "string", // Nom de la catégorie
  "color": "string", // Couleur de la catégorie
  "taggableConfigurations": [
    {
      "taggableDefinition": "string", // Présence de définition d'étiquette
      "maxTags": 0, // Nombre maximum d'étiquette autorisé
      "allowAddTags": true, // Option de l'ajout d'étiquette supplémentaire
      "public": true // État de visibilité
    }
  ]
}
				
			

Réponse : 

				
					{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "name": "string",
  "color": "string",
  "taggableConfigurations": [
    {
      "@context": "string",
      "@id": "string",
      "@type": "string"
    }
  ]
}
				
			
GET /api/tag_categories/{id}

Description :

Récupère un ensemble de données d’une catégorie d’étiquette.

Paramètres : 

Id (string) : Identifiant de la catégorie d’étiquette accessible grâce à GET /api/tag_categories

Réponse : 

				
					{
  "@context": "string", // Nom de la route
  "@id": "string", // ID de la route
  "@type": "string", // Type de la route
  "name": "string", // Nom de la catégorie
  "color": "string", // Couleur de la catégorie
  "taggableConfigurations": [
    {
      "@context": "string", // Nom de la route
      "@id": "string", // ID de la route
      "@type": "string", // Type de la route
      "taggableDefinition": "string", // Présence de définition d'étiquette
      "maxTags": 0, // Nombre maximum d'étiquette autorisé
      "allowAddTags": true, // Option de l'ajout d'étiquette supplémentaire
      "public": true // État de visibilité
    }
  ]
}
				
			
PATCH /api/tag_categories/{id}

Description :

Met à jour certaines informations d’une catégorie d’étiquette. 

Paramètres : 

Id (string) : Identifiant de la catégorie d’étiquette accessible grâce à GET /api/tag_categories.

Réponse : 

				
					{
  "id": 0, // ID
  "name": "string", // Nom de la catégorie
  "color": "string", // Couleur de la catégorie
  "taggableConfigurations": [
    {
      "taggableDefinition": "string", // Présence de définition d'étiquette
      "maxTags": 0, // Nombre maximum d'étiquette autorisé
      "allowAddTags": true, // Option de l'ajout d'étiquette supplémentaire
      "public": true // État de visibilité
    }
  ]
}
				
			

2. TaggableDefinition

GET /api/taggable_definitions

Description :

Récupère un ensemble de données concernant la configuration possible des catégories d’étiquette.

Au niveau de la plateforme, les étiquettes peuvent être appelées dans 4 menus : Evaluations > Questions / Evaluations > Epreuves / Apprentissage > Parcours / Apprentissage > Formations.

Paramètres : 

page (integer) : 1 (Valeur par défaut)

Réponse : 

				
					{
  "@context": "/api/contexts/TaggableDefinition",
  "@id": "/api/taggable_definitions",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/api/taggable_definitions/1",
      "@type": "TaggableDefinition",
      "id": 1,
      "alias": "docimocontent",
      "labelKey": "theia.docimocontent.label"
    },
    {
      "@id": "/api/taggable_definitions/2",
      "@type": "TaggableDefinition",
      "id": 2,
      "alias": "learningsessionmodel",
      "labelKey": "theia.learningsessionmodel.label"
    },
    {
      "@id": "/api/taggable_definitions/3",
      "@type": "TaggableDefinition",
      "id": 3,
      "alias": "pedagosession",
      "labelKey": "theia.pedagosession.label"
    },
    {
      "@id": "/api/taggable_definitions/4",
      "@type": "TaggableDefinition",
      "id": 4,
      "alias": "assessment",
      "labelKey": "theia.assessment.label"
    }
  ],
  "hydra:totalItems": 4
}
				
			
GET /api/taggable_definitions/{id}

Description :

Récupère un ensemble de données concernant une configuration possible des catégories d’étiquettes.

Paramètres : 

Id (string) : Identification de l’élément TaggableDefinition grâce à  GET /api/taggable_definitions

Réponse : 

				
					{
  "@id": "string", // ID de la route
  "@type": "string", // Type de la route
  "@context": "string", // Nom de la route
  "id": 0, // ID
  "alias": "string" // Alias de la définition
}
				
			

3. Tag

GET /api/tags

Description :

Récupère un ensemble de données concernant l’ensemble des étiquettes présentes sur la plateforme.

Paramètres : 

category (string) :

category[] (array[string]) :

name (string) :

page (integer) :

Réponse : 

				
					{
  "hydra:member": [
    {
      "@id": "string", // ID de la route
      "@type": "string", // Type de la route
      "name": "string", // Nom de l'étiquette
      "category": "string" // Nom de la catégorie
    }
  ],
   "hydra:totalItems": 0, // Nombre total d'activité
  "hydra:view": { // Module des pages
    "@id": "string", // ID de la route
    "@type": "string", // Type de la route
    "hydra:first": "string", // Première page
    "hydra:last": "string", // Dernière page
    "hydra:next": "string" // Page suivante
  },
  "hydra:search": { // Module des fktres
    "@type": "string", // Type de la route
    "hydra:template": "string", // Représentation des filtres
    "hydra:variableRepresentation": "string", // Représentation des filtres
    "hydra:mapping": [
      {
        "@type": "string", // Type de la route
        "variable": "string", // Variable de filtre
        "property": "string", // Variable de filtre
        "required": true // État d'utilisation du filtre
      }
    ]
  }
}
				
			
POST /api/tags

Description :

Crée une étiquette sur la plateforme.

Paramètres : 

Aucune donnée n’est requise.

Corps de la requête : 

				
					{
  "name": "string", // Nom de l'étiquette
  "category": "string" // Nom de la catégorie
}
				
			

Réponse : 

				
					{
  "@context": "string", // Nom de la route
  "@id": "string", // ID de la route
  "@type": "string", // Type de la route
  "name": "string", // Nom de l'étiquette
  "category": "string" // Nom de la catégorie
}
				
			
GET /api/tags/{id}

Description :

Récupère un ensemble de données d’une étiquettes présentes sur la plateforme.

Paramètres : 

Id (string) : Identifiant de l’étiquette.

Réponse : 

				
					{
  "@context": "string", // Nom de la route
  "@id": "string", // ID de la route
  "@type": "string", // Type de la route
  "name": "string", // Nom de l'étiquette
  "category": "string" // Nom de la catégorie
}
				
			
PATCH /api/tags/{id}

Description :

Met à jour certaines informations d’une étiquette. 

Paramètres : 

Id (string) : Identifiant de l’étiquette

Corps de la requête : 

				
					{
  "name": "string", // Nom de l'étiquette
  "category": "string" // Nom de la catégorie
}
				
			

Réponse : 

				
					{
  "@context": "string", // Nom de la route
  "@id": "string", // ID de la route
  "@type": "string", // Type de la route
  "name": "string", // Nom de l'étiquette
  "category": "string" // Nom de la catégorie
}