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 catégorie
"@type": "string", // Type de l'élément (=TagCategory)
"name": "string", // Nom de la catégorie
"color": "string" // Couleur de la catégorie (Ex : "#1f5170")
}
],
...
}
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 :
{
"@context": "string",
"@id": "string",
"@type": "string",
"name": "string",
"color": "string",
"taggableConfigurations": [
{
"@context": "string",
"@id": "string",
"@type": "string"
}
]
}
Réponse :
{
"name": "string", // Nom de la catégorie
"color": "string", // Couleur de la catégorie (Ex : "#1f5170")
"taggableConfigurations": [
{
"taggableDefinition": "string", // Contenu pouvant être taggé
// Contenus docimologiques (questions / dossiers) = "/api/taggable_definitions/1"
// Parcours d'activités = "/api/taggable_definitions/2"
// Sessions de formation = "/api/taggable_definitions/3"
// IGE (Examens, Conférences) = "/api/taggable_definitions/4"
"maxTags": 0, // Nombre maximum d'étiquette autorisé
"allowAddTags": true, // Autoriser l'ajout d'étiquettes dans cette catégorie lors de la saisie
"public": true // Rendre visible les étiquettes pour les étudiants
}
]
}
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",
"@id": "string", // Id de la catégorie
"@type": "string", // Type de l'élément (=TagCategory)
"name": "string", // Nom de la catégorie
"color": "string", // Couleur de la catégorie (Ex : "#1f5170")
"taggableConfigurations": [
{
"@type": "string", // Type de l'élément (=TaggableConfigurationDto)
"@id": "string", // Id de l'élément
"taggableDefinition": "string", // Contenu pouvant être taggé
// Contenus docimologiques (questions / dossiers) = "/api/taggable_definitions/1"
// Parcours d'activités = "/api/taggable_definitions/2"
// Sessions de formation = "/api/taggable_definitions/3"
// IGE (Examens, Conférences) = "/api/taggable_definitions/4"
"maxTags": 0, // Nombre maximum d'étiquette autorisé
"allowAddTags": true, // Autoriser l'ajout d'étiquettes dans cette catégorie lors de la saisie
"public": true // Rendre visible les étiquettes pour les étudiants
}
]
}
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 de la catégorie
"name": "string", // Nom de la catégorie
"color": "string", // Couleur de la catégorie (Ex : "#1f5170")
"taggableConfigurations": [
{
"taggableDefinition": "string", // Contenu pouvant être taggé
// Contenus docimologiques (questions / dossiers) = "/api/taggable_definitions/1"
// Parcours d'activités = "/api/taggable_definitions/2"
// Sessions de formation = "/api/taggable_definitions/3"
// IGE (Examens, Conférences) = "/api/taggable_definitions/4"
"maxTags": 0, // Nombre maximum d'étiquette autorisé
"allowAddTags": true, // Autoriser l'ajout d'étiquettes dans cette catégorie lors de la saisie
"public": true // Rendre visible les étiquettes pour les étudiants
}
]
}
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 = « /api/taggable_definitions/1 »
- Evaluations > Epreuves = « /api/taggable_definitions/4 »
- Apprentissage > Parcours = « /api/taggable_definitions/2 »
- Apprentissage > Formations = « /api/taggable_definitions/3 »
Ces éléments pourront être utilisés pour créer et modifier des catégories.
Paramètres :
page (integer) : 1 (Valeur par défaut)
Réponse :
{
...
"hydra:member": [
{
"@id": "/api/taggable_definitions/1", // Id de l'élément
"@type": "TaggableDefinition", // Type de l'élément (=TaggableDefinition)
"id": 1, // Id de l'élément
"alias": "docimocontent",
"labelKey": "theia.docimocontent.label"
},
{
"@id": "/api/taggable_definitions/2", // Id de l'élément
"@type": "TaggableDefinition", // Type de l'élément (=TaggableDefinition)
"id": 2, // Id de l'élément
"alias": "learningsessionmodel",
"labelKey": "theia.learningsessionmodel.label"
},
{
"@id": "/api/taggable_definitions/3", // Id de l'élément
"@type": "TaggableDefinition", // Type de l'élément (=TaggableDefinition)
"id": 3, // Id de l'élément
"alias": "pedagosession",
"labelKey": "theia.pedagosession.label"
},
{
"@id": "/api/taggable_definitions/4", // Id de l'élément
"@type": "TaggableDefinition", // Type de l'élément (=TaggableDefinition)
"id": 4, // Id de l'élément
"alias": "assessment",
"labelKey": "theia.assessment.label"
}
],
...
}
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 (integer) : Identification de l’élément TaggableDefinition grâce à GET /api/taggable_definitions
Réponse :
{
"@context": "string",
"@id": "string", // Id de l'élément
"@type": "string", // Type de l'élément (=TaggableDefinition
"id": integer, // Id de l'élément
"alias": "string",
"labelKey": "string"
}
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) : Chaine de caractères contenu dans l’identifiant de la catégorie d’étiquettes (= « /api/tag_categories/576″)
category[] (array[string]) : Tableau des identifiants des catégories d’étiquettes
name (string) : Chaine de caractères contenu dans le nom de l’étiquette
page (integer) : 1 (valeur par défaut)
Réponse :
{
...
"hydra:member": [
{
"@id": "string", // Id de l'étiquette
"@type": "string", // Type de l'élément (=Tag)
"name": "string", // Nom de l'étiquette
"category": "string" // Id de la catégorie
}
],
...
}
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" // Id de la catégorie (Ex : "/api/tag_categories/680")
}
Réponse :
{
"@context": "string",
"@id": "string", // Id de l'étiquette
"@type": "string", // Type de l'élément (=Tag)
"name": "string", // Nom de l'étiquette
"category": "string" // Id 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",
"@id": "string", // Id de l'étiquette
"@type": "string", // Type de l'élément (=Tag)
"name": "string", // Nom de l'étiquette
"category": "string" // Id 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" // Id de la catégorie (Ex : "/api/tag_categories/680")
}
Réponse :
{
"@context": "string",
"@id": "string", // Id de l'étiquette
"@type": "string", // Type de l'élément (=Tag)
"name": "string", // Nom de l'étiquette
"category": "string" // Id de la catégorie
}