La Poste Groupe JDD / Métadonnées API

openapi: 3.2.0
info:
  title: Data Fair JDD / Métadonnées API
  description: 'Cette documentation interactive à destination des développeurs permet de gérer les ressources de ce service de publication de données et de consommer les opérations applicables aux jeux de données (toutes variantes confondues : fichier, éditable, virtuel, métadonnées seules, master data), incluant les opérations privées et d''administration.'
  version: 6.17.2
  x-api-id: data-fair
  termsOfService: https://koumoul.com/pages/conditions-generales-dutilisation
  contact:
    name: Koumoul
    url: https://koumoul.com
    email: support@koumoul.com
servers:
- url: https://data.laposte.fr/data-fair/api/v1
  description: Instance Data Fair - data.laposte.fr
security:
- apiKey: []
- sdCookie: []
tags:
- name: JDD / Métadonnées
paths:
  /datasets/{id}:
    parameters:
    - in: path
      name: id
      description: Identifiant du jeu de données. L'identifiant de publication (`slug`) fonctionne aussi lorsque l'API est appelée depuis un portail.
      required: true
      schema:
        type: string
        title: Identifiant du jeu de données
    put:
      summary: Créer ou mettre à jour un jeu de données
      description: Créer ou mettre à jour un jeu de données en spécifiant son identifiant.
      operationId: putDataset
      tags:
      - JDD / Métadonnées
      requestBody:
        description: Fichier à charger et autres informations.
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/datasetPost'
      responses:
        '200':
          description: Jeu de données modifié.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataset'
        '201':
          description: Jeu de données créé.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataset'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '413':
          description: Quota de stockage dépassé ou fichier trop volumineux.
          content:
            text/plain:
              schema:
                type: string
    get:
      summary: Lire les informations
      description: Récupérer les informations du jeu de données.
      operationId: readDescription
      x-permissionClass: read
      tags:
      - JDD / Métadonnées
      responses:
        '200':
          description: Les informations du jeu de données.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dataset'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      summary: Modifier le jeu de données
      description: Mettre à jour les informations du jeu de données.
      operationId: writeDescription
      x-permissionClass: write
      tags:
      - JDD / Métadonnées
      requestBody:
        description: Les informations à modifier sur le jeu de données.
        required: true
        content:
          application/json:
            schema:
              x-exports:
              - types
              - resolvedSchema
              title: Dataset patch
              type: object
              additionalProperties: false
              properties:
                slug:
                  anyOf:
                  - type: string
                    description: Identifier of the dataset, usually a slug for URL readability (unique inside the tenant)
                    pattern: ^[a-z0-9]{1}[a-z0-9_\-]*[a-z0-9]{1}$
                  - type: 'null'
                title:
                  type: string
                  description: Short title of the dataset
                summary:
                  anyOf:
                  - type: string
                    description: Short description of the dataset
                  - type: 'null'
                description:
                  anyOf:
                  - type: string
                    description: Detailed description of the dataset
                  - type: 'null'
                image:
                  anyOf:
                  - type: string
                    description: URL d'une image, illustration du jeu de données
                  - type: 'null'
                spatial:
                  anyOf:
                  - type: string
                    description: spatial coverage
                  - type: 'null'
                temporal:
                  anyOf:
                  - type: object
                    description: temporal coverage
                    properties:
                      start:
                        type: string
                        format: date
                      end:
                        type: string
                        format: date
                  - type: 'null'
                keywords:
                  anyOf:
                  - type: array
                    description: keywords
                    items:
                      type: string
                  - type: 'null'
                frequency:
                  anyOf:
                  - type: string
                    description: update frequency
                    enum:
                    - ''
                    - triennial
                    - biennial
                    - annual
                    - semiannual
                    - threeTimesAYear
                    - quarterly
                    - bimonthly
                    - monthly
                    - semimonthly
                    - biweekly
                    - threeTimesAMonth
                    - weekly
                    - semiweekly
                    - threeTimesAWeek
                    - daily
                    - continuous
                    - irregular
                  - type: 'null'
                creator:
                  anyOf:
                  - type: string
                  - type: 'null'
                modified:
                  anyOf:
                  - type: string
                    format: date
                  - type: 'null'
                attachments:
                  anyOf:
                  - type: array
                    items:
                      type: object
                      required:
                      - title
                      properties:
                        title:
                          type: string
                          title: Titre
                          layout:
                            props:
                              outlined: true
                              dense: true
                        description:
                          type: string
                          title: Description
                          layout: markdown
                        includeInCatalogPublications:
                          type: boolean
                          title: Inclure dans les publications sur catalogue
                          default: false
                      oneOf:
                      - title: Fichier
                        required:
                        - name
                        properties:
                          type:
                            title: Type de pièce jointe
                            const: file
                          name:
                            layout: none
                            type: string
                            description: Name of the file that was used to create or update this attachment
                          size:
                            layout: none
                            type: number
                            description: Size of the file on disk
                          mimetype:
                            layout: none
                            type: string
                            description: Mime type of the file
                          updatedAt:
                            layout: none
                            type: string
                            description: Date of the last update for this attachment
                            format: date-time
                          url:
                            layout: none
                            readOnly: true
                            type: string
                            title: URL
                      - title: Lien
                        required:
                        - url
                        properties:
                          type:
                            title: Type de pièce jointe
                            const: url
                          url:
                            type: string
                            title: URL
                      - title: Fichier récupéré depuis une URL
                        required:
                        - name
                        properties:
                          type:
                            title: Type de pièce jointe
                            const: remoteFile
                          name:
                            type: string
                            title: Nom du fichier
                            description: Ce nom doit contenir l'extension qui doit correspondre au format du fichier téléchargé.
                            layout:
                              rules:
                              - hasExtension
                          targetUrl:
                            type: string
                            title: URL de téléchargement
                            description: Cette URL n'est pas consultable après écriture. Elle est utilisée pour télécharger le fichier depuis un service distant et peut contenir un secret. Vous pouvez la laisser vide quand vous modifiez les autres informations, mais vous devez la renseigner de nouveau si vous changez le nom de fichier.
                  - type: 'null'
                primaryKey:
                  anyOf:
                  - type: array
                    description: List of properties of the schema used as unique primary key for each line
                    items:
                      type: string
                  - type: 'null'
                schema:
                  anyOf:
                  - type: array
                    description: JSON schema properties of the fields
                    items:
                      type: object
                      required:
                      - key
                      properties:
                        key:
                          type: string
                          readOnly: true
                          layout: none
                        type:
                          type: string
                        format:
                          type:
                          - string
                          - 'null'
                        x-originalName:
                          type:
                          - string
                          - 'null'
                        title:
                          type: string
                        description:
                          type: string
                        icon:
                          type: string
                        x-group:
                          type: string
                        x-refersTo:
                          deprecated: true
                          type:
                          - string
                          - 'null'
                        x-concept:
                          type: object
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                            primary:
                              type: boolean
                        x-calculated:
                          type: boolean
                        x-capabilities:
                          type: object
                          properties:
                            index:
                              type: boolean
                              default: true
                              layout: switch
                              title: Filtrable sur valeur exacte
                              description: Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels des filtres sur valeurs exactes ont peu de sens.
                            values:
                              type: boolean
                              default: true
                              layout: switch
                              title: Triable et groupable
                              description: Désactivez cette capacité si la donnée contient par exemple des textes longs pour lesquels trier ou grouper par valeur a peu de sens.
                            textStandard:
                              type: boolean
                              default: true
                              layout: switch
                              title: Texte analysé pour recherche textuelle
                              description: Désactivez cette capacité dans le cas d'un code, une url, etc. N'importe quel contenu sur lequel la recherche de mots a peu de sens.
                            text:
                              type: boolean
                              default: true
                              layout: switch
                              title: Texte analysé spécifiquement pour la langue française
                              description: Désactivez cette capacité pour tout contenu qui n'est pas en langue française ou pour lequel la recherche de mots a peu de sens.
                            textAgg:
                              type: boolean
                              default: false
                              layout: switch
                              title: Statistiques de mots
                              description: Activez cette capacité si avez l'intention d'obtenir des statistiques sur les occurrences de mots (par exemple pour construire un nuage de mot).
                            wildcard:
                              type: boolean
                              default: false
                              layout: switch
                              title: Texte filtrable sur groupe de caractères
                              description: Activez cette capacité si vous avez l'intention de filtrer ce contenu spécifiquement sur une suite de caractères (par exemple si un filtre sur mots entiers ou sur valeur exacte ne convient pas).
                            insensitive:
                              type: boolean
                              default: true
                              layout: switch
                              title: Tri amélioré avec casse et accents
                              description: Désactivez cette capacité si le contenu ne sera pas utilisé pour du tri ou bien si il ne contient pas de variations avec accents et majuscules.
                            geoShape:
                              type: boolean
                              default: true
                              layout: switch
                              title: Formes géométriques complexes
                              description: Désactivez cette capacité si la donnée ne contient que des géométries basiques de points ou bien si requêter les géométries uniquement à partir de leurs centroïdes est suffisant pour vos besoins.
                            vtPrepare:
                              type: boolean
                              default: false
                              layout: switch
                              title: Tuiles vectorielles préparées
                              description: Activez cette capacité pour précalculer des éléments utiles à la construction de tuiles vectorielles pour le rendu cartographique du jeu de données. Activez cette option si le jeu de données contient des données géogreaphiques denses à afficher en grande quantité. La contre-partie est une augmentation du temps d'indexation et du volume de données indexées.
                            indexAttachment:
                              type: boolean
                              default: true
                              layout: switch
                              title: Contenu des pièces jointes analysé pour recherche textuelle
                              description: Désactivez cette option si vous souhaitez que les pièces jointes soient simplement téléchargeables et que l'extraction de leur contenu textuel pour recherche de mots n'est pas pertinente.
                        x-labels:
                          type: object
                          patternProperties:
                            .*:
                              type: string
                        x-labelsRestricted:
                          type: boolean
                        readOnly:
                          type: boolean
                        x-required:
                          type: boolean
                        minLength:
                          type: integer
                        maxLength:
                          type: integer
                        minimum:
                          type: number
                        maximum:
                          type: number
                        pattern:
                          type: string
                          format: regex
                        patternErrorMessage:
                          type: string
                        x-master:
                          type: object
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                            remoteService:
                              type: string
                              description: L'identifiant du service distant utilisé pour l'enrichissement
                            action:
                              type: string
                              description: L'identifiant de l'action du service distant à utiliser pour l'enrichissement
                        x-display:
                          type: string
                        enum:
                          type: array
                          readOnly: true
                          description: This differs from JSON schema. It is not a restriction, just and observation of the values that are present in the dataset.
                        x-cardinality:
                          type: integer
                          description: The number of distinct values for this field
                          readOnly: true
                        x-transform:
                          type: object
                          description: Transformation to apply to the field
                          properties:
                            expr:
                              type: string
                            examples:
                              type: array
                              items:
                                type: string
                            type:
                              type: string
                            format:
                              type: string
                  - type: 'null'
                projection:
                  anyOf:
                  - type: object
                    description: The cartographic projection of this dataset. Refers to the list of supported projections in contract/projections.json
                    properties:
                      title:
                        type: string
                      code:
                        type: string
                  - type: 'null'
                conformsTo:
                  anyOf:
                  - type: object
                    description: Reference to an external schema or standard the dataset conforms to.
                    additionalProperties: false
                    properties:
                      title:
                        type: string
                        description: Short title of the schema / standard.
                      version:
                        type: string
                        description: Version of the schema / standard.
                      url:
                        type: string
                        description: URL of the schema / standard specification.
                  - type: 'null'
                license:
                  anyOf:
                  - type: object
                    additionalProperties: false
                    required:
                    - title
                    - href
                    properties:
                      title:
                        type: string
                        description: Short title for the license
                      href:
                        type: string
                        description: The URL where the license can be read
                  - type: 'null'
                origin:
                  anyOf:
                  - type: string
                    description: The URL where the original data can be found
                  - type: 'null'
                constraints:
                  anyOf:
                  - type: array
                    title: Contraintes d'unicité
                    description: Contraintes de validation à l'échelle du jeu de données, au delà des validations par colonne.
                    items:
                      type: object
                      title: Contrainte
                      oneOf:
                      - required:
                        - type
                        - properties
                        title: Unicité
                        properties:
                          type:
                            type: string
                            const: unique
                          properties:
                            type: array
                            title: Colonnes
                            description: La combinaison des valeurs de ces colonnes doit être unique sur chaque ligne du jeu de données.
                            items:
                              type: string
                  - type: 'null'
                extensions:
                  anyOf:
                  - type: array
                    description: Définition des enrichissements appliqués à ce jeu de données
                    items:
                      type: object
                      properties:
                        active:
                          type: boolean
                          description: Toggle on and off the extension
                        needsUpdate:
                          type: boolean
                        autoUpdate:
                          type: boolean
                        nextUpdate:
                          type: string
                          format: date-time
                      oneOf:
                      - required:
                        - type
                        - expr
                        - property
                        properties:
                          type:
                            type: string
                            const: exprEval
                          expr:
                            type: string
                          property:
                            type: object
                            required:
                            - key
                            - type
                            properties:
                              key:
                                type: string
                              type:
                                type: string
                      - required:
                        - type
                        - remoteService
                        - action
                        properties:
                          type:
                            type: string
                            const: remoteService
                          remoteService:
                            type: string
                            description: L'identifiant du service distant utilisé pour l'enrichissement
                          action:
                            type: string
                            description: L'identifiant de l'action du service distant à utiliser pour l'enrichissement
                          select:
                            type: array
                            description: La liste des colonnes à sélectionner dans le retour du service distant. Toutes les colonnes si absent ou vide.
                            items:
                              type: string
                          overwriteProperties:
                            type: object
                            description: Les attributs à surcharger sur les proprités résultats de l'enrichissement
                            additionalProperties:
                              type: object
                              properties:
                                title:
                                  type: string
                                x-originalName:
                                  type: string
                          shortId:
                            type: string
                            description: Id court (déprécié)
                            readOnly: true
                          propertyPrefix:
                            type: string
                            description: Chaine à utiliser comme préfixe des clés de champs issus de cette extension
                          mandatory:
                            type: boolean
                            description: Si vrai, un échec d'enrichissement sur une ligne est traité comme une erreur de validation bloquante.
                  - type: 'null'
                masterData:
                  anyOf:
                  - type: object
                    title: Données de référence
                    layout:
                      title: null
                    properties:
                      shareOrgs:
                        type: array
                        title: Partagez cette donnée de référence avec vos partenaires
                        description: Le partage à des partenaires affecte simplement la visibilité des actions liées à ces données de référence. Il est sans effet sur les permissions que vous devez définir séparément.
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                        layout:
                          if:
                            type: js-eval
                            expr: context.ownerOrg
                            pure: true
                          props:
                            noDataText: Vous n'avez pas encore de partenaires configurés pour votre organisation.
                          getItems:
                            url:
                              type: js-tpl
                              expr: ${context.directoryUrl}/api/${context.dataset.owner.type}s/${context.dataset.owner.id}
                              pure: true
                            itemKey: data["id"]
                            itemTitle: data["name"]
                            itemsResults: data["partners"]
                      bulkSearchs:
                        type: array
                        title: Récupération de lignes en masse
                        description: Permettez à vos utilisateurs de récupérer un grand nombre de lignes à partir d'une règle de correspondance simple. Cette fonctionnalité permet de créer une nouvelle source d'enrichissement.
                        items:
                          type: object
                          required:
                          - title
                          properties:
                            id:
                              type: string
                              title: Identifiant
                              readOnly: true
                              layout:
                                if:
                                  type: js-eval
                                  expr: parent.data.id
                                  pure: false
                            title:
                              type: string
                              title: Titre
                              minLength: 3
                              layout:
                                props:
                                  placeholder: Exemple "Récupérer les informations de plusieurs produits"
                            description:
                              type: string
                              title: Description
                              layout:
                                comp: textarea
                                props:
                                  placeholder: Exemple "Cet enrichissement vous permet de récupérer les informations de plusieurs produits à partir d'une liste de codes produits."
                            filters:
                              type: array
                              title: Filtres statiques
                              items:
                                type: object
                                required:
                                - property
                                - values
                                properties:
                                  property:
                                    type: object
                                    title: Propriété sur laquelle appliquer le filtre
                                    layout:
                                      getItems:
                                        type: js-eval
                                        expr: context.filterProperties
                                        pure: true
                                        itemKey: data["key"]
                                        itemTitle: data["title"]
                                  values:
                                    type: array
                                    title: Valeurs
                                    items:
                                      type: string
                            input:
                              type: array
                              title: Méthodes de correspondance
                              minItems: 1
                              items:
                                type: object
                                required:
                                - type
                                - property
                                oneOf:
                                - title: Valeurs exactement égales
                                  required:
                                  - type
                                  - property
                                  properties:
                                    type:
                                      type: string
                                      const: equals
                                      title: Type de méthode de correspondance
                                    property:
                                      type: object
                                      title: Propriété comparée
                                      layout:
                                        props:
                                          noDataText: Aucune colonne de ce jeu de données n'a de concept associé. Définissez des concepts dans l'onglet Schéma.
                                        getItems:
                                          type: js-eval
                                          expr: context.propertiesWithConcepts
                                          pure: true
                                          itemKey: data["key"]
                                          itemTitle: data["title"]
                                - title: Date dans un intervalle
                                  required:
                                  - type
 

# --- truncated at 32 KB (250 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/la-poste-groupe/refs/heads/main/openapi/la-poste-groupe-jdd-m-tadonn-es-api-openapi.yml