departements
This commit is contained in:
el
parent
6b53a419c9
commit
4c180fe1f8
19 changed files with 21999 additions and 431 deletions
2833
backend/api/la_bonne_boite_bundled.json
Normal file
2833
backend/api/la_bonne_boite_bundled.json
Normal file
File diff suppressed because it is too large
Load diff
3405
backend/api/marche_du_travail_bundled.json
Normal file
3405
backend/api/marche_du_travail_bundled.json
Normal file
File diff suppressed because it is too large
Load diff
2463
backend/api/offres_emploi_v2_bundled.json
Normal file
2463
backend/api/offres_emploi_v2_bundled.json
Normal file
File diff suppressed because it is too large
Load diff
4017
backend/api/rome_4_competences.json
Normal file
4017
backend/api/rome_4_competences.json
Normal file
File diff suppressed because it is too large
Load diff
674
backend/api/rome_4_fiches_rome.json
Normal file
674
backend/api/rome_4_fiches_rome.json
Normal file
|
|
@ -0,0 +1,674 @@
|
|||
{
|
||||
"openapi": "3.0.1",
|
||||
"info": {
|
||||
"version": "1",
|
||||
"title": "ROME V4.0 - Fiches ROME",
|
||||
"description": "L'API « ROME 4.0 - Fiches métiers » permet de structurer les données au format de la fiche ROME.<br/> Cette API vous permet d'identifier, pour chaque fiche :<br/> <ul> <li>Les groupes de compétences mobilisées : les compétences sont classées et ordonnées par enjeu,</li> <li>Les groupes de savoirs : les savoirs sont classés et ordonnés par catégorie de savoir.</li> </ul>\r\n\r\n**Scopes** : `api_rome-fiches-metiersv1`,`nomenclatureRome`\r\n\r\n**Royaume** : `/partenaire`"
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/rome-fiches-metiers"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/v1/fiches-rome/fiche-metier": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Fiche métier"
|
||||
],
|
||||
"summary": "Lister les fiches métier",
|
||||
"description": "Permet de lister les fiches métier.\r\n\r\nSi vous renseignez une ou plusieurs valeurs dans \"champs\", alors vous obtiendrez le résultat pour ces champs.\r\n\r\nSi vous ne renseignez aucune valeur dans \"champs\", alors vous obtiendrez le résultat par défaut. (Sélectionner l'exemple \"***Par défaut***\" pour voir les données retournées)",
|
||||
"operationId": "listerFichesMetier",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "champs",
|
||||
"in": "query",
|
||||
"description": "Sélecteur de champs : il est possible de paramétrer le retour de la requête en définissant les champs souhaités (liste exhaustive des champs possibles : `Allowed values`). <br/> Vous pouvez vous aider des exemples de réponse pour identifier les champs que vous voulez récupérer.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"code",
|
||||
"groupescompetencesmobilisees(competences(libelle,code),enjeu(libelle,code))",
|
||||
"groupessavoirs(savoirs(libelle,code),categoriesavoirs(libelle,code))",
|
||||
"metier(libelle,code)"
|
||||
],
|
||||
"example": "code,metier(libelle,code)"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer lPjmA7mM6zOTJFjbJndC1sf3WJg"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Retourne la liste des fiches métier.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/FicheMetier"
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"Retour complet": {
|
||||
"value": [
|
||||
{
|
||||
"code": "A1201",
|
||||
"groupesCompetencesMobilisees": [
|
||||
{
|
||||
"competences": [
|
||||
{
|
||||
"type": "string",
|
||||
"libelle": "Techniques de soudage",
|
||||
"code": "100007"
|
||||
}
|
||||
],
|
||||
"enjeu": {
|
||||
"libelle": "Animation",
|
||||
"code": "3"
|
||||
}
|
||||
}
|
||||
],
|
||||
"groupesSavoirs": [
|
||||
{
|
||||
"savoirs": [
|
||||
{
|
||||
"type": "SAVOIR",
|
||||
"libelle": "Techniques de soudage",
|
||||
"code": "100007"
|
||||
}
|
||||
],
|
||||
"categorieSavoirs": {
|
||||
"libelle": "Véhicules",
|
||||
"code": "30"
|
||||
}
|
||||
}
|
||||
],
|
||||
"metier": {
|
||||
"libelle": "Bûcheronnage et élagage",
|
||||
"code": "A1201"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"Retour par défaut": {
|
||||
"value": [
|
||||
{
|
||||
"code": "A1201",
|
||||
"metier": {
|
||||
"libelle": "Bûcheronnage et élagage",
|
||||
"code": "A1201"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request : peut-être causé par un sélecteur de champs incorrect.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"message": "L'attribut 'monAttribut' n'est pas selectionnable",
|
||||
"codeMetier": "SELECTOR",
|
||||
"service": "/v1/mon_uri",
|
||||
"code": 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [],
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/rome-fiches-metiers",
|
||||
"description": "PROD"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/fiches-rome/fiche-metier/{code}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Fiche métier"
|
||||
],
|
||||
"summary": "Lire une fiche métier",
|
||||
"description": "Permet de lire une fiche métier depuis son code.\r\n\r\nSi vous renseignez une ou plusieurs valeurs dans \"champs\", alors vous obtiendrez le résultat pour ces champs.\r\n\r\nSi vous ne renseignez aucune valeur dans \"champs\", alors vous obtiendrez le résultat par défaut. (Sélectionner l'exemple \"***Par défaut***\" pour voir les données retournées)",
|
||||
"operationId": "lireFicheMetier",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "champs",
|
||||
"in": "query",
|
||||
"description": "Sélecteur de champs : il est possible de paramétrer le retour de la requête en définissant les champs souhaités (liste exhaustive des champs possibles : `Allowed values`). <br/> Vous pouvez vous aider des exemples de réponse pour identifier les champs que vous voulez récupérer.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"code",
|
||||
"datefin",
|
||||
"groupescompetencesmobilisees(competences(libelle,code),enjeu(libelle,code))",
|
||||
"groupessavoirs(savoirs(libelle,code),categoriesavoirs(libelle,code))",
|
||||
"metier(libelle,code)",
|
||||
"obsolete"
|
||||
],
|
||||
"example": "obsolete,code,groupescompetencesmobilisees(competences(libelle,code),enjeu(libelle,code)),groupessavoirs(savoirs(libelle,code),categoriesavoirs(libelle,code)),datefin,metier(libelle,code)"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "date",
|
||||
"in": "query",
|
||||
"description": "Date de la recherche au format yyyy-MM-dd ou yyyyMMdd.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"example": "2022-05-28"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "code",
|
||||
"in": "path",
|
||||
"description": "Code de la fiche métier.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer lPjmA7mM6zOTJFjbJndC1sf3WJg"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Retourne les données pour une fiche métier.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/FicheMetier"
|
||||
},
|
||||
"examples": {
|
||||
"Retour complet": {
|
||||
"value": {
|
||||
"obsolete": false,
|
||||
"code": "A1201",
|
||||
"groupesCompetencesMobilisees": [
|
||||
{
|
||||
"competences": [
|
||||
{
|
||||
"type": "string",
|
||||
"libelle": "Techniques de soudage",
|
||||
"code": "100007"
|
||||
}
|
||||
],
|
||||
"enjeu": {
|
||||
"libelle": "Animation",
|
||||
"code": "3"
|
||||
}
|
||||
}
|
||||
],
|
||||
"groupesSavoirs": [
|
||||
{
|
||||
"savoirs": [
|
||||
{
|
||||
"type": "SAVOIR",
|
||||
"libelle": "Techniques de soudage",
|
||||
"code": "100007"
|
||||
}
|
||||
],
|
||||
"categorieSavoirs": {
|
||||
"libelle": "Véhicules",
|
||||
"code": "30"
|
||||
}
|
||||
}
|
||||
],
|
||||
"dateFin": "2024-02-23T14:40:14.848Z",
|
||||
"metier": {
|
||||
"libelle": "Bûcheronnage et élagage",
|
||||
"code": "A1201"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Retour par défaut": {
|
||||
"value": {
|
||||
"obsolete": false,
|
||||
"code": "A1201",
|
||||
"groupesCompetencesMobilisees": [
|
||||
{
|
||||
"competences": [
|
||||
{
|
||||
"type": "string",
|
||||
"libelle": "Techniques de soudage",
|
||||
"code": "100007"
|
||||
}
|
||||
],
|
||||
"enjeu": {
|
||||
"libelle": "Animation",
|
||||
"code": "3"
|
||||
}
|
||||
}
|
||||
],
|
||||
"groupesSavoirs": [
|
||||
{
|
||||
"savoirs": [
|
||||
{
|
||||
"type": "SAVOIR",
|
||||
"libelle": "Techniques de soudage",
|
||||
"code": "100007"
|
||||
}
|
||||
],
|
||||
"categorieSavoirs": {
|
||||
"libelle": "Véhicules",
|
||||
"code": "30"
|
||||
}
|
||||
}
|
||||
],
|
||||
"dateFin": "2024-02-23T14:40:14.848Z",
|
||||
"metier": {
|
||||
"libelle": "Bûcheronnage et élagage",
|
||||
"code": "A1201"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request : peut-être causé par un sélecteur de champs incorrect.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"message": "L'attribut 'monAttribut' n'est pas selectionnable",
|
||||
"codeMetier": "SELECTOR",
|
||||
"service": "/v1/mon_uri",
|
||||
"code": 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not found.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"service": "/v1/mon_uri",
|
||||
"message": "Code inexistant: monCode",
|
||||
"code": 404
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [],
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/rome-fiches-metiers",
|
||||
"description": "PROD"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/fiches-rome/version": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Versionning du ROME"
|
||||
],
|
||||
"summary": "Récupérer la version actuelle du ROME",
|
||||
"description": "Récupère la version actuelle du ROME.",
|
||||
"operationId": "lireVersion",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "champs",
|
||||
"in": "query",
|
||||
"description": "Sélecteur de champs : il est possible de paramétrer le retour de la requête en définissant les champs souhaités (liste exhaustive des champs possibles : `Allowed values`). <br/> Vous pouvez vous aider des exemples de réponse pour identifier les champs que vous voulez récupérer.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"version",
|
||||
"lastModifiedDate",
|
||||
"version,lastModifiedDate"
|
||||
],
|
||||
"example": "version,lastModifiedDate"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer lPjmA7mM6zOTJFjbJndC1sf3WJg"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/VersionRome"
|
||||
},
|
||||
"examples": {
|
||||
"Retour complet": {
|
||||
"value": {
|
||||
"version": "19",
|
||||
"lastModifiedDate": "2025-05-22T12:04:43.281Z"
|
||||
}
|
||||
},
|
||||
"Retour par défaut": {
|
||||
"value": {
|
||||
"version": "19",
|
||||
"lastModifiedDate": "2025-05-22T12:04:43.281Z"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request : peut-être causé par un sélecteur de champs incorrect",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"message": "L'attribut 'monAttribut' n'est pas selectionnable",
|
||||
"codeMetier": "SELECTOR",
|
||||
"service": "/v1/mon_uri",
|
||||
"code": 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [],
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.pole-emploi.io/partenaire/rome-fiches-metiers",
|
||||
"description": "PROD"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"FicheMetier": {
|
||||
"type": "object",
|
||||
"description": "Fiche Métier",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "Code unique de la fiche métier",
|
||||
"example": "A1201"
|
||||
},
|
||||
"dateFin": {
|
||||
"type": "string",
|
||||
"description": "date de fin de validité (renseignée si l'entité est obsolete)",
|
||||
"format": "date-time"
|
||||
},
|
||||
"groupesCompetencesMobilisees": {
|
||||
"type": "array",
|
||||
"description": "Groupes de compétences mobilisées",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/GroupeCompetences"
|
||||
}
|
||||
},
|
||||
"groupesSavoirs": {
|
||||
"type": "array",
|
||||
"description": "Groupes de savoirs",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/GroupeSavoirs"
|
||||
}
|
||||
},
|
||||
"metier": {
|
||||
"$ref": "#/components/schemas/Metier"
|
||||
},
|
||||
"obsolete": {
|
||||
"type": "boolean",
|
||||
"description": "boolean définissant si l'entité est obsolete"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GroupeCompetences": {
|
||||
"type": "object",
|
||||
"description": "Groupe de compétences",
|
||||
"properties": {
|
||||
"competences": {
|
||||
"type": "array",
|
||||
"description": "Compétences rattachées. Il peut s'agir, de façon pêle-mêle, de macro-savoir-faire, de macro-savoir-êtres professionnels ou bien de compétence détaillée. Il ne peut pas y avoir de savoirs.",
|
||||
"items": {
|
||||
"oneOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/CompetenceDetaillee"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/MacroSavoirEtreProfessionnel"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/MacroSavoirFaire"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/Savoir"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"enjeu": {
|
||||
"$ref": "#/components/schemas/Enjeu"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CompetenceDetaillee": {
|
||||
"type": "object",
|
||||
"description": "Compétence détaillée (en provenance du référentiel 'Compétences').",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Competence"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Cette propriété est forcément à la valeur 'COMPETENCE-DETAILLEE'."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"Competence": {
|
||||
"type": "object",
|
||||
"description": "Compétence (en provenance du référentiel 'Compétences'). Cette entité se décompose en quatre catégories : les macro-savoir-faires, les macro-savoir-êtres professionnels, les compétences détaillées et enfin les savoirs.",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "Code unique de la compétence.",
|
||||
"example": "100007"
|
||||
},
|
||||
"libelle": {
|
||||
"type": "string",
|
||||
"description": "Libellé de la compétence.",
|
||||
"example": "Techniques de soudage"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Le type de l'objet. Il y a quatre valeurs possibles :\n<ul>\n<li>'MACRO-SAVOIR-FAIRE' pour un macro-savoir-faire</li>\n<li>'MACRO-SAVOIR-ETRE-PROFESSIONNEL' pour un macro-savoir-être professionnel</li>\n<li>'COMPETENCE-DETAILLEE' pour un compétence détaillée</li>\n<li>'SAVOIR' pour un savoir</li>\n</ul>\n"
|
||||
}
|
||||
},
|
||||
"discriminator": {
|
||||
"propertyName": "type"
|
||||
}
|
||||
},
|
||||
"MacroSavoirEtreProfessionnel": {
|
||||
"type": "object",
|
||||
"description": "Macro savoir-être professionnel (en provenance du référentiel 'Compétences').",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Competence"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Cette propriété est forcément à la valeur 'MACRO-SAVOIR-ETRE-PROFESSIONNEL'."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"MacroSavoirFaire": {
|
||||
"type": "object",
|
||||
"description": "Macro savoir-faire (en provenance du référentiel 'Compétences').",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/components/schemas/Competence"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Cette propriété est forcément à la valeur 'MACRO-SAVOIR-FAIRE'."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"Savoir": {
|
||||
"type": "object",
|
||||
"description": "Savoir (en provenance du référentiel 'Compétences').",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "Code unique de la compétence.",
|
||||
"example": "100007"
|
||||
},
|
||||
"libelle": {
|
||||
"type": "string",
|
||||
"description": "Libellé de la compétence.",
|
||||
"example": "Techniques de soudage"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Cette propriété est forcément à la valeur 'SAVOIR'."
|
||||
}
|
||||
}
|
||||
},
|
||||
"Enjeu": {
|
||||
"type": "object",
|
||||
"description": "Enjeu (en provenance du référentiel 'Compétences')",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "Code unique de l'enjeu.",
|
||||
"example": "3"
|
||||
},
|
||||
"libelle": {
|
||||
"type": "string",
|
||||
"description": "Libellé de l'enjeu.",
|
||||
"example": "Animation"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GroupeSavoirs": {
|
||||
"type": "object",
|
||||
"description": "Groupe de savoirs",
|
||||
"properties": {
|
||||
"categorieSavoirs": {
|
||||
"$ref": "#/components/schemas/CategorieSavoirs"
|
||||
},
|
||||
"savoirs": {
|
||||
"type": "array",
|
||||
"description": "Savoirs rattachés",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Savoir"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"CategorieSavoirs": {
|
||||
"type": "object",
|
||||
"description": "Catégorie de savoir (en provenance du référentiel 'Compétences')",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "Code unique de la catégorie de savoirs.",
|
||||
"example": "30"
|
||||
},
|
||||
"libelle": {
|
||||
"type": "string",
|
||||
"description": "Libellé de la catégorie de savoirs.",
|
||||
"example": "Véhicules"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Metier": {
|
||||
"type": "object",
|
||||
"description": "Métier (depuis le référentiel 'Métiers')",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "Code unique du métier.",
|
||||
"example": "A1201"
|
||||
},
|
||||
"libelle": {
|
||||
"type": "string",
|
||||
"description": "Libellé unique du métier.",
|
||||
"example": "Bûcheronnage et élagage"
|
||||
}
|
||||
}
|
||||
},
|
||||
"VersionRome": {
|
||||
"title": "VersionRome",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"version": {
|
||||
"type": "string",
|
||||
"description": "La version actuelle.",
|
||||
"example": "19"
|
||||
},
|
||||
"lastModifiedDate": {
|
||||
"type": "string",
|
||||
"description": "La date de dernière modification de la version.",
|
||||
"format": "date-time"
|
||||
}
|
||||
},
|
||||
"description": "Version du rome"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
4015
backend/api/rome_4_metiers.json
Normal file
4015
backend/api/rome_4_metiers.json
Normal file
File diff suppressed because it is too large
Load diff
358
backend/api/rome_4_situations_de_travail.json
Normal file
358
backend/api/rome_4_situations_de_travail.json
Normal file
|
|
@ -0,0 +1,358 @@
|
|||
{
|
||||
"openapi": "3.0.1",
|
||||
"info": {
|
||||
"version": "1",
|
||||
"title": "ROME V4.0 - Situations de travail",
|
||||
"description": " Référentiel des environnements dans lequel une personne exerce son travail.<br/> Le contexte de travail englobe les différents éléments physiques, organisationnels et sociaux qui influencent les tâches, les activités et les interactions professionnelles. Il permet de mieux caractériser l’emploi à pourvoir (avantages et contraintes du poste proposé) et réduire les « échecs » de recrutement liés aux conditions de travail.<br/> Le référentiel des contextes de travail se décline en 6 rubriques : Conditions de travail et risques professionnels, Horaires et durées de travail, Lieux et déplacements, Statut d'emploi, Publics spécifiques et Types de structure d’accueil. \r\n\r\n**Scopes** : `api_rome-contextes-travailv1`,`nomenclatureRome`\r\n\r\n**Royaume** : `/partenaire`"
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/rome-contextes-travail"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/v1/situations-travail/contexte-travail": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Contexte de travail"
|
||||
],
|
||||
"summary": "Lister les contextes de travail",
|
||||
"description": "Permet de lister les contextes de travail.\r\n\r\nSi vous renseignez une ou plusieurs valeurs dans \"champs\", alors vous obtiendrez le résultat pour ces champs.\r\n\r\nSi vous ne renseignez aucune valeur dans \"champs\", alors vous obtiendrez le résultat par défaut. (Sélectionner l'exemple \"***Par défaut***\" pour voir les données retournées)",
|
||||
"operationId": "listerContextesTravail",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "champs",
|
||||
"in": "query",
|
||||
"description": "Sélecteur de champs : il est possible de paramétrer le retour de la requête en définissant les champs souhaités (liste exhaustive des champs possibles : `Allowed values`). <br/> Vous pouvez vous aider des exemples de réponse pour identifier les champs que vous voulez récupérer.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"categorie",
|
||||
"code",
|
||||
"libelle"
|
||||
],
|
||||
"example": "libelle,code,categorie"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer 72xlz9Ri8sUL-EK2Bkbr5Uqk498"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Retourne la liste des contextes de travail.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/ContexteTravail"
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"Retour complet": {
|
||||
"value": [
|
||||
{
|
||||
"libelle": "En club sportif",
|
||||
"code": "403091",
|
||||
"categorie": "CONDITIONS_TRAVAIL"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Retour par défaut": {
|
||||
"value": [
|
||||
{
|
||||
"libelle": "En club sportif",
|
||||
"code": "403091",
|
||||
"categorie": "CONDITIONS_TRAVAIL"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request : peut-être causé par un sélecteur de champs incorrect.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"message": "L'attribut 'monAttribut' n'est pas selectionnable",
|
||||
"codeMetier": "SELECTOR",
|
||||
"service": "/v1/mon_uri",
|
||||
"code": 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [],
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/rome-contextes-travail",
|
||||
"description": "PROD"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/situations-travail/contexte-travail/{code}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Contexte de travail"
|
||||
],
|
||||
"summary": "Lire un contexte de travail",
|
||||
"description": "Permet de lire un contexte de travail depuis son code.\r\n\r\nSi vous renseignez une ou plusieurs valeurs dans \"champs\", alors vous obtiendrez le résultat pour ces champs.\r\n\r\nSi vous ne renseignez aucune valeur dans \"champs\", alors vous obtiendrez le résultat par défaut. (Sélectionner l'exemple \"***Par défaut***\" pour voir les données retournées)",
|
||||
"operationId": "lireContexteTravail",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "champs",
|
||||
"in": "query",
|
||||
"description": "Sélecteur de champs : il est possible de paramétrer le retour de la requête en définissant les champs souhaités (liste exhaustive des champs possibles : `Allowed values`). <br/> Vous pouvez vous aider des exemples de réponse pour identifier les champs que vous voulez récupérer.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"categorie",
|
||||
"code",
|
||||
"libelle"
|
||||
],
|
||||
"example": "libelle,code,categorie"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "code",
|
||||
"in": "path",
|
||||
"description": "Code du contexte de travail.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer 72xlz9Ri8sUL-EK2Bkbr5Uqk498"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Retourne les données pour un contexte de travail renseigné.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ContexteTravail"
|
||||
},
|
||||
"examples": {
|
||||
"Retour complet": {
|
||||
"value": {
|
||||
"libelle": "En club sportif",
|
||||
"code": "403091",
|
||||
"categorie": "CONDITIONS_TRAVAIL"
|
||||
}
|
||||
},
|
||||
"Retour par défaut": {
|
||||
"value": {
|
||||
"libelle": "En club sportif",
|
||||
"code": "403091",
|
||||
"categorie": "CONDITIONS_TRAVAIL"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request : peut-être causé par un sélecteur de champs incorrect.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"message": "L'attribut 'monAttribut' n'est pas selectionnable",
|
||||
"codeMetier": "SELECTOR",
|
||||
"service": "/v1/mon_uri",
|
||||
"code": 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not found.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"service": "/v1/mon_uri",
|
||||
"message": "Code inexistant: monCode",
|
||||
"code": 404
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [],
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/rome-contextes-travail",
|
||||
"description": "PROD"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/situations-travail/version": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Versionning du ROME"
|
||||
],
|
||||
"summary": "Récupérer la version actuelle du ROME",
|
||||
"description": "Récupère la version actuelle du ROME.",
|
||||
"operationId": "lireVersion",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "champs",
|
||||
"in": "query",
|
||||
"description": "Sélecteur de champs : il est possible de paramétrer le retour de la requête en définissant les champs souhaités (liste exhaustive des champs possibles : `Allowed values`). <br/> Vous pouvez vous aider des exemples de réponse pour identifier les champs que vous voulez récupérer.",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"version",
|
||||
"lastModifiedDate",
|
||||
"version,lastModifiedDate"
|
||||
],
|
||||
"example": "version,lastModifiedDate"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer 72xlz9Ri8sUL-EK2Bkbr5Uqk498"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/VersionRome"
|
||||
},
|
||||
"examples": {
|
||||
"Retour complet": {
|
||||
"value": {
|
||||
"version": "19",
|
||||
"lastModifiedDate": "2025-05-22T12:04:43.281Z"
|
||||
}
|
||||
},
|
||||
"Retour par défaut": {
|
||||
"value": {
|
||||
"version": "19",
|
||||
"lastModifiedDate": "2025-05-22T12:04:43.281Z"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad request : peut-être causé par un sélecteur de champs incorrect",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"examples": {
|
||||
"default": {
|
||||
"value": {
|
||||
"message": "L'attribut 'monAttribut' n'est pas selectionnable",
|
||||
"codeMetier": "SELECTOR",
|
||||
"service": "/v1/mon_uri",
|
||||
"code": 400
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/rome-contextes-travail",
|
||||
"description": "PROD"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"ContexteTravail": {
|
||||
"type": "object",
|
||||
"description": "Contexte de travail",
|
||||
"properties": {
|
||||
"categorie": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"CONDITIONS_TRAVAIL",
|
||||
"TYPE_BENEFICIAIRE",
|
||||
"LIEU_ET_DEPLACEMENT",
|
||||
"HORAIRE_ET_DUREE_TRAVAIL",
|
||||
"TYPE_STRUCTURE_ACCUEIL",
|
||||
"STATUT_EMPLOI"
|
||||
],
|
||||
"description": "Catégorie de contexte de travail.",
|
||||
"example": "CONDITIONS_TRAVAIL"
|
||||
},
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "Code unique du contexte de travail.",
|
||||
"example": "403091"
|
||||
},
|
||||
"libelle": {
|
||||
"type": "string",
|
||||
"description": "Libellé du contexte de travail.",
|
||||
"example": "En club sportif"
|
||||
}
|
||||
}
|
||||
},
|
||||
"VersionRome": {
|
||||
"title": "VersionRome",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"version": {
|
||||
"type": "string",
|
||||
"description": "La version actuelle.",
|
||||
"example": "19"
|
||||
},
|
||||
"lastModifiedDate": {
|
||||
"type": "string",
|
||||
"description": "La date de dernière modification de la version.",
|
||||
"format": "date-time"
|
||||
}
|
||||
},
|
||||
"description": "Version du rome"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
811
backend/api/romeo_v2.json
Normal file
811
backend/api/romeo_v2.json
Normal file
|
|
@ -0,0 +1,811 @@
|
|||
{
|
||||
"openapi": "3.0.3",
|
||||
"info": {
|
||||
"version": "2.0",
|
||||
"title": "Romeo",
|
||||
"description": "Utilisez l’IA afin de vous aider à rapprocher un texte libre à une appellation ou à un savoir / savoir-faire du Répertoire Opérationnel des Métiers et des Emplois (ROME).\r\n\r\n***Scope :*** `api_romeov2`\r\n\r\n***Royaume :*** `/partenaire`"
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/romeo/v2",
|
||||
"description": "PROD"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/performancePredictionCompetences": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Competence"
|
||||
],
|
||||
"summary": "Renvoyez-nous votre feedback pour permettre l'amélioration du modèle IA",
|
||||
"description": "Cette ressource vous permet de nous envoyer votre feedback par rapport à la prédiction faite par l'IA. Cette information est importante pour mesurer la performance du modèle IA, pour améliorer la qualité des prédictions et délivrer un service de qualité.",
|
||||
"operationId": "Renvoyez-nous votre feedback pour permettre l'amélioration du modèle IA",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PerformanceCompetenceDTO"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"performanceCompetence": [
|
||||
{
|
||||
"uuidInference": "b42110bb-3d55-4e92-9930-133c5d92a555",
|
||||
"bonnePrediction": true,
|
||||
"codeCompetence": "101846"
|
||||
}
|
||||
],
|
||||
"optionsSupervision": {
|
||||
"nomAppelant": "francetravail"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "En cas de succès à l'appel API, cette dernière renvoie un code http : 200 OK ",
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ExceptionPerformanceCompetence"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"uuidInference": "b42110bb-3d55-4e92-9930-133c5d92a555"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "En cas de réponse 400, veuillez vous référer à l'erreur mentionnée dans l'objet message.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"classeOrigine": "fr.pe.empl.service.so072.exceptions.RomeoBadRequestException",
|
||||
"codeErreur": "J072000G",
|
||||
"codeHttp": 400,
|
||||
"message": "Le champ optionsSupervision.nomAppelant est obligatoire"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Erreur serveur."
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/romeo/v2",
|
||||
"description": ""
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer SR-QkBNyazIvwyry39FxlZ7BMw4"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/performancePredictionMetiers": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Appellation"
|
||||
],
|
||||
"summary": "Renvoyez-nous votre feedback pour permettre l'amélioration du modèle IA",
|
||||
"description": "Cette ressource vous permet de nous envoyer votre feedback par rapport à la prédiction faite par l'IA. Cette information est importante pour mesurer la performance du modèle IA, pour améliorer la qualité des prédictions et délivrer un service de qualité.",
|
||||
"operationId": "Renvoyez-nous votre feedback pour permettre l amélioration du modèle IA",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PerformanceAppellationDTO"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"performanceAppellation": [
|
||||
{
|
||||
"uuidInference": "93f7f573-da71-4382-94c7-e21db9c9a30f",
|
||||
"bonnePrediction": true,
|
||||
"codeAppellation": "11564"
|
||||
}
|
||||
],
|
||||
"optionsSupervision": {
|
||||
"nomAppelant": "francetravail"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ExceptionPerformanceAppellation"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"uuidInference": "b42110bb-3d55-4e92-9930-133c5d92a555"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "En cas de réponse 400, veuillez vous référer à l'erreur mentionnée dans l'objet message.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"classeOrigine": "fr.pe.empl.service.so072.exceptions.RomeoBadRequestException",
|
||||
"codeErreur": "J072000G",
|
||||
"codeHttp": 400,
|
||||
"message": "Le champ optionsSupervision.nomAppelant est obligatoire"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Erreur serveur."
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/romeo/v2",
|
||||
"description": ""
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer SR-QkBNyazIvwyry39FxlZ7BMw4"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/predictionCompetences": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Competence"
|
||||
],
|
||||
"summary": "Prédiction des savoirs / savoir-faire du ROME",
|
||||
"description": "Obtenez le savoir / savoir-faire du ROME le plus proche à partir d’un texte libre renseigné.\r\n\r\n\r\n\r\nCas d'usage possibles :\r\n\r\n- Rapprocher une compétence d’un CV à des savoirs / savoir-faire du ROME 4.0\r\n\r\n- Rapprocher une compétence d’un référentiel extérieure à des savoirs / savoir-faire du ROME 4.0\r\n\r\n\r\n\r\nLes bonnes pratiques pour utiliser /PredictionCompetences\r\n\r\nSi votre texte contient plusieurs compétences libres, /PredictionCompetences ne pourra pas les séparer pour ensuite les associer au ROME de façon individuelle. Il est préférable de fournir un texte contenant une seule compétence libre.\r\n\r\nUtiliser /performancePredictionCompetences pour nous aider à améliorer notre modèle IA (cf. ressource ci-dessous : /performancePredictionCompetences - Renvoyez-nous votre feedback pour permettre l'amélioration du modèle IA).",
|
||||
"operationId": "Prédiction des savoirs / savoir-faire du ROME",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/CompetenceDTO"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"competences": [
|
||||
{
|
||||
"intitule": "faire du pain",
|
||||
"identifiant": "123456"
|
||||
}
|
||||
],
|
||||
"options": {
|
||||
"nomAppelant": "francetravail",
|
||||
"nbResultats": 2,
|
||||
"seuilScorePrediction": 0.7
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/PredictionCompetence"
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": [
|
||||
{
|
||||
"uuidInference": "93f7f573-da71-4382-94c7-e21db9c9a30f",
|
||||
"identifiant": "123456",
|
||||
"intitule": "faire du pain",
|
||||
"competencesRome": [
|
||||
{
|
||||
"libelleCompetence": "Fabriquer des produits de boulangerie",
|
||||
"codeCompetence": "119357",
|
||||
"typeCompetence": "COMPETENCE-DETAILLEE",
|
||||
"scorePrediction": 0.8
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "En cas de réponse 400, veuillez vous référer à l'erreur mentionnée dans l'objet message.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"classeOrigine": "fr.pe.empl.service.so072.exceptions.RomeoBadRequestException",
|
||||
"codeErreur": "J072000G",
|
||||
"codeHttp": 400,
|
||||
"message": "Le champ optionsSupervision.nomAppelant est obligatoire"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Erreur serveur."
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/romeo/v2",
|
||||
"description": ""
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer SR-QkBNyazIvwyry39FxlZ7BMw4"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/predictionMetiers": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Appellation"
|
||||
],
|
||||
"summary": "Prédiction des appellations métier du ROME",
|
||||
"description": "Obtenez l‘appellation métier du ROME la plus proche à partir d’un texte libre renseigné.\r\n\r\n\r\n\r\nCas d'usage possibles\r\n- Rapprocher un intitulé d’offre d’emploi à des appellations métier du ROME 4.0\r\n- Rapprocher un intitulé d’expérience d’un CV à des appellations métier du ROME 4.0\r\n\r\nLes bonnes pratiques pour utiliser /predictionMetiers\r\n- Un texte court augmente la pertinence des prédictions (évitez les textes longs).\r\n- Si le texte à rapprocher du ROME est peu explicite, précisez le champ \"contexte\" pour faciliter la prédiction de /PredictionMetiers (par exemple, l’intitulé \"conseiller\" peut se décliner en plusieurs appellations métier telles que \"conseiller en immobilier\" ou \"conseiller à l'emploi« , en précisant le champ contexte vous vous assurez d’une prédiction plus cohérente).\r\n- Il n'est pas possible de prédire plus de 20 intitulés par appel.\r\nUtiliser /performancePredictionMetiers pour nous aider à améliorer notre modèle IA.",
|
||||
"operationId": "Prédiction des appellations métier du ROME",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/AppellationDTO"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"appellations": [
|
||||
{
|
||||
"intitule": "Boucher",
|
||||
"identifiant": "123456",
|
||||
"contexte": "Commerce de détail de viandes et de produits à base de viande en magasin spécialisé"
|
||||
}
|
||||
],
|
||||
"options": {
|
||||
"nomAppelant": "francetravail",
|
||||
"nbResultats": 2,
|
||||
"seuilScorePrediction": 0.7
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "En cas de succès à l'appel API, cette dernière renvoie un code http : 200 OK ",
|
||||
"content": {
|
||||
"application/json; charset=utf-8": {
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/PredictionAppellation"
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": [
|
||||
{
|
||||
"metiersRome": [
|
||||
{
|
||||
"libelleAppellation": "Boucher / Bouchère",
|
||||
"codeAppellation": "11564",
|
||||
"libelleRome": "Boucherie",
|
||||
"codeRome": "D1101",
|
||||
"scorePrediction": 0.75
|
||||
}
|
||||
],
|
||||
"uuidInference": "bca57776-9e3f-4c72-b939-8a48cd87ff6e",
|
||||
"identifiant": "123456",
|
||||
"intitule": "boucher",
|
||||
"contexte": "Commerce de détail de viandes et de produits à base de viande en magasin spécialisé"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "En cas de réponse 400, veuillez vous référer à l'erreur mentionnée dans l'objet message.",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object"
|
||||
},
|
||||
"examples": {
|
||||
"Example 1": {
|
||||
"value": {
|
||||
"classeOrigine": "fr.pe.empl.service.so072.exceptions.RomeoBadRequestException",
|
||||
"codeErreur": "J072000G",
|
||||
"codeHttp": 400,
|
||||
"message": "Le champ optionsSupervision.nomAppelant est obligatoire"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"500": {
|
||||
"description": "Erreur serveur."
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "https://api.francetravail.io/partenaire/romeo/v2",
|
||||
"description": ""
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "Authorization",
|
||||
"in": "header",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"default": "Bearer SR-QkBNyazIvwyry39FxlZ7BMw4"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
{
|
||||
"name": "Appellation",
|
||||
"description": "Prédictions sur les appellations"
|
||||
},
|
||||
{
|
||||
"name": "Competence",
|
||||
"description": "Prédictions sur les compétences"
|
||||
}
|
||||
],
|
||||
"components": {
|
||||
"schemas": {
|
||||
"PerformanceCompetenceDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"performanceCompetence": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/PerformanceCompetence"
|
||||
}
|
||||
},
|
||||
"optionsSupervision": {
|
||||
"$ref": "#/components/schemas/OptionsSupervision"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PerformanceCompetence": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"uuidInference": {
|
||||
"type": "string",
|
||||
"description": "Identifiant unique de l'inférence renvoyé par l'API.",
|
||||
"example": "b42110bb-3d55-4e92-9930-133c5d92a555"
|
||||
},
|
||||
"bonnePrediction": {
|
||||
"type": "boolean",
|
||||
"enum": [
|
||||
true,
|
||||
false
|
||||
],
|
||||
"description": "- True : la prédiction est correcte\r\n- False : la prédiction est fausse "
|
||||
},
|
||||
"codeCompetence": {
|
||||
"type": "string",
|
||||
"description": "- Si \"bonneprediction\" est true : veuillez renseigner le code OGR du savoir / savoir-faire prédit par l'IA qui a été sélectionné\r\n- Si \"bonneprediction\" est false : veuillez renseigner le code OGR du savoir / savoir-faire que vous auriez souhaité avoir",
|
||||
"example": "101846"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"uuidInference",
|
||||
"bonnePrediction"
|
||||
]
|
||||
},
|
||||
"OptionsSupervision": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"nomAppelant": {
|
||||
"type": "string",
|
||||
"description": "Nom de l'application partenaire ou du partenaire appelant la ressource",
|
||||
"example": "francetravail"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"nomAppelant"
|
||||
]
|
||||
},
|
||||
"ExceptionPerformanceCompetence": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"uuidInference": {
|
||||
"type": "string",
|
||||
"description": "identifiant unique de l'inférence, utile pour l'appel à la ressource performancePredicitonCompetences",
|
||||
"example": "b42110bb-3d55-4e92-9930-133c5d92a555"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"uuidInference"
|
||||
]
|
||||
},
|
||||
"PerformanceAppellationDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"performanceAppellation": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/PerformanceAppellation"
|
||||
}
|
||||
},
|
||||
"optionsSupervision": {
|
||||
"$ref": "#/components/schemas/OptionsSupervision"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PerformanceAppellation": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"uuidInference": {
|
||||
"type": "string",
|
||||
"description": "Identifiant unique de l'inférence renvoyé par l'API.",
|
||||
"example": "93f7f573-da71-4382-94c7-e21db9c9a30f"
|
||||
},
|
||||
"bonnePrediction": {
|
||||
"type": "boolean",
|
||||
"enum": [
|
||||
true,
|
||||
false
|
||||
],
|
||||
"description": "- True : la prédiction est correcte\r\n- False : la prédiction est fausse "
|
||||
},
|
||||
"codeAppellation": {
|
||||
"type": "string",
|
||||
"description": "- Si \"bonneprediction\" est true : veuillez renseigner le code OGR de l'appellation métier prédite par l'IA qui a été sélectionnée\r\n- Si \"bonneprediction\" est false : veuillez renseigner le code OGR de l'appellation métier que vous auriez souhaité avoir",
|
||||
"example": "11564"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"uuidInference",
|
||||
"bonnePrediction"
|
||||
],
|
||||
"x-examples": {
|
||||
"Example 1": {
|
||||
"uuidInference": "string",
|
||||
"bonnePrediction": true,
|
||||
"codeAppellation": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ExceptionPerformanceAppellation": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"uuidInference": {
|
||||
"type": "string",
|
||||
"example": "b42110bb-3d55-4e92-9930-133c5d92a555"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CompetenceDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"competences": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Competence"
|
||||
}
|
||||
},
|
||||
"options": {
|
||||
"$ref": "#/components/schemas/Options"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Competence": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"intitule": {
|
||||
"type": "string",
|
||||
"description": "Texte libre pour lequel on souhaite prédire un savoir / savoir-faire du ROME (par exemple une compétence d'un CV)\r\n",
|
||||
"example": "faire du pain"
|
||||
},
|
||||
"identifiant": {
|
||||
"type": "string",
|
||||
"description": "Identifiant fonctionnel unique, clé permettant d'identifier l'intitulé à prédire dans la liste fournie en entrée du service.\r\n\r\nCet identifiant est à la main du service appelant, il permet de rapprocher l'intitulé envoyé avec la prédiction retournée.",
|
||||
"example": "123456"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"intitule",
|
||||
"identifiant"
|
||||
]
|
||||
},
|
||||
"Options": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"nomAppelant": {
|
||||
"type": "string",
|
||||
"description": "Nom de l'application partenaire ou du partenaire appelant la ressource",
|
||||
"example": "francetravail"
|
||||
},
|
||||
"nbResultats": {
|
||||
"type": "integer",
|
||||
"description": "nombre de prédictions à retourner\r\n\r\n- entier compris entre 1 et 25\r\n\r\n- par défaut, retourne 5 résultats",
|
||||
"format": "int32",
|
||||
"example": 2
|
||||
},
|
||||
"seuilScorePrediction": {
|
||||
"type": "number",
|
||||
"description": "Niveau de confiance de l'IA accompagnant chaque prédiction. Plus le score est proche de 1, plus l’IA est confiante dans sa prédiction. \r\n\r\nSi un seuil est défini, il prévaut sur le nombre de résultats qui a été renseigné",
|
||||
"format": "float",
|
||||
"example": 0.7
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"nomAppelant"
|
||||
]
|
||||
},
|
||||
"PredictionCompetence": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"uuidInference": {
|
||||
"type": "string",
|
||||
"description": "identifiant unique de l'inférence, utile pour l'appel à la ressource performancePredicitonCompetences",
|
||||
"example": "93f7f573-da71-4382-94c7-e21db9c9a30f"
|
||||
},
|
||||
"identifiant": {
|
||||
"type": "string",
|
||||
"description": "Identifiant fonctionnel unique, clé permettant d'identifier l'intitulé à prédire dans la liste fournie en entrée du service.\r\n\r\nCet identifiant est à la main du service appelant, il permet de rapprocher l'intitulé envoyé avec la prédiction retournée.",
|
||||
"example": "123456"
|
||||
},
|
||||
"intitule": {
|
||||
"type": "string",
|
||||
"description": "Texte libre renseigné lors de l'appel à l'API et pour lequel on souhaite prédire un savoir / savoir-faire du ROME",
|
||||
"example": "faire du pain"
|
||||
},
|
||||
"competencesRome": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/CompetenceRome"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"uuidInference",
|
||||
"identifiant",
|
||||
"intitule"
|
||||
],
|
||||
"x-examples": {}
|
||||
},
|
||||
"CompetenceRome": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"libelleCompetence": {
|
||||
"type": "string",
|
||||
"description": "Libellé du savoir / savoir-faire du ROME prédit",
|
||||
"example": "Fabriquer des produits de boulangerie"
|
||||
},
|
||||
"codeCompetence": {
|
||||
"type": "string",
|
||||
"description": "Code du savoir / savoir-faire du ROME prédit",
|
||||
"example": "119357"
|
||||
},
|
||||
"typeCompetence": {
|
||||
"type": "string",
|
||||
"description": "Type du savoir / savoir-faire du ROME prédit (savoir, compétence, macro-compétence)",
|
||||
"example": "COMPETENCE-DETAILLEE"
|
||||
},
|
||||
"scorePrediction": {
|
||||
"type": "number",
|
||||
"description": "Score de confiance de l'IA suite à sa prédiction (plus on est proche de 1 plus l'IA est confiante)",
|
||||
"format": "float",
|
||||
"example": 0.8
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"libelleCompetence",
|
||||
"codeCompetence",
|
||||
"typeCompetence",
|
||||
"scorePrediction"
|
||||
],
|
||||
"x-examples": {
|
||||
"Example 1": {
|
||||
"libelleCompetence": "Utiliser les réseaux sociaux",
|
||||
"codeCompetence": "300425",
|
||||
"typeCompetence": "MACRO-SAVOIR-FAIRE",
|
||||
"scorePrediction": 0.8682828
|
||||
}
|
||||
}
|
||||
},
|
||||
"AppellationDTO": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"appellations": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Appellation"
|
||||
}
|
||||
},
|
||||
"options": {
|
||||
"$ref": "#/components/schemas/Options"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Appellation": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"intitule": {
|
||||
"type": "string",
|
||||
"description": "Texte libre pour lequel on souhaite prédire un métier (par exemple l'intitulé d'une offre d'emploi). Pour rappel, il n'est pas possible de prédire plus de 20 intitulés par appel.",
|
||||
"example": "Boucher"
|
||||
},
|
||||
"identifiant": {
|
||||
"type": "string",
|
||||
"description": "Identifiant fonctionnel unique, clé permettant d'identifier l'intitulé à prédire dans la liste fournie en entrée du service.\r\n\r\nCet identifiant est à la main du service appelant, il permet de rapprocher l'intitulé envoyé avec la prédiction retournée.",
|
||||
"example": "123456"
|
||||
},
|
||||
"contexte": {
|
||||
"type": "string",
|
||||
"description": "aide l'IA à trouver la prédiction la plus pertinente en précisant le secteur d’activité. Ce contexte peut être décliné sous 3 formes :\r\n\r\n- un libellé NAF (INSEE)\r\n- un code SIRET (nous récupérons le libellé NAF associé à ce code)\r\n- un texte libre\r\n\r\nSi le texte à rapprocher du ROME est peu explicite, précisez le champ \"contexte\" pour faciliter la prédiction de Text2App (par exemple, l’intitulé \"conseiller\" peut se décliner en plusieurs appellations métier telles que \"conseiller en immobilier\" ou \"conseiller à l'emploi« , en précisant le champ contexte vous vous assurez d’une prédiction plus cohérente).",
|
||||
"example": "Commerce de détail de viandes et de produits à base de viande en magasin spécialisé"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"intitule",
|
||||
"identifiant"
|
||||
],
|
||||
"x-examples": {
|
||||
"Example 1": "Body\n{ \"appellations\": [ { \"intitule\": \"boucher\", \"contexte\": \"grande surface\", \"identifiant\": \"123456\" } ], \"options\": { \"nomAppelant\": \"Application n°1\", \"nbResultats\": 1, \"seuilScorePrediction\": \"\" } }"
|
||||
}
|
||||
},
|
||||
"PredictionAppellation": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"metiersRome": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/AppellationRome"
|
||||
}
|
||||
},
|
||||
"uuidInference": {
|
||||
"type": "string",
|
||||
"description": "Identifiant unique de l'inférence, utile pour l'appel à la ressource performancePredicitonMetiers",
|
||||
"example": "bca57776-9e3f-4c72-b939-8a48cd87ff6e"
|
||||
},
|
||||
"identifiant": {
|
||||
"type": "string",
|
||||
"description": "Identifiant fonctionnel unique, clé permettant d'identifier l'intitulé à prédire dans la liste fournie en entrée du service. Cet identifiant est à la main du service appelant, il permet de rapprocher l'intitulé envoyé avec la prédiction retournée.",
|
||||
"example": "123456"
|
||||
},
|
||||
"intitule": {
|
||||
"type": "string",
|
||||
"description": "Texte libre renseigné lors de l'appel à l'API et pour lequel on souhaite prédire un métier du ROME (par exemple l'intitulé d'une offre d'emploi).\nPour rappel, il n'est pas possible de prédire plus de 20 intitulés par appel.",
|
||||
"example": "boucher"
|
||||
},
|
||||
"contexte": {
|
||||
"type": "string",
|
||||
"description": "Contexte renseigné lors de l'appel à l'API afin de prédire un métier du ROME",
|
||||
"example": "Commerce de détail de viandes et de produits à base de viande en magasin spécialisé"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"uuidInference",
|
||||
"identifiant",
|
||||
"intitule",
|
||||
"contexte"
|
||||
]
|
||||
},
|
||||
"AppellationRome": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"libelleAppellation": {
|
||||
"type": "string",
|
||||
"description": "Libellé de l'appellation métier du ROME prédite",
|
||||
"example": "Boucher / Bouchère"
|
||||
},
|
||||
"codeAppellation": {
|
||||
"type": "string",
|
||||
"description": "Code de l'appellation métier ROME prédite",
|
||||
"example": "11564"
|
||||
},
|
||||
"libelleRome": {
|
||||
"type": "string",
|
||||
"description": "Libellé de la fiche ROME parente",
|
||||
"example": "Boucherie"
|
||||
},
|
||||
"codeRome": {
|
||||
"type": "string",
|
||||
"description": "Code ROME de la fiche parente",
|
||||
"example": "D1101"
|
||||
},
|
||||
"scorePrediction": {
|
||||
"type": "number",
|
||||
"description": "Score de confiance de l'IA suite à sa prédiction (plus on est proche de 1 plus l'IA est confiante)",
|
||||
"format": "float",
|
||||
"example": 0.75
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"libelleAppellation",
|
||||
"codeAppellation",
|
||||
"libelleRome",
|
||||
"codeRome",
|
||||
"scorePrediction"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
2781
backend/api/sortants_de_formation_et_acces_a_lemploi_bundled.json
Normal file
2781
backend/api/sortants_de_formation_et_acces_a_lemploi_bundled.json
Normal file
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue