commit 71d8607399d5152fd8173727fb0a56efb05173f8 Author: el Date: Wed Jun 11 17:46:41 2025 +0200 first commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..253ad7c --- /dev/null +++ b/README.md @@ -0,0 +1,119 @@ +# Emploi_IA + +![Version](https://img.shields.io/badge/version-1.0.0-blue.svg) +![Statut du Projet](https://img.shields.io/badge/statut-En%20D%C3%A9veloppement-orange.svg) +[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) --- + +## 🚀 Vue d'Ensemble du Projet + +**Emploi_IA** est une plateforme web intelligente et innovante dĂ©diĂ©e Ă  la **recherche d'emploi et Ă  l'Ă©volution professionnelle en France**. PropulsĂ©e par l'intelligence artificielle et enrichie par l'intĂ©gration des **APIs officielles de France Travail** (anciennement PĂŽle Emploi) et d'autres partenaires, Emploi_IA a pour mission de simplifier, personnaliser et dynamiser le parcours de chaque professionnel. + +InspirĂ©e par les principes de simplicitĂ© et d'efficacitĂ© de **Google Careers**, notre plateforme vise Ă  fournir des **matchs emploi-profil pertinents**, des **insights prĂ©cis sur le marchĂ© du travail** et des **conseils proactifs** pour une prise de dĂ©cision Ă©clairĂ©e. + +--- + +## ✹ FonctionnalitĂ©s ClĂ©s (MVP et au-delĂ ) + +* **Recherche d'Offres Intelligente :** Trouvez rapidement les offres d'emploi les plus pertinentes grĂące Ă  des filtres avancĂ©s et une recherche par mots-clĂ©s/localisation. +* **Matching IA PersonnalisĂ© :** Un moteur d'intelligence artificielle analyse votre profil (compĂ©tences, mĂ©tiers ROME) et les offres pour vous proposer les meilleures correspondances avec un indicateur de pertinence clair. +* **Profil Utilisateur Enrichi :** GĂ©rez vos compĂ©tences, vos expĂ©riences et vos prĂ©fĂ©rences pour une personnalisation accrue des recommandations. +* **Outils d'Aide Ă  la Candidature :** GĂ©nĂ©ration de lettres de motivation, mise en favoris d'offres. +* **Insights MarchĂ© (Phases futures) :** AccĂ©dez Ă  des donnĂ©es statistiques sur l'emploi, les mĂ©tiers en tension et les entreprises qui recrutent. +* **Orientation et Formation (Phases futures) :** Suggestions de formations et de parcours de carriĂšre basĂ©s sur l'analyse de vos compĂ©tences et du marchĂ©. + +--- + +## đŸ› ïž Technologies & IntĂ©grations + +### Stack Technique : + +### Stack Technique : + +* **Backend :** **Python 🐍 (avec FastAPI)** + * *Pourquoi ce choix :* Python est le langage de prĂ©dilection pour l'**intĂ©gration, l'orchestration et l'exploitation de services d'intelligence artificielle externes** (comme les APIs de Mistral et Google Gemini) ainsi que pour la **gestion et le traitement de donnĂ©es complexes**. C'est crucial pour notre moteur de matching, l'analyse des rĂ©fĂ©rentiels ROME, la gĂ©nĂ©ration de contenu, et l'exploitation des APIs de France Travail. FastAPI, un framework Python moderne et performant, nous permet de construire des APIs rapides et robustes, avec une excellente gestion de l'asynchronisme. Cette combinaison garantit une solution Ă©volutive, maintenable et "future-proof", capable de gĂ©rer efficacement les interactions avec de multiples services IA et de traiter de grands volumes de donnĂ©es. +* **Base de DonnĂ©es :** PostgreSQL (pour sa robustesse, sa scalabilitĂ© et son support natif des donnĂ©es structurĂ©es/JSON). +* **Frontend :** **React ⚛** + * *Pourquoi ce choix :* React, dĂ©veloppĂ© par Meta (Facebook), est le framework JavaScript le plus largement adoptĂ© et le plus populaire pour la construction d'interfaces utilisateur interactives et performantes. Son approche par composants, sa flexibilitĂ© et son immense Ă©cosystĂšme de librairies et d'outils garantissent une capacitĂ© Ă  crĂ©er une expĂ©rience utilisateur fluide et intuitive, tout en assurant la scalabilitĂ© et la maintenabilitĂ© du code. C'est un choix solide et "future-proof" pour une application web moderne et ambitieuse comme Emploi_IA, offrant Ă©galement un trĂšs vaste bassin de talents pour le dĂ©veloppement et une forte communautĂ©. +### APIs IntĂ©grĂ©es (France Travail et Partenaires) : + +Emploi_IA s'appuie sur une intĂ©gration profonde avec les APIs suivantes pour offrir des donnĂ©es fiables et Ă  jour : + +* `Offres d'emploi` +* `ROME 4.0 (MĂ©tiers, CompĂ©tences, Situations de travail, Fiches ROME)` +* `Romeo` (Moteur d'IA) +* `La Bonne BoĂźte` +* `MarchĂ© du travail` +* `Open formation` +* `Sortants de formation et accĂšs Ă  l'emploi` +* `Mes Ă©vĂšnements France Travail` +* Et bientĂŽt l'intĂ©gration **SSO France Travail** pour une connexion simplifiĂ©e ! + +--- + +## 📂 Structure du Projet + +Le dĂ©pĂŽt est organisĂ© de maniĂšre claire pour faciliter la navigation et la collaboration : + +* `./docs/` : Contient toute la documentation du projet. + * `./docs/api/` : SpĂ©cifications OpenAPI/Swagger de toutes les APIs France Travail utilisĂ©es (`.json`). + * `./docs/ROADMAP.md` : La feuille de route dĂ©taillĂ©e du projet, dĂ©crivant les phases de dĂ©veloppement. + * `./docs/PRD.md` : Le Product Requirements Document, dĂ©taillant les exigences fonctionnelles et non-fonctionnelles. +* `./src/` : Le dossier principal du code source de l'application (ou d'autres dossiers comme `backend/`, `frontend/` selon l'architecture). +* `./README.md` : Ce document, prĂ©sentant une vue d'ensemble du projet. + +--- + +## đŸ€ Contribution (À Venir) + +Nous sommes ouverts aux contributions ! Si vous souhaitez participer au dĂ©veloppement d'Emploi_IA, veuillez consulter nos futures directives de contribution. + +--- + +## 🚀 Lancement Local (Pour les DĂ©veloppeurs) + +Pour lancer le projet en local : + +1. **Cloner le dĂ©pĂŽt :** + ```bash + git clone [https://git.wilmoredynamics.com/ab/emploi_ia.git) + cd emploi_ia + ``` +2. **Configuration des APIs :** + * Assurez-vous d'avoir obtenu les clĂ©s d'accĂšs aux APIs France Travail. + * CrĂ©ez un fichier `.env` Ă  la racine du projet et ajoutez vos clĂ©s API (voir `/.env.example` pour un template). +3. **Installation des dĂ©pendances :** + ```bash + # Pour le backend (Python avec FastAPI) + cd backend # Adaptez le chemin si votre backend est dans un sous-dossier comme 'backend/' + pip install -r requirements.txt + cd .. + + # Pour le frontend (React) + cd frontend # Adaptez le chemin si votre frontend est dans un sous-dossier comme 'frontend/' + npm install # ou yarn install + cd .. + ``` +4. **Lancer l'application :** + ```bash + # Pour le backend (exemple avec FastAPI) + uvicorn backend.main:app --reload # Adaptez le chemin et le nom du fichier d'entrĂ©e de votre application FastAPI + + # Pour le frontend (React) + cd frontend + npm start # ou yarn start + ``` + Votre application sera accessible sur `http://localhost:XXXX`. + +--- + +## 📄 Licence + +Ce projet est sous licence [MIT](LICENSE). + +--- + +## 📧 Contact + +Pour toute question ou information supplĂ©mentaire, n'hĂ©sitez pas Ă  nous contacter Ă  [contact@wilmoredynamics.com](mailto:contact@wilmoredynamics.com). + +--- \ No newline at end of file diff --git a/docs/PRD.md b/docs/PRD.md new file mode 100644 index 0000000..7ef2829 --- /dev/null +++ b/docs/PRD.md @@ -0,0 +1,231 @@ +# Product Requirements Document (PRD) : Emploi'IA + +**Version :** 1.0 +**Date :** 11 juin 2025 +**Auteur :** [Votre Nom/Équipe] +**Nom du Produit :** Emploi'IA (ou le nom final choisi) + +--- + +## 1. Introduction + +### 1.1. Vision du Produit + +Emploi'IA est une plateforme web innovante et intelligente, conçue pour transformer l'expĂ©rience de recherche d'emploi et d'Ă©volution professionnelle en France. En s'appuyant sur l'intelligence artificielle et l'intĂ©gration profonde des donnĂ©es officielles de France Travail (anciennement PĂŽle Emploi) et de partenaires spĂ©cialisĂ©s, Emploi'IA vise Ă  offrir aux demandeurs d'emploi et aux professionnels en transition une expĂ©rience personnalisĂ©e, pertinente et proactive. Notre objectif est de simplifier les dĂ©marches, de fournir des insights prĂ©cis sur le marchĂ© du travail et d'offrir des parcours de carriĂšre sur mesure. + +### 1.2. Objectifs du Produit + +* **Simplifier la Recherche d'Emploi :** RĂ©duire le temps et l'effort nĂ©cessaires pour trouver des offres pertinentes. +* **Augmenter la Pertinence :** Fournir des matchs emploi-profil de haute qualitĂ© grĂące Ă  l'IA et aux rĂ©fĂ©rentiels ROME. +* **Autonomiser les Utilisateurs :** Offrir des outils et des informations pour une meilleure comprĂ©hension du marchĂ© du travail et une prise de dĂ©cision Ă©clairĂ©e. +* **Personnaliser l'ExpĂ©rience :** Adapter les suggestions (offres, formations, Ă©vĂ©nements) aux besoins et compĂ©tences spĂ©cifiques de chaque utilisateur. +* **FiabilitĂ© des DonnĂ©es :** Utiliser exclusivement des APIs officielles et fiables pour garantir la qualitĂ© de l'information. +* **Adoption Utilisateur (KPI) :** Atteindre X utilisateurs actifs mensuels aprĂšs 6 mois post-MVP. +* **Satisfaction Utilisateur (KPI) :** Obtenir un score NPS (Net Promoter Score) de X% ou plus. + +### 1.3. Public Cible / Personas + +Emploi'IA cible principalement : + +* **Les Demandeurs d'Emploi Actifs :** Personnes Ă  la recherche d'un nouveau poste, qu'elles soient en situation de chĂŽmage ou en transition. + * **Besoin :** Trouver rapidement des offres pertinentes, comprendre les exigences des postes, optimiser leur candidature. +* **Les Professionnels en Évolution / Reconversion :** Individus souhaitant changer de mĂ©tier, monter en compĂ©tences ou explorer de nouvelles opportunitĂ©s. + * **Besoin :** Identifier les mĂ©tiers porteurs, les formations adaptĂ©es, comprendre les passerelles entre mĂ©tiers, Ă©valuer les compĂ©tences transfĂ©rables. +* **Les Jeunes DiplĂŽmĂ©s / Entrants sur le MarchĂ© du Travail :** Cherchant un premier emploi ou une premiĂšre orientation. + * **Besoin :** Comprendre le marchĂ©, identifier les compĂ©tences clĂ©s pour un mĂ©tier, trouver des stages ou des formations. + +### 1.4. Contexte et ProblĂšme RĂ©solu + +La recherche d'emploi en France peut ĂȘtre complexe, longue et dĂ©motivante. Les outils existants sont souvent gĂ©nĂ©riques, manquent de personnalisation ou ne fournissent pas une vision complĂšte du marchĂ©. Les informations sont dispersĂ©es (offres, formations, statistiques). Les demandeurs ont du mal Ă  identifier leurs compĂ©tences rĂ©elles et celles Ă  dĂ©velopper, ou Ă  cibler les entreprises qui recrutent rĂ©ellement. + +Emploi'IA rĂ©sout ces problĂšmes en : +* Centralisant les informations pertinentes. +* Appliquant l'IA pour un matching prĂ©cis et des insights intelligents. +* Offrant une expĂ©rience utilisateur fluide et intuitive, inspirĂ©e des meilleures pratiques du marchĂ© (ex: Google Careers). + +--- + +## 2. Aperçu des FonctionnalitĂ©s (par Phase) + +Cette section fournit un aperçu de haut niveau des fonctionnalitĂ©s, dĂ©taillĂ©es ensuite. + +### 2.1. Phase 1 : MVP (Minimum Viable Product) + +* **Objectif :** Lancer une plateforme fonctionnelle de base pour la recherche d'offres et un matching IA simple. +* **FonctionnalitĂ©s ClĂ©s :** Authentification utilisateur, profil basique (mĂ©tiers/compĂ©tences ROME), recherche d'offres d'emploi, matching IA simple (texte libre -> ROME), affichage dĂ©taillĂ© des offres, ajout aux favoris, redirection pour postuler, gĂ©nĂ©ration simple de LM. + +### 2.2. Phase 2 : Enrichissement & Personnalisation Approfondie + +* **Objectif :** IntĂ©grer les fonctionnalitĂ©s d'IA avancĂ©es, l'analyse de donnĂ©es marchĂ©, et des outils de guidance de carriĂšre. +* **FonctionnalitĂ©s ClĂ©s :** IntĂ©gration SSO France Travail, profil avancĂ© (analyse CV, compĂ©tences graphiques), matching enrichi (soft skills, situations de travail), tableaux de bord marchĂ©, suggestions de formations/entreprises, fiches mĂ©tiers complĂštes, outils de candidature avancĂ©s. + +### 2.3. Phase 3 et au-delĂ  : Excellence OpĂ©rationnelle & Nouveaux Services + +* **Objectif :** Optimisation continue, IA proactive, Ă©vĂ©nements personnalisĂ©s et expansion de l'Ă©cosystĂšme. +* **FonctionnalitĂ©s ClĂ©s :** Notifications proactives (Ă©vĂ©nements, rappels), coaching IA continu, outils de nĂ©gociation salariale, potentiel de rĂ©seautage, analyse de trajectoire professionnelle. + +--- + +## 3. Exigences Fonctionnelles DĂ©taillĂ©es (Focus sur le MVP) + +### 3.1. Gestion Utilisateur + +* **Description :** Permettre aux utilisateurs de s'inscrire, se connecter et gĂ©rer un profil de base sur Emploi'IA. +* **User Stories :** + * `En tant qu'utilisateur non enregistrĂ©, je veux pouvoir m'inscrire avec mon email et un mot de passe afin d'accĂ©der aux fonctionnalitĂ©s de la plateforme.` + * `En tant qu'utilisateur enregistrĂ©, je veux pouvoir me connecter avec mon email et mon mot de passe afin de reprendre ma session.` + * `En tant qu'utilisateur, je veux pouvoir renseigner mon nom, ma localisation, mon mĂ©tier recherchĂ© et mes compĂ©tences clĂ©s afin de commencer Ă  personnaliser mon profil.` + * `En tant qu'utilisateur, je veux que mes saisies de mĂ©tier et compĂ©tences soient aidĂ©es par des suggestions pour un mapping ROME initial.` +* **DĂ©pendances APIs :** `ROME 4.0 - MĂ©tiers`, `ROME 4.0 - CompĂ©tences`, `Romeo` (pour l'aide Ă  la complĂ©tion/suggestion ROME). + +### 3.2. Recherche d'Offres d'Emploi + +* **Description :** Offrir une interface de recherche intuitive et performante pour trouver des offres d'emploi. +* **User Stories :** + * `En tant qu'utilisateur, je veux pouvoir rechercher des offres d'emploi par mots-clĂ©s et localisation afin de trouver des postes qui m'intĂ©ressent.` + * `En tant qu'utilisateur, je veux pouvoir filtrer les rĂ©sultats par type de contrat (CDI, CDD, IntĂ©rim...) et date de publication afin d'affiner ma recherche.` + * `En tant qu'utilisateur, je veux voir une liste claire et paginĂ©e des offres pertinentes avec les informations essentielles.` +* **DĂ©pendances APIs :** `Offres d'emploi`. + +### 3.3. Matching IA Basique + +* **Description :** Utiliser l'IA pour associer intelligemment le profil de l'utilisateur avec les offres d'emploi. +* **User Stories :** + * `En tant qu'utilisateur, je veux que la plateforme analyse les offres d'emploi pour identifier les mĂ©tiers et compĂ©tences ROME automatiquement.` + * `En tant qu'utilisateur, je veux voir un indicateur de pertinence (score ou badge) sur chaque offre, montrant Ă  quel point elle correspond Ă  mon profil.` +* **DĂ©pendances APIs :** `Romeo`, `ROME 4.0 - MĂ©tiers`, `ROME 4.0 - CompĂ©tences`. + +### 3.4. Consultation et Actions sur une Offre + +* **Description :** Permettre Ă  l'utilisateur de consulter les dĂ©tails d'une offre et d'effectuer des actions (favoris, candidature). +* **User Stories :** + * `En tant qu'utilisateur, je veux pouvoir cliquer sur une offre pour voir sa description complĂšte et ses informations dĂ©taillĂ©es.` + * `En tant qu'utilisateur, je veux pouvoir ajouter une offre Ă  mes favoris pour la retrouver facilement plus tard.` + * `En tant qu'utilisateur, je veux pouvoir gĂ©nĂ©rer une lettre de motivation simple pour l'offre sĂ©lectionnĂ©e, prĂ©-remplie avec mes informations et celles de l'offre.` + * `En tant qu'utilisateur, je veux pouvoir cliquer sur un bouton pour postuler Ă  l'offre, qui me redirige vers le site de candidature externe.` +* **DĂ©pendances APIs :** `Offres d'emploi` (pour le dĂ©tail). + +--- + +## 4. IntĂ©grations APIs (RĂ©capitulatif et Cas d'Usage) + +Emploi'IA s'appuiera sur les APIs suivantes, avec une authentification OAuth2 (Client Credentials Flow pour les APIs de donnĂ©es, et ultĂ©rieurement Authorization Code Flow pour le SSO Utilisateur) : + +| API (Fournisseur) | RĂŽle Principal pour Emploi'IA | Cas d'Usage Majeurs | Phase d'IntĂ©gration | +| :---------------------------- | :--------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | :------------------ | +| `Offres d'emploi` (FT) | Source principale des offres d'emploi. | Recherche d'offres, affichage des dĂ©tails, filtres. | MVP (Phase 1) | +| `ROME 4.0 - MĂ©tiers` (FT) | RĂ©fĂ©rentiel des mĂ©tiers ROME. | Synchronisation initiale, validation des mĂ©tiers, interprĂ©tation des codes ROME de `Romeo`. | MVP (Phase 1) | +| `ROME 4.0 - CompĂ©tences` (FT) | RĂ©fĂ©rentiel des compĂ©tences ROME. | Synchronisation initiale, validation des compĂ©tences, interprĂ©tation des codes ROME de `Romeo`. | MVP (Phase 1) | +| `Romeo` (FT) | Moteur d'IA pour le mapping texte libre <-> ROME. | Analyse des offres d'emploi, aide Ă  la saisie du profil, analyse de CV. | MVP (Phase 1) | +| `API SSO France Travail` (FT) | Authentification utilisateur dĂ©lĂ©guĂ©e. | Connexion simplifiĂ©e via identifiants FT, potentiel d'enrichissement du profil. | Phase 2 | +| `Match via Soft Skills` (Instarlink) | IntĂ©gration des soft skills dans le matching. | Affinage du matching, suggestions de soft skills Ă  dĂ©velopper. | Phase 2 | +| `ROME V4.0 - Situations de travail` (FT) | RĂ©fĂ©rentiel des environnements de travail. | PrĂ©fĂ©rences utilisateur sur le contexte de travail, affinage du matching. | Phase 2 | +| `ROME V4.0 - Fiches ROME` (FT) | Fiches mĂ©tiers structurĂ©es. | Pages dĂ©taillĂ©es sur les mĂ©tiers, passerelles de carriĂšre. | Phase 2 | +| `La Bonne BoĂźte` (FT) | Identification d'entreprises qui recrutent. | Aide Ă  la candidature spontanĂ©e ciblĂ©e. | Phase 2 | +| `MarchĂ© du travail` (FT) | Statistiques sur l'emploi et les tensions. | Tableaux de bord, conseils sur les mĂ©tiers porteurs, donnĂ©es localisĂ©es. | Phase 2 | +| `Open formation` (FT) | AccĂšs aux offres de formation. | Suggestions de formations personnalisĂ©es. | Phase 2 | +| `Sortants de formation et accĂšs Ă  l'emploi` (FT) | Statistiques sur le succĂšs des formations. | Validation de la pertinence des formations suggĂ©rĂ©es. | Phase 2 | +| `Mes Ă©vĂšnements France Travail` (FT) | ÉvĂ©nements emploi/formation locaux. | Notifications et suggestions d'Ă©vĂ©nements pertinents. | Phase 3+ | + +--- + +## 5. Exigences Non-Fonctionnelles + +### 5.1. Performance + +* **Temps de RĂ©ponse :** + * Moins de 2 secondes pour les requĂȘtes de recherche d'offres et l'affichage des dĂ©tails (90Ăšme percentile). + * Moins de 500 ms pour les requĂȘtes API internes critiques (authentification, accĂšs profil). +* **ScalabilitĂ© :** La plateforme doit pouvoir supporter une augmentation significative du nombre d'utilisateurs (jusqu'Ă  X utilisateurs simultanĂ©s en Phase 2) et de requĂȘtes sans dĂ©gradation majeure des performances. +* **Temps de Synchronisation ROME :** Les mises Ă  jour des rĂ©fĂ©rentiels ROME ne doivent pas impacter la disponibilitĂ© de la plateforme. + +### 5.2. SĂ©curitĂ© + +* **Authentification et Autorisation :** ImplĂ©mentation sĂ©curisĂ©e des processus d'inscription/connexion et de gestion des accĂšs (hachage des mots de passe, tokens JWT sĂ©curisĂ©s). +* **Protection des DonnĂ©es Personnelles (RGPD) :** + * Collecte et traitement des donnĂ©es conformes au RGPD (consentement explicite, droit Ă  l'oubli, droit Ă  la rectification). + * Stockage des donnĂ©es sensibles (CV, informations profil dĂ©taillĂ©es) chiffrĂ©. + * Audit rĂ©gulier des vulnĂ©rabilitĂ©s de sĂ©curitĂ©. +* **SĂ©curitĂ© API :** Gestion sĂ©curisĂ©e des clĂ©s API et des tokens OAuth2 pour les interactions avec France Travail. + +### 5.3. UI/UX (Design) + +* **Inspiration :** Fortement inspirĂ© par les principes de design de **Google Careers** (simplicitĂ©, clartĂ©, recherche puissante, hiĂ©rarchie de l'information). +* **IntuitivitĂ© :** La navigation et l'utilisation de la plateforme doivent ĂȘtre faciles et naturelles pour l'utilisateur, mĂȘme sans formation. +* **Transparence de l'IA :** L'intelligence artificielle doit ĂȘtre perçue comme un assistant utile et non comme une "boĂźte noire". Les scores de matching, les suggestions et les analyses doivent ĂȘtre prĂ©sentĂ©s de maniĂšre comprĂ©hensible et non intrusive. +* **ResponsivitĂ© :** La plateforme doit ĂȘtre pleinement fonctionnelle et optimisĂ©e pour une utilisation sur tous les types d'appareils (desktop, tablette, mobile). +* **AccessibilitĂ© :** ConformitĂ© aux normes d'accessibilitĂ© web (RGAA ou WCAG) pour garantir l'utilisation par tous. +* **Feedback Visuel :** Des indicateurs clairs et immĂ©diats sur les actions de l'utilisateur et l'Ă©tat du systĂšme. + +### 5.4. FiabilitĂ© et DisponibilitĂ© + +* **Uptime :** Objectif de disponibilitĂ© de 99.5% pour les services critiques du MVP, augmentant Ă  99.9% pour les phases ultĂ©rieures. +* **Gestion des Erreurs :** Robustesse face aux erreurs API externes (France Travail, Instarlink) avec des messages d'erreur clairs pour l'utilisateur et des mĂ©canismes de retry/fallback cĂŽtĂ© backend. +* **CohĂ©rence des DonnĂ©es :** Assurer la cohĂ©rence des donnĂ©es ROME et des offres d'emploi synchronisĂ©es. + +### 5.5. MaintenabilitĂ© + +* **QualitĂ© du Code :** Code propre, bien commentĂ©, respectant les bonnes pratiques de dĂ©veloppement. +* **Documentation Technique :** Documentation API interne, architecture, guides de dĂ©ploiement. +* **FacilitĂ© d'Évolution :** Architecture modulaire permettant d'ajouter de nouvelles fonctionnalitĂ©s et APIs sans refonte majeure. + +### 5.6. Monitoring & Logging + +* Mise en place d'outils de monitoring des performances applicatives (APM), des logs centralisĂ©s et des alertes pour dĂ©tecter et rĂ©soudre rapidement les problĂšmes. +* Suivi des appels aux APIs externes (succĂšs/Ă©checs, temps de rĂ©ponse). + +--- + +## 6. ConsidĂ©rations Techniques et Architecture (Haut Niveau) + +* **Stack Technologique (Exemple) :** + * **Backend :** Python (Django/FastAPI) ou Node.js (Express) + * **Base de DonnĂ©es :** PostgreSQL (pour sa robustesse et sa gestion JSON pour les donnĂ©es semi-structurĂ©es de ROME) + * **Frontend :** React ou Vue.js (pour une expĂ©rience utilisateur riche et dynamique) +* **Architecture :** + * **MVP :** Approche "monolithe modulaire" possible pour accĂ©lĂ©rer le dĂ©veloppement, avec des modules bien sĂ©parĂ©s pour les utilisateurs, les offres, et les intĂ©grations ROME. + * **Phases UltĂ©rieures :** Évolution vers une architecture micro-services pour les composants critiques (ex: service de matching IA, service de profil) pour une meilleure scalabilitĂ© et indĂ©pendance. + * **API Gateway :** Point d'entrĂ©e unique pour les requĂȘtes frontend vers le backend, gĂ©rant l'authentification, les redirections. +* **StratĂ©gie de Base de DonnĂ©es :** + * Stockage des utilisateurs, de leurs profils. + * Cache des offres d'emploi pertinentes et des donnĂ©es ROME pour optimiser les performances et rĂ©duire les appels API externes. +* **StratĂ©gie de DĂ©ploiement :** + * Utilisation d'un fournisseur Cloud (ex: AWS, GCP, Azure, OVH) avec des services managĂ©s pour rĂ©duire la charge opĂ©rationnelle. + * Conteneurisation (Docker) et orchestration (Kubernetes) envisagĂ©es pour la scalabilitĂ© et la gestion des dĂ©ploiements. + +--- + +## 7. MĂ©triques de SuccĂšs (KPIs) + +* **Trafic Utilisateur :** Nombre d'utilisateurs uniques, d'utilisateurs actifs mensuels (MAU). +* **Engagement :** Nombre de sessions par utilisateur, durĂ©e moyenne des sessions, nombre d'offres consultĂ©es, nombre d'offres mises en favoris, nombre de candidatures lancĂ©es. +* **Taux de Conversion :** Taux d'inscription, taux de complĂ©tion de profil. +* **QualitĂ© du Matching :** Taux de clics sur les offres "matchĂ©es", feedback utilisateur sur la pertinence des suggestions. +* **Performance Technique :** Temps de rĂ©ponse moyens, uptime, taux d'erreurs API. + +--- + +## 8. Feuille de Route et Phases de DĂ©veloppement + +La feuille de route dĂ©taillĂ©e est disponible dans le document : `docs/ROADMAP.md`. Elle dĂ©crit la progression du projet par phases (MVP, Phase 2, Phase 3+) avec les fonctionnalitĂ©s et intĂ©grations API correspondantes. + +--- + +## 9. Risques et HypothĂšses + +### 9.1. Risques + +* **DĂ©pendance APIs Externes :** Modification des APIs France Travail, latence ou indisponibilitĂ©. +* **ComplexitĂ© de l'IA :** DifficultĂ© Ă  obtenir un matching de trĂšs haute qualitĂ© ou Ă  interprĂ©ter les donnĂ©es de maniĂšre pertinente pour l'utilisateur. +* **Adoption Utilisateur :** Faible adoption si l'expĂ©rience ne rĂ©pond pas aux attentes ou si la concurrence est trop forte. +* **DĂ©lai d'Obtention SSO France Travail :** Processus d'approbation long pouvant retarder des fonctionnalitĂ©s clĂ©s de la Phase 2. +* **CoĂ»ts :** CoĂ»ts d'infrastructure et de dĂ©veloppement plus Ă©levĂ©s que prĂ©vu. + +### 9.2. HypothĂšses + +* Les APIs France Travail resteront stables et documentĂ©es. +* Le processus d'obtention de l'accĂšs SSO France Travail sera achevĂ© dans un dĂ©lai raisonnable. +* Une Ă©quipe de dĂ©veloppement qualifiĂ©e sera disponible pour la durĂ©e du projet. +* Le budget allouĂ© permettra de couvrir les coĂ»ts d'infrastructure et de dĂ©veloppement. + +--- \ No newline at end of file diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md new file mode 100644 index 0000000..df93664 --- /dev/null +++ b/docs/ROADMAP.md @@ -0,0 +1,179 @@ +# Feuille de Route DĂ©taillĂ©e JobIA + +Cette feuille de route prĂ©sente une vision stratĂ©gique et progressive du dĂ©veloppement de JobIA, depuis la prĂ©paration initiale jusqu'Ă  un Ă©cosystĂšme complet et intelligent, en s'appuyant sur les APIs identifiĂ©es et les principes de design inspirĂ©s de Google Careers. + +--- + +## Vision GĂ©nĂ©rale du Produit + +**Mission :** Faciliter et personnaliser la recherche d'emploi et l'Ă©volution professionnelle en France grĂące Ă  une plateforme intelligente, intuitive et basĂ©e sur les donnĂ©es officielles du marchĂ© du travail. + +**Objectif Final :** Devenir la rĂ©fĂ©rence française pour l'accompagnement personnalisĂ© des parcours professionnels, en offrant un matching IA avancĂ©, des informations marchĂ© pertinentes et des conseils proactifs. + +--- + +## Phases de DĂ©veloppement + +--- + +### Phase 0 : PrĂ©paration & Lancement des Demandes (Jours 1-15) + +* **Objectif :** Établir les bases techniques et administratives nĂ©cessaires au dĂ©marrage du dĂ©veloppement, sĂ©curiser les accĂšs critiques. + +* **Actions ClĂ©s :** + * **AccĂšs APIs France Travail (Client Credentials) :** + * Obtention des identifiants et clĂ©s pour toutes les APIs partenaires (Offres d'emploi, ROME x4, Romeo, La Bonne BoĂźte, MarchĂ© du travail, Sortants de formation, Open Formation, Mes Ă©vĂšnements). + * Configuration et test des premiĂšres requĂȘtes d'authentification pour confirmer l'accĂšs. + * **Demande API SSO France Travail :** + * Identification du formulaire ou du processus de demande spĂ©cifique Ă  l'API de connexion/authentification utilisateur de France Travail. + * PrĂ©paration et soumission de la demande. + * Suivi actif de l'Ă©tat d'avancement de la demande. + * **Mise en place de l'environnement de dĂ©veloppement :** + * Choix de la stack technique initiale (langages, frameworks backend/frontend). + * Configuration des dĂ©pĂŽts de code (Git, GitHub/GitLab). + * Mise en place d'un environnement de dĂ©veloppement local et d'un environnement de staging initial. + * **Architecture BDD Initiale :** + * Conception du schĂ©ma de base de donnĂ©es pour les utilisateurs et la synchronisation des rĂ©fĂ©rentiels ROME (MĂ©tiers, CompĂ©tences). + +* **APIs et DĂ©pendances Externes :** + * Toutes les APIs France Travail (demande d'accĂšs). + * Processus d'obtention de l'accĂšs SSO France Travail (lancĂ© en parallĂšle, dĂ©lai incertain). + +--- + +### Phase 1 : MVP (Minimum Viable Product) - (Mois 1-3) + +* **Objectif :** Lancer une version fonctionnelle de base de JobIA, permettant la recherche d'offres d'emploi et un matching IA simple, afin de valider l'intĂ©rĂȘt et l'expĂ©rience utilisateur de base. + +* **FonctionnalitĂ©s ClĂ©s du MVP :** + + * **Gestion Utilisateur :** + * **Inscription/Connexion :** SystĂšme d'authentification propre Ă  JobIA (email/mot de passe). + * **Profil Utilisateur Basique :** + * Informations personnelles (nom, prĂ©nom, contact, localisation). + * MĂ©tier recherchĂ© (saisie texte libre, avec aide Ă  la complĂ©tion via `Romeo`). + * CompĂ©tences clĂ©s (saisie texte libre, avec aide Ă  la complĂ©tion via `Romeo`). + * **Recherche d'Offres d'Emploi :** + * **Barre de Recherche Intuitive :** Recherche par mot-clĂ© et localisation (inspirĂ©e de Google Careers). + * **Filtres Simples :** Type de contrat, date de publication, rayon de recherche. + * **Affichage des RĂ©sultats :** Liste paginĂ©e des offres avec informations clĂ©s (titre, entreprise, lieu, date). + * **Matching IA Basique :** + * **Analyse des Offres :** Utilisation de l'API `Romeo` pour extraire automatiquement les `Appellations ROME` (mĂ©tiers) et les `Savoirs/Savoir-faire ROME` (compĂ©tences) Ă  partir des descriptions d'offres. Stockage de ces mappings. + * **Calcul de Pertinence :** Comparaison simple entre les compĂ©tences et mĂ©tiers ROME du profil utilisateur et ceux extraits des offres. Affichage d'un score de matching simple ou mise en avant des offres "les plus pertinentes". + * **DĂ©tail d'une Offre d'Emploi :** + * Affichage complet de la description de l'offre. + * Informations contextuelles (localisation, type de contrat, salaire si disponible). + * Mise en Ă©vidence des compĂ©tences et mĂ©tiers ROME extraits par l'IA. + * **Actions sur les Offres :** + * **Ajout aux Favoris :** PossibilitĂ© pour l'utilisateur de sauvegarder des offres. + * **Candidature :** Redirection simple vers la page de candidature externe (URL de l'offre France Travail). + * **GĂ©nĂ©ration de Lettre de Motivation (ModĂšle Simple) :** Permet Ă  l'utilisateur de gĂ©nĂ©rer une lettre de motivation basique, en s'appuyant sur les informations de l'offre et les infos de son profil JobIA. + +* **IntĂ©grations APIs Prioritaires pour le MVP :** + 1. **`Offres d'emploi` (France Travail) :** + * **RĂŽle :** Alimenter le moteur de recherche et l'affichage des annonces. + * **Utilisation :** Appels dynamiques pour la recherche, rĂ©cupĂ©ration des dĂ©tails d'offres spĂ©cifiques. + 2. **`ROME 4.0 - MĂ©tiers` (France Travail) :** + * **RĂŽle :** RĂ©fĂ©rentiel structurĂ© des mĂ©tiers. + * **Utilisation :** Synchronisation initiale et complĂšte dans la BDD de JobIA. UtilisĂ© pour la validation des mĂ©tiers et l'interprĂ©tation des codes ROME renvoyĂ©s par Romeo. + 3. **`ROME 4.0 - CompĂ©tences` (France Travail) :** + * **RĂŽle :** RĂ©fĂ©rentiel structurĂ© des compĂ©tences (savoirs, savoir-faire, savoir-ĂȘtre). + * **Utilisation :** Synchronisation initiale et complĂšte dans la BDD de JobIA. UtilisĂ© pour la validation des compĂ©tences et l'interprĂ©tation des codes ROME renvoyĂ©s par Romeo. + 4. **`Romeo` (France Travail) :** + * **RĂŽle :** Moteur d'IA pour le mapping texte libre <-> ROME. + * **Utilisation :** Appels dynamiques pour analyser les descriptions d'offres d'emploi. Potentiellement pour aider Ă  la complĂ©tion du profil utilisateur (mĂ©tiers/compĂ©tences). + +* **ConsidĂ©rations Techniques SpĂ©cifiques au MVP :** + * **Backend :** Langage/Framework choisi (ex: Python/Django, Node.js/Express, Java/Spring Boot). Base de donnĂ©es relationnelle (PostgreSQL recommandĂ© pour sa robustesse et sa flexibilitĂ©). Mise en place des services d'intĂ©gration pour la synchronisation ROME. + * **Frontend :** Framework UI/UX (ex: React, Vue.js, Angular) avec un focus sur les principes de design Google Careers (simplicitĂ©, clartĂ©). + * **DĂ©ploiement :** Environnement Cloud de base (ex: quelques VMs, services managĂ©s pour BDD), avec un pipeline CI/CD simple. + +--- + +### Phase 2 : Enrichissement & Personnalisation Approfondie (Mois 4-8) + +* **Objectif :** Passer d'une plateforme de recherche "simple" Ă  un assistant intelligent, en amĂ©liorant la personnalisation, la pertinence du matching et en offrant des informations stratĂ©giques. + +* **FonctionnalitĂ©s ClĂ©s :** + + * **Authentification Utilisateur AmĂ©liorĂ©e :** + * **IntĂ©gration SSO France Travail :** Permettre aux utilisateurs de se connecter via leurs identifiants France Travail, avec gestion des consentements. + * **Profil Utilisateur AvancĂ© :** + * **Analyse de CV :** TĂ©lĂ©chargement de CV (PDF/DOCX) et extraction automatique des mĂ©tiers et compĂ©tences ROME via l'API `Romeo`. + * **Visualisation des CompĂ©tences :** Affichage interactif des compĂ©tences ROME maĂźtrisĂ©es et Ă  dĂ©velopper. + * **PrĂ©fĂ©rences de Contexte de Travail :** Ajout de prĂ©fĂ©rences utilisateur basĂ©es sur le rĂ©fĂ©rentiel `ROME V4.0 - Situations de travail`. + * **Matching IA AvancĂ© :** + * **IntĂ©gration Soft Skills :** Utilisation de l'API `Match via Soft Skills` pour affiner le matching en prenant en compte les qualitĂ©s professionnelles. + * **Prise en compte des Situations de Travail :** Le matching intĂšgre les prĂ©fĂ©rences de l'utilisateur pour les environnements de travail. + * **Explication du Matching :** L'IA explique pourquoi une offre est pertinente pour un utilisateur (ex: "Vous matchez Ă  85% sur les compĂ©tences techniques, et 70% sur les savoir-ĂȘtre"). + * **Informations MarchĂ© StratĂ©giques :** + * **Tableaux de Bord MĂ©tier/Territoire :** Visualisation des donnĂ©es clĂ©s (mĂ©tiers en tension, nombre de demandeurs d'emploi, volume d'offres) via l'API `MarchĂ© du travail`. + * **Conseils de Candidature SpontanĂ©e :** Recommandation d'entreprises ayant un fort potentiel de recrutement dans un mĂ©tier ou secteur donnĂ© (`La Bonne BoĂźte`). + * **Orientation et Formation :** + * **Suggestions de Formations PersonnalisĂ©es :** BasĂ©es sur les compĂ©tences manquantes pour un mĂ©tier cible, via l'API `Open formation`. + * **Statistiques de Retour Ă  l'Emploi aprĂšs Formation :** Affichage des taux d'accĂšs Ă  l'emploi des sortants de formations pertinentes (`Sortants de formation et accĂšs Ă  l'emploi`). + * **Exploration des MĂ©tiers :** + * **Pages "Fiche MĂ©tier" DĂ©taillĂ©es :** Utilisation de l'API `ROME V4.0 - Fiches ROME` pour prĂ©senter une vue complĂšte d'un mĂ©tier (dĂ©finition, compĂ©tences clĂ©s, savoirs, contextes de travail, mĂ©tiers proches). + * **Parcours de CarriĂšre :** Suggestions de progression ou de reconversion basĂ©es sur les similitudes ROME. + * **GĂ©nĂ©ration de Contenu AvancĂ©e :** Personnalisation plus poussĂ©e de la lettre de motivation et du CV, en intĂ©grant les Ă©lĂ©ments issus de l'analyse ROME du profil et de l'offre. + +* **IntĂ©grations APIs Prioritaires pour la Phase 2 :** + 1. **API SSO France Travail :** (Si l'accĂšs est obtenu) Permet une connexion fluide et l'accĂšs potentiel Ă  des donnĂ©es de profil France Travail. + 2. **`Match via Soft Skills` (Instarlink) :** + * **RĂŽle :** IntĂ©gration des qualitĂ©s professionnelles pour un matching plus humain. + * **Utilisation :** Appels dynamiques pour Ă©valuer la correspondance des soft skills entre profil et offre. + 3. **`ROME V4.0 - Situations de travail` (France Travail) :** + * **RĂŽle :** RĂ©fĂ©rentiel des environnements de travail. + * **Utilisation :** Synchronisation initiale. Permet aux utilisateurs de dĂ©finir leurs prĂ©fĂ©rences et d'affiner le matching. + 4. **`ROME V4.0 - Fiches ROME` (France Travail) :** + * **RĂŽle :** Fiches mĂ©tiers agrĂ©gĂ©es et prĂȘtes Ă  l'emploi. + * **Utilisation :** Appels Ă  la demande pour afficher les pages dĂ©taillĂ©es des mĂ©tiers. + 5. **`La Bonne BoĂźte` (France Travail) :** + * **RĂŽle :** Identifier les entreprises qui recrutent. + * **Utilisation :** Appels dynamiques pour cibler les candidatures spontanĂ©es. + 6. **`MarchĂ© du travail` (France Travail) :** + * **RĂŽle :** Statistiques sur l'emploi, les mĂ©tiers en tension. + * **Utilisation :** Appels dynamiques pour alimenter des dashboards et des conseils marchĂ©. + 7. **`Open formation` (France Travail) :** + * **RĂŽle :** Offres de formation. + * **Utilisation :** Appels dynamiques pour suggĂ©rer des formations. + 8. **`Sortants de formation et accĂšs Ă  l'emploi` (France Travail) :** + * **RĂŽle :** Statistiques sur le succĂšs des formations. + * **Utilisation :** Appels dynamiques pour valider la pertinence des formations. + +* **ConsidĂ©rations Techniques SpĂ©cifiques Ă  la Phase 2 :** + * **ScalabilitĂ© :** PrĂ©paration Ă  l'augmentation du nombre d'utilisateurs et de requĂȘtes IA. + * **Micro-services :** PossibilitĂ© de dĂ©couper le backend en micro-services pour gĂ©rer la complexitĂ© croissante (ex: service de matching, service de profil, service de synchronisation ROME). + * **Gestion des DonnĂ©es Utilisateur :** ImplĂ©mentation stricte des rĂšgles RGPD pour les donnĂ©es sensibles issues du SSO et de l'analyse de CV. + * **Cache AvancĂ© :** StratĂ©gies de caching plus agressives pour les donnĂ©es peu changeantes (rĂ©fĂ©rentiels, fiches ROME). + * **Monitoring & Alerting :** Mise en place d'outils de surveillance des performances et de la fiabilitĂ© des APIs et des services internes. + +--- + +### Phase 3 et au-delĂ  : Excellence OpĂ©rationnelle & Expansion (Mois 9+) + +* **Objectif :** Consolider la position de JobIA, optimiser la performance, explorer de nouvelles opportunitĂ©s et fonctionnalitĂ©s. + +* **FonctionnalitĂ©s ClĂ©s :** + + * **Accompagnement Proactif :** + * **`Mes Ă©vĂšnements France Travail` :** Notifications et suggestions personnalisĂ©es d'Ă©vĂ©nements (salons, ateliers) basĂ©es sur le profil et les intĂ©rĂȘts de l'utilisateur. + * **Recommandations proactives :** L'IA suggĂšre des actions (formations, Ă©vĂ©nements, mises Ă  jour de profil) de maniĂšre non sollicitĂ©e mais pertinente. + * **AmĂ©lioration Continue de l'IA :** + * **Boucles de Feedback Utilisateur :** Exploitation des APIs de feedback de `Romeo` (`/performancePredictionCompetences`, etc.) pour amĂ©liorer l'IA. + * **Apprentissage PersonnalisĂ© :** L'IA adapte ses recommandations en fonction des interactions et des succĂšs/Ă©checs de l'utilisateur. + * **Outils d'Aide Ă  la NĂ©gociation :** BasĂ©s sur les donnĂ©es du marchĂ© du travail (`MarchĂ© du travail`). + * **Partenariats et ÉcosystĂšme :** IntĂ©gration avec d'autres services ou plateformes (ex: plateformes de micro-learning, simulateurs d'entretien). + * **Tableaux de bord personnalisĂ©s pour le suivi de la progression.** + +* **IntĂ©grations APIs :** + * **`Mes Ă©vĂšnements France Travail` :** + * **RĂŽle :** AccĂšs aux Ă©vĂ©nements liĂ©s Ă  l'emploi. + * **Utilisation :** Appels dynamiques pour afficher les Ă©vĂ©nements pertinents. + * Optimisation de l'utilisation de toutes les APIs existantes. + * Exploration de nouvelles APIs France Travail ou partenaires. + +* **ConsidĂ©rations Techniques :** + * Optimisation des coĂ»ts d'infrastructure. + * Approfondissement des stratĂ©gies d'IA (machine learning, traitement du langage naturel) pour des fonctionnalitĂ©s plus complexes. + * AmĂ©lioration de la rĂ©silience et de la gestion des pannes. \ No newline at end of file diff --git a/docs/api/La Bonne BoĂźte.json b/docs/api/La Bonne BoĂźte.json new file mode 100644 index 0000000..e9123f2 --- /dev/null +++ b/docs/api/La Bonne BoĂźte.json @@ -0,0 +1,2833 @@ +{ + "openapi": "3.1.0", + "x-stoplight": { + "id": "jmjaao1xo3usi" + }, + "info": { + "title": "La Bonne Boite", + "description": "La Bonne BoĂźte cible les entreprises ayant des perspectives d'embauche Ă©levĂ©es et permet d'ĂȘtre plus efficace dans l'envoi de candidatures spontanĂ©es.\n\nCe ciblage est rendu possible grĂące Ă  l'analyse approfondie de millions d'embauches, dans les entreprises françaises.\n\nLes ressources de l'API vous permettent :\n\n- De rechercher des entreprises qui envisagent de recruter dans les 6 prochains mois ;\n- D'obtenir directement le nombre d'entreprises prĂ©voyant de recruter dans cette pĂ©riode ;\n- D'accĂ©der Ă  des informations dĂ©taillĂ©es sur les entreprises prĂ©sentant un fort potentiel de recrutement.\n\n***Scopes :*** `api_labonneboitev2`,`search`,`office`\n\n***Royaume :*** `partenaire`\n", + "version": "2.27.3" + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/labonneboite/v2" + } + ], + "paths": { + "/recherche": { + "get": { + "tags": [ + "Recherche" + ], + "summary": "Recherche d'entreprise avec potentiel d'embauche Ă  partir d'un mĂ©tier et d'un emplacement", + "description": "Cette ressource permet de rĂ©cupĂ©rer les entreprises Ă  fort potentiel d'embauche (par ordre de score dĂ©croissant).", + "operationId": "search_search__get", + "parameters": [ + { + "name": "job", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "MĂ©tier", + "description": "Recherche libre de mĂ©tier. La recherche tentera de trouver une correspondance dans les libelles de:\n - rome\n - domain\n - granddomain\n - naf", + "examples": [ + "Boul" + ] + }, + "description": "Recherche libre de mĂ©tier. La recherche tentera de trouver une correspondance dans les libelles de:\n - rome\n - domain\n - granddomain\n - naf", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche d'un mĂ©tier commançant par `Boul`", + "value": "Boul" + } + } + }, + { + "name": "domain", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Domaine", + "description": "Recherche par domaine d'activitĂ© professionnel", + "examples": [ + "A14" + ] + }, + "description": "Recherche par domaine d'activitĂ© professionnel", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans les domaines 'Production' et 'Instruments de musique'", + "value": [ + "A14", + "B15" + ] + } + } + }, + { + "name": "granddomain", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Grand Domaine", + "description": "Recherche par grand domaine d'activitĂ© professionnel", + "examples": [ + "A" + ] + }, + "description": "Recherche par grand domaine d'activitĂ© professionnel", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans les grand domaines `Agriculture et PĂȘche, Espaces naturels et Espaces verts, Soins aux animaux` et `Arts et Façonnage d'ouvrages d'art`", + "value": [ + "A", + "B" + ] + } + } + }, + { + "name": "rome", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "ROME", + "description": "Recherche par code ROME. RĂ©fĂ©rentiel: [Fiche mĂ©tier France Travail](https://www.francetravail.fr/candidat/decouvrir-le-marche-du-travail/les-fiches-metiers/les-fiches-metiers-sont-regroupe.html)\n ", + "examples": [ + "D1102" + ] + }, + "description": "Recherche par code ROME. RĂ©fĂ©rentiel: [Fiche mĂ©tier France Travail](https://www.francetravail.fr/candidat/decouvrir-le-marche-du-travail/les-fiches-metiers/les-fiches-metiers-sont-regroupe.html)\n ", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche le code rome `Boulangerie - viennoiserie`", + "value": [ + "D1102" + ] + } + } + }, + { + "name": "naf", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "NAF", + "description": "Code mĂ©tier NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "examples": [ + "9499Z" + ] + }, + "description": "Code mĂ©tier NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche les codes naf `Autres organisations fonctionnant par adhĂ©sion volontaire` et `Restauration de type rapide`", + "value": [ + "9499Z", + "5610C" + ] + } + } + }, + { + "name": "location", + "in": "query", + "required": false, + "schema": { + "type": "string", + "title": "Lieu", + "description": "Recherche libre de lieu. La recherche tentera de trouver une correspondance dans les noms de villes, dĂ©partements ou rĂ©gions. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Met" + ] + }, + "description": "Recherche libre de lieu. La recherche tentera de trouver une correspondance dans les noms de villes, dĂ©partements ou rĂ©gions. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche d'un lieu commançant par 'Met'", + "value": "Met" + } + } + }, + { + "name": "region", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Nom de la RĂ©gion", + "description": "Nom de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Pays de la Loire" + ] + }, + "description": "Nom de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans la rĂ©gion `Pays de Loire`", + "value": [ + "Pays de la Loire" + ] + } + } + }, + { + "name": "region_number", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "integer" + }, + "title": "NumĂ©ro de la RĂ©gion", + "description": "NumĂ©ro de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + 32 + ] + }, + "description": "NumĂ©ro de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans la rĂ©gion `Hauts de France`", + "value": [ + 32 + ] + } + } + }, + { + "name": "department", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "DĂ©partement", + "description": "Nom du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Moselle" + ] + }, + "description": "Nom du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans les dĂ©partements `Moselle` et `Loire Atlantique`", + "value": [ + "Loire-Atlantique", + "Moselle" + ] + } + } + }, + { + "name": "department_number", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "integer" + }, + "title": "NumĂ©ro de dĂ©partement", + "description": "NumĂ©ro du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + 57 + ] + }, + "description": "NumĂ©ro du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans les dĂ©partements `Moselle` et `Loire Atlantique`", + "value": [ + 57, + 44 + ] + } + } + }, + { + "name": "city", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Ville", + "description": "Nom exact de la ville recherchĂ©e", + "examples": [ + "Metz" + ] + }, + "description": "Nom exact de la ville recherchĂ©e", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans `Metz`", + "value": [ + "Metz" + ] + } + } + }, + { + "name": "citycode", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Code INSEE", + "description": "Code INSEE de la ville recherchĂ©e", + "examples": [ + "57463" + ] + }, + "description": "Code INSEE de la ville recherchĂ©e", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans `Metz`", + "value": [ + "57463" + ] + } + } + }, + { + "name": "postcode", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Code Postal", + "description": "Code postal de la ville recherchĂ©e", + "examples": [ + "57000" + ] + }, + "description": "Code postal de la ville recherchĂ©e", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans `Metz`", + "value": [ + "57000" + ] + } + } + }, + { + "name": "latitude", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Latitude", + "description": "Latitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "examples": [ + 47.21837 + ] + }, + "description": "Latitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche Ă  `Nantes`", + "value": 47.21837 + } + } + }, + { + "name": "longitude", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Longitude", + "description": "Longitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "examples": [ + -1.55362 + ] + }, + "description": "Longitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche Ă  `Nantes`", + "value": -1.55362 + } + } + }, + { + "name": "distance", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer", + "exclusiveMinimum": 0 + }, + { + "type": "null" + } + ], + "title": "Distance", + "description": "PĂ©rimĂštre du rayon de recherche (en kilomĂštres).\n\nLongitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n**Utilisation**:\nCe paramĂštre (en **km**) s'utilise en combinaison avec:\n\n- `latitude` & `longitude`\n- `citycode`\n\nSi les coordonnĂ©es `latitude` / `longitude` sont utilisĂ©es, il s'agit du rayon du cercle autour du point gĂ©ographique dĂ©fini par le couple\n`longitude` / `latitude`.\nSinon, une recherche est effectuĂ© autour des coordonnĂ©es gĂ©ographique des mairies pour les villes dans la recherche (citycode).\n\nLa distance doit ĂȘtre comprise entre ] 0, 200km [", + "examples": [ + 25 + ], + "lte": 200 + }, + "description": "PĂ©rimĂštre du rayon de recherche (en kilomĂštres).\n\nLongitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n**Utilisation**:\nCe paramĂštre (en **km**) s'utilise en combinaison avec:\n\n- `latitude` & `longitude`\n- `citycode`\n\nSi les coordonnĂ©es `latitude` / `longitude` sont utilisĂ©es, il s'agit du rayon du cercle autour du point gĂ©ographique dĂ©fini par le couple\n`longitude` / `latitude`.\nSinon, une recherche est effectuĂ© autour des coordonnĂ©es gĂ©ographique des mairies pour les villes dans la recherche (citycode).\n\nLa distance doit ĂȘtre comprise entre ] 0, 200km [", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans un rayon de 25km", + "value": 25 + } + } + }, + { + "name": "bbox", + "in": "query", + "required": false, + "schema": { + "type": "string", + "title": "BBOX", + "description": "Ce paramĂštre permet de dĂ©finir un rectangle gĂ©ographique pour dĂ©finir la zone de recherche.\n\n**RĂ©fĂ©rentiel**: https://wiki.openstreetmap.org/wiki/Bounding_box\n\n**Utilisation**:\nPour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement 4 valeurs sĂ©parĂ©es par des `|` :\n\n left|bottom|right|top\n\n - left: longitude du bord gauche\n - bottom: latitude du bord en bas\n - right: longitude du bord droit\n - top: latitude du bord en haut", + "examples": [ + "-1.5|47.2|-1.6|47.3" + ] + }, + "description": "Ce paramĂštre permet de dĂ©finir un rectangle gĂ©ographique pour dĂ©finir la zone de recherche.\n\n**RĂ©fĂ©rentiel**: https://wiki.openstreetmap.org/wiki/Bounding_box\n\n**Utilisation**:\nPour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement 4 valeurs sĂ©parĂ©es par des `|` :\n\n left|bottom|right|top\n\n - left: longitude du bord gauche\n - bottom: latitude du bord en bas\n - right: longitude du bord droit\n - top: latitude du bord en haut", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans un rectangle autour de Nantes", + "value": "-1.5|47.2|-1.6|47.3" + } + } + }, + { + "name": "sort_by", + "in": "query", + "required": false, + "schema": { + "type": "string", + "title": "CritĂšre du tri", + "description": "Element de l'index elastic search sur lequel effectuer le tri. Les valeurs possible sont romes.hiring_potential, hiring_potential", + "examples": [ + "romes.hiring_score" + ], + "default": "hiring_potential" + }, + "description": "Element de l'index elastic search sur lequel effectuer le tri. Les valeurs possible sont romes.hiring_potential, hiring_potential", + "examples": { + "default": { + "summary": "Tri par score de ROME", + "description": "tri par score de code rome (dĂ©faut)", + "value": "romes.hiring_score" + }, + "normal": { + "summary": "Trie par score entreprise", + "description": "tri par score d'entreprise", + "value": "hiring_score" + } + } + }, + { + "name": "sort_direction", + "in": "query", + "required": false, + "schema": { + "type": "string", + "title": "Sens du tri", + "description": "Sens du tri", + "examples": [ + "desc" + ], + "default": "desc" + }, + "description": "Sens du tri", + "examples": { + "normal": { + "summary": "Ascendant", + "description": "tri du plus grand au plus petit (dĂ©faut)", + "value": "asc" + }, + "desc": { + "summary": "Descendant", + "description": "tri du plus petit au plus grand", + "value": "desc" + } + } + }, + { + "name": "page", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "title": "Page", + "description": "NumĂ©ro de la page demandĂ©e (Ă  partir de 1).", + "examples": [ + 1 + ], + "default": 1 + }, + "description": "NumĂ©ro de la page demandĂ©e (Ă  partir de 1).", + "examples": { + "normal": { + "summary": "Exemple 1", + "description": "Obtenir la premiĂšre page", + "value": 1 + } + } + }, + { + "name": "page_size", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "title": "Page", + "description": "Nombre de rĂ©sultats par page. Valeur par dĂ©faut 20. La valeur maximale est 100.", + "examples": [ + 50 + ], + "default": 10 + }, + "description": "Nombre de rĂ©sultats par page. Valeur par dĂ©faut 20. La valeur maximale est 100.", + "examples": { + "normal": { + "summary": "Exemple 1", + "description": "Obtenir 50 rĂ©sultats par requĂȘte", + "value": 50 + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer RnSwgeg3N-mIumxIre8JC2d7eD0" + } + } + ], + "responses": { + "200": { + "description": "SuccĂšs de la requĂȘte.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchResponse" + }, + "examples": { + "Example 1": { + "value": { + "hits": 0, + "params": { + "citycode": [ + "57463" + ], + "department": [ + "" + ], + "page": 1, + "page_size": 2, + "postcode": [ + "44000" + ], + "rome": [ + "D1102" + ], + "sort_by": "", + "sort_direction": "" + }, + "resolved_params": { + "jobs": [ + { + "display": "Boulangerie - viennoiserie", + "selection": "", + "type": "rome", + "value": "D1102" + } + ], + "locations": [ + { + "display": "Metz", + "geo": { + "latitude": 49.1196, + "longitude": 6.1764 + }, + "selection": "", + "type": "city", + "value": "57463" + } + ] + }, + "items": [ + { + "city": "Metz", + "citycode": "57463", + "company_name": "MAISON NICOLAS", + "department": "Moselle", + "department_number": 57, + "headcount_max": "5", + "headcount_min": "3", + "hiring_potential": 2.4201609999999993, + "id": 4636621, + "is_high_potential": false, + "location": { + "lat": 49.1196, + "lon": 6.17373 + }, + "naf": "4781Z", + "naf_label": "Commerce de dĂ©tail alimentaire sur Ă©ventaires et marchĂ©s", + "office_name": "", + "postcode": "57000", + "region": "Grand Est", + "rome": "D1102", + "siret": "30509416100034" + } + ] + } + } + } + } + }, + "links": { + "example": { + "description": "\n**GET** https://api.pole-emploi.io/partenaire/labonneboite/v1/company/?distance=30&latitude=49.119146&longitude=6.17602&rome_codes=M1607\n\n**Authorization**: Bearer [Access token]\n", + "parameters": { + "distance": "30", + "latitude": "49.119146", + "longitude": "6.17602", + "rome": "M1607" + } + } + } + }, + "403": { + "description": "Non authorisĂ©.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenError" + } + } + } + }, + "422": { + "description": "Erreur de validation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomValidationError" + } + } + } + }, + "500": { + "description": "Erreur interne.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalError" + } + } + } + } + }, + "x-stoplight": { + "id": "rc3z3pyirry8c" + } + }, + "parameters": [] + }, + "/nombreEntreprise": { + "get": { + "tags": [ + "Recherche" + ], + "summary": "Nombre d'entreprise avec potentiel d'embauche Ă  partir d'un mĂ©tier et d'un emplacement", + "description": "Cette ressource permet de rĂ©cupĂ©rer le nombre d'entreprises susceptibles de recruter dans les 6 prochains mois.", + "operationId": "search_count_search_count__get", + "parameters": [ + { + "name": "job", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "MĂ©tier", + "description": "Recherche libre de mĂ©tier. La recherche tentera de trouver une correspondance dans les libelles de:\n - rome\n - domain\n - granddomain\n - naf", + "examples": [ + "Boul" + ] + }, + "description": "Recherche libre de mĂ©tier. La recherche tentera de trouver une correspondance dans les libelles de:\n - rome\n - domain\n - granddomain\n - naf", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche d'un mĂ©tier commançant par `Boul`", + "value": "Boul" + } + } + }, + { + "name": "domain", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Domaine", + "description": "Recherche par domaine d'activitĂ© professionnel", + "examples": [ + "A14" + ] + }, + "description": "Recherche par domaine d'activitĂ© professionnel", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans les domaines 'Production' et 'Instruments de musique'", + "value": [ + "A14", + "B15" + ] + } + } + }, + { + "name": "granddomain", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Grand Domaine", + "description": "Recherche par grand domaine d'activitĂ© professionnel", + "examples": [ + "A" + ] + }, + "description": "Recherche par grand domaine d'activitĂ© professionnel", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans les grand domaines `Agriculture et PĂȘche, Espaces naturels et Espaces verts, Soins aux animaux` et `Arts et Façonnage d'ouvrages d'art`", + "value": [ + "A", + "B" + ] + } + } + }, + { + "name": "rome", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "ROME", + "description": "Recherche par code ROME. RĂ©fĂ©rentiel: [Fiche mĂ©tier France Travail](https://www.francetravail.fr/candidat/decouvrir-le-marche-du-travail/les-fiches-metiers/les-fiches-metiers-sont-regroupe.html)\n ", + "examples": [ + "D1102" + ] + }, + "description": "Recherche par code ROME. RĂ©fĂ©rentiel: [Fiche mĂ©tier France Travail](https://www.francetravail.fr/candidat/decouvrir-le-marche-du-travail/les-fiches-metiers/les-fiches-metiers-sont-regroupe.html)\n ", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche le code rome `Boulangerie - viennoiserie`", + "value": [ + "D1102" + ] + } + } + }, + { + "name": "naf", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "NAF", + "description": "Code mĂ©tier NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "examples": [ + "9499Z" + ] + }, + "description": "Code mĂ©tier NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche les codes naf `Autres organisations fonctionnant par adhĂ©sion volontaire` et `Restauration de type rapide`", + "value": [ + "9499Z", + "5610C" + ] + } + } + }, + { + "name": "location", + "in": "query", + "required": false, + "schema": { + "type": "string", + "title": "Lieu", + "description": "Recherche libre de lieu. La recherche tentera de trouver une correspondance dans les noms de villes, dĂ©partements ou rĂ©gions. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Met" + ] + }, + "description": "Recherche libre de lieu. La recherche tentera de trouver une correspondance dans les noms de villes, dĂ©partements ou rĂ©gions. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche d'un lieu commançant par 'Met'", + "value": "Met" + } + } + }, + { + "name": "region", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Nom de la RĂ©gion", + "description": "Nom de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Pays de la Loire" + ] + }, + "description": "Nom de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans la rĂ©gion `Pays de Loire`", + "value": [ + "Pays de la Loire" + ] + } + } + }, + { + "name": "region_number", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "integer" + }, + "title": "NumĂ©ro de la RĂ©gion", + "description": "NumĂ©ro de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + 32 + ] + }, + "description": "NumĂ©ro de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans la rĂ©gion `Hauts de France`", + "value": [ + 32 + ] + } + } + }, + { + "name": "department", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "DĂ©partement", + "description": "Nom du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Moselle" + ] + }, + "description": "Nom du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans les dĂ©partements `Moselle` et `Loire Atlantique`", + "value": [ + "Loire-Atlantique", + "Moselle" + ] + } + } + }, + { + "name": "department_number", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "integer" + }, + "title": "NumĂ©ro de dĂ©partement", + "description": "NumĂ©ro du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + 57 + ] + }, + "description": "NumĂ©ro du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans les dĂ©partements `Moselle` et `Loire Atlantique`", + "value": [ + 57, + 44 + ] + } + } + }, + { + "name": "city", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Ville", + "description": "Nom exact de la ville recherchĂ©e", + "examples": [ + "Metz" + ] + }, + "description": "Nom exact de la ville recherchĂ©e", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans `Metz`", + "value": [ + "Metz" + ] + } + } + }, + { + "name": "citycode", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Code INSEE", + "description": "Code INSEE de la ville recherchĂ©e", + "examples": [ + "57463" + ] + }, + "description": "Code INSEE de la ville recherchĂ©e", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans `Metz`", + "value": [ + "57463" + ] + } + } + }, + { + "name": "postcode", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Code Postal", + "description": "Code postal de la ville recherchĂ©e", + "examples": [ + "57000" + ] + }, + "description": "Code postal de la ville recherchĂ©e", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans `Metz`", + "value": [ + "57000" + ] + } + } + }, + { + "name": "latitude", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Latitude", + "description": "Latitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "examples": [ + 47.21837 + ] + }, + "description": "Latitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche Ă  `Nantes`", + "value": 47.21837 + } + } + }, + { + "name": "longitude", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Longitude", + "description": "Longitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "examples": [ + -1.55362 + ] + }, + "description": "Longitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche Ă  `Nantes`", + "value": -1.55362 + } + } + }, + { + "name": "distance", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer", + "exclusiveMinimum": 0 + }, + { + "type": "null" + } + ], + "title": "Distance", + "description": "PĂ©rimĂštre du rayon de recherche (en kilomĂštres).\n\nLongitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n**Utilisation**:\nCe paramĂštre (en **km**) s'utilise en combinaison avec:\n\n- `latitude` & `longitude`\n- `citycode`\n\nSi les coordonnĂ©es `latitude` / `longitude` sont utilisĂ©es, il s'agit du rayon du cercle autour du point gĂ©ographique dĂ©fini par le couple\n`longitude` / `latitude`.\nSinon, une recherche est effectuĂ© autour des coordonnĂ©es gĂ©ographique des mairies pour les villes dans la recherche (citycode).\n\nLa distance doit ĂȘtre comprise entre ] 0, 200km [", + "examples": [ + 25 + ], + "lte": 200 + }, + "description": "PĂ©rimĂštre du rayon de recherche (en kilomĂštres).\n\nLongitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n**Utilisation**:\nCe paramĂštre (en **km**) s'utilise en combinaison avec:\n\n- `latitude` & `longitude`\n- `citycode`\n\nSi les coordonnĂ©es `latitude` / `longitude` sont utilisĂ©es, il s'agit du rayon du cercle autour du point gĂ©ographique dĂ©fini par le couple\n`longitude` / `latitude`.\nSinon, une recherche est effectuĂ© autour des coordonnĂ©es gĂ©ographique des mairies pour les villes dans la recherche (citycode).\n\nLa distance doit ĂȘtre comprise entre ] 0, 200km [", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans un rayon de 25km", + "value": 25 + } + } + }, + { + "name": "bbox", + "in": "query", + "required": false, + "schema": { + "type": "string", + "title": "BBOX", + "description": "Ce paramĂštre permet de dĂ©finir un rectangle gĂ©ographique pour dĂ©finir la zone de recherche.\n\n**RĂ©fĂ©rentiel**: https://wiki.openstreetmap.org/wiki/Bounding_box\n\n**Utilisation**:\nPour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement 4 valeurs sĂ©parĂ©es par des `|` :\n\n left|bottom|right|top\n\n - left: longitude du bord gauche\n - bottom: latitude du bord en bas\n - right: longitude du bord droit\n - top: latitude du bord en haut", + "examples": [ + "-1.5|47.2|-1.6|47.3" + ] + }, + "description": "Ce paramĂštre permet de dĂ©finir un rectangle gĂ©ographique pour dĂ©finir la zone de recherche.\n\n**RĂ©fĂ©rentiel**: https://wiki.openstreetmap.org/wiki/Bounding_box\n\n**Utilisation**:\nPour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement 4 valeurs sĂ©parĂ©es par des `|` :\n\n left|bottom|right|top\n\n - left: longitude du bord gauche\n - bottom: latitude du bord en bas\n - right: longitude du bord droit\n - top: latitude du bord en haut", + "examples": { + "normal": { + "summary": "Example 1", + "description": "Recherche dans un rectangle autour de Nantes", + "value": "-1.5|47.2|-1.6|47.3" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer RnSwgeg3N-mIumxIre8JC2d7eD0" + } + } + ], + "responses": { + "200": { + "description": "SuccĂšs de la requĂȘte.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchCountResponse" + }, + "examples": { + "Example 1": { + "value": { + "hits": 0, + "params": { + "citycode": [ + "57463" + ], + "department": [ + "" + ], + "page": 1, + "page_size": 2, + "postcode": [ + "44000" + ], + "rome": [ + "D1102" + ], + "sort_by": "", + "sort_direction": "" + }, + "resolved_params": { + "jobs": [ + { + "display": "Boulangerie - viennoiserie", + "selection": "", + "type": "rome", + "value": "D1102" + } + ], + "locations": [ + { + "display": "Metz", + "geo": { + "latitude": 49.1196, + "longitude": 6.1764 + }, + "selection": "", + "type": "city", + "value": "57463" + } + ] + } + } + } + } + } + }, + "links": { + "example": { + "description": "\n**GET** https://api.pole-emploi.io/partenaire/labonneboite/v1/company/count/?distance=30&latitude=49.119146&longitude=6.17602&rome_codes=M1607\n\n**Authorization**: Bearer [Access token]\n", + "parameters": { + "distance": "30", + "latitude": "49.119146", + "longitude": "6.17602", + "rome": "M1607" + } + } + } + }, + "403": { + "description": "Non authorisĂ©.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenError" + } + } + } + }, + "422": { + "description": "Erreur de validation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomValidationError" + } + } + } + }, + "500": { + "description": "Erreur interne.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalError" + } + } + } + } + }, + "x-stoplight": { + "id": "kdezkce3z7jqy" + } + }, + "parameters": [] + }, + "/potentielEmbauche": { + "get": { + "tags": [ + "Entreprise" + ], + "summary": "Cette ressource permet de consulter les entreprises Ă  fort potentiel d'embauche par leur numĂ©ro de siret.", + "description": "Recherche d'information pour des sirets avec potentiel d'embauche", + "operationId": "with_scores_company_scores__get", + "parameters": [ + { + "name": "siret", + "in": "query", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "title": "MĂ©tier", + "description": "NumĂ©ro de siret exact de l'entreprise recherchĂ©.", + "examples": [ + "13000548100010" + ], + "required": true + }, + "description": "NumĂ©ro de siret exact de l'entreprise recherchĂ©.", + "examples": { + "normal": { + "summary": "Exemple 1", + "description": "Recherche des sirets `82193994900045` et `13000548100010`", + "value": [ + "13000548100010", + "82193994900045" + ] + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer RnSwgeg3N-mIumxIre8JC2d7eD0" + } + } + ], + "responses": { + "200": { + "description": "SuccĂšs de la requĂȘte.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OfficeScoreResponse" + }, + "examples": { + "Example 1": { + "value": { + "hits": 1, + "items": [ + { + "city": "Paris", + "citycode": "75120", + "company_name": "POLE EMPLOI", + "department": "Paris", + "department_number": 75, + "headcount_max": "1999", + "headcount_min": "1000", + "hiring_potential": 91.38373304856015, + "id": 12905309, + "is_high_potential": true, + "location": { + "lat": 48.8778, + "lon": 2.40989 + }, + "naf": "8413Z", + "naf_label": "Administration publique (tutelle) des activitĂ©s Ă©conomiques", + "office_name": "", + "postcode": "75020", + "region": "Île-de-France", + "siret": "13000548100010" + } + ] + } + } + } + } + }, + "links": { + "example": { + "description": "\n**GET** GET https://api.pole-emploi.io/partenaire/labonneboite/v2/company/scores/?siret=13000548100010\n\n**Authorization**: Bearer [Access token]\n", + "parameters": { + "siret": "13000548100010" + } + } + } + }, + "403": { + "description": "Non authorisĂ©.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForbiddenError" + } + } + } + }, + "422": { + "description": "Erreur de validation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomValidationError" + } + } + } + }, + "500": { + "description": "Erreur interne.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InternalError" + } + } + } + } + }, + "x-stoplight": { + "id": "ln57z1mmngtyc" + } + }, + "parameters": [] + } + }, + "components": { + "schemas": { + "CustomValidationError": { + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ValidationErrorDetail" + }, + "type": "array", + "title": "Errors" + } + }, + "type": "object", + "required": [ + "errors" + ], + "title": "CustomValidationError", + "x-stoplight": { + "id": "oyzninkxy756j" + } + }, + "ForbiddenError": { + "properties": { + "error": { + "type": "string", + "title": "Non authorisĂ©", + "description": "Message d'erreur dans le cas d'une erreur 403", + "examples": [ + "Vous n'avez pas le droit d'accĂ©der Ă  la ressource demandĂ©e" + ] + } + }, + "type": "object", + "required": [ + "error" + ], + "title": "ForbiddenError", + "x-stoplight": { + "id": "tgytag5k6x2zg" + } + }, + "GeoCoords": { + "properties": { + "latitude": { + "type": "number", + "title": "Latitude", + "description": "Latitude de l'entreprise.", + "examples": [ + 49.1196 + ] + }, + "longitude": { + "type": "number", + "title": "Longitude", + "description": "Longitude de l'entreprise.", + "examples": [ + 6.1764 + ] + } + }, + "type": "object", + "required": [ + "latitude", + "longitude" + ], + "title": "GeoCoords", + "example": { + "latitude": 49.1196, + "longitude": 6.1764 + }, + "x-stoplight": { + "id": "awt1ekmev1cql" + } + }, + "InternalError": { + "properties": { + "error": { + "type": "string", + "title": "Erreur interne du serveur", + "description": "Message d'erreur dans le cas d'une erreur 500", + "examples": [ + "Une erreur est survenue." + ] + } + }, + "type": "object", + "required": [ + "error" + ], + "title": "InternalError", + "x-stoplight": { + "id": "s2xugls99jv1b" + } + }, + "JobItem": { + "properties": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/JobType" + } + ], + "title": "Type de mĂ©tier", + "description": "Il peut ĂȘtre de l'une de ces catĂ©gories:\n - rome\n - domain\n - granddomain\n - naf", + "examples": [ + "rome" + ] + }, + "value": { + "type": "string", + "title": "Code du mĂ©tier", + "description": "En fonction du type du mĂ©tier, cette valeur peut varier. Mais elle reprĂ©sente le code et non l'appellation", + "examples": [ + "D1102" + ] + }, + "display": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Appellation du mĂ©tier", + "description": "Ceci est l'appellation du mĂ©tier", + "default": "", + "examples": [ + "Boulangerie - viennoiserie" + ] + }, + "selection": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Autre Appellation du mĂ©tier", + "description": "Ce champ a Ă©tĂ© mis en place pour les besoins du site La Bonne Boite et peut ĂȘtre ignorĂ©.", + "default": "", + "examples": [ + "" + ] + } + }, + "type": "object", + "required": [ + "type", + "value" + ], + "title": "JobItem", + "example": { + "display": "Boulangerie - viennoiserie", + "selection": "", + "type": "rome", + "value": "D1102" + }, + "x-stoplight": { + "id": "5ylwqs5566k66" + } + }, + "JobType": { + "type": "string", + "enum": [ + "naf", + "rome", + "domain", + "granddomain" + ], + "title": "JobType", + "x-stoplight": { + "id": "8ha9wtlw536pv" + } + }, + "LocationItem": { + "properties": { + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/LocationType" + } + ], + "title": "Type du lieu", + "description": "Il peut ĂȘtre de l'une de ces catĂ©gories:\n - city\n - region\n - department", + "examples": [ + "city" + ] + }, + "value": { + "type": "string", + "title": "Code du lieu", + "description": "En fonction du type du mĂ©tier, cette valeur peut varier. Mais elle reprĂ©sente le code INSEE, le code rĂ©gion ou le code du dĂ©partement. ", + "examples": [ + "57463" + ] + }, + "display": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nom du lieu", + "description": "Ceci est la dĂ©nomination du lieu ", + "default": "", + "examples": [ + "Metz" + ] + }, + "selection": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Autre Appellation du lieu", + "description": "Ce champ a Ă©tĂ© mis en place pour les besoins du site La Bonne Boite et peut ĂȘtre ignorĂ©.", + "default": "", + "examples": [ + "" + ] + }, + "geo": { + "anyOf": [ + { + "$ref": "#/components/schemas/GeoCoords" + }, + { + "type": "null" + } + ], + "title": "CoordonnĂ©e Mairie", + "description": "Dans le cadre d'une recherche par code INSEE, c'est l'emplacement gĂ©ographique de la mairie", + "examples": [ + { + "latitude": 49.1196, + "longitude": 6.1764 + } + ] + } + }, + "type": "object", + "required": [ + "type", + "value" + ], + "title": "LocationItem", + "example": { + "display": "Metz", + "geo": { + "latitude": 49.1196, + "longitude": 6.1764 + }, + "selection": "", + "type": "city", + "value": "57463" + }, + "x-stoplight": { + "id": "rm3xtyaev7mzc" + } + }, + "LocationType": { + "type": "string", + "enum": [ + "city", + "region", + "department" + ], + "title": "LocationType", + "x-stoplight": { + "id": "3hd6mvsv52x1o" + } + }, + "OfficeScoreResponse": { + "properties": { + "hits": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Nombre de rĂ©sultats", + "description": "Nombre de rĂ©sultats pour la recherche en cours", + "examples": [ + 150 + ] + }, + "items": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/OfficeScoreResponseItem" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Items" + } + }, + "type": "object", + "title": "OfficeScoreResponse", + "example": { + "hits": 1, + "items": [ + { + "city": "Paris", + "citycode": "75120", + "company_name": "POLE EMPLOI", + "department": "Paris", + "department_number": 75, + "headcount_max": "1999", + "headcount_min": "1000", + "hiring_potential": 91.38373304856015, + "id": 12905309, + "is_high_potential": true, + "location": { + "lat": 48.8778, + "lon": 2.40989 + }, + "naf": "8413Z", + "naf_label": "Administration publique (tutelle) des activitĂ©s Ă©conomiques", + "office_name": "", + "postcode": "75020", + "region": "Île-de-France", + "siret": "13000548100010" + } + ] + }, + "x-stoplight": { + "id": "rc09mfnehpl7t" + } + }, + "OfficeScoreResponseItem": { + "properties": { + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Id" + }, + "siret": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "SIRET", + "description": "NumĂ©ro de SIRET de l'entreprise." + }, + "company_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nom", + "description": "Nom de l'entreprise", + "examples": [ + "Leclerc" + ] + }, + "office_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nom Emplacement", + "description": "Nom d'emplacement de l'entreprise (Nom d'une agence ou nom d'une boutique).", + "examples": [ + "Leclerc Paridis" + ] + }, + "headcount_min": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nombre d'employĂ© minimum", + "description": "Nombre d'employĂ© minimum de l'entreprise", + "examples": [ + 50 + ] + }, + "headcount_max": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nombre d'employĂ© maximum", + "description": "Nombre d'employĂ© maximum de l'entreprise", + "examples": [ + 99 + ] + }, + "naf": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "NAF", + "description": "Code mĂ©tier NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "examples": [ + "5610C" + ] + }, + "naf_label": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Label Naf", + "description": "Description du code NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "examples": [ + "Restauration de type rapide" + ] + }, + "location": { + "anyOf": [ + { + "$ref": "#/components/schemas/server__routes__office__schemas__GeoResponse" + }, + { + "type": "null" + } + ] + }, + "city": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ville", + "description": "Nom exact de la ville", + "examples": [ + "Metz" + ] + }, + "citycode": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Code INSEE", + "description": "Code INSEE de la ville", + "examples": [ + "57463" + ] + }, + "postcode": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Code Postal", + "description": "Code postal de la ville", + "examples": [ + "57000" + ] + }, + "department": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "DĂ©partement", + "description": "Nom du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Moselle" + ] + }, + "region": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nom de la RĂ©gion", + "description": "Nom de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Pays de la Loire" + ] + }, + "department_number": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "NumĂ©ro de dĂ©partement", + "description": "NumĂ©ro du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + 57 + ] + }, + "hiring_potential": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Potentiel d'embauche", + "description": "Potentiel d'embauche de l'entreprise entre 0 et 100. C'est une valeur transformĂ©e depuis les donnĂ©es fournies par ADS.\n\n- Si le mode de recherche est par code NAF alors le potentiel d'embauche est celui de l'entreprise\n- Sinon, le potentiel d'embauche est celui du code ROME pour ce NAF.", + "examples": [ + 74.2658 + ] + }, + "is_high_potential": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "A fort potentiel d'embauche", + "description": "Est ce que l'entreprise est considĂ©rĂ© comme ayant un fort potentiel d'embauche.", + "examples": [ + true + ] + } + }, + "type": "object", + "title": "OfficeScoreResponseItem", + "x-stoplight": { + "id": "jx75ukj2pmt4w" + } + }, + "ResolvedSearchParams": { + "properties": { + "jobs": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/JobItem" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Jobs" + }, + "locations": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/LocationItem" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Locations" + } + }, + "type": "object", + "title": "ResolvedSearchParams", + "x-stoplight": { + "id": "ezi5157zh8vy6" + } + }, + "SearchCountResponse": { + "properties": { + "hits": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Nombre de rĂ©sultats", + "description": "Nombre de rĂ©sultats pour la recherche en cours", + "examples": [ + 151 + ] + }, + "params": { + "anyOf": [ + { + "$ref": "#/components/schemas/SearchParams" + }, + { + "type": "null" + } + ], + "title": "ParamĂštres de recherche utilisĂ©", + "description": "Retour des paramĂštres utilisĂ©s pour effectuer la recherche." + }, + "resolved_params": { + "anyOf": [ + { + "$ref": "#/components/schemas/ResolvedSearchParams" + }, + { + "type": "null" + } + ], + "title": "RĂ©solution de paramĂštres", + "description": "Certains paramĂštres font l'objet d'une rĂ©solution notamment pour les lieux et les mĂ©tiers." + } + }, + "type": "object", + "title": "SearchCountResponse", + "x-stoplight": { + "id": "swzsni1awcemw" + } + }, + "SearchParams": { + "properties": { + "job": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "MĂ©tier", + "description": "Recherche libre de mĂ©tier. La recherche tentera de trouver une correspondance dans les libelles de:\n - rome\n - domain\n - granddomain\n - naf", + "default": [ + null + ], + "examples": [ + "Boul" + ] + }, + "domain": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Domaine", + "description": "Recherche par domaine d'activitĂ© professionnel", + "default": [ + null + ], + "examples": [ + "A14" + ] + }, + "granddomain": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Grand Domaine", + "description": "Recherche par grand domaine d'activitĂ© professionnel", + "default": [ + null + ], + "examples": [ + "A" + ] + }, + "rome": { + "items": { + "type": "string" + }, + "type": "array", + "title": "ROME", + "description": "Recherche par code ROME. RĂ©fĂ©rentiel: [Fiche mĂ©tier France Travail](https://www.francetravail.fr/candidat/decouvrir-le-marche-du-travail/les-fiches-metiers/les-fiches-metiers-sont-regroupe.html)\n ", + "default": [ + null + ], + "examples": [ + "D1102" + ] + }, + "naf": { + "items": { + "type": "string" + }, + "type": "array", + "title": "NAF", + "description": "Code mĂ©tier NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "default": [ + null + ], + "examples": [ + "9499Z" + ] + }, + "location": { + "type": "string", + "title": "Lieu", + "description": "Recherche libre de lieu. La recherche tentera de trouver une correspondance dans les noms de villes, dĂ©partements ou rĂ©gions. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "default": [ + null + ], + "examples": [ + "Met" + ] + }, + "region": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Nom de la RĂ©gion", + "description": "Nom de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "default": [ + null + ], + "examples": [ + "Pays de la Loire" + ] + }, + "region_number": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "NumĂ©ro de la RĂ©gion", + "description": "NumĂ©ro de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "default": [ + null + ], + "examples": [ + 32 + ] + }, + "department": { + "items": { + "type": "string" + }, + "type": "array", + "title": "DĂ©partement", + "description": "Nom du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "default": [ + null + ], + "examples": [ + "Moselle" + ] + }, + "department_number": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "NumĂ©ro de dĂ©partement", + "description": "NumĂ©ro du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "default": [ + null + ], + "examples": [ + 57 + ] + }, + "city": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Ville", + "description": "Nom exact de la ville recherchĂ©e", + "default": [ + null + ], + "examples": [ + "Metz" + ] + }, + "citycode": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Code INSEE", + "description": "Code INSEE de la ville recherchĂ©e", + "default": [ + null + ], + "examples": [ + "57463" + ] + }, + "postcode": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Code Postal", + "description": "Code postal de la ville recherchĂ©e", + "default": [ + null + ], + "examples": [ + "57000" + ] + }, + "latitude": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Latitude", + "description": "Latitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "default": [ + null + ], + "examples": [ + 47.21837 + ] + }, + "longitude": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Longitude", + "description": "Longitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n Pour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement `latitude`, `longitude`et `distance`", + "default": [ + null + ], + "examples": [ + -1.55362 + ] + }, + "distance": { + "anyOf": [ + { + "type": "integer", + "exclusiveMinimum": 0 + }, + { + "type": "null" + } + ], + "title": "Distance", + "description": "PĂ©rimĂštre du rayon de recherche (en kilomĂštres).\n\nLongitude du point gĂ©ographique Ă  proximitĂ© duquel on recherche des entreprises Ă  fort potentiel d'embauche.\n\n**Utilisation**:\nCe paramĂštre (en **km**) s'utilise en combinaison avec:\n\n- `latitude` & `longitude`\n- `citycode`\n\nSi les coordonnĂ©es `latitude` / `longitude` sont utilisĂ©es, il s'agit du rayon du cercle autour du point gĂ©ographique dĂ©fini par le couple\n`longitude` / `latitude`.\nSinon, une recherche est effectuĂ© autour des coordonnĂ©es gĂ©ographique des mairies pour les villes dans la recherche (citycode).\n\nLa distance doit ĂȘtre comprise entre ] 0, 200km [", + "default": [ + null + ], + "examples": [ + 25 + ], + "lte": 200 + }, + "bbox": { + "type": "string", + "title": "BBOX", + "description": "Ce paramĂštre permet de dĂ©finir un rectangle gĂ©ographique pour dĂ©finir la zone de recherche.\n\n**RĂ©fĂ©rentiel**: https://wiki.openstreetmap.org/wiki/Bounding_box\n\n**Utilisation**:\nPour utiliser ce paramĂštre, il faut prĂ©ciser obligatoirement 4 valeurs sĂ©parĂ©es par des `|` :\n\n left|bottom|right|top\n\n - left: longitude du bord gauche\n - bottom: latitude du bord en bas\n - right: longitude du bord droit\n - top: latitude du bord en haut", + "default": [ + null + ], + "examples": [ + "-1.5|47.2|-1.6|47.3" + ] + } + }, + "type": "object", + "title": "SearchParams", + "example": { + "citycode": [ + "57463" + ], + "department": [ + "" + ], + "page": 1, + "page_size": 2, + "postcode": [ + "44000" + ], + "rome": [ + "D1102" + ], + "sort_by": "", + "sort_direction": "" + }, + "x-stoplight": { + "id": "bdpg41zmhrpc1" + } + }, + "SearchResponse": { + "properties": { + "hits": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Nombre de rĂ©sultats", + "description": "Nombre de rĂ©sultats pour la recherche en cours", + "examples": [ + 151 + ] + }, + "params": { + "anyOf": [ + { + "$ref": "#/components/schemas/SearchParams" + }, + { + "type": "null" + } + ], + "title": "ParamĂštres de recherche utilisĂ©", + "description": "Retour des paramĂštres utilisĂ©s pour effectuer la recherche." + }, + "resolved_params": { + "anyOf": [ + { + "$ref": "#/components/schemas/ResolvedSearchParams" + }, + { + "type": "null" + } + ], + "title": "RĂ©solution de paramĂštres", + "description": "Certains paramĂštres font l'objet d'une rĂ©solution notamment pour les lieux et les mĂ©tiers." + }, + "items": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/SearchResponseItem" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Items" + } + }, + "type": "object", + "title": "SearchResponse", + "x-stoplight": { + "id": "y1qhs0gn4sv74" + } + }, + "SearchResponseItem": { + "properties": { + "rome": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "MĂ©tier", + "description": "Code rome", + "examples": [ + "D1102" + ] + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Id", + "description": "Id de l'entreprise", + "examples": [ + 4636621 + ] + }, + "siret": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "SIRET", + "description": "NumĂ©ro de SIRET de l'entreprise.", + "examples": [ + "30509416100034" + ] + }, + "company_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nom", + "description": "Nom de l'entreprise", + "examples": [ + "MAISON NICOLAS" + ] + }, + "office_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nom Emplacement", + "description": "Nom d'emplacement de l'entreprise (Nom d'une agence ou nom d'une boutique).", + "examples": [ + "MAISON NICOLAS" + ] + }, + "headcount_min": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nombre d'employĂ© minimum", + "description": "Nombre d'employĂ© minimum de l'entreprise", + "examples": [ + 3 + ] + }, + "headcount_max": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nombre d'employĂ© maximum", + "description": "Nombre d'employĂ© maximum de l'entreprise", + "examples": [ + 5 + ] + }, + "naf": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "NAF", + "description": "Code mĂ©tier NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "examples": [ + "4781Z" + ] + }, + "naf_label": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Label Naf", + "description": "Description du code NAF associĂ©s aux entreprises. [Nomenclature d'activitĂ©s française de l'Insee (rĂ©v. 2, 2008 - Niveau 2 - Liste des divisions)](https://www.insee.fr/fr/information/2406147)", + "examples": [ + "Commerce de dĂ©tail alimentaire sur Ă©ventaires et marchĂ©s" + ] + }, + "location": { + "anyOf": [ + { + "$ref": "#/components/schemas/server__routes__search__schemas__GeoResponse" + }, + { + "type": "null" + } + ] + }, + "city": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Ville", + "description": "Nom exact de la ville", + "examples": [ + "Metz" + ] + }, + "citycode": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Code INSEE", + "description": "Code INSEE de la ville", + "examples": [ + "57463" + ] + }, + "postcode": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Code Postal", + "description": "Code postal de la ville", + "examples": [ + "57000" + ] + }, + "department": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "DĂ©partement", + "description": "Nom du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Moselle" + ] + }, + "region": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nom de la RĂ©gion", + "description": "Nom de la rĂ©gion. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "Grand Est" + ] + }, + "department_number": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "NumĂ©ro de dĂ©partement", + "description": "NumĂ©ro du dĂ©partement. Les noms des villes, dĂ©partement et rĂ©gions proviennent de [geo.api.gouv.fr](https://geo.api.gouv.fr/)", + "examples": [ + "57" + ] + }, + "hiring_potential": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Potentiel d'embauche", + "description": "Potentiel d'embauche de l'entreprise entre 0 et 100. C'est une valeur transformĂ©e depuis les donnĂ©es fournies par ADS.\n\n- Si le mode de recherche est par code NAF alors le potentiel d'embauche est celui de l'entreprise\n- Sinon, le potentiel d'embauche est celui du code ROME pour ce NAF." + }, + "is_high_potential": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "A fort potentiel d'embauche", + "description": "Longitude de l'entreprise.", + "examples": [ + true + ] + } + }, + "type": "object", + "title": "SearchResponseItem", + "example": { + "city": "Metz", + "citycode": "57463", + "company_name": "MAISON NICOLAS", + "department": "Moselle", + "department_number": 57, + "headcount_max": "5", + "headcount_min": "3", + "hiring_potential": 2.4201609999999993, + "id": 4636621, + "is_high_potential": false, + "location": { + "lat": 49.1196, + "lon": 6.17373 + }, + "naf": "4781Z", + "naf_label": "Commerce de dĂ©tail alimentaire sur Ă©ventaires et marchĂ©s", + "office_name": "", + "postcode": "57000", + "region": "Grand Est", + "rome": "D1102", + "siret": "30509416100034" + }, + "x-stoplight": { + "id": "vogsnhyf6jq7n" + } + }, + "ValidationErrorDetail": { + "properties": { + "param": { + "items": { + "type": "string" + }, + "type": "array", + "title": "ParamĂštre en erreur", + "description": "Emplacement dans le schĂ©ma du paramĂštre en erreur", + "examples": [ + "distance" + ] + }, + "message": { + "type": "string", + "title": "Message", + "description": "Message dĂ©crivant l'erreur", + "examples": [ + "distance parameter cannot be above 200km" + ] + } + }, + "type": "object", + "required": [ + "param", + "message" + ], + "title": "ValidationErrorDetail", + "x-stoplight": { + "id": "l6ict780t8asn" + } + }, + "server__routes__office__schemas__GeoResponse": { + "properties": { + "lat": { + "type": "number", + "title": "Latitude", + "description": "Latitude de l'entreprise.", + "examples": [ + 47.21837 + ] + }, + "lon": { + "type": "number", + "title": "Longitude", + "description": "Longitude de l'entreprise.", + "examples": [ + -1.55362 + ] + } + }, + "type": "object", + "required": [ + "lat", + "lon" + ], + "title": "GeoResponse", + "x-stoplight": { + "id": "nb1zrir78vg2k" + } + }, + "server__routes__search__schemas__GeoResponse": { + "properties": { + "lat": { + "type": "number", + "title": "Latitude", + "description": "Latitude de l'entreprise.", + "examples": [ + 49.1196 + ] + }, + "lon": { + "type": "number", + "title": "Longitude", + "description": "Longitude de l'entreprise.", + "examples": [ + 6.1764 + ] + } + }, + "type": "object", + "required": [ + "lat", + "lon" + ], + "title": "GeoResponse", + "example": { + "lat": 49.1196, + "lon": 6.1764 + }, + "x-stoplight": { + "id": "ob2yrovz1rfgs" + } + } + } + } +} \ No newline at end of file diff --git a/docs/api/MarchĂ© du travail.json b/docs/api/MarchĂ© du travail.json new file mode 100644 index 0000000..1caf1fa --- /dev/null +++ b/docs/api/MarchĂ© du travail.json @@ -0,0 +1,3405 @@ +{ + "openapi": "3.0.1", + "info": { + "version": "1", + "title": "MarchĂ© du travail", + "description": "AccĂ©dez aux statistiques de France Travail - MarchĂ© du travail. \r\n\r\nCette API vous fournit toutes les donnĂ©es statistiques essentielles de France Travail pour bien Ă©valuer la situation de l'emploi sur un territoire: chiffres des demandeurs d'emploi, offres, embauches. Elle intĂšgre des indicateurs clĂ©s dĂ©veloppĂ©s par France Travail vous permettant de comprendre les tensions sur les mĂ©tiers, ainsi que la dynamique globale d'un territoire.\r\n\r\n**Scopes :** `api_stats-offres-demandes-emploiv1`,`offresetdemandesemploi`\r\n\r\n**Royaume :** `/partenaire`" + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "paths": { + "/v1/indicateur/stat-demandeurs": { + "post": { + "tags": [ + "Demandeurs" + ], + "summary": "Stats des demandeurs d'emploi inscrits en fin de trimestre (DE_1)", + "description": "Permet de rechercher les donnĂ©es statistiques sur le Nombre de demandeurs d'emploi inscrits en fin de trimestre par mĂ©tier et par compĂ©tence (DE_1), selon des critĂšres obligatoires (territoire, activitĂ©) et facultatifs (catĂ©gories de candidats, pĂ©riodes, caractĂ©ristiques).", + "operationId": "rechercherStatDemandeurs", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CritereIndicateurAvecNomenclature" + }, + "examples": { + "default": { + "value": { + "codeTypeTerritoire": "REG", + "codeTerritoire": "75", + "codeTypeActivite": "ROME", + "codeActivite": "A1203", + "codeTypePeriode": "TRIMESTRE", + "codeTypeNomenclature": "CATCAND" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Statistiques demandeurs d'emploi trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/indicateur/stat-demandeurs-entrant": { + "post": { + "tags": [ + "Demandeurs" + ], + "summary": "Stats des demandeurs d'emploi nouveaux inscrits au cours du trimestre et des 12 derniers mois (DE_5)", + "description": "Permet de rechercher les donnĂ©es statistiques sur le Nombre de demandeurs d'emploi nouveaux inscrits au cours du trimestre et des 12 derniers mois, par mĂ©tier (DE_5), selon des critĂšres obligatoires (territoire, activitĂ©) et facultatifs (nomenclature, pĂ©riodes, caractĂ©ristiques).", + "operationId": "rechercherStatDemandeursEntrants", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CritereIndicateurAvecNomenclature" + }, + "examples": { + "default": { + "value": { + "codeTypeTerritoire": "REG", + "codeTerritoire": "75", + "codeTypeActivite": "ROME", + "codeActivite": "A1203", + "codeTypePeriode": "TRIMESTRE", + "codeTypeNomenclature": "CATCAND" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Statistiques demandeurs d'emploi trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/indicateur/stat-dynamique-emploi": { + "post": { + "tags": [ + "Dynamique Emploi" + ], + "summary": "Stats sur l'Indicateur global de dynamique de l’emploi sur le territoire sĂ©lectionnĂ© (DYN_1)", + "description": "Permet de rechercher les donnĂ©es statistiques sur l'Indicateur global de dynamique de l’emploi sur le territoire sĂ©lectionnĂ© (DYN_1), selon des critĂšres obligatoires (territoire, activitĂ©) et facultatifs (pĂ©riodes). ParticularitĂ©s de cet indicateur : pas de caractĂ©ristique.", + "operationId": "rechercherStatDynamiqueEmploi", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CritereIndicateurSansNomenclature" + }, + "examples": { + "default": { + "value": { + "codeTypeTerritoire": "REG", + "codeTerritoire": "75", + "codeTypeActivite": "MOYENNE", + "codeActivite": "MOYENNE", + "codeTypePeriode": "TRIMESTRE" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Statistiques dynamisme de l'emploi trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/indicateur/stat-embauches": { + "post": { + "tags": [ + "Embauches" + ], + "summary": "Stats sur les embauches (EMB_1)", + "description": "Permet de rechercher les donnĂ©es statistiques sur les Embauches par mĂ©tier recherchĂ© pour les demandeurs d'emploi et par secteur (EMB_1) selon des critĂšres obligatoires (territoire, activitĂ©) et facultatifs (CatĂ©gories de candidat, durĂ©e d’emploi, pĂ©riodes, caractĂ©ristiques).", + "operationId": "rechercherStatEmbauches", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CritereIndicateurAvecNomenclature" + }, + "examples": { + "default": { + "value": { + "codeTypeTerritoire": "REG", + "codeTerritoire": "75", + "codeTypeActivite": "ROME", + "codeActivite": "A1203", + "codeTypePeriode": "TRIMESTRE", + "codeTypeNomenclature": "CATCANDxDUREEEMP" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Statistiques sur les embauches trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/indicateur/stat-offres": { + "post": { + "tags": [ + "Offres" + ], + "summary": "Stats sur les offres d'emploi (OFF_1)", + "description": "Permet de rechercher les donnĂ©es statistiques sur les Offres enregistrĂ©es au cours du trimestre et des 12 derniers mois par mĂ©tier, secteur et compĂ©tence (OFF_1) selon des critĂšres obligatoires (territoire, activitĂ©) et facultatifs (origine des offres, pĂ©riodes, caractĂ©ristiques).", + "operationId": "rechercherStatOffres", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CritereIndicateurAvecNomenclature" + }, + "examples": { + "default": { + "value": { + "codeTypeTerritoire": "REG", + "codeTerritoire": "75", + "codeTypeActivite": "ROME", + "codeActivite": "A1203", + "codeTypePeriode": "TRIMESTRE", + "codeTypeNomenclature": "ORIGINEOFF" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Statistiques des offres d'emploi trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/indicateur/stat-perspective-employeur": { + "post": { + "tags": [ + "Perspectives Recrutement" + ], + "summary": "Stats sur les difficultĂ©s de recrutement (indicateur de tension) (PERSP_2)", + "description": "Permet de rechercher les donnĂ©es statistiques sur les difficultĂ©s de recrutement (indicateur de tension) par mĂ©tier (PERSP_2), selon des critĂšres obligatoires (territoire, activitĂ©) et facultatifs (pĂ©riodes). ParticularitĂ©s de cet indicateur : pas de caractĂ©ristique.", + "operationId": "rechercherStatPerspectivesEmployeur", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CritereIndicateurAvecNomenclature" + }, + "examples": { + "default": { + "value": { + "codeTypeTerritoire": "REG", + "codeTerritoire": "75", + "codeTypeActivite": "ROME", + "codeActivite": "A1203", + "codeTypePeriode": "ANNEE", + "codeTypeNomenclature": "TYPE_TENSION" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Statistiques des difficultĂ©s de recrutement trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/indicateur/salaire-rome-fap/{codeTypeTerritoire}/{codeTerritoire}": { + "get": { + "tags": [ + "Salaries" + ], + "summary": "Stats sur les salariĂ©s en poste par typologie de salaire (SAL_3)", + "description": "Permet de rechercher les donnĂ©es statistiques sur les montants des salaires en poste (SAL_3), selon des critĂšres obligatoires (territoire, ROME).", + "operationId": "rechercherStatSalairesParMetier", + "parameters": [ + { + "name": "codeRome", + "in": "query", + "description": "Code ROME", + "schema": { + "type": "string", + "example": "A1101" + }, + "examples": { + "default": { + "value": "A1101" + } + } + }, + { + "name": "codeTypeTerritoire", + "in": "path", + "description": "Code du type de territoire", + "required": true, + "schema": { + "type": "string", + "example": "NAT" + }, + "examples": { + "default": { + "value": "NAT" + } + } + }, + { + "name": "codeTerritoire", + "in": "path", + "description": "Code du territoire", + "required": true, + "schema": { + "type": "string", + "example": "FR" + }, + "examples": { + "default": { + "value": "FR" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Statistiques salaires en poste trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/activite": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Consulter une activitĂ©", + "description": "Permet de consulter une activitĂ© du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type activitĂ© et code activitĂ©).", + "operationId": "recupererActiviteParCodeActiviteEtCodeTypeActivite", + "parameters": [ + { + "name": "codeActivite", + "in": "query", + "description": "codeActivite", + "required": true, + "schema": { + "type": "string", + "example": "A1203" + }, + "examples": { + "default": { + "value": "A1203" + } + } + }, + { + "name": "codeTypeActivite", + "in": "query", + "description": "codeTypeActivite", + "required": true, + "schema": { + "type": "string", + "example": "ROME" + }, + "examples": { + "default": { + "value": "ROME" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne une activitĂ©", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Activite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Activite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/activites": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Lister les activitĂ©s", + "description": "Permet de lister les activitĂ©s du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeActivite", + "responses": { + "200": { + "description": "Retourne la liste d'activitĂ©s", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeActivite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeActivite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/activites/{codeTypeActivite}": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Lister les activitĂ©s pour un type d'activitĂ©", + "description": "Permet de lister les activitĂ©s du RĂ©fĂ©rentiel Smart Emploi pour un type d'activitĂ©.", + "operationId": "recupererListeActiviteParCodeTypeActivite", + "parameters": [ + { + "name": "filtreActivite", + "in": "query", + "description": "filtreActivite", + "schema": { + "type": "string", + "example": "A12" + }, + "examples": { + "default": { + "value": "A12" + } + } + }, + { + "name": "codeTypeActivite", + "in": "path", + "description": "codeTypeActivite", + "required": true, + "schema": { + "type": "string", + "example": "ROME" + }, + "examples": { + "default": { + "value": "ROME" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste d'activitĂ©s", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeActivite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeActivite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/type-activites": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Lister les types d'activitĂ©", + "description": "Permet de lister les types d'activitĂ© du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypeActivite", + "responses": { + "200": { + "description": "Retourne la liste des types d'activitĂ©s", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypeActivite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypeActivite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/type-activite/{codeTypeActivite}": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Consulter un type d'activitĂ©", + "description": "Permet de consulter un type d'activitĂ© du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypeActiviteParCodeTypeActivite", + "parameters": [ + { + "name": "codeTypeActivite", + "in": "path", + "description": "codeTypeActivite", + "required": true, + "schema": { + "type": "string", + "example": "ROME" + }, + "examples": { + "default": { + "value": "ROME" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne le type d'activitĂ©", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypeActivite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeActivite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/caracteristique": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Consulter une caractĂ©ristique", + "description": "Permet de consulter une caractĂ©ristique du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type caractĂ©ristique et code caractĂ©ristique).", + "operationId": "recupererCaracteristiqueParCodeCaracteristiqueEtCodeTypeCaracteristique", + "parameters": [ + { + "name": "codeCaracteristique", + "in": "query", + "description": "codeCaracteristique", + "required": true, + "schema": { + "type": "string", + "example": "H" + }, + "examples": { + "default": { + "value": "H" + } + } + }, + { + "name": "codeTypeCaracteristique", + "in": "query", + "description": "codeTypeCaracteristique", + "required": true, + "schema": { + "type": "string", + "example": "GENRE" + }, + "examples": { + "default": { + "value": "GENRE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la caractĂ©ristique", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Caracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Caracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/caracteristiques": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Lister les caractĂ©ristiques", + "description": "Permet de lister les caractĂ©ristiques du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeCaracteristique", + "responses": { + "200": { + "description": "Retourne la liste des caractĂ©ristiques", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeCaracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeCaracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/caracteristiques/{codeTypeCaracteristique}": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Lister les caractĂ©ristiques par type d'activitĂ©", + "description": "Permet de lister les caractĂ©ristiques du RĂ©fĂ©rentiel Smart Emploi pour un type de caractĂ©ristique.", + "operationId": "recupererListeCaracteristiqueParCodeTypeCaracteristique", + "parameters": [ + { + "name": "codeTypeCaracteristique", + "in": "path", + "description": "codeTypeCaracteristique", + "required": true, + "schema": { + "type": "string", + "example": "GENRE" + }, + "examples": { + "default": { + "value": "GENRE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des caractĂ©ristiques", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeCaracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeCaracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/type-caracteristiques": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Lister les types de caractĂ©ristique", + "description": "Permet de lister les types de caractĂ©ristique du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypeCaracteristique", + "responses": { + "200": { + "description": "Retourne la liste des types de caractĂ©ristiques", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypeCaracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypeCaracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/type-caracteristique/{codeTypeCaracteristique}": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Consulter un type de caractĂ©ristique", + "description": "Permet de consulter un type de caractĂ©ristique du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypeCaracteristiqueParCodeTypeCaracteristique", + "parameters": [ + { + "name": "codeTypeCaracteristique", + "in": "path", + "description": "codeTypeCaracteristique", + "required": true, + "schema": { + "type": "string", + "example": "GENRE" + }, + "examples": { + "default": { + "value": "GENRE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne un type de caractĂ©ristique", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypeCaracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeCaracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/details-indicateurs": { + "get": { + "tags": [ + "Catalogue Indicateur" + ], + "summary": "Consulter le dĂ©tail d'un indicateur.", + "description": "Permet de lister toutes les valeurs possibles des critĂšres d’entrĂ©e (Types de territoire, Types d'activitĂ©, Type de pĂ©riode, Nomenclatures, Croisements disponibles, CaractĂ©ristiques), et des Types de valeur obtenus, pour un indicateur donnĂ©. Un croisement disponible correspond Ă  une combinaison [Type de territoire, Type d'activitĂ©, Type de pĂ©riode et Nomenclature].", + "operationId": "recupererDetailsIndicateurs", + "parameters": [ + { + "name": "codeFamille", + "in": "query", + "description": "codeFamille", + "schema": { + "type": "string", + "example": "DEMANDEURS" + }, + "examples": { + "default": { + "value": "DEMANDEURS" + } + } + }, + { + "name": "codeIndicateur", + "in": "query", + "description": "codeIndicateur", + "schema": { + "type": "string", + "example": "DE_1" + }, + "examples": { + "default": { + "value": "DE_1" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "DĂ©tail d'un indicateur", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeDetailIndicateur" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeDetailIndicateur" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/famille-indicateur/{codeFamilleIndicateur}": { + "get": { + "tags": [ + "Catalogue Indicateur" + ], + "summary": "Consulter une famille d'indicateur", + "operationId": "recupererFamilleIndicateurParCodeFamilleIndicateur", + "parameters": [ + { + "name": "codeFamilleIndicateur", + "in": "path", + "description": "codeFamilleIndicateur", + "required": true, + "schema": { + "type": "string", + "example": "DEMANDEURS" + }, + "examples": { + "default": { + "value": "DEMANDEURS" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/xml": {}, + "application/json": {} + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/familles-indicateurs": { + "get": { + "tags": [ + "Catalogue Indicateur" + ], + "summary": "Lister les familles d'indicateur", + "operationId": "recupererListeFamilleIndicateur", + "responses": { + "default": { + "description": "default response", + "content": { + "application/xml": {}, + "application/json": {} + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/indicateurs": { + "get": { + "tags": [ + "Catalogue Indicateur" + ], + "summary": "Lister les indicateurs", + "operationId": "recupererListeIndicateur", + "responses": { + "default": { + "description": "default response", + "content": { + "application/xml": {}, + "application/json": {} + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/nomenclatures": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Lister les nomenclatures", + "description": "Permet de lister les nomenclatures du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeNomenclature", + "responses": { + "200": { + "description": "Retourne la liste des nomenclatures", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeNomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeNomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/nomenclatures/{codeTypeNomenclature}": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Lister les nomenclatures par type de nomenclature", + "description": "Permet de lister les nomenclatures du RĂ©fĂ©rentiel Smart Emploi pour un type de nomenclature.", + "operationId": "recupererListeNomenclatureParCodeTypeNomenclature", + "parameters": [ + { + "name": "codeTypeNomenclature", + "in": "path", + "description": "codeTypeNomenclature", + "required": true, + "schema": { + "type": "string", + "example": "CATCAND" + }, + "examples": { + "default": { + "value": "CATCAND" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des nomenclatures", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeNomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeNomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/type-nomenclatures": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Lister les types nomenclatures", + "description": "Permet de lister les types de nomenclature du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypeNomenclature", + "responses": { + "200": { + "description": "Retourne la liste des types nomenclatures", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypeNomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypeNomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/nomenclature": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Consulter une nomenclature", + "description": "Permet de consulter une nomenclature du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type nomenclature et code nomenclature).", + "operationId": "recupererNomenclatureParCodeNomenclatureEtCodeTypeNomenclature", + "parameters": [ + { + "name": "codeNomenclature", + "in": "query", + "description": "codeNomenclature", + "required": true, + "schema": { + "type": "string", + "example": "A" + }, + "examples": { + "default": { + "value": "A" + } + } + }, + { + "name": "codeTypeNomenclature", + "in": "query", + "description": "codeTypeNomenclature", + "required": true, + "schema": { + "type": "string", + "example": "CATCAND" + }, + "examples": { + "default": { + "value": "CATCAND" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la nomenclature", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Nomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Nomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/type-nomenclature/{codeTypeNomenclature}": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Consulter un type de nomenclature", + "description": "Permet de consulter un type de nomenclature du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypeNomenclatureParCodeTypeNomenclature", + "parameters": [ + { + "name": "codeTypeNomenclature", + "in": "path", + "description": "codeTypeNomenclature", + "required": true, + "schema": { + "type": "string", + "example": "CATCAND" + }, + "examples": { + "default": { + "value": "CATCAND" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne le type nomenclature", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypeNomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeNomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/periodes": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Lister les pĂ©riodes", + "description": "Permet de lister les pĂ©riodes du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListePeriode", + "responses": { + "200": { + "description": "Retourne la liste des pĂ©riodes", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListePeriode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListePeriode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/periodes/{codeTypePeriode}": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Lister les pĂ©riodes par type de pĂ©riode", + "description": "Permet de lister les pĂ©riodes du RĂ©fĂ©rentiel Smart Emploi pour un type de pĂ©riode.", + "operationId": "recupererListePeriodeParCodeTypePeriode", + "parameters": [ + { + "name": "codePeriode", + "in": "query", + "description": "codePeriode", + "schema": { + "type": "string", + "example": 2019 + }, + "examples": { + "default": { + "value": 2019 + } + } + }, + { + "name": "nbPeriode", + "in": "query", + "description": "nbPeriode", + "schema": { + "type": "integer", + "format": "int32", + "example": 5 + }, + "examples": { + "default": { + "value": 5 + } + } + }, + { + "name": "critereTemporel", + "in": "query", + "description": "critereTemporel", + "schema": { + "type": "string", + "example": "A" + }, + "examples": { + "default": { + "value": "A" + } + } + }, + { + "name": "codeTypePeriode", + "in": "path", + "description": "codeTypePeriode", + "required": true, + "schema": { + "type": "string", + "example": "ANNEE" + }, + "examples": { + "default": { + "value": "ANNEE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des pĂ©riodes", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListePeriode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListePeriode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/type-periodes": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Lister les types pĂ©riodes", + "description": "Permet de lister les types de pĂ©riode du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypePeriode", + "responses": { + "200": { + "description": "Retourne la liste des types de pĂ©riode", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypePeriode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypePeriode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/periode": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Consulter une pĂ©riode", + "description": "Permet de consulter une pĂ©riode du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type pĂ©riode et code pĂ©riode).", + "operationId": "recupererPeriodeParCodePeriodeEtCodeTypePeriode", + "parameters": [ + { + "name": "codePeriode", + "in": "query", + "description": "codePeriode", + "required": true, + "schema": { + "type": "string", + "example": 2019 + }, + "examples": { + "default": { + "value": 2019 + } + } + }, + { + "name": "codeTypePeriode", + "in": "query", + "description": "codeTypePeriode", + "required": true, + "schema": { + "type": "string", + "example": "ANNEE" + }, + "examples": { + "default": { + "value": "ANNEE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la pĂ©riode", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Periode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Periode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/type-periode/{codeTypePeriode}": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Consulter un type de pĂ©riode", + "description": "Permet de consulter un type de pĂ©riode du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypePeriodeParCodeTypePeriode", + "parameters": [ + { + "name": "codeTypePeriode", + "in": "path", + "description": "codeTypePeriode", + "required": true, + "schema": { + "type": "string", + "example": "ANNEE" + }, + "examples": { + "default": { + "value": "ANNEE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne le type de pĂ©riode", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypePeriode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypePeriode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/rechercherActivitesRomeFap": { + "get": { + "tags": [ + "RomeFap" + ], + "summary": "RĂ©fĂ©rentiel des correspondances ROME/FAP", + "description": "Permet de rechercher les FAP associĂ©es Ă  un code ROME.", + "operationId": "recupererListeTypeTerritoire_1", + "parameters": [ + { + "name": "codeRome", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste ROME/FAP", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeRomeFap" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeRomeFap" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/territoires": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Lister les territoires", + "description": "Permet de lister les territoires du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTerritoire", + "responses": { + "200": { + "description": "Retourne la liste des territoires", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTerritoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTerritoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/territoires/{codeTypeTerritoire}": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Lister les territoires par type de territoire", + "description": "Permet de lister les territoires du RĂ©fĂ©rentiel Smart Emploi pour un type de territoire.", + "operationId": "recupererListeTerritoireParCodeTypeTerritoire", + "parameters": [ + { + "name": "filtreTerritoire", + "in": "query", + "description": "filtreTerritoire", + "schema": { + "type": "string", + "example": "G" + }, + "examples": { + "default": { + "value": "G" + } + } + }, + { + "name": "codeTypeTerritoire", + "in": "path", + "description": "codeTypeTerritoire", + "required": true, + "schema": { + "type": "string", + "example": "DEP" + }, + "examples": { + "default": { + "value": "DEP" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des territoires pour un type", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTerritoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTerritoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/type-territoires": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Lister les types de territoire", + "description": "Permet de lister les types de territoire du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypeTerritoire_2", + "responses": { + "200": { + "description": "Retourne la liste des types de territoire", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypeTerritoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypeTerritoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ] + } + }, + "/v1/referentiel/territoire": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Consulter un territoire", + "description": "Permet de consulter un territoire du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type territoire et code territoire).", + "operationId": "recupererTerritoireParCodeTerritoireEtCodeTypeTerritoire", + "parameters": [ + { + "name": "codeTerritoire", + "in": "query", + "description": "codeTerritoire", + "required": true, + "schema": { + "type": "string", + "example": 33 + }, + "examples": { + "default": { + "value": 33 + } + } + }, + { + "name": "codeTypeTerritoire", + "in": "query", + "description": "codeTypeTerritoire", + "required": true, + "schema": { + "type": "string", + "example": "DEP" + }, + "examples": { + "default": { + "value": "DEP" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne le territoire", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/territoires-communes/{codeTypeTerritoire}": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Lister les communes avec Bassin et EPCI", + "operationId": "recupererTerritoireParCodeTypeAvecCommuneBassinEtEPCI", + "parameters": [ + { + "name": "filtreTerritoire", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "codeTypeTerritoire", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "default": { + "description": "default response", + "content": { + "application/xml": {}, + "application/json": {} + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + }, + "/v1/referentiel/type-territoire/{codeTypeTerritoire}": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Consulter un type de territoire", + "description": "Permet de consulter un type de territoire du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypeTerritoireParCodeTypeTerritoire", + "parameters": [ + { + "name": "codeTypeTerritoire", + "in": "path", + "description": "codeTypeTerritoire", + "required": true, + "schema": { + "type": "string", + "example": "DEP" + }, + "examples": { + "default": { + "value": "DEP" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer tg9yiHssTP4gz6KBPyg1OnyK9GE" + } + } + ], + "responses": { + "200": { + "description": "Retourne le type de territoire", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypeTerritoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeTerritoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-offres-demandes-emploi" + } + ] + } + } + }, + "components": { + "schemas": { + "CritereIndicateurAvecNomenclature": { + "type": "object", + "properties": { + "codeTypeTerritoire": { + "type": "string", + "description": "Le type de territoire (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "DEP" + }, + "codeTerritoire": { + "type": "string", + "description": "Le code du territoire (voir le rĂ©fĂ©rentiel Territoire pour les codes disponibles)", + "example": "33" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le type d'activitĂ© (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "ROME" + }, + "codeActivite": { + "type": "string", + "description": "Le code d'activitĂ© (voir le rĂ©fĂ©rentiel Activite pour les codes disponibles)", + "example": "K1303" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le type de pĂ©riode (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "TRIMESTRE" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le type de nomenclature (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "CATCAND" + }, + "dernierePeriode": { + "type": "boolean", + "description": "Optionnel: A renseigner Ă  true pour que la recherche se limite Ă  la pĂ©riode la plus rĂ©cente sur cet indicateur, sinon la recherche se limite Ă  la liste de pĂ©riodes fournie en entrĂ©e" + }, + "listeCodePeriode": { + "type": "array", + "description": "Optionnel: A renseigner avec les pĂ©riodes souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les pĂ©riodes disponibles sur cet indicateur", + "items": { + "type": "string", + "description": "Optionnel: A renseigner avec les pĂ©riodes souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les pĂ©riodes disponibles sur cet indicateur", + "example": "[\"2020T2\",\"2020T3\"]" + }, + "example": [ + "2020T2", + "2020T3" + ] + }, + "listeCodeNomenclature": { + "type": "array", + "description": "Optionnel: A renseigner avec les nomenclatures souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les nomenclatures disponibles sur cet indicateur", + "items": { + "type": "string", + "description": "Optionnel: A renseigner avec les nomenclatures souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les nomenclatures disponibles sur cet indicateur", + "example": "[\"A\",\"B\",\"C\"]" + }, + "example": [ + "A", + "B", + "C" + ] + }, + "sansCaracteristiques": { + "type": "boolean", + "description": "Optionnel: A renseigner Ă  true pour que la recherche se limite aux valeurs hors caractĂ©ristiques sur cet indicateur, sinon la recherche se limite aux valeurs de la liste de caractĂ©ristiques fournie en entrĂ©e" + }, + "listeCaracteristiques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Caracteristique" + } + } + }, + "required": [ + "codeTypeTerritoire", + "codeTerritoire", + "codeTypeActivite", + "codeActivite", + "codeTypePeriode", + "codeTypeNomenclature" + ] + }, + "Caracteristique": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la caractĂ©ristique", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeCaracteristique": { + "type": "string", + "description": "Le code du type de la caractĂ©ristique", + "example": "AGC_RAT" + }, + "codeCaracteristique": { + "type": "string", + "description": "Le code de la caractĂ©ristique", + "example": "AGC_BASS" + }, + "libelleCaracteristique": { + "type": "string", + "description": "Le libellĂ© de la caractĂ©ristique", + "example": "rattachement agence bassin" + }, + "masque": { + "type": "boolean", + "description": "La caractĂ©ristique est masquĂ© par l'administrateur", + "example": true + } + }, + "required": [ + "codeTypeCaracteristique", + "codeCaracteristique", + "libelleCaracteristique" + ], + "xml": { + "name": "CaracteristiqueReferentiel", + "namespace": "http://fr.pe.auto.service.da084.services.rest.model.referentiel" + } + }, + "IndicateurRetour": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeIndicateur": { + "type": "string", + "description": "Le code de l'indicateur", + "example": "DE_1" + }, + "codeFamille": { + "type": "string", + "description": "Le code famille de l'indicateur", + "example": "DEMANDEURS" + }, + "libIndicateur": { + "type": "string", + "description": "Le libellĂ© de l'indicateur", + "example": "Nombre et % de DE par catĂ©gories x caractĂ©ristiques, % par activitĂ©s (Rome, CompĂ©tence)" + }, + "libTerritoire": { + "type": "string", + "description": "Le libellĂ© du territoire", + "example": "NOUVELLE-AQUITAINE" + }, + "listeValeursParPeriode": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValeursParPeriode" + } + } + } + }, + "ValeursParPeriode": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la valeur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeTerritoire": { + "type": "string", + "description": "Le code du type de territoire", + "example": "REG" + }, + "codeTerritoire": { + "type": "string", + "description": "Le code territoire", + "example": "75" + }, + "libTerritoire": { + "type": "string", + "description": "Le libellĂ© du territoire", + "example": "NOUVELLE-AQUITAINE" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le code du type d'activitĂ©", + "example": "ROME" + }, + "codeActivite": { + "type": "string", + "description": "Le code d'activitĂ©", + "example": "A1203" + }, + "libActivite": { + "type": "string", + "description": "Le libellĂ© de l'activitĂ©", + "example": "AmĂ©nagement et entretien des espaces verts" + }, + "codeNomenclature": { + "type": "string", + "description": "Le code de nomenclature", + "example": "A" + }, + "libNomenclature": { + "type": "string", + "description": "Le libellĂ© de nomenclature", + "example": "Demandeurs d'Emploi de catĂ©gorie A" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le code du type de pĂ©riode", + "example": "TRIMESTRE" + }, + "codePeriode": { + "type": "string", + "description": "Le code de la pĂ©riode", + "example": "2023T4" + }, + "libPeriode": { + "type": "string", + "description": "Le libellĂ© de la pĂ©riode", + "example": "4Ăšme trimestre 2023" + }, + "valeurPrincipaleNom": { + "type": "string", + "description": "Le nom de la valeur principale", + "example": "Nombre de demandeurs d'emploi" + }, + "valeurPrincipaleNombre": { + "type": "integer", + "description": "La valeur principale", + "format": "int32", + "example": 4750 + }, + "valeurPrincipaleRang": { + "type": "integer", + "description": "La valeur principale si l'indicateur reprĂ©sente un rang", + "format": "int32", + "example": 4 + }, + "valeurPrincipaleMontant": { + "type": "number", + "description": "La valeur principale si l'indicateur reprĂ©sente un montant", + "format": "double", + "example": 55.5 + }, + "valeurPrincipaleTaux": { + "type": "number", + "description": "La valeur principale si l'indicateur reprĂ©sente un taux", + "format": "double", + "example": 10 + }, + "valeurSecondaireNombre": { + "type": "integer", + "description": "La valeur secondaire", + "format": "int32", + "example": 4750 + }, + "valeurSecondairePourcentage": { + "type": "number", + "description": "La valeur secondaire en pourcentage", + "format": "double", + "example": 54 + }, + "valeurSecondairePourcentage2": { + "type": "number", + "description": "La valeur secondaire en pourcentage", + "format": "double", + "example": 54 + }, + "valeurSecondaireTaux": { + "type": "number", + "description": "La valeur secondaire si l'indicateur reprĂ©sente un taux", + "format": "double", + "example": 10 + }, + "libPctParActivite": { + "type": "string", + "description": "Le libellĂ© du pourcentage par activitĂ©", + "example": "Pourcentage de demandeurs d'emploi par activitĂ©" + }, + "listeValeurParCaract": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValeursParCaracteristique" + } + } + } + }, + "ValeursParCaracteristique": { + "type": "object", + "properties": { + "codeTypeCaract": { + "type": "string", + "description": "La code du type de la caractĂ©ristique", + "example": "GENRE" + }, + "codeCaract": { + "type": "string", + "description": "La code de la caractĂ©ristique", + "example": "H" + }, + "libCaract": { + "type": "string", + "description": "Le libellĂ© de la caractĂ©ristique", + "example": "Homme" + }, + "nombre": { + "type": "integer", + "description": "La valeur de la caractĂ©ristique", + "format": "int32", + "example": 4470 + }, + "pourcentage": { + "type": "number", + "description": "Le pourcentage de la caractĂ©ristique", + "format": "double", + "example": 94 + }, + "montant": { + "type": "number", + "description": "Le montant (s'il existe) de la caractĂ©ristique", + "format": "double", + "example": 10 + }, + "taux": { + "type": "number", + "description": "Le taux (s'il existe) de la caractĂ©ristique", + "format": "double", + "example": 10 + } + } + }, + "CritereIndicateurSansNomenclature": { + "type": "object", + "properties": { + "codeTypeTerritoire": { + "type": "string", + "description": "Le type de territoire (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "DEP" + }, + "codeTerritoire": { + "type": "string", + "description": "Le code du territoire (voir le rĂ©fĂ©rentiel Territoire pour les codes disponibles)", + "example": "33" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le type d'activitĂ© (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "ROME" + }, + "codeActivite": { + "type": "string", + "description": "Le code d'activitĂ© (voir le rĂ©fĂ©rentiel Activite pour les codes disponibles)", + "example": "K1303" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le type de pĂ©riode (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "TRIMESTRE" + }, + "dernierePeriode": { + "type": "boolean", + "description": "Optionnel: A renseigner Ă  true pour que la recherche se limite Ă  la pĂ©riode la plus rĂ©cente sur cet indicateur, sinon la recherche se limite Ă  la liste de pĂ©riodes fournie en entrĂ©e" + }, + "listeCodePeriode": { + "type": "array", + "description": "Optionnel: A renseigner avec les pĂ©riodes souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les pĂ©riodes disponibles sur cet indicateur", + "items": { + "type": "string", + "description": "Optionnel: A renseigner avec les pĂ©riodes souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les pĂ©riodes disponibles sur cet indicateur", + "example": "[\"2020T2\",\"2020T3\"]" + }, + "example": [ + "2020T2", + "2020T3" + ] + }, + "sansCaracteristiques": { + "type": "boolean", + "description": "Optionnel: A renseigner Ă  true pour que la recherche se limite aux valeurs hors caractĂ©ristiques sur cet indicateur, sinon la recherche se limite aux valeurs de la liste de caractĂ©ristiques fournie en entrĂ©e" + }, + "listeCaracteristiques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Caracteristique" + } + } + }, + "required": [ + "codeTypeTerritoire", + "codeTerritoire", + "codeTypeActivite", + "codeActivite", + "codeTypePeriode" + ] + }, + "Activite": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de l'activitĂ©", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le type d'activitĂ© (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "ROME" + }, + "codeActivite": { + "type": "string", + "description": "Le code d'activitĂ© (voir le rĂ©fĂ©rentiel Activite pour les codes disponibles)", + "example": "K1303" + }, + "libelleActivite": { + "type": "string", + "description": "Le libellĂ© de l'activitĂ©", + "example": "Ouvriers qualifiĂ©s de l'Ă©lectricitĂ© et de l'Ă©lectronique" + }, + "attribut": { + "type": "string", + "description": "Optionnel: le code NSF de l'activitĂ©", + "example": "114" + } + }, + "required": [ + "codeTypeActivite", + "codeActivite", + "libelleActivite" + ] + }, + "ListeActivite": { + "type": "object", + "properties": { + "activites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Activite" + } + } + } + }, + "ListeTypeActivite": { + "type": "object", + "properties": { + "typeActivites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeActivite" + } + } + } + }, + "TypeActivite": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type d'activitĂ©", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le code du type d'activitĂ©", + "example": "ROME" + }, + "libelleTypeActivite": { + "type": "string", + "description": "Le libellĂ© du type d'activitĂ©", + "example": "MĂ©tier (ROME)" + } + } + }, + "ListeCaracteristique": { + "type": "object", + "properties": { + "caracteristiques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Caracteristique" + } + } + } + }, + "ListeTypeCaracteristique": { + "type": "object", + "properties": { + "typeCaracteristiques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeCaracteristique" + } + } + } + }, + "TypeCaracteristique": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeCaracteristique": { + "type": "string", + "description": "Le code du type de la caractĂ©ristique", + "example": "AGC_RAT" + }, + "libelleTypeCaracteristique": { + "type": "string", + "description": "Le libellĂ© du type de la caractĂ©ristique", + "example": "Territoire de rattachement de l'offre Ă  l'agence" + } + } + }, + "ListeDetailIndicateur": { + "type": "object", + "properties": { + "listeIndicateurs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailIndicateur" + } + } + } + }, + "DetailIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeIndicateur": { + "type": "string", + "description": "Le code de l'indicateur", + "example": "DE_1" + }, + "libelleIndicateur": { + "type": "string", + "description": "Le libellĂ© de l'indicateur", + "example": "Nombre et % de DE par catĂ©gories x caractĂ©ristiques, % par activitĂ©s (Rome, CompĂ©tence)" + }, + "descriptif": { + "type": "string", + "description": "Le descriptif de l'indicateur", + "example": "DĂ©finition dĂ©taillĂ©e : informations sur les sources de donnĂ©es utilisĂ©es, les mĂ©thodes de calcul, les limitations sur certains axes, les aspects rĂ©glementaires Ă©ventuels." + }, + "codeFamille": { + "type": "string", + "description": "Le code famille de l'indicateur", + "example": "DEMANDEURS" + }, + "disponibiliteIndicateur": { + "type": "integer", + "description": "Indique si l'indicateur est disponible (1) ou dĂ©sactivĂ© (0)", + "format": "int32", + "example": 1 + }, + "listeTypesValeurs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeValeur" + } + }, + "listeTypesTerritoiresIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeTerritoire" + } + }, + "listeTypesActivitesIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeActivite" + } + }, + "listeTypesPeriodesIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypePeriodeIndicateur" + } + }, + "listeTypesNomenclaturesIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeNomenclatureIndicateur" + } + }, + "listeCroisementsIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CroisementIndicateur" + } + }, + "listeCaracteristiqueIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CaracteristiqueIndicateur" + } + }, + "listeTypesCracteristiqueIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeCaracteristique" + } + } + } + }, + "TypeValeur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de valeur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "valeurPrincipale": { + "type": "string", + "description": "La valeur principale", + "example": "0" + }, + "codeTypeValeur": { + "type": "string", + "description": "Le code du type de valeur", + "example": "NB_ET_PCT" + }, + "numOrdre": { + "type": "integer", + "description": "Le numĂ©ro d'ordre de la valeur", + "format": "int32", + "example": 1 + }, + "libValeur": { + "type": "string", + "description": "Le libellĂ© du type de valeur", + "example": "Nombre et % de rĂ©partition de ce nombre par caractĂ©ristiques." + }, + "libelleValeurSpecifique": { + "type": "string", + "description": "Le libellĂ© spĂ©cifique de la valeur", + "example": "Nombre et % des retours Ă  l'emploi AB par durĂ©e d'emploi et caractĂ©ristiques" + } + } + }, + "TypeTerritoire": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de territoire", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeTerritoire": { + "type": "string", + "description": "Le code du type de territoire", + "example": "DEP" + }, + "libelleTypeTerritoire": { + "type": "string", + "description": "Le libellĂ© du type de territoire", + "example": "DĂ©partement" + } + } + }, + "TypePeriodeIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de pĂ©riode de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le code du type de pĂ©riode", + "example": "TRIMESTRE" + }, + "libelleTypePeriode": { + "type": "string", + "description": "Le libellĂ© du type de pĂ©riode", + "example": "Trimestre" + }, + "profondeurMax": { + "type": "string", + "description": "Nombre maximum de pĂ©riode interrogeable pour ce type", + "example": "12" + } + } + }, + "TypeNomenclatureIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de nomenclature de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le code du type de nomenclature de l'indicateur", + "example": "DUREEEMP" + }, + "libelleTypeNomenclature": { + "type": "string", + "description": "Le libellĂ© du type de nomenclature de l'indicateur", + "example": "DurĂ©e d'emploi > 1 mois, emploi durable (> 6 mois), Toutes durĂ©es)" + }, + "listeValeursNomenclaturesIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValeurNomenclatureIndicateur" + } + } + } + }, + "ValeurNomenclatureIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la valeur de la nomenclature", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "valeurNomenclature": { + "type": "string", + "description": "La valeur de la nomenclature", + "example": "SUP1M" + }, + "libelleNomenclature": { + "type": "string", + "description": "La libellĂ© de la nomenclature", + "example": "Emploi > 1 mois" + } + } + }, + "CroisementIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du croisement de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeTerritoire": { + "type": "string", + "description": "Le type de territoire (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "DEP" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le type d'activitĂ© (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "ROME" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le type de pĂ©riode (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "TRIMESTRE" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le type de nomenclature (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "CATCAND" + }, + "codeNomenclature": { + "type": "string", + "description": "Le code de nomenclature", + "example": "A" + } + } + }, + "CaracteristiqueIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la caractĂ©ristique de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeCaracteristique": { + "type": "string", + "description": "Le code du type de la caractĂ©ristique", + "example": "GENRE" + }, + "codeCaracteristique": { + "type": "string", + "description": "Le code de la caractĂ©ristique", + "example": "H" + }, + "libelleCaracteristique": { + "type": "string", + "description": "Le libellĂ© de la caractĂ©ristique", + "example": "Homme" + } + }, + "required": [ + "codeTypeCaracteristique", + "codeCaracteristique", + "libelleCaracteristique" + ] + }, + "ListeNomenclature": { + "type": "object", + "properties": { + "nomenclatures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Nomenclature" + } + } + } + }, + "Nomenclature": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la nomenclature", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le code du type de nomenclature", + "example": "ACCESEMP" + }, + "codeNomenclature": { + "type": "string", + "description": "Le code de la nomenclature", + "example": "12M" + }, + "libelleNomenclature": { + "type": "string", + "description": "Le libellĂ© de la nomenclature", + "example": "12 Mois" + } + } + }, + "ListeTypeNomenclature": { + "type": "object", + "properties": { + "typeNomenclatures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeNomenclature" + } + } + } + }, + "TypeNomenclature": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de nomenclature", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le code du type de nomenclature", + "example": "ACCESEMP" + }, + "libelleTypeNomenclature": { + "type": "string", + "description": "Le libellĂ© du type de nomenclature", + "example": "DĂ©lai d'accĂšs Ă  l'emploi (6 mois / 12 mois)" + } + } + }, + "ListePeriode": { + "type": "object", + "properties": { + "periodes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Periode" + } + } + } + }, + "Periode": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la pĂ©riode", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le code du type de pĂ©riode", + "example": "TRIMESTRE" + }, + "codePeriode": { + "type": "string", + "description": "Le code de la pĂ©riode", + "example": "2023T1" + }, + "ordrePeriode": { + "type": "integer", + "description": "Ordre de la pĂ©riode", + "format": "int32", + "example": 1 + }, + "libellePeriode": { + "type": "string", + "description": "LibellĂ© de la pĂ©riode", + "example": "1er trimestre 2023" + } + }, + "required": [ + "codeTypePeriode", + "codePeriode", + "ordrePeriode", + "libellePeriode" + ] + }, + "ListeTypePeriode": { + "type": "object", + "properties": { + "typePeriodes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypePeriode" + } + } + } + }, + "TypePeriode": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de pĂ©riode", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le code du type de pĂ©riode", + "example": "TRIMESTRE" + }, + "libelleTypePeriode": { + "type": "string", + "description": "Le libellĂ© du type de pĂ©riode", + "example": "Trimestre" + } + }, + "required": [ + "codeTypePeriode", + "libelleTypePeriode" + ] + }, + "ListeRomeFap": { + "type": "object", + "properties": { + "romeFapList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RomeFap" + } + } + } + }, + "RomeFap": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du couple", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeRome": { + "type": "string", + "description": "Le code ROME", + "example": "M1801" + }, + "codeFap": { + "type": "string", + "description": "Le code FAP", + "example": "M0Z60" + } + } + }, + "ListeTerritoire": { + "type": "object", + "properties": { + "territoires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Territoire" + } + } + } + }, + "Territoire": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du territoire", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeTerritoire": { + "type": "string", + "description": "Le type de territoire (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "DEP" + }, + "codeTerritoire": { + "type": "string", + "description": "Le code du territoire (voir le rĂ©fĂ©rentiel Territoire pour les codes disponibles)", + "example": "33" + }, + "libelleTerritoire": { + "type": "string", + "description": "Le libellĂ© du territoire", + "example": "GIRONDE" + }, + "codeTypeTerritoireParent": { + "type": "string", + "description": "Le code type du territoire parent", + "example": "REG" + }, + "codeTerritoireParent": { + "type": "string", + "description": "Le code du territoire parent", + "example": "75" + } + } + }, + "ListeTypeTerritoire": { + "type": "object", + "properties": { + "typeTerritoires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeTerritoire" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/docs/api/ROME 4.0 - CompĂ©tences.json b/docs/api/ROME 4.0 - CompĂ©tences.json new file mode 100644 index 0000000..8b41447 --- /dev/null +++ b/docs/api/ROME 4.0 - CompĂ©tences.json @@ -0,0 +1,4017 @@ +{ + "openapi": "3.0.1", + "info": { + "version": "1", + "title": "ROME 4.0 - CompĂ©tences", + "description": "RĂ©fĂ©rentiel des capacitĂ©s, ou des ensembles de connaissances, d'aptitudes, d'attitudes et de comportements, qui permettent Ă  une personne d'accomplir une tĂąche ou de rĂ©soudre un problĂšme de maniĂšre efficace.
Une compétence désigne la capacité à agir dans une situation professionnelle donnée, en mobilisant et en combinant des ressources telles que:
\r\n\r\n**Scopes** : `api_rome-competencesv1`,`nomenclatureRome`\r\n\r\n**Royaume** : `/partenaire`" + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-competences" + } + ], + "paths": { + "/v1/competences/categorie-savoirs": { + "get": { + "tags": [ + "CatĂ©gorie de savoirs" + ], + "summary": "Lister les catĂ©gories de savoirs", + "description": "Permet d'obtenir la liste des catĂ©gories de savoirs.\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": "listerCategorieSavoirs", + "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`).
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(libelle,code)", + "code", + "datefin", + "libelle", + "obsolete", + "savoirs(libelle,code,transitionecologique,transitionnumerique,codeogr)", + "souscategories(libelle,code)" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des catĂ©gories de savoir.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CategorieSavoir" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "sousCategories": [ + { + "libelle": "VĂ©hicules", + "code": "30" + } + ], + "obsolete": false, + "code": "30", + "savoirs": [ + { + "type": "SAVOIR", + "libelle": "Anglais maritime", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "dateFin": "2024-02-23T14:40:14.848Z" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "VĂ©hicules", + "code": "30" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/categorie-savoirs/{code}": { + "get": { + "tags": [ + "CatĂ©gorie de savoirs" + ], + "summary": "Lire une catĂ©gorie de savoirs", + "description": "Permet de lire une catĂ©gorie de savoirs 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": "lireCategorieSavoir", + "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`).
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(libelle,code)", + "code", + "datefin", + "libelle", + "obsolete", + "savoirs(libelle,code,transitionecologique,transitionnumerique,codeogr)", + "souscategories(libelle,code)" + ], + "example": "libelle,categorie(libelle,code),obsolete,code,datefin" + } + }, + { + "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 catĂ©gorie de savoirs.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es d'une catĂ©gorie de savoir.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CategorieSavoir" + }, + "examples": { + "Retour complet": { + "value": { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "sousCategories": [ + { + "libelle": "VĂ©hicules", + "code": "30" + } + ], + "obsolete": false, + "code": "30", + "savoirs": [ + { + "type": "SAVOIR", + "libelle": "Anglais maritime", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "obsolete": false, + "code": "30", + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/competence": { + "get": { + "tags": [ + "CompĂ©tence" + ], + "summary": "Lister les compĂ©tences", + "description": "Permet de lister les compĂ©tences au sens gĂ©nĂ©ral.\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": "listerCompetences", + "parameters": [ + { + "name": "code-ogr", + "in": "query", + "description": "Code OGR.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
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": [ + "@competencedetaillee(riasecmineur,macrocompetence(libelle,transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,code,riasecmineur,codearborescence,objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence),codeogr,maturite,riasecmajeur),riasecmajeur)", + "@macrocompetence(transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,riasecmineur,codearborescence,objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence),maturite,riasecmajeur)", + "@savoir(categoriesavoir(libelle,categorie(libelle,code),code))", + "code", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "libelle", + "obsolete", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des compĂ©tences.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CompetenceDetaillee" + }, + { + "$ref": "#/components/schemas/MacroCompetence" + }, + { + "$ref": "#/components/schemas/Savoir" + } + ] + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "macroCompetence": { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R" + }, + "riasecMajeur": "R", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "maturite": "HETEROGENE", + "categorieSavoir": { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "code": "30" + }, + "dateFin": "2024-02-23T14:40:14.848Z" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "type": "string", + "libelle": "Anglais maritime", + "code": "100253" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/competence-detaillee": { + "get": { + "tags": [ + "CompĂ©tence dĂ©taillĂ©e" + ], + "summary": "Lister les compĂ©tences", + "description": "Permet de lister les compĂ©tences de type compĂ©tences dĂ©taillĂ©es.\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": "listerCompetencesDetaillees", + "parameters": [ + { + "name": "code-ogr", + "in": "query", + "description": "Code OGR.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "riasec-majeur", + "in": "query", + "description": "Riasec majeur.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "riasec-mineur", + "in": "query", + "description": "Riasec mineur.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
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", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "libelle", + "macrocompetence(libelle,transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,code,riasecmineur,codearborescence,objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence),codeogr,maturite,riasecmajeur)", + "obsolete", + "riasecmajeur", + "riasecmineur", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des compĂ©tences dĂ©taillĂ©es.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CompetenceDetaillee" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "type": "COMPETENCE-DETAILLEE", + "libelle": "Anglais maritime", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "riasecMineur": "R", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "macroCompetence": { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R" + }, + "riasecMajeur": "R", + "dateFin": "2024-02-23T14:40:14.848Z" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "type": "COMPETENCE-DETAILLEE", + "libelle": "Anglais maritime", + "code": "100253" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/competence-detaillee/{code}": { + "get": { + "tags": [ + "CompĂ©tence dĂ©taillĂ©e" + ], + "summary": "Lire une compĂ©tence dĂ©taillĂ©e", + "description": "Permet la lecture d'une compĂ©tence de type compĂ©tence dĂ©taillĂ©e 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": "lireCompetenceDetaillee", + "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`).
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", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "libelle", + "macrocompetence(libelle,transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,code,riasecmineur,definition,codearborescence,objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence),codeogr,maturite,riasecmajeur)", + "obsolete", + "riasecmajeur", + "riasecmineur", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,obsolete,code,competenceesco(libelle,uri),riasecmineur,transitionecologique,transitionnumerique,codeogr,macrocompetence(libelle,transferable,souscategorie,code,riasecmineur,definition,codeogr,maturite,riasecmajeur,@macrosavoiretreprofessionnel(qualiteprofessionnelle),codearborescence,objectif(codearborescence,libelle,enjeu(codearborescence,libelle,code,domainecompetence(codearborescence,libelle,code)),code)),riasecmajeur,datefin" + } + }, + { + "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 compĂ©tence.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es de la compĂ©tence dĂ©taillĂ©e renseignĂ©e.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompetenceDetaillee" + }, + "examples": { + "Retour complet": { + "value": { + "type": "COMPETENCE-DETAILLEE", + "libelle": "Anglais maritime", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "riasecMineur": "R", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "macroCompetence": { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R" + }, + "riasecMajeur": "R", + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "type": "COMPETENCE-DETAILLEE", + "libelle": "Anglais maritime", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "riasecMineur": "R", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "macroCompetence": { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "qualiteProfessionnelle": "01", + "codeArborescence": "string", + "objectif": { + "codeArborescence": "1E4", + "libelle": "Soigner des animaux", + "enjeu": { + "codeArborescence": "1E", + "libelle": "Soin", + "code": "7", + "domaineCompetence": { + "codeArborescence": "1", + "libelle": "Management, Social, Soin", + "code": "1" + } + }, + "code": "19" + } + }, + "riasecMajeur": "R", + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/competence/{code}": { + "get": { + "tags": [ + "CompĂ©tence" + ], + "summary": "Lire une compĂ©tence", + "description": "Permet la lecture d'une compĂ©tence 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": "lireCompetence", + "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`).
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": [ + "@competencedetaillee(riasecmineur,macrocompetence(libelle,transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,code,riasecmineur,definition,codearborescence,objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence),codeogr,maturite,riasecmajeur),riasecmajeur)", + "@macrocompetence(competences(libelle,@competencedetaillee(riasecmineur,riasecmajeur),code,transitionecologique,transitionnumerique,codeogr,@macrocompetence(riasecmineur,riasecmajeur)),transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,riasecmineur,definition,codearborescence,objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence),maturite,riasecmajeur)", + "@savoir(categoriesavoir(libelle,categorie(libelle,code),code))", + "code", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "libelle", + "obsolete", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,@competencedetaillee(macrocompetence(libelle,transferable,souscategorie,code,riasecmineur,definition,codeogr,maturite,riasecmajeur,@macrosavoiretreprofessionnel(qualiteprofessionnelle),codearborescence,objectif(codearborescence,libelle,enjeu(codearborescence,libelle,code,domainecompetence(codearborescence,libelle,code)),code)),riasecmajeur,riasecmineur),obsolete,code,competenceesco(libelle,uri),transitionecologique,transitionnumerique,codeogr,@macrocompetence(transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,riasecmineur,definition,codearborescence,objectif(codearborescence,libelle,enjeu(codearborescence,libelle,code,domainecompetence(codearborescence,libelle,code)),code),maturite,riasecmajeur),@savoir(categoriesavoir(libelle,categorie(libelle,code),code)),datefin" + } + }, + { + "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 compĂ©tence.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es de la compĂ©tence renseignĂ©e.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/CompetenceDetaillee" + }, + { + "$ref": "#/components/schemas/MacroCompetence" + }, + { + "$ref": "#/components/schemas/Savoir" + } + ] + }, + "examples": { + "Retour complet": { + "value": { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "macroCompetence": { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R" + }, + "riasecMajeur": "R", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "competences": [ + { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "definition": "string", + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "maturite": "HETEROGENE", + "categorieSavoir": { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "code": "30" + }, + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "type": "string", + "libelle": "Anglais maritime", + "macroCompetence": { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "qualiteProfessionnelle": "01", + "codeArborescence": "string", + "objectif": { + "codeArborescence": "1E4", + "libelle": "Soigner des animaux", + "enjeu": { + "codeArborescence": "1E", + "libelle": "Soin", + "code": "7", + "domaineCompetence": { + "codeArborescence": "1", + "libelle": "Management, Social, Soin", + "code": "1" + } + }, + "code": "19" + } + }, + "riasecMajeur": "R", + "riasecMineur": "R", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "definition": "string", + "codeArborescence": "string", + "objectif": { + "codeArborescence": "1E4", + "libelle": "Soigner des animaux", + "enjeu": { + "codeArborescence": "1E", + "libelle": "Soin", + "code": "7", + "domaineCompetence": { + "codeArborescence": "1", + "libelle": "Management, Social, Soin", + "code": "1" + } + }, + "code": "19" + }, + "maturite": "HETEROGENE", + "categorieSavoir": { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "code": "30" + }, + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/domaine-competence": { + "get": { + "tags": [ + "Domaine de compĂ©tence" + ], + "summary": "Lister les domaines de compĂ©tence", + "description": "Permet de lister les domaines de compĂ©tence.\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": "listerDomainesCompetence", + "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`).
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", + "codearborescence", + "datefin", + "enjeux(objectifs(libelle,macrocompetences(libelle,transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,code,riasecmineur,codearborescence,transitionecologique,transitionnumerique,codeogr,maturite,riasecmajeur),code,codearborescence),libelle,code,codearborescence)", + "libelle", + "obsolete" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des domaines de compĂ©tence.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomaineCompetence" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "libelle": "Management, Social, Soin", + "obsolete": false, + "code": "1", + "codeArborescence": "1", + "enjeux": [ + { + "objectifs": [ + { + "libelle": "Soigner des animaux", + "macroCompetences": [ + { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "codeArborescence": "string", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R" + } + ], + "code": "19", + "codeArborescence": "1E4" + } + ], + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E" + } + ], + "dateFin": "2024-02-23T14:40:14.848Z" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "Management, Social, Soin", + "code": "1" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/domaine-competence/{code}": { + "get": { + "tags": [ + "Domaine de compĂ©tence" + ], + "summary": "Lire un domaine de compĂ©tence", + "description": "Permet la lecture d'un domaine de compĂ©tence 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": "lireDomaineCompetence", + "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`).
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", + "codearborescence", + "datefin", + "enjeux(objectifs(libelle,macrocompetences(libelle,transferable,souscategorie,code,riasecmineur,transitionnumerique,codeogr,maturite,riasecmajeur,competences(libelle,@competencedetaillee(riasecmineur,riasecmajeur),code,transitionecologique,transitionnumerique,codeogr,@macrocompetence(riasecmineur,riasecmajeur)),@macrosavoiretreprofessionnel(qualiteprofessionnelle),codearborescence,transitionecologique),code,codearborescence),libelle,code,codearborescence)", + "libelle", + "obsolete" + ], + "example": "libelle,obsolete,code,codearborescence,datefin" + } + }, + { + "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 du domaine de compĂ©tence.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es du domaine de compĂ©tence renseignĂ©.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomaineCompetence" + }, + "examples": { + "Retour complet": { + "value": { + "libelle": "Management, Social, Soin", + "obsolete": false, + "code": "1", + "codeArborescence": "1", + "enjeux": [ + { + "objectifs": [ + { + "libelle": "Soigner des animaux", + "macroCompetences": [ + { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "competences": [ + { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "qualiteProfessionnelle": "01", + "codeArborescence": "string", + "transitionEcologique": false + } + ], + "code": "19", + "codeArborescence": "1E4" + } + ], + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E" + } + ], + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "Management, Social, Soin", + "obsolete": false, + "code": "1", + "codeArborescence": "1", + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/enjeu": { + "get": { + "tags": [ + "Enjeu de compĂ©tences" + ], + "summary": "Lister les enjeux de compĂ©tences", + "description": "Permet de lister les enjeux de compĂ©tences.\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": "listerEnjeux", + "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`).
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", + "codearborescence", + "datefin", + "domainecompetence(libelle,code,codearborescence)", + "libelle", + "objectifs(libelle,macrocompetences(libelle,transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,code,riasecmineur,codearborescence,transitionecologique,transitionnumerique,codeogr,maturite,riasecmajeur),code,codearborescence)", + "obsolete" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des enjeux de compĂ©tences.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Enjeu" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "objectifs": [ + { + "libelle": "Soigner des animaux", + "macroCompetences": [ + { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "codeArborescence": "string", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R" + } + ], + "code": "19", + "codeArborescence": "1E4" + } + ], + "libelle": "Soin", + "obsolete": false, + "code": "7", + "codeArborescence": "1E", + "dateFin": "2024-02-23T14:40:14.848Z", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "Soin", + "code": "7" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/enjeu/{code}": { + "get": { + "tags": [ + "Enjeu de compĂ©tences" + ], + "summary": "Lire un enjeu de compĂ©tences", + "description": "Permet la lecture d'un enjeu de compĂ©tences 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": "lireEnjeu", + "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`).
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", + "codearborescence", + "datefin", + "domainecompetence(libelle,code,codearborescence)", + "libelle", + "objectifs(libelle,macrocompetences(libelle,transferable,souscategorie,code,riasecmineur,transitionnumerique,codeogr,maturite,riasecmajeur,competences(libelle,@competencedetaillee(riasecmineur,riasecmajeur),code,transitionecologique,transitionnumerique,codeogr,@macrocompetence(riasecmineur,riasecmajeur)),@macrosavoiretreprofessionnel(qualiteprofessionnelle),codearborescence,transitionecologique),code,codearborescence)", + "obsolete" + ], + "example": "libelle,obsolete,code,codearborescence,datefin,domainecompetence(codearborescence,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 enjeu.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es pour un enjeu de compĂ©tences renseignĂ©.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Enjeu" + }, + "examples": { + "Retour complet": { + "value": { + "objectifs": [ + { + "libelle": "Soigner des animaux", + "macroCompetences": [ + { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "competences": [ + { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "qualiteProfessionnelle": "01", + "codeArborescence": "string", + "transitionEcologique": false + } + ], + "code": "19", + "codeArborescence": "1E4" + } + ], + "libelle": "Soin", + "obsolete": false, + "code": "7", + "codeArborescence": "1E", + "dateFin": "2024-02-23T14:40:14.848Z", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "Soin", + "obsolete": false, + "code": "7", + "codeArborescence": "1E", + "dateFin": "2024-02-23T14:40:14.848Z", + "domaineCompetence": { + "codeArborescence": "1", + "libelle": "Management, Social, Soin", + "code": "1" + } + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/macro-competence": { + "get": { + "tags": [ + "Macro-compĂ©tence" + ], + "summary": "Lister les macro-compĂ©tences", + "description": "Permet de lister les macro-compĂ©tences.\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": "listerMacroCompetences", + "parameters": [ + { + "name": "code-ogr", + "in": "query", + "description": "Code OGR.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "riasec-majeur", + "in": "query", + "description": "Riasec majeur.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "riasec-mineur", + "in": "query", + "description": "Riasec mineur.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
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": [ + "@macrosavoiretreprofessionnel(qualiteprofessionnelle)", + "code", + "codearborescence", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "definition", + "libelle", + "maturite", + "objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence)", + "obsolete", + "riasecmajeur", + "riasecmineur", + "souscategorie", + "transferable", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des macro-compĂ©tences.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/MacroSavoirEtreProfessionnel" + }, + { + "$ref": "#/components/schemas/MacroSavoirFaire" + } + ] + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "qualiteProfessionnelle": "01", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "code": "100253" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/macro-competence/{code}": { + "get": { + "tags": [ + "Macro-compĂ©tence" + ], + "summary": "Lire une macro-compĂ©tence", + "description": "Permet la lecture d'une macro-compĂ©tence 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": "lireMacroCompetence", + "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`).
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": [ + "@macrosavoiretreprofessionnel(qualiteprofessionnelle)", + "code", + "codearborescence", + "codeogr", + "competenceesco(libelle,uri)", + "competences(libelle,@competencedetaillee(riasecmineur,riasecmajeur),code,transitionecologique,transitionnumerique,codeogr,@macrocompetence(riasecmineur,riasecmajeur))", + "datefin", + "definition", + "libelle", + "maturite", + "objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence)", + "obsolete", + "riasecmajeur", + "riasecmineur", + "souscategorie", + "transferable", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,transferable,souscategorie,obsolete,code,riasecmineur,definition,transitionnumerique,codeogr,maturite,riasecmajeur,@macrosavoiretreprofessionnel(qualiteprofessionnelle),competenceesco(libelle,uri),codearborescence,objectif(codearborescence,libelle,enjeu(codearborescence,libelle,code,domainecompetence(codearborescence,libelle,code)),code),transitionecologique,datefin" + } + }, + { + "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 macro-compĂ©tence.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es pour une macro-compĂ©tence renseignĂ©e.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/MacroSavoirEtreProfessionnel" + }, + { + "$ref": "#/components/schemas/MacroSavoirFaire" + } + ] + }, + "examples": { + "Retour complet": { + "value": { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "competences": [ + { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "qualiteProfessionnelle": "01", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "qualiteProfessionnelle": "01", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "codeArborescence": "1E4", + "libelle": "Soigner des animaux", + "enjeu": { + "codeArborescence": "1E", + "libelle": "Soin", + "code": "7", + "domaineCompetence": { + "codeArborescence": "1", + "libelle": "Management, Social, Soin", + "code": "1" + } + }, + "code": "19" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/macro-savoir-faire": { + "get": { + "tags": [ + "Macro-savoir-faire" + ], + "summary": "Lister les macros savoir-faire", + "description": "Permet de lister les macros savoir-faire.\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": "listerMacroSavoirFaires", + "parameters": [ + { + "name": "code-ogr", + "in": "query", + "description": "Code OGR.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
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", + "codearborescence", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "definition", + "libelle", + "maturite", + "objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence)", + "obsolete", + "riasecmajeur", + "riasecmineur", + "souscategorie", + "transferable", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des macros savoir-faire.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MacroSavoirFaire" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "type": "MACRO-SAVOIR-FAIRE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "type": "MACRO-SAVOIR-FAIRE", + "libelle": "Anglais maritime", + "code": "100253" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/macro-savoir-faire/{code}": { + "get": { + "tags": [ + "Macro-savoir-faire" + ], + "summary": "Lire une macro savoir-faire", + "description": "Permet la lecture d'un macro savoir-faire 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": "lireMacroSavoirFaire", + "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`).
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", + "codearborescence", + "codeogr", + "competenceesco(libelle,uri)", + "competences(libelle,@competencedetaillee(riasecmineur,riasecmajeur),code,transitionecologique,transitionnumerique,codeogr,@macrocompetence(riasecmineur,riasecmajeur))", + "datefin", + "definition", + "libelle", + "maturite", + "objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence)", + "obsolete", + "riasecmajeur", + "riasecmineur", + "souscategorie", + "transferable", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,transferable,souscategorie,obsolete,code,riasecmineur,definition,transitionnumerique,codeogr,maturite,riasecmajeur,competenceesco(libelle,uri),codearborescence,objectif(codearborescence,libelle,enjeu(codearborescence,libelle,code,domainecompetence(codearborescence,libelle,code)),code),transitionecologique,datefin" + } + }, + { + "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 macro savoir-faire.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es pour un macro savoir-faire.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MacroSavoirFaire" + }, + "examples": { + "Retour complet": { + "value": { + "type": "MACRO-SAVOIR-FAIRE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "competences": [ + { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "type": "MACRO-SAVOIR-FAIRE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "codeArborescence": "1E4", + "libelle": "Soigner des animaux", + "enjeu": { + "codeArborescence": "1E", + "libelle": "Soin", + "code": "7", + "domaineCompetence": { + "codeArborescence": "1", + "libelle": "Management, Social, Soin", + "code": "1" + } + }, + "code": "19" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/macro-savoir-etre-professionnel": { + "get": { + "tags": [ + "Macro-savoir-ĂȘtre professionnel" + ], + "summary": "Lister les macros savoir-ĂȘtre professionnel", + "description": "Permet de lister les macros savoir-ĂȘtre professionnels.\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": "listerMacroSavoirEtreProfessionnels", + "parameters": [ + { + "name": "code-ogr", + "in": "query", + "description": "Code OGR.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "qualite-professionnelle", + "in": "query", + "description": "code qualitĂ© professionnelle.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
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", + "codearborescence", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "definition", + "libelle", + "maturite", + "objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence)", + "obsolete", + "qualiteprofessionnelle", + "riasecmajeur", + "riasecmineur", + "souscategorie", + "transferable", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MacroSavoirEtreProfessionnel" + }, + "examples": { + "Retour complet": { + "value": { + "type": "MACRO-SAVOIR-ETRE-PROFESSIONNEL", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "qualiteProfessionnelle": "01", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "type": "MACRO-SAVOIR-ETRE-PROFESSIONNEL", + "libelle": "Anglais maritime", + "code": "100253" + } + } + } + } + } + }, + "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 + } + } + } + }, + "text/csv": { + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/macro-savoir-etre-professionnel/{code}": { + "get": { + "tags": [ + "Macro-savoir-ĂȘtre professionnel" + ], + "summary": "Lire une macro savoir-ĂȘtre professionnel", + "description": "Permet la lecture d'un macro savoir-ĂȘtre professionnel 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": "lireMacroSavoirEtreProfessionnel", + "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`).
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", + "codearborescence", + "codeogr", + "competenceesco(libelle,uri)", + "competences(libelle,@competencedetaillee(riasecmineur,riasecmajeur),code,transitionecologique,transitionnumerique,codeogr,@macrocompetence(riasecmineur,riasecmajeur))", + "datefin", + "definition", + "libelle", + "maturite", + "objectif(libelle,enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence)),code,codearborescence)", + "obsolete", + "qualiteprofessionnelle", + "riasecmajeur", + "riasecmineur", + "souscategorie", + "transferable", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,transferable,souscategorie,obsolete,code,riasecmineur,definition,transitionnumerique,codeogr,maturite,riasecmajeur,qualiteprofessionnelle,competenceesco(libelle,uri),codearborescence,objectif(codearborescence,libelle,enjeu(codearborescence,libelle,code,domainecompetence(codearborescence,libelle,code)),code),transitionecologique,datefin" + } + }, + { + "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 macro savoir-ĂȘtre professionnel.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es pour un macro savoir-ĂȘtre professionel renseignĂ©.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MacroSavoirEtreProfessionnel" + }, + "examples": { + "Retour complet": { + "value": { + "type": "MACRO-SAVOIR-ETRE-PROFESSIONNEL", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "qualiteProfessionnelle": "01", + "competences": [ + { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "code": "19", + "codeArborescence": "1E4" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "type": "MACRO-SAVOIR-ETRE-PROFESSIONNEL", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "obsolete": false, + "code": "100253", + "riasecMineur": "R", + "definition": "string", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "qualiteProfessionnelle": "01", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "codeArborescence": "string", + "objectif": { + "codeArborescence": "1E4", + "libelle": "Soigner des animaux", + "enjeu": { + "codeArborescence": "1E", + "libelle": "Soin", + "code": "7", + "domaineCompetence": { + "codeArborescence": "1", + "libelle": "Management, Social, Soin", + "code": "1" + } + }, + "code": "19" + }, + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/objectif": { + "get": { + "tags": [ + "Objectif" + ], + "summary": "Lister les objectifs", + "description": "Permet de lister les objectifs de compĂ©tences.\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": "listerObjectifs", + "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`).
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", + "codearborescence", + "datefin", + "enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence))", + "libelle", + "macrocompetences(libelle,transferable,@macrosavoiretreprofessionnel(qualiteprofessionnelle),souscategorie,code,riasecmineur,codearborescence,transitionecologique,transitionnumerique,codeogr,maturite,riasecmajeur)", + "obsolete" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des objectifs.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Objectif" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "macroCompetences": [ + { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "qualiteProfessionnelle": "01", + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "codeArborescence": "string", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R" + } + ], + "obsolete": false, + "code": "19", + "codeArborescence": "1E4", + "dateFin": "2024-02-23T14:40:14.848Z" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "Soigner des animaux", + "code": "19" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/objectif/{code}": { + "get": { + "tags": [ + "Objectif" + ], + "summary": "Lire un objectif", + "description": "Permet la lecture d'un objectif 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": "lireObjectif", + "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`).
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", + "codearborescence", + "datefin", + "enjeu(libelle,code,codearborescence,domainecompetence(libelle,code,codearborescence))", + "libelle", + "macrocompetences(libelle,transferable,souscategorie,code,riasecmineur,transitionnumerique,codeogr,maturite,riasecmajeur,competences(libelle,@competencedetaillee(riasecmineur,riasecmajeur),code,transitionecologique,transitionnumerique,codeogr,@macrocompetence(riasecmineur,riasecmajeur)),@macrosavoiretreprofessionnel(qualiteprofessionnelle),codearborescence,transitionecologique)", + "obsolete" + ], + "example": "libelle,enjeu(codearborescence,libelle,code,domainecompetence(codearborescence,libelle,code)),obsolete,code,codearborescence,datefin" + } + }, + { + "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 objectif.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es pour un objectif renseignĂ©.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Objectif" + }, + "examples": { + "Retour complet": { + "value": { + "libelle": "Soigner des animaux", + "enjeu": { + "libelle": "Soin", + "code": "7", + "codeArborescence": "1E", + "domaineCompetence": { + "libelle": "Management, Social, Soin", + "code": "1", + "codeArborescence": "1" + } + }, + "macroCompetences": [ + { + "type": "MACRO-COMPETENCE", + "libelle": "Anglais maritime", + "transferable": false, + "sousCategorie": "TECHNIQUE", + "code": "100253", + "riasecMineur": "R", + "transitionNumerique": false, + "codeOgr": "100253", + "maturite": "HETEROGENE", + "riasecMajeur": "R", + "competences": [ + { + "type": "string", + "libelle": "Anglais maritime", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100253", + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253" + } + ], + "qualiteProfessionnelle": "01", + "codeArborescence": "string", + "transitionEcologique": false + } + ], + "obsolete": false, + "code": "19", + "codeArborescence": "1E4", + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "Soigner des animaux", + "enjeu": { + "codeArborescence": "1E", + "libelle": "Soin", + "code": "7", + "domaineCompetence": { + "codeArborescence": "1", + "libelle": "Management, Social, Soin", + "code": "1" + } + }, + "obsolete": false, + "code": "19", + "codeArborescence": "1E4", + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/savoir": { + "get": { + "tags": [ + "Savoir" + ], + "summary": "Lister les savoirs", + "description": "Permet de lister les savoirs.\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": "listerSavoirs", + "parameters": [ + { + "name": "code-ogr", + "in": "query", + "description": "Code OGR.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
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": [ + "categoriesavoir(libelle,categorie(libelle,code),code)", + "code", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "libelle", + "obsolete", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,code" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des savoirs.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Savoir" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "type": "SAVOIR", + "libelle": "Anglais maritime", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "categorieSavoir": { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "code": "30" + }, + "dateFin": "2024-02-23T14:40:14.848Z" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "type": "SAVOIR", + "libelle": "Anglais maritime", + "code": "100253" + } + ] + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/savoir/{code}": { + "get": { + "tags": [ + "Savoir" + ], + "summary": "Lire un savoir", + "description": "Permet de lire un savoir 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": "lireSavoir", + "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`).
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": [ + "categoriesavoir(libelle,categorie(libelle,code),code)", + "code", + "codeogr", + "competenceesco(libelle,uri)", + "datefin", + "libelle", + "obsolete", + "transitionecologique", + "transitionnumerique" + ], + "example": "libelle,obsolete,code,competenceesco(libelle,uri),transitionecologique,transitionnumerique,codeogr,categoriesavoir(libelle,categorie(libelle,code),code),datefin" + } + }, + { + "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 savoir.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es pour un savoir renseignĂ©.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Savoir" + }, + "examples": { + "Retour complet": { + "value": { + "type": "SAVOIR", + "libelle": "Anglais maritime", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "categorieSavoir": { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "code": "30" + }, + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "type": "SAVOIR", + "libelle": "Anglais maritime", + "obsolete": false, + "code": "100253", + "competenceEsco": { + "libelle": "abattre des arbres", + "uri": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + }, + "transitionEcologique": false, + "transitionNumerique": false, + "codeOgr": "100253", + "categorieSavoir": { + "libelle": "VĂ©hicules", + "categorie": { + "libelle": "VĂ©hicules", + "code": "30" + }, + "code": "30" + }, + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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-competences", + "description": "PROD" + } + ] + } + }, + "/v1/competences/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`).
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 eeUGwjJL1XTGqEKXl_3y_qTtzlc" + } + } + ], + "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-competences", + "description": "PROD" + } + ] + } + } + }, + "components": { + "schemas": { + "CategorieSavoir": { + "type": "object", + "description": "CatĂ©gorie de Savoirs. Il y a seulement deux niveaux de catĂ©gories de savoirs: l'un qui dispose de sous-catĂ©gories et l'autre qui dispose d'une catĂ©gorie de savoir parente et de savoirs.", + "properties": { + "categorie": { + "$ref": "#/components/schemas/CategorieSavoir" + }, + "code": { + "type": "string", + "description": "Code unique de la catĂ©gorie de savoirs.", + "example": "30" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© de la catĂ©gorie de savoirs.", + "example": "VĂ©hicules" + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + }, + "savoirs": { + "type": "array", + "description": "Savoirs.", + "items": { + "$ref": "#/components/schemas/Savoir" + } + }, + "sousCategories": { + "type": "array", + "description": "Sous-catĂ©gories rattachĂ©es.", + "items": { + "$ref": "#/components/schemas/CategorieSavoir" + } + } + } + }, + "Savoir": { + "type": "object", + "description": "Savoir.", + "allOf": [ + { + "$ref": "#/components/schemas/Competence" + }, + { + "type": "object", + "properties": { + "categorieSavoir": { + "$ref": "#/components/schemas/CategorieSavoir" + }, + "type": { + "type": "string", + "description": "Cette propriĂ©tĂ© est forcĂ©ment Ă  la valeur 'SAVOIR'." + } + } + } + ] + }, + "Competence": { + "type": "object", + "description": "CompĂ©tence. Une compĂ©tence est forcĂ©ment soit un macro-savoir-faire soit un macro-savoir-ĂȘtre professionnel, soit une compĂ©tence dĂ©taillĂ©e soit un savoir.", + "properties": { + "code": { + "type": "string", + "description": "Code unique de la compĂ©tence.", + "example": "100253" + }, + "codeOgr": { + "type": "string", + "description": "Code OGR. Ce champ est conservĂ© uniquement pour des raisons de rĂ©tro-compatibilitĂ©.", + "example": "100253", + "x-deprecated": true + }, + "competenceEsco": { + "$ref": "#/components/schemas/CompetenceEsco" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© de la compĂ©tence.", + "example": "Anglais maritime" + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + }, + "transitionEcologique": { + "type": "boolean", + "description": "Transition Ă©cologique: oui/non. Ce champ est optionnel." + }, + "transitionNumerique": { + "type": "boolean", + "description": "Transition numĂ©rique: oui/non. Ce champ est optionnel." + }, + "type": { + "type": "string", + "description": "Le type de l'objet. Il y a quatre valeurs possibles :\n\n" + } + }, + "discriminator": { + "propertyName": "type" + } + }, + "CompetenceEsco": { + "type": "object", + "description": "CompĂ©tence ESCO (en provenance du rĂ©fĂ©rentiel 'ESCO')", + "properties": { + "libelle": { + "type": "string", + "description": "LibellĂ© de la compĂ©tence ESCO.", + "example": "abattre des arbres" + }, + "uri": { + "type": "string", + "description": "Uri unique de la compĂ©tence ESCO.", + "example": "http://data.europa.eu/esco/skill/b8cfe3d0-15a7-4be4-a7f1-f5141ed11f16" + } + } + }, + "CompetenceDetaillee": { + "type": "object", + "description": "CompĂ©tence dĂ©taillĂ©e.", + "allOf": [ + { + "$ref": "#/components/schemas/Competence" + }, + { + "type": "object", + "properties": { + "macroCompetence": { + "$ref": "#/components/schemas/MacroCompetence" + }, + "riasecMajeur": { + "type": "string", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ], + "description": "Riasec Majeur. Ce champ est optionnel." + }, + "riasecMineur": { + "type": "string", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ], + "description": "Riasec Mineur. Ce champ est optionnel." + }, + "type": { + "type": "string", + "description": "Cette propriĂ©tĂ© est forcĂ©ment Ă  la valeur 'COMPETENCE-DETAILLEE'." + } + } + } + ] + }, + "MacroCompetence": { + "type": "object", + "description": "Macro-CompĂ©tence. Une macro-compĂ©tence est forcĂ©ment soit un macro-savoir-faire soit un macro-savoir-ĂȘtre professionnel.", + "allOf": [ + { + "$ref": "#/components/schemas/Competence" + }, + { + "type": "object", + "properties": { + "codeArborescence": { + "type": "string", + "description": "Code Arborescence. Il s'agit d'un code unique sur cinq caractĂšres qui est prĂ©fixĂ© par le code arborescence de l'objectif liĂ©." + }, + "competences": { + "type": "array", + "description": "Liste des compĂ©tences dĂ©taillĂ©es rattachĂ©es.", + "items": { + "$ref": "#/components/schemas/CompetenceDetaillee" + } + }, + "definition": { + "type": "string", + "description": "DĂ©finition. Ce champ est optionnel." + }, + "maturite": { + "type": "string", + "enum": [ + "HETEROGENE", + "TRES_HOMOGENE", + "HOMOGENE" + ], + "description": "MaturitĂ© de macro-compĂ©tence. Ce champ est optionnel." + }, + "objectif": { + "$ref": "#/components/schemas/Objectif" + }, + "riasecMajeur": { + "type": "string", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ], + "description": "Riasec Majeur. Ce champ est optionnel." + }, + "riasecMineur": { + "type": "string", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ], + "description": "Riasec Mineur. Ce champ est optionnel." + }, + "sousCategorie": { + "type": "string", + "enum": [ + "TECHNIQUE", + "TECHNIQUE_EXPERT", + "TRANSVERSE" + ], + "description": "Sous-catĂ©gorie de macro-compĂ©tence. Ce champ est optionnel." + }, + "transferable": { + "type": "boolean", + "description": "TransfĂ©rable: oui/non. Ce champ est optionnel." + }, + "type": { + "type": "string", + "description": "Cette propriĂ©tĂ© est soit Ă  la valeur 'MACRO-SAVOIR-ETRE-PROFESSIONNEL' soit Ă  la valeur 'MACRO-SAVOIR-FAIRE'." + } + } + } + ], + "discriminator": { + "propertyName": "type" + } + }, + "Objectif": { + "type": "object", + "description": "Objectif", + "properties": { + "code": { + "type": "string", + "description": "Code unique de l'objectif.", + "example": "19" + }, + "codeArborescence": { + "type": "string", + "description": "Code Arborescence. Il s'agit d'un code unique sur trois caractĂšres qui est prĂ©fixĂ© par le code arborescence de l'enjeu liĂ©.", + "example": "10000.0" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "enjeu": { + "$ref": "#/components/schemas/Enjeu" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© de l'objectif.", + "example": "Soigner des animaux" + }, + "macroCompetences": { + "type": "array", + "description": "Liste des macros-compĂ©tences rattachĂ©es.", + "items": { + "$ref": "#/components/schemas/MacroCompetence" + } + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + } + } + }, + "Enjeu": { + "type": "object", + "description": "Enjeu", + "properties": { + "code": { + "type": "string", + "description": "Code unique de l'enjeu.", + "example": "7" + }, + "codeArborescence": { + "type": "string", + "description": "Code Arborescence. Il s'agit d'un code unique sur deux caractĂšres dont le premier caractĂšre de ce code correspond au code arborescence du domaine de compĂ©tence parent.", + "example": "1E" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "domaineCompetence": { + "$ref": "#/components/schemas/DomaineCompetence" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© de l'enjeu.", + "example": "Soin" + }, + "objectifs": { + "type": "array", + "description": "Liste des objectifs rattachĂ©s.", + "items": { + "$ref": "#/components/schemas/Objectif" + } + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + } + } + }, + "DomaineCompetence": { + "type": "object", + "description": "Domaine de compĂ©tence", + "properties": { + "code": { + "type": "string", + "description": "Code unique du domaine de compĂ©tence.", + "example": "1" + }, + "codeArborescence": { + "type": "string", + "description": "Code Arborescence. Il s'agit d'un code unique sur un caractĂšre qui est prĂ©fixe le code arborescence des enjeux liĂ©s au domaine.", + "example": "1" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "enjeux": { + "type": "array", + "description": "Liste des enjeux rattachĂ©s.", + "items": { + "$ref": "#/components/schemas/Enjeu" + } + }, + "libelle": { + "type": "string", + "description": "LibellĂ© du domaine de compĂ©tence.", + "example": "Management, Social, Soin" + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + } + } + }, + "MacroSavoirEtreProfessionnel": { + "type": "object", + "description": "Macro savoir-ĂȘtre professionnel.", + "allOf": [ + { + "$ref": "#/components/schemas/MacroCompetence" + }, + { + "type": "object", + "properties": { + "qualiteProfessionnelle": { + "type": "string", + "description": "Code sur deux caractĂšres de la qualitĂ© professionnelle.\n\nUne qualitĂ© professionnelle dĂ©crit les capacitĂ©s d’agir et d’interagir dans un contexte professionnel et sont contenues dans le rĂ©fĂ©rentiel 'QualitĂ©s professionnelles'.\n\nCe champ est optionnel.\n", + "example": "01" + }, + "type": { + "type": "string", + "description": "Cette propriĂ©tĂ© est forcĂ©ment Ă  la valeur 'MACRO-SAVOIR-ETRE-PROFESSIONNEL'." + } + } + } + ] + }, + "MacroSavoirFaire": { + "type": "object", + "description": "Macro Savoir-Faire.", + "allOf": [ + { + "$ref": "#/components/schemas/MacroCompetence" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Cette propriĂ©tĂ© est forcĂ©ment Ă  la valeur 'MACRO-SAVOIR-FAIRE'." + } + } + } + ] + }, + "VersionRome": { + "title": "VersionRome", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "La version actuelle." + }, + "lastModifiedDate": { + "type": "string", + "description": "La date de derniĂšre modification de la version.", + "format": "date-time" + } + }, + "description": "Version du rome" + } + } + } +} \ No newline at end of file diff --git a/docs/api/ROME 4.0 - MĂ©tiers.json b/docs/api/ROME 4.0 - MĂ©tiers.json new file mode 100644 index 0000000..8171dfc --- /dev/null +++ b/docs/api/ROME 4.0 - MĂ©tiers.json @@ -0,0 +1,4015 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "ROME 4.0 - MĂ©tiers", + "description": "RĂ©fĂ©rentiel des professions caractĂ©risĂ©es par une spĂ©cificitĂ© exigeant un apprentissage, de l'expĂ©rience, etc., et entrant dans un cadre lĂ©gal.
Un métier est une activité professionnelle pouvant nécessiter une formation professionnelle et des compétences métier et transverses garantissant une rémunération (salariée ou non salariée).
Le mĂ©tier recherchĂ© correspond au mĂ©tier qui peut ĂȘtre exercĂ© avec ou sans dĂ©lai (avec ou sans action de formation) correspondant soit au mĂ©tier exercĂ© et perdu, soit Ă  un premier ‘emploi’ lors de l'entrĂ©e sur le marchĂ© du travail. Il est l’un des Ă©lĂ©ments permettant de contractualiser l’ORE – Offre Raisonnable d’Emploi - dans le profil de compĂ©tences du dossier MAP du demandeur d'emploi.\r\n\r\n**Scopes** : `api_rome-metiersv1`,`nomenclatureRome`\r\n\r\n**Royaume** : `/partenaire`", + "version": "1" + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ], + "paths": { + "/v1/metiers/appellation": { + "get": { + "tags": [ + "Appellation" + ], + "summary": "Lister les appellations", + "description": "Permet d'obtenir la liste des appellation des mĂ©tiers.\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": "listerAppellations", + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,code", + "enum": [ + "appellationesco(libelle,uri)", + "classification", + "code", + "emploicadre", + "emploireglemente", + "libelle", + "libellecourt", + "metier(emploireglemente,libelle,domaineprofessionnel(libelle,code,granddomaine(libelle,code)),code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique)", + "romeparent", + "secondaire", + "transitiondemographique", + "transitionecologique", + "transitionecologiquedetaillee", + "transitionnumerique" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des appellations des mĂ©tiers.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Appellation" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "appellationEsco": { + "libelle": "string", + "uri": "string" + }, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "secondaire": false, + "romeParent": "12374", + "libelleCourt": "Chef de station fruitiĂšre", + "metier": { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "domaineProfessionnel": { + "libelle": "Production", + "code": "A14", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + } + }, + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false + } + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374" + } + ] + } + } + } + } + }, + "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-metiers" + } + ] + } + }, + "/v1/metiers/appellation/requete": { + "get": { + "tags": [ + "Appellation" + ], + "summary": "Rechercher une appellation", + "description": "Permet de rechercher des appellations.\r\n\r\nCe service a pour vocation d'ĂȘtre utilisĂ© dans le cas d'une autocomplĂ©tion.\r\n\r\nDe ce fait, on peut avoir une diffĂ©rence entre le nombre de rĂ©sultats affichĂ©s (dans le tableau ***resultats***) et le nombre total de rĂ©sultats disponibles (indiquĂ© dans ***totalResultats***).\r\n\r\nAttention, le sĂ©lecteur de champs s'applique uniquement Ă  l'attribut ***resultats*** de la rĂ©ponse.\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": "rechercherAppellation", + "parameters": [ + { + "name": "q", + "in": "query", + "description": "Le(s) mot(s) et/ou dĂ©but de mot(s) recherchĂ©(s).", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qf", + "in": "query", + "description": "Les indexe(s) de recherche (query fields). Si non prĂ©cisĂ©, on cherche sur le code et libellĂ©.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fq", + "in": "query", + "description": "Les filtre(s) de recherche (filters query). Ex : fq=code:1 AND (code:2 OR libelle:app). Si non prĂ©cisĂ©, aucun filtre n'est appliquĂ©.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "op", + "in": "query", + "description": "Lorsque plusieurs mots sont prĂ©sents dans la recherche (q=mot1 mot2), indique si au moins 1 mot doit correspondre 'OR' ou s'ils doivent tous correspondre 'AND'. Si non prĂ©cisĂ©, 'OR' est utilisĂ©", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,code,metier(libelle,code)", + "enum": [ + "appellationesco(libelle,uri)", + "classification", + "secondaire", + "code", + "emploicadre", + "emploireglemente", + "libelle", + "metier(code,libelle,riasecmineur,riasecmajeur)", + "transitiondemographique", + "transitionecologique", + "transitionecologiquedetaillee", + "transitionnumerique" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Le rĂ©sultat de la recherche d'appellations pour une autocomplĂ©tion.", + "content": { + "application/json": { + "examples": { + "Retour complet": { + "value": { + "totalResultats": 123, + "requete": "string", + "resultats": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "appellationEsco": { + "libelle": "string", + "uri": "string" + }, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "secondaire": "12374", + "metier": { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + } + ] + } + }, + "Retour par dĂ©faut": { + "value": { + "totalResultats": 123, + "requete": "string", + "resultats": [ + { + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374", + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/appellation/{code}": { + "get": { + "tags": [ + "Appellation" + ], + "summary": "Lire une appellation", + "description": "Permet de lire une appellation 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": "lireAppellation", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code de l'appellation.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "emploireglemente,libelle,obsolete,code,emploicadre,transitionnumerique,classification,competencescles(frequence,competence(libelle,@macrosavoiretreprofessionnel(riasecmajeur,riasecmineur),@competencedetaillee(riasecmajeur,riasecmineur),code,@macrosavoirfaire(riasecmajeur,riasecmineur),codeogr)),transitionecologiquedetaillee,appellationesco(libelle,uri),transitionecologique,transitiondemographique,libellecourt,datefin,metier(emploireglemente,libelle,domaineprofessionnel(libelle,granddomaine(libelle,code),code),code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique)", + "enum": [ + "appellationesco(libelle,uri)", + "appellationsenvisageables(libelle,code,metier(libelle,code,riasecmineur,riasecmajeur))", + "appellationsproches(libelle,code,metier(libelle,code,riasecmineur,riasecmajeur))", + "classification", + "code", + "competencescles(frequence,competence(libelle,@macrosavoiretreprofessionnel(riasecmineur,riasecmajeur),@competencedetaillee(riasecmineur,riasecmajeur),code,@macrosavoirfaire(riasecmineur,riasecmajeur),codeogr))", + "datefin", + "emploicadre", + "emploireglemente", + "libelle", + "libellecourt", + "metier(emploireglemente,libelle,domaineprofessionnel(libelle,code,granddomaine(libelle,code)),code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique)", + "metiersenvisageables(libelle,code,riasecmineur,riasecmajeur)", + "metiersproches(libelle,code,riasecmineur,riasecmajeur)", + "obsolete", + "romeparent", + "secondaire", + "transitiondemographique", + "transitionecologique", + "transitionecologiquedetaillee", + "transitionnumerique" + ] + } + }, + { + "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": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es d'une appellation.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Appellation" + }, + "examples": { + "Retour complet": { + "value": { + "emploiReglemente": false, + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "obsolete": false, + "code": "12374", + "emploiCadre": false, + "transitionNumerique": false, + "classification": "PRINCIPALE", + "competencesCles": [ + { + "frequence": 123, + "competence": { + "type": "string", + "libelle": "Techniques de soudage", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100007", + "codeOgr": "string" + } + } + ], + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "appellationsEnvisageables": [ + { + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374", + "metier": { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + } + ], + "appellationEsco": { + "libelle": "string", + "uri": "string" + }, + "metiersProches": [ + { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + ], + "metiersEnvisageables": [ + { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + ], + "appellationsProches": [ + { + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374", + "metier": { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + } + ], + "transitionEcologique": false, + "transitionDemographique": false, + "romeParent": "12374", + "libelleCourt": "Chef de station fruitiĂšre", + "dateFin": "2024-02-23T14:40:14.848Z", + "metier": { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "domaineProfessionnel": { + "libelle": "Production", + "code": "A14", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + } + }, + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false + } + } + }, + "Retour par dĂ©faut": { + "value": { + "emploiReglemente": false, + "libelle": "Chef / Cheffe de station fruitiĂšre", + "obsolete": false, + "code": "12374", + "emploiCadre": false, + "transitionNumerique": false, + "classification": "PRINCIPALE", + "competencesCles": [ + { + "frequence": 123, + "competence": { + "type": "string", + "libelle": "Techniques de soudage", + "riasecMajeur": "R", + "riasecMineur": "R", + "code": "100007", + "codeOgr": "string" + } + } + ], + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "appellationEsco": { + "libelle": "string", + "uri": "string" + }, + "transitionEcologique": false, + "transitionDemographique": false, + "libelleCourt": "Chef de station fruitiĂšre", + "dateFin": "2024-02-23T14:40:14.848Z", + "metier": { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "domaineProfessionnel": { + "libelle": "Production", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + }, + "code": "A14" + }, + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false + } + } + } + } + } + } + }, + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/centre-interet": { + "get": { + "tags": [ + "Centre d'intĂ©rĂȘt" + ], + "summary": "Lister les centres d'intĂ©rĂȘt", + "description": "Permet de lister les centres d'intĂ©rĂȘt.\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": "listerCentreInterets", + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,code", + "enum": [ + "code", + "definition", + "libelle", + "metiers(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification))", + "metierslies(principal,metier(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent)))" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des centres d'intĂ©rĂȘt.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CentreInteret" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "libelle": "Je suis amateur / amatrice de sensations fortes", + "code": "25", + "definition": "string", + "metiersLies": [ + { + "principal": false, + "metier": { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + } + ], + "metiers": [ + { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE" + } + ] + } + ] + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "Je suis amateur / amatrice de sensations fortes", + "code": "25" + } + ] + } + } + } + } + }, + "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-metiers" + } + ] + } + }, + "/v1/metiers/centre-interet/{code}": { + "get": { + "tags": [ + "Centre d'intĂ©rĂȘt" + ], + "summary": "Lire un centre d'intĂ©rĂȘt", + "description": "Permet de lire un centre d'intĂ©rĂȘt 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": "lireCentreInteret", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du centre d'intĂ©rĂȘt.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,obsolete,code,definition,datefin", + "enum": [ + "code", + "datefin", + "definition", + "libelle", + "metiers(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent))", + "metierslies(principal,metier(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification)))", + "obsolete" + ] + } + }, + { + "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": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es d'un centre d'intĂ©rĂȘt.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CentreInteret" + }, + "examples": { + "Retour complet": { + "value": { + "libelle": "Je suis amateur / amatrice de sensations fortes", + "obsolete": false, + "code": "25", + "definition": "string", + "metiersLies": [ + { + "principal": false, + "metier": { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE" + } + ] + } + } + ], + "metiers": [ + { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + ], + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "Je suis amateur / amatrice de sensations fortes", + "obsolete": false, + "code": "25", + "definition": "string", + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/domaine-professionnel": { + "get": { + "tags": [ + "Domaine professionnel" + ], + "summary": "Lister les domaines professionnels", + "description": "Permet de lister les domaines professionnels.\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": "listerDomainesProfessionnels", + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,code", + "enum": [ + "code", + "granddomaine(libelle,code)", + "libelle", + "metiers(label,transitionecologiquedetaillee,libelle,codeisco,code,riasecmineur,transitionecologique,transitionnumerique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent),riasecmajeur)" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des domaines professionnels", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DomaineProfessionnel" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "libelle": "Production", + "code": "A14", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + }, + "metiers": [ + { + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "BĂ»cheronnage et Ă©lagage", + "codeIsco": "6210", + "code": "A1201", + "riasecMineur": "R", + "transitionEcologique": false, + "transitionNumerique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ], + "riasecMajeur": "R" + } + ] + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "Production", + "code": "A14" + } + ] + } + } + } + } + }, + "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-metiers" + } + ] + } + }, + "/v1/metiers/domaine-professionnel/{code}": { + "get": { + "tags": [ + "Domaine professionnel" + ], + "summary": "Lire un domaine professionnel", + "description": "Permet de lire un domaine professionnel 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": "lireDomaineProfessionnel", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du domaine professionnel.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,obsolete,code,granddomaine(libelle,code),datefin", + "enum": [ + "code", + "datefin", + "granddomaine(libelle,code)", + "libelle", + "metiers(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent))", + "obsolete" + ] + } + }, + { + "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": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es d'un domaine professionnel.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DomaineProfessionnel" + }, + "examples": { + "Retour complet": { + "value": { + "libelle": "Production", + "obsolete": false, + "code": "A14", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + }, + "metiers": [ + { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + ], + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "Production", + "obsolete": false, + "code": "A14", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + }, + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/grand-domaine": { + "get": { + "tags": [ + "Grand domaine" + ], + "summary": "Lister les grands domaines", + "description": "Permet de lister les grands domaines des mĂ©tiers.\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": "listerGrandDomaines", + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,code", + "enum": [ + "code", + "domaineprofessionnels(libelle,code,metiers(label,transitionecologiquedetaillee,libelle,codeisco,code,riasecmineur,transitionecologique,transitionnumerique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent),riasecmajeur))", + "libelle" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des grands domaines", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GrandDomaine" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "libelle": "Industrie", + "domaineProfessionnels": [ + { + "libelle": "Production", + "code": "A14", + "metiers": [ + { + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "BĂ»cheronnage et Ă©lagage", + "codeIsco": "6210", + "code": "A1201", + "riasecMineur": "R", + "transitionEcologique": false, + "transitionNumerique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ], + "riasecMajeur": "R" + } + ] + } + ], + "code": "H" + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "Industrie", + "code": "H" + } + ] + } + } + } + } + }, + "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-metiers" + } + ] + } + }, + "/v1/metiers/grand-domaine/{code}": { + "get": { + "tags": [ + "Grand domaine" + ], + "summary": "Lire un grand domaine", + "description": "Permet de lire un grand domaine 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": "lireGrandDomaine", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du grand domaine.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,obsolete,code,datefin", + "enum": [ + "code", + "datefin", + "domaineprofessionnels(libelle,code,metiers(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent)))", + "libelle", + "obsolete" + ] + } + }, + { + "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": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es d'un grand domaine.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GrandDomaine" + }, + "examples": { + "Retour complet": { + "value": { + "libelle": "Industrie", + "domaineProfessionnels": [ + { + "libelle": "Production", + "code": "A14", + "metiers": [ + { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + ] + } + ], + "obsolete": false, + "code": "H", + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "Industrie", + "obsolete": false, + "code": "H", + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/metier": { + "get": { + "tags": [ + "MĂ©tier" + ], + "summary": "Lister les mĂ©tiers", + "description": "Permet de lister les mĂ©tiers.\r\n\r\nIl est possible de filtrer les mĂ©tiers selon leur Riasec (majeur et/ou mineur), le code d'une des divisions NAF auquel il est rattachĂ© ou encore selon la compĂ©tence mobilisĂ©e (principale, Ă©mergente ou autre) auquel il est liĂ©.\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": "listerMetiers", + "parameters": [ + { + "name": "riasec-majeur", + "in": "query", + "description": "Riasec majeur.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "riasec-mineur", + "in": "query", + "description": "Riasec mineur.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "code-naf", + "in": "query", + "description": "Code de la division NAF.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "code-competence", + "in": "query", + "description": "Code compĂ©tence.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "formacodes(libelle,code),libelle,code", + "enum": [ + "accesemploi", + "appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent,libellecourt)", + "code", + "codeisco", + "definition", + "domaineprofessionnel(libelle,code,granddomaine(libelle,code))", + "emploicadre", + "emploireglemente", + "formacodes(libelle,code)", + "label", + "libelle", + "riasecmajeur", + "riasecmineur", + "transitiondemographique", + "transitionecologique", + "transitionecologiquedetaillee", + "transitionnumerique" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des mĂ©tiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "emploiReglemente": false, + "formacodes": [ + { + "libelle": "culture algue", + "code": "21317" + } + ], + "libelle": "BĂ»cheronnage et Ă©lagage", + "domaineProfessionnel": { + "libelle": "Production", + "code": "A14", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + } + }, + "code": "A1201", + "emploiCadre": false, + "definition": "RĂ©alise des opĂ©rations de coupe et d'entretien d'arbres", + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374", + "libelleCourt": "Chef de station fruitiĂšre" + } + ], + "accesEmploi": "Ce mĂ©tier est accessible avec un CAP/BEP Agricole en travaux forestiers et bĂ»cheronnage." + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "formacodes": [ + { + "libelle": "culture algue", + "code": "21317" + } + ], + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/metier/requete": { + "get": { + "tags": [ + "MĂ©tier" + ], + "summary": "Rechercher un mĂ©tier", + "description": "Permet de rechercher des mĂ©tiers.\r\n\r\n\nCe service a pour vocation d'ĂȘtre utilisĂ© dans le cas d'une autocomplĂ©tion.\r\n\r\n\nDe ce fait, on peut avoir une diffĂ©rence entre le nombre de rĂ©sultats affichĂ©s (dans le tableau ***resultats***) et le nombre total de rĂ©sultats disponibles (indiquĂ© dans ***totalResultats***).\r\n\r\n\nAttention, le sĂ©lecteur de champs s'applique uniquement Ă  l'attribut ***resultats*** de la rĂ©ponse.\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 pour voir les donnĂ©es retournĂ©es)", + "operationId": "recherchermetier", + "parameters": [ + { + "name": "q", + "in": "query", + "description": "Le(s) mot(s) et/ou dĂ©but de mot(s) recherchĂ©(s).", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "qf", + "in": "query", + "description": "Les indexe(s) de recherche (query fields). Si non prĂ©cisĂ©, on cherche sur le code et libellĂ©.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fq", + "in": "query", + "description": "Les filtre(s) de recherche (filters query). Ex : fq=code:1 AND (code:2 OR libelle:app). Si non prĂ©cisĂ©, aucun filtre n'est appliquĂ©.", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "op", + "in": "query", + "description": "Lorsque plusieurs mots sont prĂ©sents dans la recherche (q=mot1 mot2), indique si au moins 1 mot doit correspondre 'OR' ou s'ils doivent tous correspondre 'AND'. Si non prĂ©cisĂ©, 'OR' est utilisĂ©", + "required": false, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider de l'exemple de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "riasecmineur,riasecmajeur,libelle,code", + "enum": [ + "code", + "libelle", + "riasecmineur", + "riasecmajeur" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Le rĂ©sultat de la recherche de mĂ©tiers pour une autocomplĂ©tion.", + "content": { + "application/json": { + "examples": { + "Retour du service": { + "value": { + "totalResultats": 123, + "requete": "string", + "resultats": [ + { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + ] + } + } + } + } + } + }, + "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-metiers" + } + ] + } + }, + "/v1/metiers/metier/{code}": { + "get": { + "tags": [ + "MĂ©tier" + ], + "summary": "Lire un mĂ©tier", + "description": "Permet de lire un 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": "lireMetier", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du mĂ©tier.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "emploireglemente,formacodes(libelle,code),libelle,domaineprofessionnel(libelle,granddomaine(libelle,code),code),obsolete,code,definition,secteursactiviteslies(secteuractivite(libelle,code,secteuractivite(libelle,code)),principal),divisionsnaf(libelle,code),riasecmajeur,transitionecologiquedetaillee,themes(libelle,code),transitionecologique,datefin,competencesmobiliseesprincipales(libelle,@macrosavoiretreprofessionnel(riasecmajeur,riasecmineur),@competencedetaillee(riasecmajeur,riasecmineur),code,@macrosavoirfaire(riasecmajeur,riasecmineur),codeogr),emploicadre,riasecmineur,transitionnumerique,contextestravail(libelle,code,categorie),codeisco,centresinterets(libelle,code),competencesmobilisees(libelle,@macrosavoiretreprofessionnel(riasecmajeur,riasecmineur),@competencedetaillee(riasecmajeur,riasecmineur),code,@macrosavoirfaire(riasecmajeur,riasecmineur),codeogr),transitiondemographique,secteursactivites(libelle,code,secteuractivite(libelle,code)),appellations(emploireglemente,transitionecologiquedetaillee,libelle,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,libellecourt,competencescles(frequence,competence(libelle,codeogr,code))),competencesmobiliseesemergentes(libelle,@macrosavoiretreprofessionnel(riasecmajeur,riasecmineur),@competencedetaillee(riasecmajeur,riasecmineur),code,@macrosavoirfaire(riasecmajeur,riasecmineur),codeogr),centresinteretslies(centreinteret(libelle,code),principal),accesemploi", + "enum": [ + "accesemploi", + "appellations(emploireglemente,libelle,secondaire,code,emploicadre,transitionnumerique,classification,competencescles(frequence,competence(libelle,code,codeogr)),transitionecologiquedetaillee,appellationsenvisageables(libelle,code,metier(libelle,code,riasecmineur,riasecmajeur)),metiersproches(libelle,code,riasecmineur,riasecmajeur),metiersenvisageables(libelle,code,riasecmineur,riasecmajeur),appellationsproches(libelle,code,metier(libelle,code,riasecmineur,riasecmajeur)),transitionecologique,transitiondemographique,romeparent,libellecourt)", + "appellationsenvisageables(libelle,code,metier(libelle,code,riasecmineur,riasecmajeur))", + "appellationsproches(libelle,code,metier(libelle,code,riasecmineur,riasecmajeur))", + "centresinterets(libelle,code,definition)", + "centresinteretslies(centreinteret(libelle,code,definition),principal)", + "code", + "codeisco", + "competencesmobilisees(libelle,@macrosavoiretreprofessionnel(riasecmineur,riasecmajeur),@competencedetaillee(riasecmineur,riasecmajeur),code,@macrosavoirfaire(riasecmineur,riasecmajeur),codeogr)", + "competencesmobiliseesemergentes(libelle,@macrosavoiretreprofessionnel(riasecmineur,riasecmajeur),@competencedetaillee(riasecmineur,riasecmajeur),code,@macrosavoirfaire(riasecmineur,riasecmajeur),codeogr)", + "competencesmobiliseesprincipales(libelle,@macrosavoiretreprofessionnel(riasecmineur,riasecmajeur),@competencedetaillee(riasecmineur,riasecmajeur),code,@macrosavoirfaire(riasecmineur,riasecmajeur),codeogr)", + "contextestravail(libelle,code,categorie)", + "datefin", + "definition", + "divisionsnaf(libelle,code)", + "domaineprofessionnel(libelle,code,granddomaine(libelle,code))", + "emploicadre", + "emploireglemente", + "formacodes(libelle,code)", + "label", + "libelle", + "metiersenproximite(libelle,code,riasecmineur,riasecmajeur)", + "metiersenvisageables(libelle,code,riasecmineur,riasecmajeur)", + "metiersproches(libelle,code,riasecmineur,riasecmajeur)", + "obsolete", + "riasecmajeur", + "riasecmineur", + "secteursactivites(libelle,code,secteuractivite(libelle,code,definition),definition)", + "secteursactiviteslies(secteuractivite(libelle,code,secteuractivite(libelle,code,definition),definition),principal)", + "themes(libelle,code)", + "transitiondemographique", + "transitionecologique", + "transitionecologiquedetaillee", + "transitionnumerique" + ] + } + }, + { + "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": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es d'un mĂ©tier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Metier" + }, + "examples": { + "Retour complet": { + "value": { + "emploiReglemente": false, + "formacodes": [ + { + "libelle": "culture algue", + "code": "21317" + } + ], + "libelle": "BĂ»cheronnage et Ă©lagage", + "domaineProfessionnel": { + "libelle": "Production", + "code": "A14", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + } + }, + "obsolete": false, + "code": "A1201", + "definition": "RĂ©alise des opĂ©rations de coupe et d'entretien d'arbres", + "secteursActivitesLies": [ + { + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "definition": "string" + }, + "definition": "string" + }, + "principal": false + } + ], + "divisionsNaf": [ + { + "libelle": "MĂ©tallurgie", + "code": "24" + } + ], + "riasecMajeur": "R", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "themes": [ + { + "libelle": "MĂ©tiers auprĂšs des enfants", + "code": "12" + } + ], + "appellationsEnvisageables": [ + { + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374", + "metier": { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + } + ], + "metiersEnvisageables": [ + { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + ], + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z", + "competencesMobiliseesPrincipales": [ + { + "type": "string", + "libelle": "Techniques de soudage", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100007", + "codeOgr": "string" + } + ], + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "contextesTravail": [ + { + "libelle": "En club sportif", + "code": "403091", + "categorie": "CONDITIONS_TRAVAIL" + } + ], + "label": "A1201", + "codeIsco": "6210", + "metiersProches": [ + { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + ], + "centresInterets": [ + { + "libelle": "Je suis amateur / amatrice de sensations fortes", + "code": "25", + "definition": "string" + } + ], + "competencesMobilisees": [ + { + "type": "string", + "libelle": "Techniques de soudage", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100007", + "codeOgr": "string" + } + ], + "appellationsProches": [ + { + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374", + "metier": { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + } + ], + "transitionDemographique": false, + "secteursActivites": [ + { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "definition": "string" + }, + "definition": "string" + } + ], + "metiersEnProximite": [ + { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + ], + "appellations": [ + { + "emploiReglemente": false, + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionNumerique": false, + "classification": "PRINCIPALE", + "competencesCles": [ + { + "frequence": 123, + "competence": { + "type": "string", + "libelle": "Techniques de soudage", + "code": "100007", + "codeOgr": "string" + } + } + ], + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "appellationsEnvisageables": [ + { + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374", + "metier": { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + } + ], + "metiersProches": [ + { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + ], + "metiersEnvisageables": [ + { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + ], + "appellationsProches": [ + { + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374", + "metier": { + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "riasecMineur": "R", + "riasecMajeur": "R" + } + } + ], + "transitionEcologique": false, + "transitionDemographique": false, + "romeParent": "12374", + "libelleCourt": "Chef de station fruitiĂšre" + } + ], + "competencesMobiliseesEmergentes": [ + { + "type": "string", + "libelle": "Techniques de soudage", + "riasecMineur": "R", + "riasecMajeur": "R", + "code": "100007", + "codeOgr": "string" + } + ], + "centresInteretsLies": [ + { + "centreInteret": { + "libelle": "Je suis amateur / amatrice de sensations fortes", + "code": "25", + "definition": "string" + }, + "principal": false + } + ], + "accesEmploi": "Ce mĂ©tier est accessible avec un CAP/BEP Agricole en travaux forestiers et bĂ»cheronnage." + } + }, + "Retour par dĂ©faut": { + "value": { + "emploiReglemente": false, + "formacodes": [ + { + "libelle": "culture algue", + "code": "21317" + } + ], + "libelle": "BĂ»cheronnage et Ă©lagage", + "domaineProfessionnel": { + "libelle": "Production", + "grandDomaine": { + "libelle": "Industrie", + "code": "H" + }, + "code": "A14" + }, + "obsolete": false, + "code": "A1201", + "definition": "RĂ©alise des opĂ©rations de coupe et d'entretien d'arbres", + "secteursActivitesLies": [ + { + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79" + } + }, + "principal": false + } + ], + "divisionsNaf": [ + { + "libelle": "MĂ©tallurgie", + "code": "24" + } + ], + "riasecMajeur": "R", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "themes": [ + { + "libelle": "MĂ©tiers auprĂšs des enfants", + "code": "12" + } + ], + "transitionEcologique": false, + "dateFin": "2024-02-23T14:40:14.848Z", + "competencesMobiliseesPrincipales": [ + { + "type": "string", + "libelle": "Techniques de soudage", + "riasecMajeur": "R", + "riasecMineur": "R", + "code": "100007", + "codeOgr": "string" + } + ], + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "contextesTravail": [ + { + "libelle": "En club sportif", + "code": "403091", + "categorie": "CONDITIONS_TRAVAIL" + } + ], + "codeIsco": "6210", + "centresInterets": [ + { + "libelle": "Je suis amateur / amatrice de sensations fortes", + "code": "25" + } + ], + "competencesMobilisees": [ + { + "type": "string", + "libelle": "Techniques de soudage", + "riasecMajeur": "R", + "riasecMineur": "R", + "code": "100007", + "codeOgr": "string" + } + ], + "transitionDemographique": false, + "secteursActivites": [ + { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79" + } + } + ], + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "libelleCourt": "Chef de station fruitiĂšre", + "competencesCles": [ + { + "frequence": 123, + "competence": { + "type": "string", + "libelle": "Techniques de soudage", + "codeOgr": "string", + "code": "100007" + } + } + ] + } + ], + "competencesMobiliseesEmergentes": [ + { + "type": "string", + "libelle": "Techniques de soudage", + "riasecMajeur": "R", + "riasecMineur": "R", + "code": "100007", + "codeOgr": "string" + } + ], + "centresInteretsLies": [ + { + "centreInteret": { + "libelle": "Je suis amateur / amatrice de sensations fortes", + "code": "25" + }, + "principal": false + } + ], + "accesEmploi": "Ce mĂ©tier est accessible avec un CAP/BEP Agricole en travaux forestiers et bĂ»cheronnage." + } + } + } + } + } + }, + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/secteur-activite": { + "get": { + "tags": [ + "Secteur d'activitĂ©s" + ], + "summary": "Lister les secteurs d'activitĂ©s", + "description": "Permet de lister les secteurs d'activitĂ©s des mĂ©tiers.\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": "listerSecteurActivites", + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,code", + "enum": [ + "code", + "definition", + "libelle", + "metiers(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeParent))", + "metierslies(principal,metier(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent)))", + "secteuractivite(libelle,code,definition)", + "soussecteurs(libelle,code,definition)" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des secteurs d'activitĂ©s.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SecteurActivite" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "definition": "string" + }, + "definition": "string", + "metiersLies": [ + { + "principal": false, + "metier": { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + } + ], + "sousSecteurs": [ + { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "definition": "string" + } + ], + "metiers": [ + { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + ] + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "Agriculture et Ă©levage", + "code": "79" + } + ] + } + } + } + } + }, + "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-metiers" + } + ] + } + }, + "/v1/metiers/secteur-activite/{code}": { + "get": { + "tags": [ + "Secteur d'activitĂ©s" + ], + "summary": "Lire un secteur d'activitĂ©s", + "description": "Permet de lire un secteur d'activitĂ©s 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": "lireSecteurActivite", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du secteur d'activitĂ©s.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,obsolete,code,secteuractivite(libelle,code,definition),definition,datefin", + "enum": [ + "code", + "datefin", + "definition", + "libelle", + "metiers(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent))", + "metierslies(principal,metier(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent)))", + "obsolete", + "secteuractivite(libelle,code,definition)", + "soussecteurs(libelle,code,definition)" + ] + } + }, + { + "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": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es d'un secteur d'activitĂ©s.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecteurActivite" + }, + "examples": { + "Retour complet": { + "value": { + "libelle": "Agriculture et Ă©levage", + "obsolete": false, + "code": "79", + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "definition": "string" + }, + "definition": "string", + "metiersLies": [ + { + "principal": false, + "metier": { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + } + ], + "sousSecteurs": [ + { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "definition": "string" + } + ], + "metiers": [ + { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + ], + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "Agriculture et Ă©levage", + "obsolete": false, + "code": "79", + "secteurActivite": { + "libelle": "Agriculture et Ă©levage", + "code": "79", + "definition": "string" + }, + "definition": "string", + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/theme": { + "get": { + "tags": [ + "ThĂšme" + ], + "summary": "Lister les thĂšmes", + "description": "Permet de lister les thĂšmes des mĂ©tiers.\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": "listerThemes", + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,code", + "enum": [ + "code", + "definition", + "libelle", + "metiers(label,transitionecologiquedetaillee,libelle,codeisco,code,riasecmineur,transitionecologique,transitionnumerique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent),riasecmajeur)" + ] + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des thĂšmes.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + }, + "examples": { + "Retour complet": { + "value": [ + { + "libelle": "MĂ©tiers auprĂšs des enfants", + "code": "12", + "definition": "MĂ©tiers liĂ©s Ă  l'Ă©ducation, l'enseignement, l'animation, aux loisirs et aux soins des enfants ", + "metiers": [ + { + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "BĂ»cheronnage et Ă©lagage", + "codeIsco": "6210", + "code": "A1201", + "riasecMineur": "R", + "transitionEcologique": false, + "transitionNumerique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ], + "riasecMajeur": "R" + } + ] + } + ] + }, + "Retour par dĂ©faut": { + "value": [ + { + "libelle": "MĂ©tiers auprĂšs des enfants", + "code": "12" + } + ] + } + } + } + } + }, + "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-metiers" + } + ] + } + }, + "/v1/metiers/theme/{code}": { + "get": { + "tags": [ + "ThĂšme" + ], + "summary": "Lire un thĂšme", + "description": "Permet de lire un thĂšme 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": "lireTheme", + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Code du thĂšme.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`).
Vous pouvez vous aider des exemples de rĂ©ponse pour identifier les champs que vous voulez rĂ©cupĂ©rer.", + "required": false, + "schema": { + "type": "string", + "example": "libelle,obsolete,code,definition,datefin", + "enum": [ + "code", + "datefin", + "definition", + "libelle", + "metiers(emploireglemente,libelle,code,emploicadre,riasecmineur,transitionnumerique,riasecmajeur,label,transitionecologiquedetaillee,codeisco,transitionecologique,transitiondemographique,appellations(emploireglemente,transitionecologiquedetaillee,libelle,secondaire,code,emploicadre,transitionecologique,transitionnumerique,transitiondemographique,classification,romeparent))", + "obsolete" + ] + } + }, + { + "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": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "responses": { + "200": { + "description": "Retourne les donnĂ©es d'un thĂšme.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Theme" + }, + "examples": { + "Retour complet": { + "value": { + "libelle": "MĂ©tiers auprĂšs des enfants", + "obsolete": false, + "code": "12", + "definition": "MĂ©tiers liĂ©s Ă  l'Ă©ducation, l'enseignement, l'animation, aux loisirs et aux soins des enfants ", + "metiers": [ + { + "emploiReglemente": false, + "libelle": "BĂ»cheronnage et Ă©lagage", + "code": "A1201", + "emploiCadre": false, + "riasecMineur": "R", + "transitionNumerique": false, + "riasecMajeur": "R", + "label": "A1201", + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "codeIsco": "6210", + "transitionEcologique": false, + "transitionDemographique": false, + "appellations": [ + { + "emploiReglemente": false, + "transitionEcologiqueDetaillee": "EMPLOI_STRATEGIQUE", + "libelle": "Chef / Cheffe de station fruitiĂšre", + "secondaire": false, + "code": "12374", + "emploiCadre": false, + "transitionEcologique": false, + "transitionNumerique": false, + "transitionDemographique": false, + "classification": "PRINCIPALE", + "romeParent": "12374" + } + ] + } + ], + "dateFin": "2024-02-23T14:40:14.848Z" + } + }, + "Retour par dĂ©faut": { + "value": { + "libelle": "MĂ©tiers auprĂšs des enfants", + "obsolete": false, + "code": "12", + "definition": "MĂ©tiers liĂ©s Ă  l'Ă©ducation, l'enseignement, l'animation, aux loisirs et aux soins des enfants ", + "dateFin": "2024-02-23T14:40:14.848Z" + } + } + } + } + } + }, + "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 + } + } + } + } + } + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/rome-metiers" + } + ] + } + }, + "/v1/metiers/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`).
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 keFpprOPzla4TR2mDnBgJU_RG6A" + } + } + ], + "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-metiers", + "description": "PROD" + } + ] + } + } + }, + "components": { + "schemas": { + "Appellation": { + "type": "object", + "properties": { + "appellationEsco": { + "$ref": "#/components/schemas/AppellationEsco" + }, + "appellationsEnvisageables": { + "type": "array", + "description": "Liste des appellations envisageable. Cette mobilitĂ© est obsolĂšte mais conservĂ©e pour compatibilitĂ© ascendante.", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Appellation" + } + }, + "appellationsProches": { + "type": "array", + "description": "Liste des appellations proches. Cette mobilitĂ© est obsolĂšte mais conservĂ©e pour compatibilitĂ© ascendante.", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Appellation" + } + }, + "classification": { + "type": "string", + "description": "Classification.", + "enum": [ + "PRINCIPALE", + "SYNONYME" + ] + }, + "code": { + "type": "string", + "description": "Code unique de l'appellation.", + "example": "12374" + }, + "competencesCles": { + "type": "array", + "description": "Liste des CompĂ©tences clĂ©s rattachĂ©es.", + "items": { + "$ref": "#/components/schemas/CompetenceCle" + } + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "emploiCadre": { + "type": "boolean", + "description": "Emploi cadre: oui/non. Ce champ est optionnel." + }, + "emploiReglemente": { + "type": "boolean", + "description": "Emploi rĂšglementĂ©: oui/non. Ce champ est optionnel." + }, + "libelle": { + "type": "string", + "description": "LibellĂ© de l'appellation.", + "example": "Chef / Cheffe de station fruitiĂšre" + }, + "libelleCourt": { + "type": "string", + "description": "LibellĂ© court de l'appellation. Ce champ est optionnel.", + "example": "Chef de station fruitiĂšre" + }, + "metier": { + "$ref": "#/components/schemas/Metier" + }, + "metiersEnvisageables": { + "type": "array", + "description": "Liste des mĂ©tiers envisageables. Cette mobilitĂ© est obsolĂšte mais conservĂ©e pour compatibilitĂ© ascendante.", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "metiersProches": { + "type": "array", + "description": "Liste des mĂ©tiers proches. Cette mobilitĂ© est obsolĂšte mais conservĂ©e pour compatibilitĂ© ascendante.", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + }, + "romeParent": { + "type": "string", + "description": "Code rome du mĂ©tier parent.", + "example": "12374" + }, + "secondaire": { + "type": "boolean", + "description": "Appellation secondaire: oui/non. Ce champ est optionnel." + }, + "transitionDemographique": { + "type": "boolean", + "description": "Transition dĂ©mographique: oui/non. Ce champ est optionnel." + }, + "transitionEcologique": { + "type": "boolean", + "description": "Transition Ă©cologique: oui/non. Ce champ est optionnel." + }, + "transitionEcologiqueDetaillee": { + "type": "string", + "description": "Transition Ă©cologique dĂ©taillĂ©e. Ce champ est optionnel.", + "enum": [ + "EMPLOI_STRATEGIQUE", + "EMPLOI_VERT", + "EMPLOI_BLANC", + "EMPLOI_BRUN" + ] + }, + "transitionNumerique": { + "type": "boolean", + "description": "Transition numĂ©rique: oui/non. Ce champ est optionnel." + } + }, + "description": "Appellation" + }, + "AppellationEsco": { + "type": "object", + "properties": { + "libelle": { + "type": "string", + "description": "LibellĂ© de l'appellation ESCO." + }, + "uri": { + "type": "string", + "description": "Uri unique de l'appellation ESCO." + } + }, + "description": "Appellation ESCO (en provenance du rĂ©fĂ©rentiel 'ESCO')" + }, + "CentreInteret": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code unique du centre d'intĂ©rĂȘt.", + "example": "25" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "definition": { + "type": "string", + "description": "DĂ©finition du centre d'intĂ©rĂȘt. Ce champs est optionnel." + }, + "libelle": { + "type": "string", + "description": "LibellĂ© du centre d'intĂ©rĂȘts.", + "example": "Je suis amateur / amatrice de sensations fortes" + }, + "metiers": { + "type": "array", + "description": "Liste des mĂ©tiers liĂ©s. Cet attribut est dĂ©prĂ©ciĂ©, utiliser l'attribut metiersLies", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "metiersLies": { + "type": "array", + "description": "Liste des mĂ©tiers liĂ©s.", + "items": { + "$ref": "#/components/schemas/LiaisonEntreMetierEtCentreInteret" + } + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + } + }, + "description": "Centre d'intĂ©rĂȘts" + }, + "Competence": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code unique de la compĂ©tence.", + "example": "100007" + }, + "codeOgr": { + "type": "string", + "description": "Code OGR. Cet attribut est dĂ©prĂ©ciĂ© et n'est plus prĂ©sent que pour des raisons de rĂ©tro-compatibilitĂ©s", + "deprecated": true + }, + "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\n" + } + }, + "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.", + "discriminator": { + "propertyName": "type" + } + }, + "CompetenceCle": { + "type": "object", + "properties": { + "competence": { + "oneOf": [ + { + "$ref": "#/components/schemas/CompetenceDetaillee" + }, + { + "$ref": "#/components/schemas/MacroSavoirEtreProfessionnel" + }, + { + "$ref": "#/components/schemas/MacroSavoirFaire" + }, + { + "$ref": "#/components/schemas/Savoir" + } + ] + }, + "frequence": { + "type": "integer", + "description": "FrĂ©quence (entre 0 inclus et 100 inclus).", + "format": "int32" + } + }, + "description": "CompĂ©tence clĂ©" + }, + "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": { + "riasecMajeur": { + "type": "string", + "description": "Riasec Majeur. Ce champ est optionnel.", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ] + }, + "riasecMineur": { + "type": "string", + "description": "Riasec Mineur. Ce champ est optionnel.", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ] + }, + "type": { + "type": "string", + "description": "Cette propriĂ©tĂ© est forcĂ©ment Ă  la valeur 'COMPETENCE-DETAILLEE'." + } + } + } + ] + }, + "ContexteTravail": { + "type": "object", + "properties": { + "categorie": { + "type": "string", + "description": "CatĂ©gorie de contexte de travail.", + "enum": [ + "CONDITIONS_TRAVAIL", + "TYPE_BENEFICIAIRE", + "LIEU_ET_DEPLACEMENT", + "HORAIRE_ET_DUREE_TRAVAIL", + "TYPE_STRUCTURE_ACCUEIL", + "STATUT_EMPLOI" + ] + }, + "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" + } + }, + "description": "Contexte de travail (en provenance du rĂ©fĂ©rentiel 'Situations de travail')" + }, + "DivisionNaf": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code unique de la division NAF.", + "example": "24" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© de la division NAF.", + "example": "MĂ©tallurgie" + } + }, + "description": "Division NAF (en provenance du rĂ©fĂ©rentiel 'NAF')" + }, + "DomaineProfessionnel": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code unique du domaine professionnel.", + "example": "A14" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "grandDomaine": { + "$ref": "#/components/schemas/GrandDomaine" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© du domaine professionnel.", + "example": "Production" + }, + "metiers": { + "type": "array", + "description": "Liste des mĂ©tiers rattachĂ©s.", + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + } + }, + "description": "Domaine professionnel" + }, + "Formacode": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code unique du formacode V13.", + "example": "21317" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© du formacode.", + "example": "culture algue" + } + }, + "description": "Formacode (en provenance du rĂ©fĂ©rentiel 'FORMACODES V13')" + }, + "GrandDomaine": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code unique du grand domaine.", + "example": "H" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "domaineProfessionnels": { + "type": "array", + "description": "Liste des domaines professionnels rattachĂ©s.", + "items": { + "$ref": "#/components/schemas/DomaineProfessionnel" + } + }, + "libelle": { + "type": "string", + "description": "LibellĂ© du grand domaine.", + "example": "Industrie" + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + } + }, + "description": "Grand Domaine" + }, + "LiaisonEntreMetierEtCentreInteret": { + "type": "object", + "properties": { + "centreInteret": { + "$ref": "#/components/schemas/CentreInteret" + }, + "metier": { + "$ref": "#/components/schemas/Metier" + }, + "principal": { + "type": "boolean", + "description": "Principal: oui/non." + } + }, + "description": "Liaison entre un mĂ©tier et un centre d'intĂ©rĂȘt" + }, + "LiaisonEntreMetierEtSecteurActivite": { + "type": "object", + "properties": { + "metier": { + "$ref": "#/components/schemas/Metier" + }, + "principal": { + "type": "boolean", + "description": "Principal: oui/non." + }, + "secteurActivite": { + "$ref": "#/components/schemas/SecteurActivite" + } + }, + "description": "Liaison entre un mĂ©tier et un secteur d'activitĂ©" + }, + "MacroSavoirEtreProfessionnel": { + "type": "object", + "description": "Macro savoir-ĂȘtre professionnel (en provenance du rĂ©fĂ©rentiel 'CompĂ©tences').", + "allOf": [ + { + "$ref": "#/components/schemas/Competence" + }, + { + "type": "object", + "properties": { + "riasecMajeur": { + "type": "string", + "description": "Riasec Majeur. Ce champ est optionnel.", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ] + }, + "riasecMineur": { + "type": "string", + "description": "Riasec Mineur. Ce champ est optionnel.", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ] + }, + "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": { + "riasecMajeur": { + "type": "string", + "description": "Riasec Majeur. Ce champ est optionnel.", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ] + }, + "riasecMineur": { + "type": "string", + "description": "Riasec Mineur. Ce champ est optionnel.", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ] + }, + "type": { + "type": "string", + "description": "Cette propriĂ©tĂ© est forcĂ©ment Ă  la valeur 'MACRO-SAVOIR-FAIRE'." + } + } + } + ] + }, + "Metier": { + "type": "object", + "properties": { + "accesEmploi": { + "type": "string", + "description": "Acces emploi.", + "example": "Ce mĂ©tier est accessible avec un CAP/BEP Agricole en travaux forestiers et bĂ»cheronnage." + }, + "appellations": { + "type": "array", + "description": "Liste des appellations rattachĂ©es.", + "items": { + "$ref": "#/components/schemas/Appellation" + } + }, + "appellationsEnvisageables": { + "type": "array", + "description": "Liste des appellations envisageable. Cette mobilitĂ© est obsolĂšte mais conservĂ©e pour compatibilitĂ© ascendante.", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Appellation" + } + }, + "appellationsProches": { + "type": "array", + "description": "Liste des appellations proches. Cette mobilitĂ© est obsolĂšte mais conservĂ©e pour compatibilitĂ© ascendante.", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Appellation" + } + }, + "centresInterets": { + "type": "array", + "description": "Liste des centres d'intĂ©rĂȘts liĂ©s. Cet attribut est dĂ©prĂ©ciĂ©, utiliser l'attribut centresInteretsLies", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/CentreInteret" + } + }, + "centresInteretsLies": { + "type": "array", + "description": "Liste des centres d'intĂ©rĂȘts liĂ©s.", + "items": { + "$ref": "#/components/schemas/LiaisonEntreMetierEtCentreInteret" + } + }, + "code": { + "type": "string", + "description": "Code unique du mĂ©tier.", + "example": "A1201" + }, + "codeIsco": { + "type": "string", + "description": "Code ISCO (International Standard Classification of Occupations ou CITP en français). Ce champ est optionnel.", + "example": "6210" + }, + "competencesMobilisees": { + "type": "array", + "description": "Liste des compĂ©tences mobilisĂ©es ni principales ni emergentes.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CompetenceDetaillee" + }, + { + "$ref": "#/components/schemas/MacroSavoirEtreProfessionnel" + }, + { + "$ref": "#/components/schemas/MacroSavoirFaire" + }, + { + "$ref": "#/components/schemas/Savoir" + } + ] + } + }, + "competencesMobiliseesEmergentes": { + "type": "array", + "description": "Liste des compĂ©tences mobilisĂ©es.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CompetenceDetaillee" + }, + { + "$ref": "#/components/schemas/MacroSavoirEtreProfessionnel" + }, + { + "$ref": "#/components/schemas/MacroSavoirFaire" + }, + { + "$ref": "#/components/schemas/Savoir" + } + ] + } + }, + "competencesMobiliseesPrincipales": { + "type": "array", + "description": "Liste des compĂ©tences mobilisĂ©es.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CompetenceDetaillee" + }, + { + "$ref": "#/components/schemas/MacroSavoirEtreProfessionnel" + }, + { + "$ref": "#/components/schemas/MacroSavoirFaire" + }, + { + "$ref": "#/components/schemas/Savoir" + } + ] + } + }, + "contextesTravail": { + "type": "array", + "description": "Liste des contextes de travail liĂ©s.", + "items": { + "$ref": "#/components/schemas/ContexteTravail" + } + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "definition": { + "type": "string", + "description": "DĂ©finition.", + "example": "RĂ©alise des opĂ©rations de coupe et d'entretien d'arbres" + }, + "divisionsNaf": { + "type": "array", + "description": "Liste des divisions NAF liĂ©es.", + "items": { + "$ref": "#/components/schemas/DivisionNaf" + } + }, + "domaineProfessionnel": { + "$ref": "#/components/schemas/DomaineProfessionnel" + }, + "emploiCadre": { + "type": "boolean", + "description": "Emploi cadre: oui/non. Ce champ est optionnel." + }, + "emploiReglemente": { + "type": "boolean", + "description": "Emploi rĂ©glementĂ©: oui/non. Ce champ est optionnel." + }, + "formacodes": { + "type": "array", + "description": "Liste des formacodes liĂ©s.", + "items": { + "$ref": "#/components/schemas/Formacode" + } + }, + "label": { + "type": "string", + "description": "Label (code mĂ©tier d'origine). Cette valeur est utilisĂ©e dans le cas oĂč un mĂ©tier a Ă©tĂ© divisĂ© en plusieurs mĂ©tiers. Ce champ est optionnel.", + "example": "A1201" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© du mĂ©tier.", + "example": "BĂ»cheronnage et Ă©lagage" + }, + "metiersEnProximite": { + "type": "array", + "description": "Liste des mĂ©tiers en proximitĂ©.", + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "metiersEnvisageables": { + "type": "array", + "description": "Liste des mĂ©tiers envisageables. Cette mobilitĂ© est obsolĂšte mais conservĂ©e pour compatibilitĂ© ascendante.", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "metiersProches": { + "type": "array", + "description": "Liste des mĂ©tiers proches. Cette mobilitĂ© est obsolĂšte mais conservĂ©e pour compatibilitĂ© ascendante.", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + }, + "riasecMajeur": { + "type": "string", + "description": "Riasec Majeur. Ce champ est optionnel.", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ] + }, + "riasecMineur": { + "type": "string", + "description": "Riasec Mineur. Ce champ est optionnel.", + "enum": [ + "R", + "I", + "A", + "S", + "E", + "C" + ] + }, + "secteursActivites": { + "type": "array", + "description": "Liste des secteurs d'activites liĂ©s. Cet attribut est dĂ©prĂ©ciĂ©, utiliser l'attribut secteursActivitesLies", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/SecteurActivite" + } + }, + "secteursActivitesLies": { + "type": "array", + "description": "Liste des centres d'intĂ©rĂȘts liĂ©s.", + "items": { + "$ref": "#/components/schemas/LiaisonEntreMetierEtSecteurActivite" + } + }, + "themes": { + "type": "array", + "description": "Liste des thĂšmes liĂ©s.", + "items": { + "$ref": "#/components/schemas/Theme" + } + }, + "transitionDemographique": { + "type": "boolean", + "description": "Transition dĂ©mographique: oui/non. Ce champ est optionnel." + }, + "transitionEcologique": { + "type": "boolean", + "description": "Transition Ă©cologique: oui/non. Ce champ est optionnel." + }, + "transitionEcologiqueDetaillee": { + "type": "string", + "description": "Transition Ă©cologique dĂ©taillĂ©e. Ce champ est optionnel.", + "enum": [ + "EMPLOI_STRATEGIQUE", + "EMPLOI_VERT", + "EMPLOI_BLANC", + "EMPLOI_BRUN" + ] + }, + "transitionNumerique": { + "type": "boolean", + "description": "Transition numĂ©rique: oui/non. Ce champ est optionnel." + } + }, + "description": "MĂ©tier" + }, + "Savoir": { + "type": "object", + "description": "Savoir (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 'SAVOIR'." + } + } + } + ] + }, + "SecteurActivite": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code unique du secteur d'activitĂ©.", + "example": "79" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "definition": { + "type": "string", + "description": "DĂ©finition du secteur d'activitĂ©. Ce champ est optionnel." + }, + "libelle": { + "type": "string", + "description": "LibellĂ© du secteur d'activitĂ©.", + "example": "Agriculture et Ă©levage" + }, + "metiersLies": { + "type": "array", + "description": "Liste des mĂ©tiers liĂ©s.", + "items": { + "$ref": "#/components/schemas/LiaisonEntreMetierEtSecteurActivite" + } + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + }, + "secteurActivite": { + "$ref": "#/components/schemas/SecteurActivite" + }, + "sousSecteurs": { + "type": "array", + "description": "Sous-secteur d'activitĂ©s rattachĂ©s.", + "items": { + "$ref": "#/components/schemas/SecteurActivite" + } + } + }, + "description": "Secteur d'activitĂ©s. Il y a seulement deux niveaux de secteur d'activitĂ©s: l'un qui dispose de sous-secteurs d'activitĂ©s et l'autre qui dispose d'un secteur d'activitĂ© parent et de mĂ©tiers rattachĂ©s." + }, + "Theme": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code unique du thĂšme.", + "example": "12" + }, + "dateFin": { + "type": "string", + "description": "date de fin de validitĂ© (renseignĂ©e si l'entitĂ© est obsolete)", + "format": "date-time" + }, + "definition": { + "type": "string", + "description": "DĂ©finition du thĂšme. Ce champs est optionnel.", + "example": "MĂ©tiers liĂ©s Ă  l'Ă©ducation, l'enseignement, l'animation, aux loisirs et aux soins des enfants " + }, + "libelle": { + "type": "string", + "description": "LibellĂ© du thĂšme.", + "example": "MĂ©tiers auprĂšs des enfants" + }, + "metiers": { + "type": "array", + "description": "MĂ©tiers rattachĂ©s.", + "items": { + "$ref": "#/components/schemas/Metier" + } + }, + "obsolete": { + "type": "boolean", + "description": "boolean dĂ©finissant si l'entitĂ© est obsolete" + } + }, + "description": "ThĂšme" + }, + "VersionRome": { + "title": "VersionRome", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "La version actuelle." + }, + "lastModifiedDate": { + "type": "string", + "description": "La date de derniĂšre modification de la version.", + "format": "date-time" + } + }, + "description": "Version du rome" + } + } + } +} \ No newline at end of file diff --git a/docs/api/ROME V4.0 - Fiches ROME.json b/docs/api/ROME V4.0 - Fiches ROME.json new file mode 100644 index 0000000..e7dbe86 --- /dev/null +++ b/docs/api/ROME V4.0 - Fiches ROME.json @@ -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.
Cette API vous permet d'identifier, pour chaque fiche :
\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`).
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 e3jfZTLucZOACCBhtRVSsiYIjxs" + } + } + ], + "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`).
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 e3jfZTLucZOACCBhtRVSsiYIjxs" + } + } + ], + "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`).
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 e3jfZTLucZOACCBhtRVSsiYIjxs" + } + } + ], + "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\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" + } + } + } +} \ No newline at end of file diff --git a/docs/api/ROME V4.0 - Situations de travail.json b/docs/api/ROME V4.0 - Situations de travail.json new file mode 100644 index 0000000..7ba6a6e --- /dev/null +++ b/docs/api/ROME V4.0 - Situations de travail.json @@ -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.
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.
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`).
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 laUXEy7zv0tls9FTzpzDr7WsJxo" + } + } + ], + "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`).
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 laUXEy7zv0tls9FTzpzDr7WsJxo" + } + } + ], + "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`).
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 laUXEy7zv0tls9FTzpzDr7WsJxo" + } + } + ], + "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" + } + } + } +} \ No newline at end of file diff --git a/docs/api/Romeo.json b/docs/api/Romeo.json new file mode 100644 index 0000000..e9ddc80 --- /dev/null +++ b/docs/api/Romeo.json @@ -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 FFvSPYX5oebdxJgVYUzRU219eNE" + } + } + ] + } + }, + "/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 FFvSPYX5oebdxJgVYUzRU219eNE" + } + } + ] + } + }, + "/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 FFvSPYX5oebdxJgVYUzRU219eNE" + } + } + ] + } + }, + "/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 FFvSPYX5oebdxJgVYUzRU219eNE" + } + } + ] + } + } + }, + "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" + ] + } + } + } +} \ No newline at end of file diff --git a/docs/api/Sortants de formation et accĂšs Ă  l'emploi.json b/docs/api/Sortants de formation et accĂšs Ă  l'emploi.json new file mode 100644 index 0000000..fdf7da4 --- /dev/null +++ b/docs/api/Sortants de formation et accĂšs Ă  l'emploi.json @@ -0,0 +1,2781 @@ +{ + "openapi": "3.0.1", + "info": { + "version": "1", + "title": "Sortants de formation et accĂšs Ă  l'emploi", + "description": "AccĂ©dez aux statistiques de France Travail - Sortants de formation et accĂšs Ă  l'emploi. \n\nCette API vous met Ă  disposition des chiffres exacts sur les sorties de formation et l'accĂšs Ă  l'emploi des demandeurs d'emploi en catĂ©gories A et B.\n\n**Scopes :** `api_stats-entrees-sorties-formationsv1`,`accesemploiDEformes`\n\n**Royaume :** `/partenaire`\n" + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "paths": { + "/v1/indicateur/stat-acces-emploi-sorties-formation": { + "post": { + "tags": [ + "AccĂšs Ă  l'emploi" + ], + "summary": "Stats d'accĂšs Ă  l'emploi des demandeurs d'emploi sortants de formation (ACC_2)", + "description": "Permet de rechercher les donnĂ©es statistiques sur l’AccĂšs Ă  l’emploi Ă  6 mois des demandeurs d'emploi sortants de formation (ACC_2) selon des critĂšres obligatoires (territoire, activitĂ©) et facultatifs (dĂ©lai d’accĂšs Ă  l’emploi, durĂ©e d’emploi, pĂ©riodes, caractĂ©ristiques).", + "operationId": "rechercherStatAccesEmploiSortiesFormation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CritereIndicateurAvecNomenclature" + }, + "examples": { + "default": { + "value": { + "codeTypeTerritoire": "REG", + "codeTerritoire": "75", + "codeTypeActivite": "FORM14", + "codeActivite": "00101", + "codeTypePeriode": "TRIMESTRE", + "codeTypeNomenclature": "ACCESEMP" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Statistiques accĂšs Ă  l’emploi trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne du serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/indicateur/stat-demandeurs-sorties-formation": { + "post": { + "tags": [ + "Demandeurs" + ], + "summary": "Stats des demandeurs d'emploi sortants de formation (DE_3)", + "description": "Permet de rechercher les donnĂ©es statistiques sur les demandeurs d'emploi sortants de formation par type de formation et mĂ©tier recherchĂ© (DE_3), selon des critĂšres obligatoires (territoire, activitĂ©) et facultatifs (pĂ©riodes, caractĂ©ristiques).", + "operationId": "rechercherStatDemandeursSortiesFormation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CritereIndicateurSansNomenclature" + }, + "examples": { + "default": { + "value": { + "codeTypeTerritoire": "REG", + "codeTerritoire": "75", + "codeTypeActivite": "ROME", + "codeActivite": "A1203", + "codeTypePeriode": "TRIMESTRE" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Statistiques demandeurs d'emploi sorties formation trouvĂ©es", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicateurRetour" + } + } + } + }, + "400": { + "description": "Les paramĂštres en entrĂ©e ne sont pas valides" + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/activite": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Consulter une activitĂ©", + "description": "Permet de consulter une activitĂ© du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type activitĂ© et code activitĂ©).", + "operationId": "recupererActiviteParCodeActiviteEtCodeTypeActivite", + "parameters": [ + { + "name": "codeActivite", + "in": "query", + "description": "codeActivite", + "required": true, + "schema": { + "type": "string", + "example": "A1203" + }, + "examples": { + "default": { + "value": "A1203" + } + } + }, + { + "name": "codeTypeActivite", + "in": "query", + "description": "codeTypeActivite", + "required": true, + "schema": { + "type": "string", + "example": "ROME" + }, + "examples": { + "default": { + "value": "ROME" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne une activitĂ©", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Activite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Activite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/activites": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Lister les activitĂ©s", + "description": "Permet de lister les activitĂ©s du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeActivite", + "responses": { + "200": { + "description": "Retourne la liste d'activitĂ©s", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeActivite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeActivite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/activites/{codeTypeActivite}": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Lister les activitĂ©s pour un type d'activitĂ©", + "description": "Permet de lister les activitĂ©s du RĂ©fĂ©rentiel Smart Emploi pour un type d'activitĂ©.", + "operationId": "recupererListeActiviteParCodeTypeActivite", + "parameters": [ + { + "name": "filtreActivite", + "in": "query", + "description": "filtreActivite", + "schema": { + "type": "string", + "example": "A12" + }, + "examples": { + "default": { + "value": "A12" + } + } + }, + { + "name": "codeTypeActivite", + "in": "path", + "description": "codeTypeActivite", + "required": true, + "schema": { + "type": "string", + "example": "ROME" + }, + "examples": { + "default": { + "value": "ROME" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste d'activitĂ©s", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeActivite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeActivite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/type-activites": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Lister les types d'activitĂ©", + "description": "Permet de lister les types d'activitĂ© du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypeActivite", + "responses": { + "200": { + "description": "Retourne la liste des types d'activitĂ©s", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypeActivite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypeActivite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/type-activite/{codeTypeActivite}": { + "get": { + "tags": [ + "Activite" + ], + "summary": "Consulter un type d'activitĂ©", + "description": "Permet de consulter un type d'activitĂ© du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypeActiviteParCodeTypeActivite", + "parameters": [ + { + "name": "codeTypeActivite", + "in": "path", + "description": "codeTypeActivite", + "required": true, + "schema": { + "type": "string", + "example": "ROME" + }, + "examples": { + "default": { + "value": "ROME" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne le type d'activitĂ©", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypeActivite" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeActivite" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/caracteristique": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Consulter une caractĂ©ristique", + "description": "Permet de consulter une caractĂ©ristique du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type caractĂ©ristique et code caractĂ©ristique).", + "operationId": "recupererCaracteristiqueParCodeCaracteristiqueEtCodeTypeCaracteristique", + "parameters": [ + { + "name": "codeCaracteristique", + "in": "query", + "description": "codeCaracteristique", + "required": true, + "schema": { + "type": "string", + "example": "H" + }, + "examples": { + "default": { + "value": "H" + } + } + }, + { + "name": "codeTypeCaracteristique", + "in": "query", + "description": "codeTypeCaracteristique", + "required": true, + "schema": { + "type": "string", + "example": "GENRE" + }, + "examples": { + "default": { + "value": "GENRE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne la caractĂ©ristique", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Caracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Caracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/caracteristiques": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Lister les caractĂ©ristiques", + "description": "Permet de lister les caractĂ©ristiques du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeCaracteristique", + "responses": { + "200": { + "description": "Retourne la liste des caractĂ©ristiques", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeCaracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeCaracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/caracteristiques/{codeTypeCaracteristique}": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Lister les caractĂ©ristiques par type d'activitĂ©", + "description": "Permet de lister les caractĂ©ristiques du RĂ©fĂ©rentiel Smart Emploi pour un type de caractĂ©ristique.", + "operationId": "recupererListeCaracteristiqueParCodeTypeCaracteristique", + "parameters": [ + { + "name": "codeTypeCaracteristique", + "in": "path", + "description": "codeTypeCaracteristique", + "required": true, + "schema": { + "type": "string", + "example": "GENRE" + }, + "examples": { + "default": { + "value": "GENRE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des caractĂ©ristiques", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeCaracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeCaracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/type-caracteristiques": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Lister les types de caractĂ©ristique", + "description": "Permet de lister les types de caractĂ©ristique du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypeCaracteristique", + "responses": { + "200": { + "description": "Retourne la liste des types de caractĂ©ristiques", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypeCaracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypeCaracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/type-caracteristique/{codeTypeCaracteristique}": { + "get": { + "tags": [ + "Caracteristique" + ], + "summary": "Consulter un type de caractĂ©ristique", + "description": "Permet de consulter un type de caractĂ©ristique du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypeCaracteristiqueParCodeTypeCaracteristique", + "parameters": [ + { + "name": "codeTypeCaracteristique", + "in": "path", + "description": "codeTypeCaracteristique", + "required": true, + "schema": { + "type": "string", + "example": "GENRE" + }, + "examples": { + "default": { + "value": "GENRE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne un type de caractĂ©ristique", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypeCaracteristique" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeCaracteristique" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/details-indicateurs": { + "get": { + "tags": [ + "Catalogue Indicateur" + ], + "summary": "Consulter le dĂ©tail d'un indicateur.", + "description": "Permet de lister toutes les valeurs possibles des critĂšres d’entrĂ©e (Types de territoire, Types d'activitĂ©, Type de pĂ©riode, Nomenclatures, Croisements disponibles, CaractĂ©ristiques), et des Types de valeur obtenus, pour un indicateur donnĂ©. Un croisement disponible correspond Ă  une combinaison [Type de territoire, Type d'activitĂ©, Type de pĂ©riode et Nomenclature].", + "operationId": "recupererDetailsIndicateurs", + "parameters": [ + { + "name": "codeFamille", + "in": "query", + "description": "codeFamille", + "schema": { + "type": "string", + "example": "DEMANDEURS" + }, + "examples": { + "default": { + "value": "DEMANDEURS" + } + } + }, + { + "name": "codeIndicateur", + "in": "query", + "description": "codeIndicateur", + "schema": { + "type": "string", + "example": "DE_1" + }, + "examples": { + "default": { + "value": "DE_1" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "DĂ©tail d'un indicateur", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeDetailIndicateur" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeDetailIndicateur" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/nomenclatures": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Lister les nomenclatures", + "description": "Permet de lister les nomenclatures du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeNomenclature", + "responses": { + "200": { + "description": "Retourne la liste des nomenclatures", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeNomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeNomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/nomenclatures/{codeTypeNomenclature}": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Lister les nomenclatures par type de nomenclature", + "description": "Permet de lister les nomenclatures du RĂ©fĂ©rentiel Smart Emploi pour un type de nomenclature.", + "operationId": "recupererListeNomenclatureParCodeTypeNomenclature", + "parameters": [ + { + "name": "codeTypeNomenclature", + "in": "path", + "description": "codeTypeNomenclature", + "required": true, + "schema": { + "type": "string", + "example": "CATCAND" + }, + "examples": { + "default": { + "value": "CATCAND" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des nomenclatures", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeNomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeNomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/type-nomenclatures": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Lister les types nomenclatures", + "description": "Permet de lister les types de nomenclature du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypeNomenclature", + "responses": { + "200": { + "description": "Retourne la liste des types nomenclatures", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypeNomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypeNomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/nomenclature": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Consulter une nomenclature", + "description": "Permet de consulter une nomenclature du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type nomenclature et code nomenclature).", + "operationId": "recupererNomenclatureParCodeNomenclatureEtCodeTypeNomenclature", + "parameters": [ + { + "name": "codeNomenclature", + "in": "query", + "description": "codeNomenclature", + "required": true, + "schema": { + "type": "string", + "example": "A" + }, + "examples": { + "default": { + "value": "A" + } + } + }, + { + "name": "codeTypeNomenclature", + "in": "query", + "description": "codeTypeNomenclature", + "required": true, + "schema": { + "type": "string", + "example": "CATCAND" + }, + "examples": { + "default": { + "value": "CATCAND" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne la nomenclature", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Nomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Nomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/type-nomenclature/{codeTypeNomenclature}": { + "get": { + "tags": [ + "Nomenclature" + ], + "summary": "Consulter un type de nomenclature", + "description": "Permet de consulter un type de nomenclature du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypeNomenclatureParCodeTypeNomenclature", + "parameters": [ + { + "name": "codeTypeNomenclature", + "in": "path", + "description": "codeTypeNomenclature", + "required": true, + "schema": { + "type": "string", + "example": "CATCAND" + }, + "examples": { + "default": { + "value": "CATCAND" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne le type nomenclature", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypeNomenclature" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeNomenclature" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/periodes": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Lister les pĂ©riodes", + "description": "Permet de lister les pĂ©riodes du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListePeriode", + "responses": { + "200": { + "description": "Retourne la liste des pĂ©riodes", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListePeriode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListePeriode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/periodes/{codeTypePeriode}": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Lister les pĂ©riodes par type de pĂ©riode", + "description": "Permet de lister les pĂ©riodes du RĂ©fĂ©rentiel Smart Emploi pour un type de pĂ©riode.", + "operationId": "recupererListePeriodeParCodeTypePeriode", + "parameters": [ + { + "name": "codePeriode", + "in": "query", + "description": "codePeriode", + "schema": { + "type": "string", + "example": 2019 + }, + "examples": { + "default": { + "value": 2019 + } + } + }, + { + "name": "nbPeriode", + "in": "query", + "description": "nbPeriode", + "schema": { + "type": "integer", + "format": "int32", + "example": 5 + }, + "examples": { + "default": { + "value": 5 + } + } + }, + { + "name": "critereTemporel", + "in": "query", + "description": "critereTemporel", + "schema": { + "type": "string", + "example": "A" + }, + "examples": { + "default": { + "value": "A" + } + } + }, + { + "name": "codeTypePeriode", + "in": "path", + "description": "codeTypePeriode", + "required": true, + "schema": { + "type": "string", + "example": "ANNEE" + }, + "examples": { + "default": { + "value": "ANNEE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des pĂ©riodes", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListePeriode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListePeriode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/type-periodes": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Lister les types pĂ©riodes", + "description": "Permet de lister les types de pĂ©riode du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypePeriode", + "responses": { + "200": { + "description": "Retourne la liste des types de pĂ©riode", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypePeriode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypePeriode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/periode": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Consulter une pĂ©riode", + "description": "Permet de consulter une pĂ©riode du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type pĂ©riode et code pĂ©riode).", + "operationId": "recupererPeriodeParCodePeriodeEtCodeTypePeriode", + "parameters": [ + { + "name": "codePeriode", + "in": "query", + "description": "codePeriode", + "required": true, + "schema": { + "type": "string", + "example": 2019 + }, + "examples": { + "default": { + "value": 2019 + } + } + }, + { + "name": "codeTypePeriode", + "in": "query", + "description": "codeTypePeriode", + "required": true, + "schema": { + "type": "string", + "example": "ANNEE" + }, + "examples": { + "default": { + "value": "ANNEE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne la pĂ©riode", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Periode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Periode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/type-periode/{codeTypePeriode}": { + "get": { + "tags": [ + "Periode" + ], + "summary": "Consulter un type de pĂ©riode", + "description": "Permet de consulter un type de pĂ©riode du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypePeriodeParCodeTypePeriode", + "parameters": [ + { + "name": "codeTypePeriode", + "in": "path", + "description": "codeTypePeriode", + "required": true, + "schema": { + "type": "string", + "example": "ANNEE" + }, + "examples": { + "default": { + "value": "ANNEE" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne le type de pĂ©riode", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypePeriode" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypePeriode" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/territoires": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Lister les territoires", + "description": "Permet de lister les territoires du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTerritoire", + "responses": { + "200": { + "description": "Retourne la liste des territoires", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTerritoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTerritoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/territoires/{codeTypeTerritoire}": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Lister les territoires par type de territoire", + "description": "Permet de lister les territoires du RĂ©fĂ©rentiel Smart Emploi pour un type de territoire.", + "operationId": "recupererListeTerritoireParCodeTypeTerritoire", + "parameters": [ + { + "name": "filtreTerritoire", + "in": "query", + "description": "filtreTerritoire", + "schema": { + "type": "string", + "example": "G" + }, + "examples": { + "default": { + "value": "G" + } + } + }, + { + "name": "codeTypeTerritoire", + "in": "path", + "description": "codeTypeTerritoire", + "required": true, + "schema": { + "type": "string", + "example": "DEP" + }, + "examples": { + "default": { + "value": "DEP" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne la liste des territoires pour un type", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTerritoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTerritoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/type-territoires": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Lister les types de territoire", + "description": "Permet de lister les types de territoire du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererListeTypeTerritoire_1", + "responses": { + "200": { + "description": "Retourne la liste des types de territoire", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/ListeTypeTerritoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListeTypeTerritoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ] + } + }, + "/v1/referentiel/territoire": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Consulter un territoire", + "description": "Permet de consulter un territoire du RĂ©fĂ©rentiel Smart Emploi selon des critĂšres obligatoires (code type territoire et code territoire).", + "operationId": "recupererTerritoireParCodeTerritoireEtCodeTypeTerritoire", + "parameters": [ + { + "name": "codeTerritoire", + "in": "query", + "description": "codeTerritoire", + "required": true, + "schema": { + "type": "string", + "example": 33 + }, + "examples": { + "default": { + "value": 33 + } + } + }, + { + "name": "codeTypeTerritoire", + "in": "query", + "description": "codeTypeTerritoire", + "required": true, + "schema": { + "type": "string", + "example": "DEP" + }, + "examples": { + "default": { + "value": "DEP" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne le territoire", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Territoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + }, + "/v1/referentiel/type-territoire/{codeTypeTerritoire}": { + "get": { + "tags": [ + "Territoire" + ], + "summary": "Consulter un type de territoire", + "description": "Permet de consulter un type de territoire du RĂ©fĂ©rentiel Smart Emploi.", + "operationId": "recupererTypeTerritoireParCodeTypeTerritoire", + "parameters": [ + { + "name": "codeTypeTerritoire", + "in": "path", + "description": "codeTypeTerritoire", + "required": true, + "schema": { + "type": "string", + "example": "DEP" + }, + "examples": { + "default": { + "value": "DEP" + } + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer 8WcQT_1352lN0yG971lyrKCaeQs" + } + } + ], + "responses": { + "200": { + "description": "Retourne le type de territoire", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/TypeTerritoire" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TypeTerritoire" + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/stats-entrees-sorties-formations" + } + ] + } + } + }, + "components": { + "schemas": { + "CritereIndicateurAvecNomenclature": { + "type": "object", + "properties": { + "codeTypeTerritoire": { + "type": "string", + "description": "Le type de territoire (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "DEP" + }, + "codeTerritoire": { + "type": "string", + "description": "Le code du territoire (voir le rĂ©fĂ©rentiel Territoire pour les codes disponibles)", + "example": "33" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le type d'activitĂ© (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "ROME" + }, + "codeActivite": { + "type": "string", + "description": "Le code d'activitĂ© (voir le rĂ©fĂ©rentiel Activite pour les codes disponibles)", + "example": "K1303" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le type de pĂ©riode (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "TRIMESTRE" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le type de nomenclature (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "CATCAND" + }, + "dernierePeriode": { + "type": "boolean", + "description": "Optionnel: A renseigner Ă  true pour que la recherche se limite Ă  la pĂ©riode la plus rĂ©cente sur cet indicateur, sinon la recherche se limite Ă  la liste de pĂ©riodes fournie en entrĂ©e" + }, + "listeCodePeriode": { + "type": "array", + "description": "Optionnel: A renseigner avec les pĂ©riodes souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les pĂ©riodes disponibles sur cet indicateur", + "items": { + "type": "string", + "description": "Optionnel: A renseigner avec les pĂ©riodes souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les pĂ©riodes disponibles sur cet indicateur", + "example": "[\"2020T2\",\"2020T3\"]" + }, + "example": [ + "2020T2", + "2020T3" + ] + }, + "listeCodeNomenclature": { + "type": "array", + "description": "Optionnel: A renseigner avec les nomenclatures souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les nomenclatures disponibles sur cet indicateur", + "items": { + "type": "string", + "description": "Optionnel: A renseigner avec les nomenclatures souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les nomenclatures disponibles sur cet indicateur", + "example": "[\"A\",\"B\",\"C\"]" + }, + "example": [ + "A", + "B", + "C" + ] + }, + "sansCaracteristiques": { + "type": "boolean", + "description": "Optionnel: A renseigner Ă  true pour que la recherche se limite aux valeurs hors caractĂ©ristiques sur cet indicateur, sinon la recherche se limite aux valeurs de la liste de caractĂ©ristiques fournie en entrĂ©e" + }, + "listeCaracteristiques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Caracteristique" + } + } + }, + "required": [ + "codeTypeTerritoire", + "codeTerritoire", + "codeTypeActivite", + "codeActivite", + "codeTypePeriode", + "codeTypeNomenclature" + ] + }, + "Caracteristique": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la caractĂ©ristique", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeCaracteristique": { + "type": "string", + "description": "Le code du type de la caractĂ©ristique", + "example": "AGC_RAT" + }, + "codeCaracteristique": { + "type": "string", + "description": "Le code de la caractĂ©ristique", + "example": "AGC_BASS" + }, + "libelleCaracteristique": { + "type": "string", + "description": "Le libellĂ© de la caractĂ©ristique", + "example": "rattachement agence bassin" + }, + "masque": { + "type": "boolean", + "description": "La caractĂ©ristique est masquĂ© par l'administrateur", + "example": true + } + }, + "required": [ + "codeTypeCaracteristique", + "codeCaracteristique", + "libelleCaracteristique" + ], + "xml": { + "name": "CaracteristiqueReferentiel", + "namespace": "http://fr.pe.auto.service.da084.services.rest.model.referentiel" + } + }, + "IndicateurRetour": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeIndicateur": { + "type": "string", + "description": "Le code de l'indicateur", + "example": "DE_1" + }, + "codeFamille": { + "type": "string", + "description": "Le code famille de l'indicateur", + "example": "DEMANDEURS" + }, + "libIndicateur": { + "type": "string", + "description": "Le libellĂ© de l'indicateur", + "example": "Nombre et % de DE par catĂ©gories x caractĂ©ristiques, % par activitĂ©s (Rome, CompĂ©tence)" + }, + "libTerritoire": { + "type": "string", + "description": "Le libellĂ© du territoire", + "example": "NOUVELLE-AQUITAINE" + }, + "listeValeursParPeriode": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValeursParPeriode" + } + } + } + }, + "ValeursParPeriode": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la valeur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeTerritoire": { + "type": "string", + "description": "Le code du type de territoire", + "example": "REG" + }, + "codeTerritoire": { + "type": "string", + "description": "Le code territoire", + "example": "75" + }, + "libTerritoire": { + "type": "string", + "description": "Le libellĂ© du territoire", + "example": "NOUVELLE-AQUITAINE" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le code du type d'activitĂ©", + "example": "ROME" + }, + "codeActivite": { + "type": "string", + "description": "Le code d'activitĂ©", + "example": "A1203" + }, + "libActivite": { + "type": "string", + "description": "Le libellĂ© de l'activitĂ©", + "example": "AmĂ©nagement et entretien des espaces verts" + }, + "codeNomenclature": { + "type": "string", + "description": "Le code de nomenclature", + "example": "A" + }, + "libNomenclature": { + "type": "string", + "description": "Le libellĂ© de nomenclature", + "example": "Demandeurs d'Emploi de catĂ©gorie A" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le code du type de pĂ©riode", + "example": "TRIMESTRE" + }, + "codePeriode": { + "type": "string", + "description": "Le code de la pĂ©riode", + "example": "2023T4" + }, + "libPeriode": { + "type": "string", + "description": "Le libellĂ© de la pĂ©riode", + "example": "4Ăšme trimestre 2023" + }, + "valeurPrincipaleNom": { + "type": "string", + "description": "Le nom de la valeur principale", + "example": "Nombre de demandeurs d'emploi" + }, + "valeurPrincipaleNombre": { + "type": "integer", + "description": "La valeur principale", + "format": "int32", + "example": 4750 + }, + "valeurPrincipaleRang": { + "type": "integer", + "description": "La valeur principale si l'indicateur reprĂ©sente un rang", + "format": "int32", + "example": 4 + }, + "valeurPrincipaleMontant": { + "type": "number", + "description": "La valeur principale si l'indicateur reprĂ©sente un montant", + "format": "double", + "example": 55.5 + }, + "valeurPrincipaleTaux": { + "type": "number", + "description": "La valeur principale si l'indicateur reprĂ©sente un taux", + "format": "double", + "example": 10 + }, + "valeurSecondaireNombre": { + "type": "integer", + "description": "La valeur secondaire", + "format": "int32", + "example": 4750 + }, + "valeurSecondairePourcentage": { + "type": "number", + "description": "La valeur secondaire en pourcentage", + "format": "double", + "example": 54 + }, + "valeurSecondairePourcentage2": { + "type": "number", + "description": "La valeur secondaire en pourcentage", + "format": "double", + "example": 54 + }, + "valeurSecondaireTaux": { + "type": "number", + "description": "La valeur secondaire si l'indicateur reprĂ©sente un taux", + "format": "double", + "example": 10 + }, + "libPctParActivite": { + "type": "string", + "description": "Le libellĂ© du pourcentage par activitĂ©", + "example": "Pourcentage de demandeurs d'emploi par activitĂ©" + }, + "listeValeurParCaract": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValeursParCaracteristique" + } + } + } + }, + "ValeursParCaracteristique": { + "type": "object", + "properties": { + "codeTypeCaract": { + "type": "string", + "description": "La code du type de la caractĂ©ristique", + "example": "GENRE" + }, + "codeCaract": { + "type": "string", + "description": "La code de la caractĂ©ristique", + "example": "H" + }, + "libCaract": { + "type": "string", + "description": "Le libellĂ© de la caractĂ©ristique", + "example": "Homme" + }, + "nombre": { + "type": "integer", + "description": "La valeur de la caractĂ©ristique", + "format": "int32", + "example": 4470 + }, + "pourcentage": { + "type": "number", + "description": "Le pourcentage de la caractĂ©ristique", + "format": "double", + "example": 94 + }, + "montant": { + "type": "number", + "description": "Le montant (s'il existe) de la caractĂ©ristique", + "format": "double", + "example": 10 + }, + "taux": { + "type": "number", + "description": "Le taux (s'il existe) de la caractĂ©ristique", + "format": "double", + "example": 10 + } + } + }, + "CritereIndicateurSansNomenclature": { + "type": "object", + "properties": { + "codeTypeTerritoire": { + "type": "string", + "description": "Le type de territoire (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "DEP" + }, + "codeTerritoire": { + "type": "string", + "description": "Le code du territoire (voir le rĂ©fĂ©rentiel Territoire pour les codes disponibles)", + "example": "33" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le type d'activitĂ© (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "ROME" + }, + "codeActivite": { + "type": "string", + "description": "Le code d'activitĂ© (voir le rĂ©fĂ©rentiel Activite pour les codes disponibles)", + "example": "K1303" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le type de pĂ©riode (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "TRIMESTRE" + }, + "dernierePeriode": { + "type": "boolean", + "description": "Optionnel: A renseigner Ă  true pour que la recherche se limite Ă  la pĂ©riode la plus rĂ©cente sur cet indicateur, sinon la recherche se limite Ă  la liste de pĂ©riodes fournie en entrĂ©e" + }, + "listeCodePeriode": { + "type": "array", + "description": "Optionnel: A renseigner avec les pĂ©riodes souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les pĂ©riodes disponibles sur cet indicateur", + "items": { + "type": "string", + "description": "Optionnel: A renseigner avec les pĂ©riodes souhaitĂ©es, sinon la recherche est rĂ©alisĂ©e sur toutes les pĂ©riodes disponibles sur cet indicateur", + "example": "[\"2020T2\",\"2020T3\"]" + }, + "example": [ + "2020T2", + "2020T3" + ] + }, + "sansCaracteristiques": { + "type": "boolean", + "description": "Optionnel: A renseigner Ă  true pour que la recherche se limite aux valeurs hors caractĂ©ristiques sur cet indicateur, sinon la recherche se limite aux valeurs de la liste de caractĂ©ristiques fournie en entrĂ©e" + }, + "listeCaracteristiques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Caracteristique" + } + } + }, + "required": [ + "codeTypeTerritoire", + "codeTerritoire", + "codeTypeActivite", + "codeActivite", + "codeTypePeriode" + ] + }, + "Activite": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de l'activitĂ©", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le type d'activitĂ© (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "ROME" + }, + "codeActivite": { + "type": "string", + "description": "Le code d'activitĂ© (voir le rĂ©fĂ©rentiel Activite pour les codes disponibles)", + "example": "K1303" + }, + "libelleActivite": { + "type": "string", + "description": "Le libellĂ© de l'activitĂ©", + "example": "Ouvriers qualifiĂ©s de l'Ă©lectricitĂ© et de l'Ă©lectronique" + }, + "attribut": { + "type": "string", + "description": "Optionnel: le code NSF de l'activitĂ©", + "example": "114" + } + }, + "required": [ + "codeTypeActivite", + "codeActivite", + "libelleActivite" + ] + }, + "ListeActivite": { + "type": "object", + "properties": { + "activites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Activite" + } + } + } + }, + "ListeTypeActivite": { + "type": "object", + "properties": { + "typeActivites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeActivite" + } + } + } + }, + "TypeActivite": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type d'activitĂ©", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le code du type d'activitĂ©", + "example": "ROME" + }, + "libelleTypeActivite": { + "type": "string", + "description": "Le libellĂ© du type d'activitĂ©", + "example": "MĂ©tier (ROME)" + } + } + }, + "ListeCaracteristique": { + "type": "object", + "properties": { + "caracteristiques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Caracteristique" + } + } + } + }, + "ListeTypeCaracteristique": { + "type": "object", + "properties": { + "typeCaracteristiques": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeCaracteristique" + } + } + } + }, + "TypeCaracteristique": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeCaracteristique": { + "type": "string", + "description": "Le code du type de la caractĂ©ristique", + "example": "AGC_RAT" + }, + "libelleTypeCaracteristique": { + "type": "string", + "description": "Le libellĂ© du type de la caractĂ©ristique", + "example": "Territoire de rattachement de l'offre Ă  l'agence" + } + } + }, + "ListeDetailIndicateur": { + "type": "object", + "properties": { + "listeIndicateurs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DetailIndicateur" + } + } + } + }, + "DetailIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeIndicateur": { + "type": "string", + "description": "Le code de l'indicateur", + "example": "DE_1" + }, + "libelleIndicateur": { + "type": "string", + "description": "Le libellĂ© de l'indicateur", + "example": "Nombre et % de DE par catĂ©gories x caractĂ©ristiques, % par activitĂ©s (Rome, CompĂ©tence)" + }, + "descriptif": { + "type": "string", + "description": "Le descriptif de l'indicateur", + "example": "DĂ©finition dĂ©taillĂ©e : informations sur les sources de donnĂ©es utilisĂ©es, les mĂ©thodes de calcul, les limitations sur certains axes, les aspects rĂ©glementaires Ă©ventuels." + }, + "codeFamille": { + "type": "string", + "description": "Le code famille de l'indicateur", + "example": "DEMANDEURS" + }, + "disponibiliteIndicateur": { + "type": "integer", + "description": "Indique si l'indicateur est disponible (1) ou dĂ©sactivĂ© (0)", + "format": "int32", + "example": 1 + }, + "listeTypesValeurs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeValeur" + } + }, + "listeTypesTerritoiresIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeTerritoire" + } + }, + "listeTypesActivitesIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeActivite" + } + }, + "listeTypesPeriodesIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypePeriodeIndicateur" + } + }, + "listeTypesNomenclaturesIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeNomenclatureIndicateur" + } + }, + "listeCroisementsIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CroisementIndicateur" + } + }, + "listeCaracteristiqueIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CaracteristiqueIndicateur" + } + }, + "listeTypesCracteristiqueIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeCaracteristique" + } + } + } + }, + "TypeValeur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de valeur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "valeurPrincipale": { + "type": "string", + "description": "La valeur principale", + "example": "0" + }, + "codeTypeValeur": { + "type": "string", + "description": "Le code du type de valeur", + "example": "NB_ET_PCT" + }, + "numOrdre": { + "type": "integer", + "description": "Le numĂ©ro d'ordre de la valeur", + "format": "int32", + "example": 1 + }, + "libValeur": { + "type": "string", + "description": "Le libellĂ© du type de valeur", + "example": "Nombre et % de rĂ©partition de ce nombre par caractĂ©ristiques." + }, + "libelleValeurSpecifique": { + "type": "string", + "description": "Le libellĂ© spĂ©cifique de la valeur", + "example": "Nombre et % des retours Ă  l'emploi AB par durĂ©e d'emploi et caractĂ©ristiques" + } + } + }, + "TypeTerritoire": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de territoire", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeTerritoire": { + "type": "string", + "description": "Le code du type de territoire", + "example": "DEP" + }, + "libelleTypeTerritoire": { + "type": "string", + "description": "Le libellĂ© du type de territoire", + "example": "DĂ©partement" + } + } + }, + "TypePeriodeIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de pĂ©riode de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le code du type de pĂ©riode", + "example": "TRIMESTRE" + }, + "libelleTypePeriode": { + "type": "string", + "description": "Le libellĂ© du type de pĂ©riode", + "example": "Trimestre" + }, + "profondeurMax": { + "type": "string", + "description": "Nombre maximum de pĂ©riode interrogeable pour ce type", + "example": "12" + } + } + }, + "TypeNomenclatureIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de nomenclature de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le code du type de nomenclature de l'indicateur", + "example": "DUREEEMP" + }, + "libelleTypeNomenclature": { + "type": "string", + "description": "Le libellĂ© du type de nomenclature de l'indicateur", + "example": "DurĂ©e d'emploi > 1 mois, emploi durable (> 6 mois), Toutes durĂ©es)" + }, + "listeValeursNomenclaturesIndicateur": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValeurNomenclatureIndicateur" + } + } + } + }, + "ValeurNomenclatureIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la valeur de la nomenclature", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "valeurNomenclature": { + "type": "string", + "description": "La valeur de la nomenclature", + "example": "SUP1M" + }, + "libelleNomenclature": { + "type": "string", + "description": "La libellĂ© de la nomenclature", + "example": "Emploi > 1 mois" + } + } + }, + "CroisementIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du croisement de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeTerritoire": { + "type": "string", + "description": "Le type de territoire (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "DEP" + }, + "codeTypeActivite": { + "type": "string", + "description": "Le type d'activitĂ© (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "ROME" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le type de pĂ©riode (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "TRIMESTRE" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le type de nomenclature (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "CATCAND" + }, + "codeNomenclature": { + "type": "string", + "description": "Le code de nomenclature", + "example": "A" + } + } + }, + "CaracteristiqueIndicateur": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la caractĂ©ristique de l'indicateur", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeCaracteristique": { + "type": "string", + "description": "Le code du type de la caractĂ©ristique", + "example": "GENRE" + }, + "codeCaracteristique": { + "type": "string", + "description": "Le code de la caractĂ©ristique", + "example": "H" + }, + "libelleCaracteristique": { + "type": "string", + "description": "Le libellĂ© de la caractĂ©ristique", + "example": "Homme" + } + }, + "required": [ + "codeTypeCaracteristique", + "codeCaracteristique", + "libelleCaracteristique" + ] + }, + "ListeNomenclature": { + "type": "object", + "properties": { + "nomenclatures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Nomenclature" + } + } + } + }, + "Nomenclature": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la nomenclature", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le code du type de nomenclature", + "example": "ACCESEMP" + }, + "codeNomenclature": { + "type": "string", + "description": "Le code de la nomenclature", + "example": "12M" + }, + "libelleNomenclature": { + "type": "string", + "description": "Le libellĂ© de la nomenclature", + "example": "12 Mois" + } + } + }, + "ListeTypeNomenclature": { + "type": "object", + "properties": { + "typeNomenclatures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeNomenclature" + } + } + } + }, + "TypeNomenclature": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de nomenclature", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeNomenclature": { + "type": "string", + "description": "Le code du type de nomenclature", + "example": "ACCESEMP" + }, + "libelleTypeNomenclature": { + "type": "string", + "description": "Le libellĂ© du type de nomenclature", + "example": "DĂ©lai d'accĂšs Ă  l'emploi (6 mois / 12 mois)" + } + } + }, + "ListePeriode": { + "type": "object", + "properties": { + "periodes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Periode" + } + } + } + }, + "Periode": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour de la pĂ©riode", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le code du type de pĂ©riode", + "example": "TRIMESTRE" + }, + "codePeriode": { + "type": "string", + "description": "Le code de la pĂ©riode", + "example": "2023T1" + }, + "ordrePeriode": { + "type": "integer", + "description": "Ordre de la pĂ©riode", + "format": "int32", + "example": 1 + }, + "libellePeriode": { + "type": "string", + "description": "LibellĂ© de la pĂ©riode", + "example": "1er trimestre 2023" + } + }, + "required": [ + "codeTypePeriode", + "codePeriode", + "ordrePeriode", + "libellePeriode" + ] + }, + "ListeTypePeriode": { + "type": "object", + "properties": { + "typePeriodes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypePeriode" + } + } + } + }, + "TypePeriode": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du type de pĂ©riode", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypePeriode": { + "type": "string", + "description": "Le code du type de pĂ©riode", + "example": "TRIMESTRE" + }, + "libelleTypePeriode": { + "type": "string", + "description": "Le libellĂ© du type de pĂ©riode", + "example": "Trimestre" + } + }, + "required": [ + "codeTypePeriode", + "libelleTypePeriode" + ] + }, + "ListeTerritoire": { + "type": "object", + "properties": { + "territoires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Territoire" + } + } + } + }, + "Territoire": { + "type": "object", + "properties": { + "datMaj": { + "type": "string", + "description": "Date de mise Ă  jour du territoire", + "format": "date-time", + "example": "2024-04-21T17:13:44+02:00" + }, + "codeTypeTerritoire": { + "type": "string", + "description": "Le type de territoire (voir le rĂ©fĂ©rentiel du Catalogue des Indicateurs pour les types disponibles)", + "example": "DEP" + }, + "codeTerritoire": { + "type": "string", + "description": "Le code du territoire (voir le rĂ©fĂ©rentiel Territoire pour les codes disponibles)", + "example": "33" + }, + "libelleTerritoire": { + "type": "string", + "description": "Le libellĂ© du territoire", + "example": "GIRONDE" + }, + "codeTypeTerritoireParent": { + "type": "string", + "description": "Le code type du territoire parent", + "example": "REG" + }, + "codeTerritoireParent": { + "type": "string", + "description": "Le code du territoire parent", + "example": "75" + } + } + }, + "ListeTypeTerritoire": { + "type": "object", + "properties": { + "typeTerritoires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeTerritoire" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/docs/api/offres_emploi_v2_bundled.json b/docs/api/offres_emploi_v2_bundled.json new file mode 100644 index 0000000..d2c8260 --- /dev/null +++ b/docs/api/offres_emploi_v2_bundled.json @@ -0,0 +1,2463 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Offres d'emploi", + "description": "AccĂ©dez aux offres d'emploi disponibles sur [francetravail.fr](https://www.francetravail.fr)\r\n\r\nConsultez les rĂ©fĂ©rentiels pour renseigner les critĂšres de recherche d'offres\r\n\r\n**Scopes :**`o2dsoffre`, `api_offresdemploiv2`\r\n\r\n**Royaume** : `/partenaire`\r\n", + "version": "2" + }, + "servers": [ + { + "url": "https://api.francetravail.io/partenaire/offresdemploi" + } + ], + "paths": { + "/v2/offres/search": { + "get": { + "tags": [ + "Offres" + ], + "summary": "Rechercher des offres", + "description": "Cette ressource permet de rĂ©aliser une recherche d'offres Ă  partir de critĂšres de sĂ©lection, parmi les offres de France Travail et de ses partenaires.\r\n\r\nLa liste des offres retournĂ©es est paginĂ©e.\r\n\r\nLa quantitĂ© d'offres renvoyĂ©es par l'API peut varier par rapport Ă  ce qui est affichĂ© dans la recherche d'offres sur francetravail.fr, selon si le partenaire (voir le paramĂštre d'entrĂ©e \"origineOffre\") a donnĂ© ou non son accord pour la diffusion de ses offres.", + "operationId": "recupererListeOffre", + "parameters": [ + { + "name": "range", + "in": "query", + "description": "Pagination des donnĂ©es. La plage de rĂ©sultats est limitĂ©e Ă  150.\r\n\r\nFormat : p-d, oĂč : ", + "schema": { + "type": "string" + }, + "example": "0-49" + }, + { + "name": "sort", + "in": "query", + "description": "Il est possible de trier les rĂ©sultats de 3 façons : ", + "schema": { + "type": "string" + }, + "example": 1 + }, + { + "name": "domaine", + "in": "query", + "description": "Domaine de l'offre.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des domaines mĂ©tiers.", + "schema": { + "type": "string" + }, + "example": "G17" + }, + { + "name": "codeROME", + "in": "query", + "description": "Code ROME de l'offre. Jusqu'Ă  200 valeurs possibles, sĂ©parĂ©es par une virgule.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des mĂ©tiers ROME.", + "schema": { + "type": "string" + }, + "example": "D1102,D1104,D1108" + }, + { + "name": "appellation", + "in": "query", + "description": "Code appellation ROME de l'offre.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des appellations ROME.", + "schema": { + "type": "string" + }, + "example": 38444 + }, + { + "name": "theme", + "in": "query", + "description": "ThĂšme ROME du mĂ©tier.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des thĂšmes.", + "schema": { + "type": "string" + }, + "example": 12 + }, + { + "name": "secteurActivite", + "in": "query", + "description": "Division NAF de l'offre (2 premiers chiffres). Jusqu'Ă  2 valeurs possibles, sĂ©parĂ©es par une virgule.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des secteurs d'activitĂ©s.", + "schema": { + "type": "string" + }, + "example": "01,02" + }, + { + "name": "codeNAF", + "in": "query", + "description": "Code NAF (Code APE) de l'offre, (format 99.99X). Jusqu'Ă  2 valeurs possibles, sĂ©parĂ©es par une virgule.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des codes nafs.", + "schema": { + "type": "string" + }, + "example": "78.20Z" + }, + { + "name": "experience", + "in": "query", + "description": "Niveau d'expĂ©rience demandĂ© : 0 - Non prĂ©cisĂ©, 1 - Moins d'un an, 2 - De 1 Ă  3 ans, 3 - Plus de 3 ans.", + "schema": { + "type": "string" + }, + "example": 2 + }, + { + "name": "typeContrat", + "in": "query", + "description": "Code du type de contrat.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des type de contrats.\r\n\r\nRemarque : L'opĂ©rateur utilisĂ© entre les filtres typeContrat et natureContrat est un OU, c'est-Ă -dire que pour la recherche \"typeContrat=CDI,CDD\" avec \"natureContrat=E1\" alors les rĂ©sultats contiendront toutes les offres en type de contrat CDI ou CDD (peu importe la nature) mais Ă©galement toutes les offres de nature E1 (sans prendre en compte le type de contrat).", + "schema": { + "type": "string" + }, + "example": "CDI" + }, + { + "name": "natureContrat", + "in": "query", + "description": "Code de la nature du contrat.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des natures de contrats.\r\n\r\nRemarque : L'opĂ©rateur utilisĂ© entre les filtres typeContrat et natureContrat est un OU, c'est-Ă -dire que pour la recherche \"typeContrat=CDI,CDD\" avec \"natureContrat=E1\" alors les rĂ©sultats contiendront toutes les offres en type de contrat CDI ou CDD (peu importe la nature) mais Ă©galement toutes les offres de nature E1 (sans prendre en compte le type de contrat).", + "schema": { + "type": "string" + }, + "example": "E1" + }, + { + "name": "origineOffre", + "in": "query", + "description": "Origine de l'offre\r\n\r\n Valeurs possibles : ", + "schema": { + "type": "integer", + "format": "int64" + }, + "example": 1 + }, + { + "name": "qualification", + "in": "query", + "description": "Qualification du poste : 0 - non-cadre, 9 - cadre.", + "schema": { + "type": "string" + }, + "example": 9 + }, + { + "name": "tempsPlein", + "in": "query", + "description": "Temps plein ou partiel.\r\n\r\nFavoriser l'utilisation du filtre DureeHebdo", + "schema": { + "type": "boolean" + }, + "example": true + }, + { + "name": "commune", + "in": "query", + "description": "Code INSEE de la commune. Jusqu'Ă  5 valeurs possibles, sĂ©parĂ©es par une virgule.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des communes.\r\n\r\nLe comportement de recherche permet de remonter les offres pour lesquelles la distance entre la commune recherchĂ©e et la commune de l'offre est infĂ©rieure ou Ă©gale Ă  la distance maximum demandĂ©e, ainsi que les offres pour lesquelles cette distance est marginalement plus Ă©levĂ©e (jusqu'Ă  + 30% de la distance maximum demandĂ©e).\r\n\r\nSpĂ©cificitĂ© de la ville de Paris, l'ensemble des offres de Paris sont remontĂ©es pour :SpĂ©cificitĂ© de la ville de Lyon, l'ensemble des offres de Lyon sont remontĂ©es dĂšs que le centre de Lyon est atteint par le rayon de distance recherchĂ©.\r\n\r\nRemarque : pour obtenir seulement les offres d'une commune spĂ©cifique, alors il faut renseigner le paramĂštre \"distance=0\"", + "schema": { + "type": "string" + }, + "example": "33063,31555" + }, + { + "name": "distance", + "in": "query", + "description": "Distance kilomĂ©trique du rayon de la recherche autour de la commune (pris en compte uniquement si une commune est renseignĂ©e).", + "schema": { + "type": "integer", + "format": "int64" + }, + "example": 10 + }, + { + "name": "departement", + "in": "query", + "description": "DĂ©partement de l'offre. Jusqu'Ă  5 valeurs possibles, sĂ©parĂ©es par une virgule.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des dĂ©partements.", + "schema": { + "type": "string" + }, + "example": "33,31" + }, + { + "name": "inclureLimitrophes", + "in": "query", + "description": "Inclure les dĂ©partements limitrophes dans la recherche.", + "schema": { + "type": "boolean" + }, + "example": false + }, + { + "name": "region", + "in": "query", + "description": "RĂ©gion de l'offre.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des rĂ©gions.", + "schema": { + "type": "string" + }, + "example": 75 + }, + { + "name": "paysContinent", + "in": "query", + "description": "Pays ou continent de l'offre.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des pays ou des continents.", + "schema": { + "type": "string" + }, + "example": 99127 + }, + { + "name": "niveauFormation", + "in": "query", + "description": "Niveau de formation demandĂ©.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des niveaux de formations.", + "schema": { + "type": "string" + }, + "example": "NV3" + }, + { + "name": "permis", + "in": "query", + "description": "Permis demandĂ©.\r\n\r\n Voir la ressource rĂ©fĂ©rentiel des permis.", + "schema": { + "type": "string" + }, + "example": "B" + }, + { + "name": "motsCles", + "in": "query", + "description": "Chaque mot clĂ© (ou expression) comprend au moins 2 caractĂšres et doit ĂȘtre sĂ©parĂ© par une virgule.\r\n\r\nLa recherche sur plusieurs mots clefs est traitĂ©e via l'opĂ©rateur logique \"ET\"\r\n\r\nLa recherche de mots clĂ©s peut permettre de rechercher sur : CaractĂšres autorisĂ©s : [aA-zZ]+[0-9]+[espace]+[@#$%^&+./-\"]", + "schema": { + "type": "string" + }, + "example": "boulanger,patissier" + }, + { + "name": "salaireMin", + "in": "query", + "description": "Salaire minimum recherchĂ©. Si cette donnĂ©e est renseignĂ©e, le code du type de salaire minimum est obligatoire.", + "schema": { + "type": "string" + }, + "example": 1400 + }, + { + "name": "periodeSalaire", + "in": "query", + "description": "PĂ©riode pour le calcul du salaire minimum : M - Mensuel, A - Annuel, H - Horaire, C - Cachet. Si cette donnĂ©e est renseignĂ©e, le salaire minimum est obligatoire.", + "schema": { + "type": "string" + }, + "example": "M" + }, + { + "name": "accesTravailleurHandicape", + "in": "query", + "description": "Offres pour lesquelles l'employeur est handi friendly.", + "schema": { + "type": "boolean" + }, + "example": false + }, + { + "name": "publieeDepuis", + "in": "query", + "description": "Recherche les offres publiĂ©es depuis maximum « X » jours.", + "schema": { + "type": "integer", + "format": "int64" + }, + "example": 7 + }, + { + "name": "minCreationDate", + "in": "query", + "description": "Date minimale pour laquelle rechercher des offres (format yyyy-MM-dd'T'hh:mm:ss'Z').", + "schema": { + "type": "string" + }, + "example": "2022-03-25T14:52:00Z" + }, + { + "name": "maxCreationDate", + "in": "query", + "description": "Date maximale pour laquelle rechercher des offres (format yyyy-MM-dd'T'hh:mm:ss'Z').", + "schema": { + "type": "string" + }, + "example": "2022-04-15T07:18:25Z" + }, + { + "name": "offresMRS", + "in": "query", + "description": "Uniquement les offres d'emplois avec mĂ©thode de recrutement par simulation proposĂ©e.", + "schema": { + "type": "boolean" + }, + "example": false + }, + { + "name": "experienceExigence", + "in": "query", + "description": "Exigence d'expĂ©rience : D - dĂ©butant acceptĂ©, S - expĂ©rience souhaitĂ©e, E - expĂ©rience exigĂ©e.", + "schema": { + "type": "string" + }, + "example": "D" + }, + { + "name": "grandDomaine", + "in": "query", + "description": "Code du grand domaine de l'offre : ", + "schema": { + "type": "string" + }, + "example": "M16" + }, + { + "name": "partenaires", + "in": "query", + "description": "Liste des codes partenaires dont les offres sont Ă  inclure ou exclure en fonction du mode de sĂ©lection associĂ© et du filtre de l'origine de l'offre.", + "schema": { + "type": "string" + }, + "example": "PARTENAIRE1" + }, + { + "name": "modeSelectionPartenaires", + "in": "query", + "description": "Mode de sĂ©lection des partenaires. ÉnumĂ©ration (INCLUS ou EXCLU).", + "schema": { + "type": "string" + }, + "example": "INCLUS" + }, + { + "name": "dureeHebdoMin", + "in": "query", + "description": "Recherche les offres avec une durĂ©e minimale (format HHMM).", + "schema": { + "type": "string" + }, + "example": 800 + }, + { + "name": "dureeHebdoMax", + "in": "query", + "description": "Recherche les offres avec une durĂ©e maximale (format HHMM).", + "schema": { + "type": "string" + }, + "example": 2430 + }, + { + "name": "dureeContratMin", + "in": "query", + "description": "Recherche les offres avec une durĂ©e de contrat minimale (en mois, format double de 0 Ă  99 bornes incluses).", + "schema": { + "type": "string" + }, + "example": 0.5 + }, + { + "name": "dureeContratMax", + "in": "query", + "description": "Recherche les offres avec une durĂ©e de contrat maximale (en mois, format double de 0 Ă  99 bornes incluses).", + "schema": { + "type": "string" + }, + "example": 24 + }, + { + "name": "dureeHebdo ", + "in": "query", + "description": "Type de durĂ©e du contrat de l'offre : 0 - Non prĂ©cisĂ©, 1 - Temps plein, 2 - Temps partiel.", + "schema": { + "type": "string" + }, + "example": 1 + }, + { + "name": "offresManqueCandidats", + "in": "query", + "description": "Filtre les offres difficiles Ă  pourvoir.", + "schema": { + "type": "boolean" + }, + "example": true + }, + { + "name": "entreprisesAdaptees", + "in": "query", + "description": "Filtre les offres dont l'entreprise permet Ă  un travailleur en situation de handicap d'exercer une activitĂ© professionnelle dans des conditions adaptĂ©es Ă  ses capacitĂ©s.", + "schema": { + "type": "boolean" + }, + "example": true + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ], + "responses": { + "200": { + "description": "Tous les rĂ©sultats ont Ă©tĂ© rĂ©cupĂ©rĂ©s avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"offres p-d/t\", oĂč ", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResultatRecherche" + } + } + } + }, + "204": { + "description": "Aucune offre correspondante", + "headers": { + "Content-Range": { + "description": "\"*/0\" : Aucun rĂ©sultat correspondant Ă  ces critĂšres", + "style": "simple", + "schema": { + "type": "string" + } + } + } + }, + "206": { + "description": "Les rĂ©sultats ont Ă©tĂ© rĂ©cupĂ©rĂ©s avec succĂšs, il y a d'autres rĂ©sultats disponibles", + "headers": { + "Content-Range": { + "description": "Format : \"offres p-d/t\", oĂč ", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResultatRecherche" + } + } + } + }, + "400": { + "description": "Mauvaise requĂȘte" + }, + "500": { + "description": "Erreur interne au serveur" + } + } + } + }, + "/v2/offres/{id}": { + "get": { + "tags": [ + "Offres" + ], + "summary": "Consulter un dĂ©tail d'offre", + "description": "Cette ressource permet de rĂ©cupĂ©rer le dĂ©tail d'une offre Ă  partir de son identifiant.", + "operationId": "recupererOffre", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifiant de l'offre d'emploi.", + "required": true, + "schema": { + "type": "string" + }, + "example": "048KLTP" + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ], + "responses": { + "200": { + "description": "L'offre a Ă©tĂ© rĂ©cupĂ©rĂ©e avec succĂšs", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Offre" + } + } + } + }, + "204": { + "description": "L'offre n'existe pas" + }, + "400": { + "description": "Mauvaise requĂȘte" + }, + "500": { + "description": "Erreur interne au serveur" + } + } + } + }, + "/v2/referentiel/appellations": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Appellations ROME", + "description": "Renvoie le rĂ©fĂ©rentiel des appellations ROME", + "operationId": "recupererReferentielAppellations", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"appellations */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/nafs": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Codes nafs", + "description": "Renvoie le rĂ©fĂ©rentiel des codes nafs", + "operationId": "recupererReferentielCodesNAFs", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"nafs */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/communes": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Communes", + "description": "Renvoie le rĂ©fĂ©rentiel des communes", + "operationId": "recupererReferentielCommunes", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"communes */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Commune" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/continents": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Continents", + "description": "Renvoie le rĂ©fĂ©rentiel des continents", + "operationId": "recupererReferentielContinents", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"continents */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/departements": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "DĂ©partements", + "description": "Renvoie le rĂ©fĂ©rentiel des dĂ©partements", + "operationId": "recupererReferentielDepartements", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"departements */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Departement" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/domaines": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Domaines mĂ©tiers", + "description": "Renvoie le rĂ©fĂ©rentiel des domaines mĂ©tiers", + "operationId": "recupererReferentielDomainesMetiers", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"domaines */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/langues": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Langues", + "description": "Renvoie le rĂ©fĂ©rentiel des langues", + "operationId": "recupererReferentielLangues", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"langues */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/metiers": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "MĂ©tiers ROME", + "description": "Renvoie le rĂ©fĂ©rentiel des mĂ©tiers ROME", + "operationId": "recupererReferentielMetiers", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"metiers */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/naturesContrats": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Natures de contrats", + "description": "Renvoie le rĂ©fĂ©rentiel des natures de contrats", + "operationId": "recupererReferentielNaturesContrats", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"naturesContrats */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/niveauxFormations": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Niveaux de formations", + "description": "Renvoie le rĂ©fĂ©rentiel des niveaux de formations", + "operationId": "recupererReferentielNiveauxFormations", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"niveauxFormations */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/pays": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Pays", + "description": "Renvoie le rĂ©fĂ©rentiel des pays", + "operationId": "recupererReferentielPays", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"pays */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/permis": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Permis", + "description": "Renvoie le rĂ©fĂ©rentiel des permis", + "operationId": "recupererReferentielPermis", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"permis */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/regions": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "RĂ©gions", + "description": "Renvoie le rĂ©fĂ©rentiel des rĂ©gions", + "operationId": "recupererReferentielRegions", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"regions */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Region" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/secteursActivites": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Secteurs d'activitĂ©s", + "description": "Renvoie le rĂ©fĂ©rentiel des secteurs d'activitĂ©s", + "operationId": "recupererReferentielSecteursActivites", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"secteursActivites */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/themes": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "ThĂšmes", + "description": "Renvoie le rĂ©fĂ©rentiel des thĂšmes", + "operationId": "recupererReferentielThemes", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"themes */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + }, + "/v2/referentiel/typesContrats": { + "get": { + "tags": [ + "RĂ©fĂ©rentiel" + ], + "summary": "Types de contrats", + "description": "Renvoie le rĂ©fĂ©rentiel des types de contrats", + "operationId": "recupererReferentielTypesContrats", + "responses": { + "200": { + "description": "Le rĂ©fĂ©rentiel a Ă©tĂ© renvoyĂ© avec succĂšs", + "headers": { + "Content-Range": { + "description": "Format : \"typesContrats */size\" oĂč size est le nombre d’élĂ©ments attendus, * si inconnu", + "style": "simple", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Referentiel" + } + } + } + } + }, + "500": { + "description": "Erreur interne au serveur" + } + }, + "parameters": [ + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer gEoDOnecV-iQam2bxhijIkJDvfA" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer JfHAwKqXzYsBXA7XWJuEYbt1Wr8" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer H37Wm18OEJlPiTmllLzE0eNUhZo" + } + }, + { + "name": "Authorization", + "in": "header", + "required": true, + "schema": { + "type": "string", + "default": "Bearer KzDJSNAHeWOuX1JzR-ObZ1r0t2Q" + } + } + ] + } + } + }, + "components": { + "schemas": { + "Agence": { + "type": "object", + "properties": { + "telephone": { + "type": "string", + "description": "N° de tĂ©lĂ©phone de l’agence France Travail", + "example": "06 12 34 56 78" + }, + "courriel": { + "type": "string", + "description": "Le courriel de l'agence n'est plus affichĂ© pour des raisons de sĂ©curitĂ©, le champ fournit dĂ©sormais le lien vers l'offre sur le site FranceTravail.fr afin de connaitre les modalitĂ©s pour postuler", + "example": "Pour postuler, utiliser le lien suivant : https://candidat.francetravail.fr/offres/recherche/detail/XXXXXXX" + } + }, + "description": "Agence France Travail" + }, + "Agregation": { + "type": "object", + "properties": { + "valeurPossible": { + "type": "string", + "description": "Valeur possible du filtre", + "example": "E1" + }, + "nbResultats": { + "type": "integer", + "description": "Nombre de rĂ©sultats attendus pour cette valeur", + "format": "int32", + "example": 45 + } + }, + "description": "AgrĂ©gations" + }, + "Competence": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code de la compĂ©tence", + "example": "483320" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© de la compĂ©tence", + "example": "Maintenir un environnement de travail propre et organisĂ©" + }, + "exigence": { + "type": "string", + "description": "E : la compĂ©tence est exigĂ©e, S : la compĂ©tence est souhaitĂ©e", + "example": "E" + } + }, + "description": "CompĂ©tences" + }, + "Contact": { + "type": "object", + "properties": { + "nom": { + "type": "string", + "description": "Nom du recruteur", + "example": "Etienne Dupont" + }, + "coordonnees1": { + "type": "string", + "description": "Adresse du recruteur", + "example": "12 impasse du caillou" + }, + "coordonnees2": { + "type": "string", + "description": "Adresse du recruteur" + }, + "coordonnees3": { + "type": "string", + "description": "Adresse du recruteur" + }, + "telephone": { + "type": "string", + "description": "N° de tĂ©lĂ©phone du recruteur", + "example": "06 12 34 56 78" + }, + "courriel": { + "type": "string", + "description": "Le courriel du recruteur n'est plus affichĂ© pour des raisons de sĂ©curitĂ©, le champ fournit dĂ©sormais le lien vers l'offre sur le site FranceTravail.fr afin de connaitre les modalitĂ©s pour postuler", + "example": "Pour postuler, utiliser le lien suivant : https://candidat.francetravail.fr/offres/recherche/detail/XXXXXXX" + }, + "commentaire": { + "type": "string", + "description": "PrĂ©cision sur le contact de l’offre", + "example": "A contacter aprĂšs 19h" + }, + "urlRecruteur": { + "type": "string", + "description": "URL du recruteur", + "example": "https://boulanger-austral.net" + }, + "urlPostulation": { + "type": "string", + "description": "URL du formulaire de postulation", + "example": "https://boulanger-austral.net/carrieres" + } + }, + "description": "Contact" + }, + "ContexteTravail": { + "type": "object", + "properties": { + "horaires": { + "type": "array", + "description": "Liste des horaires du contexte de travail", + "example": "35H Travail le samedi", + "items": { + "type": "string", + "description": "Liste des horaires du contexte de travail", + "example": "35H Travail le samedi" + } + }, + "conditionsExercice": { + "type": "array", + "description": "Liste des conditions d'exercice du contexte de travail", + "example": "Port de tenue professionnelle ou d'uniforme", + "items": { + "type": "string", + "description": "Liste des conditions d'exercice du contexte de travail", + "example": "Port de tenue professionnelle ou d'uniforme" + } + } + }, + "description": "Ensemble des contextes de travail (horaires et exercices)" + }, + "Entreprise": { + "type": "object", + "properties": { + "nom": { + "type": "string", + "description": "Nom de l’entreprise", + "example": "Le boulanger austral" + }, + "description": { + "type": "string", + "description": "Description de l’entreprise", + "example": "Votre nouvelle boulangerie locale" + }, + "logo": { + "type": "string", + "description": "URL du logo de l’entreprise", + "example": "https://boulanger-austral.net/logo.png" + }, + "url": { + "type": "string", + "description": "URL du site de l’entreprise", + "example": "https://boulanger-austral.net" + }, + "entrepriseAdaptee": { + "type": "boolean", + "description": "Flag entreprise adaptee", + "example": true + } + }, + "description": "Entreprise" + }, + "FiltrePossible": { + "type": "object", + "properties": { + "filtre": { + "type": "string", + "description": "Nom du filtre", + "example": "natureContrat" + }, + "agregation": { + "type": "array", + "description": "AgrĂ©gations", + "items": { + "$ref": "#/components/schemas/Agregation" + } + } + }, + "description": "Liste des filtres supplĂ©mentaires possibles" + }, + "Formation": { + "type": "object", + "properties": { + "codeFormation": { + "type": "string", + "description": "Code du domaine de formation souhaitĂ©", + "example": "21538" + }, + "domaineLibelle": { + "type": "string", + "description": "Domaine de formation souhaitĂ©", + "example": "boulangerie" + }, + "niveauLibelle": { + "type": "string", + "description": "Niveau de formation souhaitĂ©", + "example": "CAP, BEP et Ă©quivalents" + }, + "commentaire": { + "type": "string", + "description": "Commentaire sur la formation", + "example": "Mention bien souhaitĂ©e" + }, + "exigence": { + "type": "string", + "description": "E : la formation est exigĂ©e, S : la formation est souhaitĂ©e", + "example": "E" + } + }, + "description": "Formations" + }, + "Langue": { + "type": "object", + "properties": { + "libelle": { + "type": "string", + "description": "Langue souhaitĂ©e", + "example": "Anglais" + }, + "exigence": { + "type": "string", + "description": "E : la langue est exigĂ©e, S : la langue est souhaitĂ©e", + "example": "E" + } + }, + "description": "Langues" + }, + "LieuTravail": { + "type": "object", + "properties": { + "libelle": { + "type": "string", + "description": "LibellĂ© du lieu de travail", + "example": "74 - ANNECY" + }, + "latitude": { + "type": "number", + "description": "Latitude du lieu de travail", + "format": "double", + "example": 45.901584 + }, + "longitude": { + "type": "number", + "description": "Longitude de lieu de travail", + "format": "double", + "example": 6.125296 + }, + "codePostal": { + "type": "string", + "description": "Code postal du lieu de travail", + "example": "74000" + }, + "commune": { + "type": "string", + "description": "Code Insee du lieu de travail", + "example": "74010" + } + }, + "description": "Lieu de travail" + }, + "Offre": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Identifiant de l’offre d’emploi", + "example": "048KLTP" + }, + "intitule": { + "type": "string", + "description": "IntitulĂ© de l’offre", + "example": "Boulanger / BoulangĂšre (H/F)" + }, + "description": { + "type": "string", + "description": "Description de l’offre", + "example": "Nous rechercons un/e Boulanger/Ăšre pour notre nouveau magasin." + }, + "dateCreation": { + "type": "string", + "description": "Date de crĂ©ation de l’offre", + "format": "date-time", + "example": "2022-10-23T08:15:42Z" + }, + "dateActualisation": { + "type": "string", + "description": "Date de derniĂšre actualisation de l'offre", + "format": "date-time", + "example": "2022-10-23T08:15:42Z" + }, + "lieuTravail": { + "$ref": "#/components/schemas/LieuTravail" + }, + "romeCode": { + "type": "string", + "description": "Code ROME de l’offre", + "example": "D1102" + }, + "romeLibelle": { + "type": "string", + "description": "LibellĂ© associĂ© au code ROME", + "example": "Boulanger / BoulangĂšre" + }, + "appellationlibelle": { + "type": "string", + "description": "LibellĂ© de l’appellation ROME de l’offre", + "example": "Boulanger / BoulangĂšre" + }, + "entreprise": { + "$ref": "#/components/schemas/Entreprise" + }, + "typeContrat": { + "type": "string", + "description": "Code du type de contrat proposĂ© (CDD, CDI, etc.)", + "example": "CDD" + }, + "typeContratLibelle": { + "type": "string", + "description": "LibellĂ© du type de contrat proposĂ©", + "example": "CDD - 6 Mois" + }, + "natureContrat": { + "type": "string", + "description": "Nature du contrat (contrat d’apprentissage, etc.)", + "example": "Contrat travail" + }, + "experienceExige": { + "type": "string", + "description": "D : dĂ©butant acceptĂ©, E : l’expĂ©rience est exigĂ©e, S : l’expĂ©rience est souhaitĂ©e", + "example": "D" + }, + "experienceLibelle": { + "type": "string", + "description": "LibellĂ© de l’expĂ©rience", + "example": "DĂ©butant acceptĂ©" + }, + "experienceCommentaire": { + "type": "string", + "description": "Commentaire sur l’expĂ©rience", + "example": "ExpĂ©rience dans la vente souhaitĂ©e" + }, + "formations": { + "type": "array", + "description": "Formations", + "items": { + "$ref": "#/components/schemas/Formation" + } + }, + "langues": { + "type": "array", + "description": "Langues", + "items": { + "$ref": "#/components/schemas/Langue" + } + }, + "permis": { + "type": "array", + "description": "Permis", + "items": { + "$ref": "#/components/schemas/Permis" + } + }, + "outilsBureautiques": { + "type": "array", + "description": "Liste des outils bureautiques utilisĂ©s", + "example": "Traitement de texte", + "items": { + "type": "string", + "description": "Liste des outils bureautiques utilisĂ©s", + "example": "Traitement de texte" + } + }, + "competences": { + "type": "array", + "description": "CompĂ©tences", + "items": { + "$ref": "#/components/schemas/Competence" + } + }, + "salaire": { + "$ref": "#/components/schemas/Salaire" + }, + "dureeTravailLibelle": { + "type": "string", + "description": "LibellĂ© de la durĂ©e de travail", + "example": "35H" + }, + "dureeTravailLibelleConverti": { + "type": "string", + "description": "Temps plein ou temps partiel", + "example": "Temps plein" + }, + "complementExercice": { + "type": "string", + "description": "ComplĂ©ment exercice", + "example": "Gestion de la comptabilitĂ©" + }, + "conditionExercice": { + "type": "string", + "description": "Conditions d'exercice", + "example": "Travail de nuit" + }, + "alternance": { + "type": "boolean", + "description": "Vrai si c’est une offre pour de l’alternance", + "example": false + }, + "contact": { + "$ref": "#/components/schemas/Contact" + }, + "agence": { + "$ref": "#/components/schemas/Agence" + }, + "nombrePostes": { + "type": "integer", + "description": "Nombre de postes disponibles pour cette offre", + "format": "int32", + "example": 3 + }, + "accessibleTH": { + "type": "boolean", + "description": "Vrai si l’offre est accessible aux travailleurs handicapĂ©s", + "example": true + }, + "deplacementCode": { + "type": "string", + "description": "Code de la frĂ©quence des dĂ©placements", + "example": "1" + }, + "deplacementLibelle": { + "type": "string", + "description": "Description des dĂ©placements demandĂ©s", + "example": "Jamais" + }, + "qualificationCode": { + "type": "string", + "description": "Qualification du poste. Pour la qualification, on remonte les 9 valeurs 1 - manƓuvre, ..., 8 - agent de maitrise, 9 - cadre", + "example": "6" + }, + "qualificationLibelle": { + "type": "string", + "description": "LibellĂ© de la qualification du poste", + "example": "EmployĂ© qualifiĂ©" + }, + "codeNAF": { + "type": "string", + "description": "Code NAF (Code APE)", + "example": "10.71C" + }, + "secteurActivite": { + "type": "string", + "description": "Division NAF (comprend les deux premiers chiffre du code NAF)", + "example": "10" + }, + "secteurActiviteLibelle": { + "type": "string", + "description": "Secteur d’activitĂ© de l’offre", + "example": "Boulangerie et boulangerie-pĂątisserie" + }, + "qualitesProfessionnelles": { + "type": "array", + "description": "QualitĂ©s professionnelles", + "items": { + "$ref": "#/components/schemas/QualitePro" + } + }, + "trancheEffectifEtab": { + "type": "string", + "description": "LibellĂ© de la tranche d'effectif de l'Ă©tablissement", + "example": "1 Ă  5 employĂ©s" + }, + "origineOffre": { + "$ref": "#/components/schemas/OrigineOffre" + }, + "offresManqueCandidats": { + "type": "boolean", + "description": "Vrai si c'est une offre difficile Ă  pourvoir", + "example": true + }, + "contexteTravail": { + "$ref": "#/components/schemas/ContexteTravail" + } + } + }, + "OrigineOffre": { + "type": "object", + "properties": { + "origine": { + "type": "string", + "description": "Origine de l’offre. 1 : France Tavail, 2 - Partenaire", + "example": "2" + }, + "urlOrigine": { + "type": "string", + "description": "URL de l’offre sur les sites des partenaires", + "example": "https://partenaire-offre.net/boulanger-austral-46841" + }, + "partenaires": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PartenaireOffre" + } + } + }, + "description": "Origine de l'offre" + }, + "PartenaireOffre": { + "type": "object", + "properties": { + "nom": { + "type": "string", + "description": "Nom du partenaire", + "example": "PARTENAIRE1" + }, + "url": { + "type": "string", + "description": "URL de l’offre sur les sites des partenaires", + "example": "https://partenaire-offre.net/boulanger-austral-46841" + }, + "logo": { + "type": "string", + "description": "URL du logo sur les sites des partenaires", + "example": "https://partenaire-offre.net/logo.png" + } + } + }, + "Permis": { + "type": "object", + "properties": { + "libelle": { + "type": "string", + "description": "Permis souhaitĂ©", + "example": "B - VĂ©hicule lĂ©ger" + }, + "exigence": { + "type": "string", + "description": "E : le permis est exigĂ©, S : le permis est souhaitĂ©", + "example": "S" + } + }, + "description": "Permis" + }, + "QualitePro": { + "type": "object", + "properties": { + "libelle": { + "type": "string", + "description": "LibellĂ© de la qualitĂ© professionnelle demandĂ©e", + "example": "Faire preuve d'autonomie" + }, + "description": { + "type": "string", + "description": "Description de la qualitĂ© professionnelle demandĂ©e", + "example": "CapacitĂ© Ă  prendre en charge son activitĂ© sans devoir ĂȘtre encadrĂ© de façon continue." + } + }, + "description": "QualitĂ©s professionnelles" + }, + "ResultatRecherche": { + "type": "object", + "properties": { + "resultats": { + "type": "array", + "description": "Liste des offres retournĂ©es", + "items": { + "$ref": "#/components/schemas/Offre" + } + }, + "filtresPossibles": { + "type": "array", + "description": "Liste des filtres supplĂ©mentaires possibles", + "items": { + "$ref": "#/components/schemas/FiltrePossible" + } + } + } + }, + "Salaire": { + "type": "object", + "properties": { + "libelle": { + "type": "string", + "description": "LibellĂ© du salaire", + "example": "Mensuel de 1923.00 Euros sur 12 mois" + }, + "commentaire": { + "type": "string", + "description": "Commentaire sur le salaire", + "example": "Selon expĂ©rience" + }, + "complement1": { + "type": "string", + "description": "ComplĂ©ment 1 de rĂ©munĂ©ration (prime, vĂ©hicule, ...)", + "example": "VĂ©hicule de fonction" + }, + "complement2": { + "type": "string", + "description": "ComplĂ©ment 2 de rĂ©munĂ©ration (prime, vĂ©hicule, ...)", + "example": "Prime de vacances" + } + }, + "description": "Salaire" + }, + "Referentiel": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code du rĂ©fĂ©rentiel", + "example": "01" + }, + "libelle": { + "type": "string", + "description": "LibellĂ© associĂ© au code", + "example": "LibellĂ©" + } + } + }, + "Commune": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code INSEE de la commune", + "example": "21704" + }, + "libelle": { + "type": "string", + "description": "Nom de la commune", + "example": "VILLIERS LE DUC" + }, + "codePostal": { + "type": "string", + "description": "Code postal de la commune", + "example": "21400" + }, + "codeDepartement": { + "type": "string", + "description": "Code du dĂ©partement de la commune", + "example": "21" + } + } + }, + "Departement": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code du dĂ©partement", + "example": "01" + }, + "libelle": { + "type": "string", + "description": "Nom du dĂ©partement", + "example": "Ain" + }, + "region": { + "$ref": "#/components/schemas/Region" + } + } + }, + "Region": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Code de la rĂ©gion", + "example": "84" + }, + "libelle": { + "type": "string", + "description": "Nom de la rĂ©gion", + "example": "Auvergne-RhĂŽne-Alpes" + } + } + } + }, + "securitySchemes": { + "authentification": { + "type": "oauth2", + "flows": { + "clientCredentials": { + "tokenUrl": "https://entreprise.francetravail.fr/connexion/oauth2/access_token", + "scopes": { + "o2dsoffre": "Obligatoire" + } + } + } + } + } + } +} \ No newline at end of file