{"openapi":"3.1.0","info":{"title":"API Data Fair","description":"\nCette 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.\n\nLes opérations réellement exposées pour un jeu de données particulier dépendent de son type et de sa configuration. Pour un jeu de données précis, sa propre documentation reste accessible via `/datasets/{id}/api-docs.json` (publique) ou `/datasets/{id}/private-api-docs.json` (privée).\n\nLes opérations spécifiques à une application particulière (configuration, journal, pièces jointes, etc.) ainsi que les services distants disposent chacune de leur propre documentation séparée.\n\nPour utiliser cette API dans un programme vous aurez besoin d'une clé que vous pouvez créer dans vos paramètres personnels ou dans les paramètres d'une organisation dont vous êtes administrateur.\n\nPour des exemples simples de publication de données vous pouvez consulter la documentation sur ce sujet.\n","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"}],"components":{"schemas":{"dataset":{"x-exports":["types","resolvedSchema"],"title":"Dataset","type":"object","additionalProperties":false,"required":["id","createdAt","owner","title"],"properties":{"id":{"type":"string","description":"Globally unique identifier of the dataset","pattern":"^[a-z0-9_\\-]+$"},"slug":{"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}$"},"href":{"type":"string","description":"Readonly field. The URL where this resource can be fetched"},"page":{"type":"string","description":"Readonly field. The URL where this resource can be viewed in the UI"},"title":{"type":"string","description":"Short title of the dataset"},"summary":{"type":"string","description":"Short description of the dataset"},"description":{"type":"string","description":"Detailed description of the dataset"},"image":{"type":"string","description":"URL d'une image, illustration du jeu de données"},"spatial":{"type":"string","description":"spatial coverage"},"temporal":{"type":"object","description":"temporal coverage","properties":{"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"}}},"keywords":{"type":"array","description":"keywords","items":{"type":"string"}},"frequency":{"type":"string","description":"update frequency","enum":["","triennial","biennial","annual","semiannual","threeTimesAYear","quarterly","bimonthly","monthly","semimonthly","biweekly","threeTimesAMonth","weekly","semiweekly","threeTimesAWeek","daily","continuous","irregular"]},"creator":{"type":"string"},"modified":{"type":"string","format":"date"},"visibility":{"type":"string","enum":["public","protected","private"]},"file":{"type":"object","additionalProperties":false,"required":["name","size","mimetype","schema"],"properties":{"name":{"type":"string","description":"Name of the file that was used to create or update this dataset"},"size":{"type":"number","description":"Size of the file on disk"},"encoding":{"type":"string","description":"Encoding of the file (either explicitly defined or detected)"},"explicitEncoding":{"type":"string","description":"Encoding of the file explicitly defined when loading it"},"mimetype":{"type":"string","description":"Mime type of the file"},"schema":{"type":"array","description":"JSON schema properties of the fields in the file","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"separator":{"type":["string","null"]},"dateFormat":{"type":["string","null"]},"dateTimeFormat":{"type":["string","null"]},"timeZone":{"type":["string","null"]}}}},"props":{"type":"object","additionalProperties":false,"properties":{"numLines":{"type":"number","description":"Number of lines this file has."},"linesDelimiter":{"type":"string","description":"New line character or characters (can be \r\n))"},"fieldsDelimiter":{"type":"string","description":"Fields delimiter"},"escapeChar":{"type":"string","description":"Character used to escape string"},"quote":{"type":"string","description":"Character used to wrap strings"}}}}},"originalFile":{"type":"object","additionalProperties":false,"required":["name","size","mimetype"],"properties":{"name":{"type":"string","description":"Name of the file that was used to create or update this dataset"},"size":{"type":"number","description":"Size of the file on disk"},"encoding":{"type":"string","description":"Encoding of the file (either explicitly defined or detected)"},"explicitEncoding":{"type":"string","description":"Encoding of the file explicitly defined when loading it"},"normalizeOptions":{"type":"object","description":"Normalize options specific to the original file format","additionalProperties":false,"properties":{"spreadsheetWorksheetIndex":{"type":"number"},"spreadsheetHeaderLine":{"type":"number"},"spreadsheetStartCol":{"type":"number"}}},"mimetype":{"type":"string","description":"Mime type of the file"},"md5":{"type":"string","description":"MD5 hash of the file content"}}},"attachments":{"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."}}}]}},"storage":{"type":"object","description":"All storage space info of this dataset","properties":{"size":{"type":"integer"},"indexed":{"type":"object","properties":{"size":{"type":"integer"},"parts":{"type":"array","items":{"type":"string","enum":["collection","original-file","normalized-file","full-file","attachments","master-data"]}}}},"attachments":{"type":"object","properties":{"count":{"type":"integer"},"size":{"type":"integer"}}},"metadataAttachments":{"type":"object","properties":{"count":{"type":"integer"},"size":{"type":"integer"}}},"collection":{"type":"object","properties":{"count":{"type":"integer"},"size":{"type":"integer"}}},"revisions":{"type":"object","properties":{"count":{"type":"integer"},"size":{"type":"integer"}}},"masterData":{"type":"object","properties":{"count":{"type":"integer"},"size":{"type":"integer"}}},"dataFiles":{"type":"array","description":"Le tableau de résultats.","items":{"type":"object","properties":{"key":{"type":"string"},"size":{"type":"number"},"name":{"type":"string"},"mimetype":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"title":{"type":"string"},"url":{"type":"string"}}}}}},"createdAt":{"type":"string","description":"Creation date of this dataset","format":"date-time"},"createdBy":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string"}}},"updatedAt":{"type":"string","description":"Date of the last metadata update for this dataset","format":"date-time"},"updatedBy":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string"}}},"dataUpdatedAt":{"type":"string","description":"Date of the last update for this dataset","format":"date-time"},"dataUpdatedBy":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string"}}},"finalizedAt":{"type":"string","description":"Date of the last finalization for this dataset","format":"date-time"},"owner":{"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"],"description":"Indique si le propriétaire est un utilisateur ou une organisation."},"id":{"type":"string","description":"Identifiant unique de l'utilisateur ou de l'organisation."},"name":{"type":"string","description":"Nom affiché de l'utilisateur ou de l'organisation."},"role":{"type":"string","deprecated":true,"description":"DÉPRÉCIÉ - Si cette propriété est renseignée et que le propriétaire est une organisation, restreint la propriété aux utilisateurs de cette organisation ayant ce rôle ou le rôle administrateur."},"department":{"type":"string","description":"Si cette propriété est renseignée et que le propriétaire est une organisation, restreint la propriété aux utilisateurs de cette organisation appartenant à ce département."},"departmentName":{"type":"string","description":"Nom affiché du département."}}},"status":{"type":"string","enum":["draft","created","remote","uploaded","loaded","imported","stored","analyzed","normalized","validated","validation-updated","schematized","indexed","extended","finalized","error"],"description":"The processing steps of a dataset."},"errorStatus":{"type":"string","enum":["draft","created","remote","uploaded","loaded","imported","stored","analyzed","normalized","validated","validation-updated","schematized","indexed","extended","finalized","error"],"description":"The processing step the dataset was in when it encountered an error."},"errorRetry":{"type":"string","format":"date-time","description":"If defined the task that triggered an error will be retried after a delay."},"integrity":{"type":"object","readOnly":true,"description":"Tamper-detection state for the dataset (file + metadata classes), managed by the integrity checker. Only present in responses to the owner account admins and superadmins.","required":["active"],"properties":{"active":{"type":"boolean"},"file":{"type":"object","properties":{"lastCheck":{"type":"object","required":["date","status"],"properties":{"date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["ok","breach","unknown"]}}},"lastRevision":{"type":"object","required":["i","hash","date"],"properties":{"i":{"type":"number"},"hash":{"type":"object","properties":{"md5":{"type":"string"},"sha256":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"retainUntil":{"type":"string","format":"date-time"}}},"lastRenewal":{"type":"object","required":["date","status"],"properties":{"date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["ok","failed"]},"retainUntil":{"type":"string","format":"date-time"},"error":{"type":"string"}}}}},"metadata":{"type":"object","properties":{"lastCheck":{"type":"object","required":["date","status"],"properties":{"date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["ok","breach","unknown"]}}},"lastRevision":{"type":"object","required":["i","hash","date"],"properties":{"i":{"type":"number"},"hash":{"type":"object","properties":{"md5":{"type":"string"},"sha256":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"retainUntil":{"type":"string","format":"date-time"}}},"lastRenewal":{"type":"object","required":["date","status"],"properties":{"date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["ok","failed"]},"retainUntil":{"type":"string","format":"date-time"},"error":{"type":"string"}}}}}}},"primaryKey":{"type":"array","description":"List of properties of the schema used as unique primary key for each line","items":{"type":"string"}},"schema":{"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"}}}}}},"count":{"type":"number","description":"The number of indexed documents of a dataset"},"bbox":{"type":"array","description":"The spatial coverage of this dataset, in bounding box format.","items":{"type":"number"}},"timePeriod":{"type":"object","description":"The temporal coverage of this dataset","properties":{"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"}}},"timeZone":{"type":"string","description":"The original time zone of the calendar."},"projection":{"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"}}},"conformsTo":{"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."}}},"license":{"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"}}},"origin":{"type":"string","description":"The URL where the original data can be found"},"constraints":{"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"}}}}]}},"extensions":{"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."}}}]}},"masterData":{"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","property"],"properties":{"type":{"type":"string","const":"date-in-interval"},"property":{"type":"object","title":"Date à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://schema.org/Date"},"key":{"type":"string","const":"_date"},"type":{"type":"string","const":"string"},"format":{"type":"string","const":"date-time"}}}},"layout":{"if":{"type":"js-eval","expr":"context.hasDateIntervalConcepts","pure":true}}},{"title":"Coordonnée géographique à proximité","required":["type","distance"],"properties":{"type":{"type":"string","const":"geo-distance"},"distance":{"type":"integer","title":"Distance","default":0},"property":{"type":"object","title":"Point à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://www.w3.org/2003/01/geo/wgs84_pos#lat_long"},"key":{"type":"string","const":"_geopoint"},"type":{"type":"string","const":"string"}}}},"layout":{"if":{"type":"js-eval","expr":"context.dataset.bbox","pure":true}}}],"oneOfLayout":{"label":"Type de méthode de correspondance"}}},"sort":{"type":"string","title":"Tri pour choisir parmi des résultats ambigus","description":"\nRemarque : ce paramètre est optionnel et utile uniquement si la manière d'établir une correspondance est susceptible de retourner plusieurs résultats par ligne.\n\nLe tri est exprimé sous forme d'une liste de clés de colonnes séparées par des virgules. Par défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple: ma_colonne,-ma_colonne2"}}},"layout":{"itemTitle":"data.title"}},"singleSearchs":{"type":"array","title":"Recherche de paires code / libellé","description":"Permettez à vos utilisateurs de récupérer une liste de résultats à partir d'une recherche textuelle sur une colonne de libellés. Cette fonctionnalité permet de créer des champs de recherche dans les formulaires d'édition de ligne des jeux éditables.","items":{"type":"object","required":["title","output"],"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 \"Recherche d'un produit\""}}},"description":{"type":"string","title":"Description","layout":{"comp":"textarea","props":{"placeholder":"Exemple \"Récupérez un code produit en effectuant une recherche dans son code ou son libellé\""}}},"output":{"type":"object","title":"Propriété à retourner (code)","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\"]"}}},"label":{"type":"object","title":"Propriété affichée lors de la saisie (libellé)","description":"Propriété affichée à côté du code dans la liste des suggestions, sous la forme « code (libellé) », pour aider l'utilisateur à identifier la bonne valeur. La recherche s'effectue sur toutes les colonnes textuelles du jeu de données.","layout":{"props":{"noDataText":"Aucune colonne textuelle dans ce jeu de données."},"getItems":{"type":"js-eval","expr":"context.stringProperties","pure":true,"itemKey":"data[\"key\"]","itemTitle":"data[\"title\"]"}}},"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"}}}}}}},"layout":{"itemTitle":"data.title"}},"virtualDatasets":{"type":"object","description":"Proposez à vos utilisateurs de créer des jeux virtuels à partir de ce jeu de données. C'est une option intéressante pour faciliter la création de vues filtrées de cette donnée.","properties":{"active":{"type":"boolean","title":"Création de jeux virtuels"}}},"standardSchema":{"type":"object","description":"Proposez à vos utilisateurs d'initialiser des jeux éditables à partir des métadonnées et des données de ce jeu de données.","properties":{"active":{"type":"boolean","title":"Initialisation de jeux éditables"}}}}},"publications":{"type":"array","description":"References to all the catalogs the dataset metadata is published too","items":{"type":"object","required":["catalog","status"],"additionalProperties":false,"properties":{"id":{"type":"string"},"catalog":{"type":"string","description":"L'identifiant du catalogue de destination de cette publication."},"status":{"type":"string","description":"Statut indiquant clairement si la publication a réussi. Si \"published\", la propriété targetUrl doit être renseignée. Si \"error\", la propriété error doit être renseignée.","enum":["waiting","published","error","deleted"]},"publishedAt":{"type":"string","description":"Date de la dernière mise à jour de cette publication.","format":"date-time"},"error":{"type":"string"},"targetUrl":{"type":"string"},"result":{"type":"object","description":"Résultat de la publication. La structure de cet objet est libre et dépend du type de catalogue."},"addToDataset":{"type":"object","description":"Fill this object to create a new resource (or community resource) to an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"replaceDataset":{"type":"object","description":"Fill this object to overwrite an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}},"publicationSites":{"type":"array","description":"References to all sites the dataset is exposed in.","items":{"type":"string"}},"requestedPublicationSites":{"type":"array","description":"References to all sites the dataset would be exposed in if validated by an admin.","items":{"type":"string"}},"hasFiles":{"type":"boolean","default":false,"description":"true when the dataset has attached files"},"attachmentsAsImage":{"type":"boolean","default":false,"description":"Set to true to use attached files as illustrations of the line"},"isVirtual":{"type":"boolean","default":false,"description":"Used to identify virtual datasets. A virtual datasets does not have data, only references to other datasets."},"virtual":{"type":"object","description":"A configuration object dedicated to virtual datasets.","required":["children"],"properties":{"children":{"type":"array","description":"Array of ids of the children datasets","items":{"type":"string"}},"filters":{"type":"array","description":"Array of static filters to always apply when querying the dataset","items":{"type":"object","required":["key","values"],"properties":{"key":{"type":"string","description":"Key of the field in the schema"},"operator":{"type":"string","enum":["in","nin"],"default":"in"},"values":{"type":"array","items":{"type":"string"}}}}},"filterActiveAccount":{"type":"boolean"}}},"isRest":{"type":"boolean","default":false,"description":"Used to identify REST datasets. A REST dataset is not created from a data file, but instead is based on a dynamic collection in a database."},"rest":{"type":"object","description":"A configuration object dedicated to REST datasets.","properties":{"ttl":{"type":"object","required":["prop","delay"],"properties":{"active":{"type":"boolean"},"prop":{"type":"string"},"checkedAt":{"type":"string","format":"date-time","readOnly":true},"delay":{"type":"object","properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"history":{"type":"boolean","default":false,"description":"Set to true to let data-fair store revisions of the lines in the dataset."},"historyTTL":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean"},"delay":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"lineOwnership":{"type":"boolean"},"storeUpdatedBy":{"type":"boolean"},"primaryKeyMode":{"type":"string","enum":["base64","sha256"]},"indiceMode":{"type":"string","enum":["timestamp1","timestamp2","timestamp3"]}}},"isMetaOnly":{"type":"boolean","default":false,"description":"Used to identify datasets without any local data and only some metadata."},"topics":{"type":"array","title":"Liste de thématiques","layout":{"itemTitle":"item.title"},"items":{"title":"Topic","x-exports":["types","schema"],"type":"object","required":["title"],"additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","title":"Title","x-i18n-title":{"fr":"Titre"},"layout":{"cols":{"md":5}}},"icon":{"type":"object","title":"Icon","x-i18n-title":{"fr":"Icône"},"description":"Il est possible de consulter plus facilement la liste des icônes disponibles sur ce site .
Commencez à taper pour rechercher dans la collection complète d'icônes. Seuls quelques icônes sont chargées initialement pour de meilleures performances.","x-i18n-description":{"en":"You can easily browse the list of available icons on this this website.
Start typing to search through the complete collection of icons. Only a few icons are loaded initially for better performance."},"layout":{"getItems":{"url":"https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25","itemsResults":"data.results","itemTitle":"item.name","itemIcon":"item.svg","itemKey":"item.name"},"cols":{"md":5,"sm":6}},"required":["name"],"properties":{"name":{"type":"string"},"svg":{"type":"string"},"svgPath":{"type":"string"}}},"color":{"type":"string","title":"Color","x-i18n-title":{"fr":"Couleur"},"layout":{"comp":"color-picker","cols":{"md":2,"sm":6}}}}}},"relatedDatasets":{"type":"array","title":"Autres jeux de données à recommender","items":{"type":"object","additionalProperties":false,"required":["id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"}}}},"thumbnails":{"type":"object","properties":{"resizeMode":{"type":"string","description":"Define how the thumbnails will be adapted to the size requested by visualizations","enum":["crop","smartCrop","fitIn"],"default":"crop"}}},"extras":{"type":"object","description":"An object for extra content from client services of data-fair"},"customMetadata":{"type":"object","patternProperties":{"^(.*)$":{"type":"string"}}},"analysis":{"type":"object","additionalProperties":false,"properties":{"escapeKeyAlgorithm":{"type":"string","default":"slug","enum":["legacy","slug","compat-ods"]}}},"permissions":{"title":"Permissions","x-exports":["types","validate","resolvedSchema"],"type":"array","items":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}},"$defs":{"permission":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}}}},"previews":{"type":"array","title":"Prévisualisations","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"href":{"type":"string"}}}},"readApiKey":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean","title":"Activer l'accès par clé d'API"},"interval":{"type":"string","title":"Durée de validité des clés","oneOf":[{"const":"P1W","title":"1 semaine"},{"const":"P1M","title":"1 mois"},{"const":"P1Y","title":"1 année"}]},"expiresAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"},"renewAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"}}},"esWarning":{"type":["string","null"],"enum":["MissingIndex","IndexHealthRed","MissingIndexSettings","ShardingRecommended","MissingSearchOnWide","MappingNearLimit","ReplicaDrift"]},"draftReason":{"type":"object","title":"Why was the dataset switched in draft mode","properties":{"key":{"type":"string","enum":["manual","file-new","file-updated"]},"message":{"type":"string"},"validationMode":{"type":"string","enum":["never","always","compatible","compatibleOrCancel"]}}},"nonBlockingValidation":{"type":"boolean"},"draft":{"title":"Dataset draft","description":"Some properties waiting for confirmation before being merged into the main dataset info","type":"object","additionalProperties":false,"properties":{"draftReason":{"type":"object","title":"Why was the dataset switched in draft mode","properties":{"key":{"type":"string","enum":["manual","file-new","file-updated"]},"message":{"type":"string"},"validationMode":{"type":"string","enum":["never","always","compatible","compatibleOrCancel"]}}},"validateDraft":{"type":"boolean","title":"indicates that the draft was validated and is being processed to replace the current state"},"file":{"type":"object","additionalProperties":false,"required":["name","size","mimetype","schema"],"properties":{"name":{"type":"string","description":"Name of the file that was used to create or update this dataset"},"size":{"type":"number","description":"Size of the file on disk"},"encoding":{"type":"string","description":"Encoding of the file (either explicitly defined or detected)"},"explicitEncoding":{"type":"string","description":"Encoding of the file explicitly defined when loading it"},"mimetype":{"type":"string","description":"Mime type of the file"},"schema":{"type":"array","description":"JSON schema properties of the fields in the file","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"separator":{"type":["string","null"]},"dateFormat":{"type":["string","null"]},"dateTimeFormat":{"type":["string","null"]},"timeZone":{"type":["string","null"]}}}},"props":{"type":"object","additionalProperties":false,"properties":{"numLines":{"type":"number","description":"Number of lines this file has."},"linesDelimiter":{"type":"string","description":"New line character or characters (can be \r\n))"},"fieldsDelimiter":{"type":"string","description":"Fields delimiter"},"escapeChar":{"type":"string","description":"Character used to escape string"},"quote":{"type":"string","description":"Character used to wrap strings"}}}}},"originalFile":{"type":"object","additionalProperties":false,"required":["name","size","mimetype"],"properties":{"name":{"type":"string","description":"Name of the file that was used to create or update this dataset"},"size":{"type":"number","description":"Size of the file on disk"},"encoding":{"type":"string","description":"Encoding of the file (either explicitly defined or detected)"},"explicitEncoding":{"type":"string","description":"Encoding of the file explicitly defined when loading it"},"normalizeOptions":{"type":"object","description":"Normalize options specific to the original file format","additionalProperties":false,"properties":{"spreadsheetWorksheetIndex":{"type":"number"},"spreadsheetHeaderLine":{"type":"number"},"spreadsheetStartCol":{"type":"number"}}},"mimetype":{"type":"string","description":"Mime type of the file"},"md5":{"type":"string","description":"MD5 hash of the file content"}}},"schema":{"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"}}}}}},"description":{"type":"string","description":"Detailed description of the dataset"},"title":{"type":"string","description":"Short title of the dataset"},"license":{"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"}}},"origin":{"type":"string","description":"The URL where the original data can be found"},"estensions":{"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."}}}]}},"publications":{"type":"array","description":"References to all the catalogs the dataset metadata is published too","items":{"type":"object","required":["catalog","status"],"additionalProperties":false,"properties":{"id":{"type":"string"},"catalog":{"type":"string","description":"L'identifiant du catalogue de destination de cette publication."},"status":{"type":"string","description":"Statut indiquant clairement si la publication a réussi. Si \"published\", la propriété targetUrl doit être renseignée. Si \"error\", la propriété error doit être renseignée.","enum":["waiting","published","error","deleted"]},"publishedAt":{"type":"string","description":"Date de la dernière mise à jour de cette publication.","format":"date-time"},"error":{"type":"string"},"targetUrl":{"type":"string"},"result":{"type":"object","description":"Résultat de la publication. La structure de cet objet est libre et dépend du type de catalogue."},"addToDataset":{"type":"object","description":"Fill this object to create a new resource (or community resource) to an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"replaceDataset":{"type":"object","description":"Fill this object to overwrite an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}},"publicationSites":{"type":"array","description":"References to all sites the dataset is exposed in.","items":{"type":"string"}},"virtual":{"type":"object","description":"A configuration object dedicated to virtual datasets.","required":["children"],"properties":{"children":{"type":"array","description":"Array of ids of the children datasets","items":{"type":"string"}},"filters":{"type":"array","description":"Array of static filters to always apply when querying the dataset","items":{"type":"object","required":["key","values"],"properties":{"key":{"type":"string","description":"Key of the field in the schema"},"operator":{"type":"string","enum":["in","nin"],"default":"in"},"values":{"type":"array","items":{"type":"string"}}}}},"filterActiveAccount":{"type":"boolean"}}},"rest":{"type":"object","description":"A configuration object dedicated to REST datasets.","properties":{"ttl":{"type":"object","required":["prop","delay"],"properties":{"active":{"type":"boolean"},"prop":{"type":"string"},"checkedAt":{"type":"string","format":"date-time","readOnly":true},"delay":{"type":"object","properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"history":{"type":"boolean","default":false,"description":"Set to true to let data-fair store revisions of the lines in the dataset."},"historyTTL":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean"},"delay":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"lineOwnership":{"type":"boolean"},"storeUpdatedBy":{"type":"boolean"},"primaryKeyMode":{"type":"string","enum":["base64","sha256"]},"indiceMode":{"type":"string","enum":["timestamp1","timestamp2","timestamp3"]}}},"extras":{"type":"object","description":"An object for extra content from client services of data-fair"},"attachmentsAsImage":{"type":"boolean","default":false,"description":"Set to true to use attached files as illustrations of the line"},"projection":{"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"}}},"attachments":{"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."}}}]}},"topics":{"type":"array","title":"Liste de thématiques","layout":{"itemTitle":"item.title"},"items":{"title":"Topic","x-exports":["types","schema"],"type":"object","required":["title"],"additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","title":"Title","x-i18n-title":{"fr":"Titre"},"layout":{"cols":{"md":5}}},"icon":{"type":"object","title":"Icon","x-i18n-title":{"fr":"Icône"},"description":"Il est possible de consulter plus facilement la liste des icônes disponibles sur ce site .
Commencez à taper pour rechercher dans la collection complète d'icônes. Seuls quelques icônes sont chargées initialement pour de meilleures performances.","x-i18n-description":{"en":"You can easily browse the list of available icons on this this website.
Start typing to search through the complete collection of icons. Only a few icons are loaded initially for better performance."},"layout":{"getItems":{"url":"https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25","itemsResults":"data.results","itemTitle":"item.name","itemIcon":"item.svg","itemKey":"item.name"},"cols":{"md":5,"sm":6}},"required":["name"],"properties":{"name":{"type":"string"},"svg":{"type":"string"},"svgPath":{"type":"string"}}},"color":{"type":"string","title":"Color","x-i18n-title":{"fr":"Couleur"},"layout":{"comp":"color-picker","cols":{"md":2,"sm":6}}}}}},"thumbnails":{"type":"object","properties":{"resizeMode":{"type":"string","description":"Define how the thumbnails will be adapted to the size requested by visualizations","enum":["crop","smartCrop","fitIn"],"default":"crop"}}},"masterData":{"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","property"],"properties":{"type":{"type":"string","const":"date-in-interval"},"property":{"type":"object","title":"Date à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://schema.org/Date"},"key":{"type":"string","const":"_date"},"type":{"type":"string","const":"string"},"format":{"type":"string","const":"date-time"}}}},"layout":{"if":{"type":"js-eval","expr":"context.hasDateIntervalConcepts","pure":true}}},{"title":"Coordonnée géographique à proximité","required":["type","distance"],"properties":{"type":{"type":"string","const":"geo-distance"},"distance":{"type":"integer","title":"Distance","default":0},"property":{"type":"object","title":"Point à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://www.w3.org/2003/01/geo/wgs84_pos#lat_long"},"key":{"type":"string","const":"_geopoint"},"type":{"type":"string","const":"string"}}}},"layout":{"if":{"type":"js-eval","expr":"context.dataset.bbox","pure":true}}}],"oneOfLayout":{"label":"Type de méthode de correspondance"}}},"sort":{"type":"string","title":"Tri pour choisir parmi des résultats ambigus","description":"\nRemarque : ce paramètre est optionnel et utile uniquement si la manière d'établir une correspondance est susceptible de retourner plusieurs résultats par ligne.\n\nLe tri est exprimé sous forme d'une liste de clés de colonnes séparées par des virgules. Par défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple: ma_colonne,-ma_colonne2"}}},"layout":{"itemTitle":"data.title"}},"singleSearchs":{"type":"array","title":"Recherche de paires code / libellé","description":"Permettez à vos utilisateurs de récupérer une liste de résultats à partir d'une recherche textuelle sur une colonne de libellés. Cette fonctionnalité permet de créer des champs de recherche dans les formulaires d'édition de ligne des jeux éditables.","items":{"type":"object","required":["title","output"],"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 \"Recherche d'un produit\""}}},"description":{"type":"string","title":"Description","layout":{"comp":"textarea","props":{"placeholder":"Exemple \"Récupérez un code produit en effectuant une recherche dans son code ou son libellé\""}}},"output":{"type":"object","title":"Propriété à retourner (code)","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\"]"}}},"label":{"type":"object","title":"Propriété affichée lors de la saisie (libellé)","description":"Propriété affichée à côté du code dans la liste des suggestions, sous la forme « code (libellé) », pour aider l'utilisateur à identifier la bonne valeur. La recherche s'effectue sur toutes les colonnes textuelles du jeu de données.","layout":{"props":{"noDataText":"Aucune colonne textuelle dans ce jeu de données."},"getItems":{"type":"js-eval","expr":"context.stringProperties","pure":true,"itemKey":"data[\"key\"]","itemTitle":"data[\"title\"]"}}},"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"}}}}}}},"layout":{"itemTitle":"data.title"}},"virtualDatasets":{"type":"object","description":"Proposez à vos utilisateurs de créer des jeux virtuels à partir de ce jeu de données. C'est une option intéressante pour faciliter la création de vues filtrées de cette donnée.","properties":{"active":{"type":"boolean","title":"Création de jeux virtuels"}}},"standardSchema":{"type":"object","description":"Proposez à vos utilisateurs d'initialiser des jeux éditables à partir des métadonnées et des données de ce jeu de données.","properties":{"active":{"type":"boolean","title":"Initialisation de jeux éditables"}}}}},"primaryKey":{"type":"array","description":"List of properties of the schema used as unique primary key for each line","items":{"type":"string"}},"image":{"type":"string","description":"URL d'une image, illustration du jeu de données"},"spatial":{"type":"string","description":"spatial coverage"},"temporal":{"type":"object","description":"temporal coverage","properties":{"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"}}},"keywords":{"type":"array","description":"keywords","items":{"type":"string"}},"frequency":{"type":"string","description":"update frequency","enum":["","triennial","biennial","annual","semiannual","threeTimesAYear","quarterly","bimonthly","monthly","semimonthly","biweekly","threeTimesAMonth","weekly","semiweekly","threeTimesAWeek","daily","continuous","irregular"]},"customMetadata":{"type":"object","patternProperties":{"^(.*)$":{"type":"string"}}}}}},"$id":"https://github.com/data-fair/data-fair/dataset-resolved","$defs":{"integrityClassState":{"type":"object","properties":{"lastCheck":{"type":"object","required":["date","status"],"properties":{"date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["ok","breach","unknown"]}}},"lastRevision":{"type":"object","required":["i","hash","date"],"properties":{"i":{"type":"number"},"hash":{"type":"object","properties":{"md5":{"type":"string"},"sha256":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"retainUntil":{"type":"string","format":"date-time"}}},"lastRenewal":{"type":"object","required":["date","status"],"properties":{"date":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["ok","failed"]},"retainUntil":{"type":"string","format":"date-time"},"error":{"type":"string"}}}}},"normalizeOptions":{"type":"object","description":"Normalize options specific to the original file format","additionalProperties":false,"properties":{"spreadsheetWorksheetIndex":{"type":"number"},"spreadsheetHeaderLine":{"type":"number"},"spreadsheetStartCol":{"type":"number"}}},"schemaProperty":{"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"}}}}}}},"datasetPatch":{"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","property"],"properties":{"type":{"type":"string","const":"date-in-interval"},"property":{"type":"object","title":"Date à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://schema.org/Date"},"key":{"type":"string","const":"_date"},"type":{"type":"string","const":"string"},"format":{"type":"string","const":"date-time"}}}},"layout":{"if":{"type":"js-eval","expr":"context.hasDateIntervalConcepts","pure":true}}},{"title":"Coordonnée géographique à proximité","required":["type","distance"],"properties":{"type":{"type":"string","const":"geo-distance"},"distance":{"type":"integer","title":"Distance","default":0},"property":{"type":"object","title":"Point à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://www.w3.org/2003/01/geo/wgs84_pos#lat_long"},"key":{"type":"string","const":"_geopoint"},"type":{"type":"string","const":"string"}}}},"layout":{"if":{"type":"js-eval","expr":"context.dataset.bbox","pure":true}}}],"oneOfLayout":{"label":"Type de méthode de correspondance"}}},"sort":{"type":"string","title":"Tri pour choisir parmi des résultats ambigus","description":"\nRemarque : ce paramètre est optionnel et utile uniquement si la manière d'établir une correspondance est susceptible de retourner plusieurs résultats par ligne.\n\nLe tri est exprimé sous forme d'une liste de clés de colonnes séparées par des virgules. Par défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple: ma_colonne,-ma_colonne2"}}},"layout":{"itemTitle":"data.title"}},"singleSearchs":{"type":"array","title":"Recherche de paires code / libellé","description":"Permettez à vos utilisateurs de récupérer une liste de résultats à partir d'une recherche textuelle sur une colonne de libellés. Cette fonctionnalité permet de créer des champs de recherche dans les formulaires d'édition de ligne des jeux éditables.","items":{"type":"object","required":["title","output"],"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 \"Recherche d'un produit\""}}},"description":{"type":"string","title":"Description","layout":{"comp":"textarea","props":{"placeholder":"Exemple \"Récupérez un code produit en effectuant une recherche dans son code ou son libellé\""}}},"output":{"type":"object","title":"Propriété à retourner (code)","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\"]"}}},"label":{"type":"object","title":"Propriété affichée lors de la saisie (libellé)","description":"Propriété affichée à côté du code dans la liste des suggestions, sous la forme « code (libellé) », pour aider l'utilisateur à identifier la bonne valeur. La recherche s'effectue sur toutes les colonnes textuelles du jeu de données.","layout":{"props":{"noDataText":"Aucune colonne textuelle dans ce jeu de données."},"getItems":{"type":"js-eval","expr":"context.stringProperties","pure":true,"itemKey":"data[\"key\"]","itemTitle":"data[\"title\"]"}}},"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"}}}}}}},"layout":{"itemTitle":"data.title"}},"virtualDatasets":{"type":"object","description":"Proposez à vos utilisateurs de créer des jeux virtuels à partir de ce jeu de données. C'est une option intéressante pour faciliter la création de vues filtrées de cette donnée.","properties":{"active":{"type":"boolean","title":"Création de jeux virtuels"}}},"standardSchema":{"type":"object","description":"Proposez à vos utilisateurs d'initialiser des jeux éditables à partir des métadonnées et des données de ce jeu de données.","properties":{"active":{"type":"boolean","title":"Initialisation de jeux éditables"}}}}},{"type":"null"}]},"publications":{"anyOf":[{"type":"array","description":"References to all the catalogs the dataset metadata is published too","items":{"type":"object","required":["catalog","status"],"additionalProperties":false,"properties":{"id":{"type":"string"},"catalog":{"type":"string","description":"L'identifiant du catalogue de destination de cette publication."},"status":{"type":"string","description":"Statut indiquant clairement si la publication a réussi. Si \"published\", la propriété targetUrl doit être renseignée. Si \"error\", la propriété error doit être renseignée.","enum":["waiting","published","error","deleted"]},"publishedAt":{"type":"string","description":"Date de la dernière mise à jour de cette publication.","format":"date-time"},"error":{"type":"string"},"targetUrl":{"type":"string"},"result":{"type":"object","description":"Résultat de la publication. La structure de cet objet est libre et dépend du type de catalogue."},"addToDataset":{"type":"object","description":"Fill this object to create a new resource (or community resource) to an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"replaceDataset":{"type":"object","description":"Fill this object to overwrite an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}},{"type":"null"}]},"publicationSites":{"anyOf":[{"type":"array","description":"References to all sites the dataset is exposed in.","items":{"type":"string"}},{"type":"null"}]},"requestedPublicationSites":{"anyOf":[{"type":"array","description":"References to all sites the dataset would be exposed in if validated by an admin.","items":{"type":"string"}},{"type":"null"}]},"attachmentsAsImage":{"anyOf":[{"type":"boolean","default":false,"description":"Set to true to use attached files as illustrations of the line"},{"type":"null"}]},"virtual":{"anyOf":[{"type":"object","description":"A configuration object dedicated to virtual datasets.","required":["children"],"properties":{"children":{"type":"array","description":"Array of ids of the children datasets","items":{"type":"string"}},"filters":{"type":"array","description":"Array of static filters to always apply when querying the dataset","items":{"type":"object","required":["key","values"],"properties":{"key":{"type":"string","description":"Key of the field in the schema"},"operator":{"type":"string","enum":["in","nin"],"default":"in"},"values":{"type":"array","items":{"type":"string"}}}}},"filterActiveAccount":{"type":"boolean"}}},{"type":"null"}]},"rest":{"anyOf":[{"type":"object","description":"A configuration object dedicated to REST datasets.","properties":{"ttl":{"type":"object","required":["prop","delay"],"properties":{"active":{"type":"boolean"},"prop":{"type":"string"},"checkedAt":{"type":"string","format":"date-time","readOnly":true},"delay":{"type":"object","properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"history":{"type":"boolean","default":false,"description":"Set to true to let data-fair store revisions of the lines in the dataset."},"historyTTL":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean"},"delay":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"lineOwnership":{"type":"boolean"},"storeUpdatedBy":{"type":"boolean"},"primaryKeyMode":{"type":"string","enum":["base64","sha256"]},"indiceMode":{"type":"string","enum":["timestamp1","timestamp2","timestamp3"]}}},{"type":"null"}]},"topics":{"anyOf":[{"type":"array","title":"Liste de thématiques","layout":{"itemTitle":"item.title"},"items":{"title":"Topic","x-exports":["types","schema"],"type":"object","required":["title"],"additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","title":"Title","x-i18n-title":{"fr":"Titre"},"layout":{"cols":{"md":5}}},"icon":{"type":"object","title":"Icon","x-i18n-title":{"fr":"Icône"},"description":"Il est possible de consulter plus facilement la liste des icônes disponibles sur ce site .
Commencez à taper pour rechercher dans la collection complète d'icônes. Seuls quelques icônes sont chargées initialement pour de meilleures performances.","x-i18n-description":{"en":"You can easily browse the list of available icons on this this website.
Start typing to search through the complete collection of icons. Only a few icons are loaded initially for better performance."},"layout":{"getItems":{"url":"https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25","itemsResults":"data.results","itemTitle":"item.name","itemIcon":"item.svg","itemKey":"item.name"},"cols":{"md":5,"sm":6}},"required":["name"],"properties":{"name":{"type":"string"},"svg":{"type":"string"},"svgPath":{"type":"string"}}},"color":{"type":"string","title":"Color","x-i18n-title":{"fr":"Couleur"},"layout":{"comp":"color-picker","cols":{"md":2,"sm":6}}}}}},{"type":"null"}]},"relatedDatasets":{"anyOf":[{"type":"array","title":"Autres jeux de données à recommender","items":{"type":"object","additionalProperties":false,"required":["id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"}}}},{"type":"null"}]},"thumbnails":{"anyOf":[{"type":"object","properties":{"resizeMode":{"type":"string","description":"Define how the thumbnails will be adapted to the size requested by visualizations","enum":["crop","smartCrop","fitIn"],"default":"crop"}}},{"type":"null"}]},"extras":{"anyOf":[{"type":"object","description":"An object for extra content from client services of data-fair"},{"type":"null"}]},"customMetadata":{"anyOf":[{"type":"object","patternProperties":{"^(.*)$":{"type":"string"}}},{"type":"null"}]},"analysis":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"escapeKeyAlgorithm":{"type":"string","default":"slug","enum":["legacy","slug","compat-ods"]}}},{"type":"null"}]},"readApiKey":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean","title":"Activer l'accès par clé d'API"},"interval":{"type":"string","title":"Durée de validité des clés","oneOf":[{"const":"P1W","title":"1 semaine"},{"const":"P1M","title":"1 mois"},{"const":"P1Y","title":"1 année"}]},"expiresAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"},"renewAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"}}},{"type":"null"}]},"nonBlockingValidation":{"anyOf":[{"type":"boolean"},{"type":"null"}]}}},"datasetPost":{"title":"Post dataset body","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","property"],"properties":{"type":{"type":"string","const":"date-in-interval"},"property":{"type":"object","title":"Date à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://schema.org/Date"},"key":{"type":"string","const":"_date"},"type":{"type":"string","const":"string"},"format":{"type":"string","const":"date-time"}}}},"layout":{"if":{"type":"js-eval","expr":"context.hasDateIntervalConcepts","pure":true}}},{"title":"Coordonnée géographique à proximité","required":["type","distance"],"properties":{"type":{"type":"string","const":"geo-distance"},"distance":{"type":"integer","title":"Distance","default":0},"property":{"type":"object","title":"Point à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://www.w3.org/2003/01/geo/wgs84_pos#lat_long"},"key":{"type":"string","const":"_geopoint"},"type":{"type":"string","const":"string"}}}},"layout":{"if":{"type":"js-eval","expr":"context.dataset.bbox","pure":true}}}],"oneOfLayout":{"label":"Type de méthode de correspondance"}}},"sort":{"type":"string","title":"Tri pour choisir parmi des résultats ambigus","description":"\nRemarque : ce paramètre est optionnel et utile uniquement si la manière d'établir une correspondance est susceptible de retourner plusieurs résultats par ligne.\n\nLe tri est exprimé sous forme d'une liste de clés de colonnes séparées par des virgules. Par défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple: ma_colonne,-ma_colonne2"}}},"layout":{"itemTitle":"data.title"}},"singleSearchs":{"type":"array","title":"Recherche de paires code / libellé","description":"Permettez à vos utilisateurs de récupérer une liste de résultats à partir d'une recherche textuelle sur une colonne de libellés. Cette fonctionnalité permet de créer des champs de recherche dans les formulaires d'édition de ligne des jeux éditables.","items":{"type":"object","required":["title","output"],"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 \"Recherche d'un produit\""}}},"description":{"type":"string","title":"Description","layout":{"comp":"textarea","props":{"placeholder":"Exemple \"Récupérez un code produit en effectuant une recherche dans son code ou son libellé\""}}},"output":{"type":"object","title":"Propriété à retourner (code)","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\"]"}}},"label":{"type":"object","title":"Propriété affichée lors de la saisie (libellé)","description":"Propriété affichée à côté du code dans la liste des suggestions, sous la forme « code (libellé) », pour aider l'utilisateur à identifier la bonne valeur. La recherche s'effectue sur toutes les colonnes textuelles du jeu de données.","layout":{"props":{"noDataText":"Aucune colonne textuelle dans ce jeu de données."},"getItems":{"type":"js-eval","expr":"context.stringProperties","pure":true,"itemKey":"data[\"key\"]","itemTitle":"data[\"title\"]"}}},"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"}}}}}}},"layout":{"itemTitle":"data.title"}},"virtualDatasets":{"type":"object","description":"Proposez à vos utilisateurs de créer des jeux virtuels à partir de ce jeu de données. C'est une option intéressante pour faciliter la création de vues filtrées de cette donnée.","properties":{"active":{"type":"boolean","title":"Création de jeux virtuels"}}},"standardSchema":{"type":"object","description":"Proposez à vos utilisateurs d'initialiser des jeux éditables à partir des métadonnées et des données de ce jeu de données.","properties":{"active":{"type":"boolean","title":"Initialisation de jeux éditables"}}}}},{"type":"null"}]},"publications":{"anyOf":[{"type":"array","description":"References to all the catalogs the dataset metadata is published too","items":{"type":"object","required":["catalog","status"],"additionalProperties":false,"properties":{"id":{"type":"string"},"catalog":{"type":"string","description":"L'identifiant du catalogue de destination de cette publication."},"status":{"type":"string","description":"Statut indiquant clairement si la publication a réussi. Si \"published\", la propriété targetUrl doit être renseignée. Si \"error\", la propriété error doit être renseignée.","enum":["waiting","published","error","deleted"]},"publishedAt":{"type":"string","description":"Date de la dernière mise à jour de cette publication.","format":"date-time"},"error":{"type":"string"},"targetUrl":{"type":"string"},"result":{"type":"object","description":"Résultat de la publication. La structure de cet objet est libre et dépend du type de catalogue."},"addToDataset":{"type":"object","description":"Fill this object to create a new resource (or community resource) to an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"replaceDataset":{"type":"object","description":"Fill this object to overwrite an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}},{"type":"null"}]},"publicationSites":{"anyOf":[{"type":"array","description":"References to all sites the dataset is exposed in.","items":{"type":"string"}},{"type":"null"}]},"requestedPublicationSites":{"anyOf":[{"type":"array","description":"References to all sites the dataset would be exposed in if validated by an admin.","items":{"type":"string"}},{"type":"null"}]},"attachmentsAsImage":{"anyOf":[{"type":"boolean","default":false,"description":"Set to true to use attached files as illustrations of the line"},{"type":"null"}]},"virtual":{"anyOf":[{"type":"object","description":"A configuration object dedicated to virtual datasets.","required":["children"],"properties":{"children":{"type":"array","description":"Array of ids of the children datasets","items":{"type":"string"}},"filters":{"type":"array","description":"Array of static filters to always apply when querying the dataset","items":{"type":"object","required":["key","values"],"properties":{"key":{"type":"string","description":"Key of the field in the schema"},"operator":{"type":"string","enum":["in","nin"],"default":"in"},"values":{"type":"array","items":{"type":"string"}}}}},"filterActiveAccount":{"type":"boolean"}}},{"type":"null"}]},"rest":{"anyOf":[{"type":"object","description":"A configuration object dedicated to REST datasets.","properties":{"ttl":{"type":"object","required":["prop","delay"],"properties":{"active":{"type":"boolean"},"prop":{"type":"string"},"checkedAt":{"type":"string","format":"date-time","readOnly":true},"delay":{"type":"object","properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"history":{"type":"boolean","default":false,"description":"Set to true to let data-fair store revisions of the lines in the dataset."},"historyTTL":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean"},"delay":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"lineOwnership":{"type":"boolean"},"storeUpdatedBy":{"type":"boolean"},"primaryKeyMode":{"type":"string","enum":["base64","sha256"]},"indiceMode":{"type":"string","enum":["timestamp1","timestamp2","timestamp3"]}}},{"type":"null"}]},"topics":{"anyOf":[{"type":"array","title":"Liste de thématiques","layout":{"itemTitle":"item.title"},"items":{"title":"Topic","x-exports":["types","schema"],"type":"object","required":["title"],"additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","title":"Title","x-i18n-title":{"fr":"Titre"},"layout":{"cols":{"md":5}}},"icon":{"type":"object","title":"Icon","x-i18n-title":{"fr":"Icône"},"description":"Il est possible de consulter plus facilement la liste des icônes disponibles sur ce site .
Commencez à taper pour rechercher dans la collection complète d'icônes. Seuls quelques icônes sont chargées initialement pour de meilleures performances.","x-i18n-description":{"en":"You can easily browse the list of available icons on this this website.
Start typing to search through the complete collection of icons. Only a few icons are loaded initially for better performance."},"layout":{"getItems":{"url":"https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25","itemsResults":"data.results","itemTitle":"item.name","itemIcon":"item.svg","itemKey":"item.name"},"cols":{"md":5,"sm":6}},"required":["name"],"properties":{"name":{"type":"string"},"svg":{"type":"string"},"svgPath":{"type":"string"}}},"color":{"type":"string","title":"Color","x-i18n-title":{"fr":"Couleur"},"layout":{"comp":"color-picker","cols":{"md":2,"sm":6}}}}}},{"type":"null"}]},"relatedDatasets":{"anyOf":[{"type":"array","title":"Autres jeux de données à recommender","items":{"type":"object","additionalProperties":false,"required":["id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"}}}},{"type":"null"}]},"thumbnails":{"anyOf":[{"type":"object","properties":{"resizeMode":{"type":"string","description":"Define how the thumbnails will be adapted to the size requested by visualizations","enum":["crop","smartCrop","fitIn"],"default":"crop"}}},{"type":"null"}]},"extras":{"anyOf":[{"type":"object","description":"An object for extra content from client services of data-fair"},{"type":"null"}]},"customMetadata":{"anyOf":[{"type":"object","patternProperties":{"^(.*)$":{"type":"string"}}},{"type":"null"}]},"analysis":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"escapeKeyAlgorithm":{"type":"string","default":"slug","enum":["legacy","slug","compat-ods"]}}},{"type":"null"}]},"readApiKey":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean","title":"Activer l'accès par clé d'API"},"interval":{"type":"string","title":"Durée de validité des clés","oneOf":[{"const":"P1W","title":"1 semaine"},{"const":"P1M","title":"1 mois"},{"const":"P1Y","title":"1 année"}]},"expiresAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"},"renewAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"}}},{"type":"null"}]},"nonBlockingValidation":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"initFrom":{"type":"object","title":"Init from","additionalProperties":false,"required":["dataset","parts"],"properties":{"dataset":{"type":"string"},"parts":{"type":"array","items":{"type":"string","enum":["data","description","schema","metadataAttachments","primaryKey","extensions"]}}}},"isVirtual":{"type":"boolean","default":false,"description":"Used to identify virtual datasets. A virtual datasets does not have data, only references to other datasets."},"isRest":{"type":"boolean","default":false,"description":"Used to identify REST datasets. A REST dataset is not created from a data file, but instead is based on a dynamic collection in a database."},"isMetaOnly":{"type":"boolean","default":false,"description":"Used to identify datasets without any local data and only some metadata."},"owner":{"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"],"description":"Indique si le propriétaire est un utilisateur ou une organisation."},"id":{"type":"string","description":"Identifiant unique de l'utilisateur ou de l'organisation."},"name":{"type":"string","description":"Nom affiché de l'utilisateur ou de l'organisation."},"role":{"type":"string","deprecated":true,"description":"DÉPRÉCIÉ - Si cette propriété est renseignée et que le propriétaire est une organisation, restreint la propriété aux utilisateurs de cette organisation ayant ce rôle ou le rôle administrateur."},"department":{"type":"string","description":"Si cette propriété est renseignée et que le propriétaire est une organisation, restreint la propriété aux utilisateurs de cette organisation appartenant à ce département."},"departmentName":{"type":"string","description":"Nom affiché du département."}}}}},"application":{"$id":"https://github.com/data-fair/data-fair/application-resolved","title":"Application","x-exports":["types","validate","resolvedSchema"],"type":"object","additionalProperties":false,"required":["id","slug","url","title","owner"],"properties":{"id":{"type":"string","description":"Globally unique identifier of the application","pattern":"^[a-z0-9_\\-]+$"},"slug":{"type":"string","description":"Identifier of the application, usually a slug for URL readability (unique inside the tenant)","pattern":"^[a-z0-9]{1}[a-z0-9_\\-]*[a-z0-9]{1}$"},"href":{"type":"string","description":"Readonly field. The URL where this resource can be fetched"},"page":{"type":"string","description":"Readonly field. The URL where this resource can be viewed in the UI"},"title":{"type":"string","description":"Short title of the application"},"summary":{"type":"string","description":"Short description of the application"},"description":{"type":"string","description":"Detailed description of the application"},"image":{"type":"string","description":"URL d'une image, illustration du jeu de données"},"applicationName":{"type":"string","description":"Identifier of the origin application"},"createdBy":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string"}}},"updatedBy":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string"}}},"createdAt":{"type":"string","description":"Creation date of this application","format":"date-time"},"updatedAt":{"type":"string","description":"Date of the last update for this application","format":"date-time"},"lastConfigured":{"type":"string","description":"Date of the last validation of a configuration for this application","format":"date-time"},"status":{"type":"string","enum":["created","configured-draft","configured","error"]},"owner":{"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"],"description":"Indique si le propriétaire est un utilisateur ou une organisation."},"id":{"type":"string","description":"Identifiant unique de l'utilisateur ou de l'organisation."},"name":{"type":"string","description":"Nom affiché de l'utilisateur ou de l'organisation."},"role":{"type":"string","deprecated":true,"description":"DÉPRÉCIÉ - Si cette propriété est renseignée et que le propriétaire est une organisation, restreint la propriété aux utilisateurs de cette organisation ayant ce rôle ou le rôle administrateur."},"department":{"type":"string","description":"Si cette propriété est renseignée et que le propriétaire est une organisation, restreint la propriété aux utilisateurs de cette organisation appartenant à ce département."},"departmentName":{"type":"string","description":"Nom affiché du département."}}},"configuration":{"x-exports":["types","validate","resolvedSchema"],"title":"App config","type":"object","description":"A free format configuration object used by applications. A minimal common structure is used to ensure proper linking between applications and datasets and remote services","additionalProperties":true,"properties":{"datasets":{"type":"array","items":{"type":["object","null"],"required":["href"],"properties":{"href":{"type":"string"},"key":{"type":"string","description":"Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context."},"name":{"type":"string"},"applicationKeyPermissions":{"type":"object","description":"The permissions that should be applied to users accessing this dataset through a protecte application key of this application","default":{"classes":["read"]},"properties":{"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}}}}}}},"configurationDraft":{"x-exports":["types","validate","resolvedSchema"],"title":"App config","type":"object","description":"A free format configuration object used by applications. A minimal common structure is used to ensure proper linking between applications and datasets and remote services","additionalProperties":true,"properties":{"datasets":{"type":"array","items":{"type":["object","null"],"required":["href"],"properties":{"href":{"type":"string"},"key":{"type":"string","description":"Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context."},"name":{"type":"string"},"applicationKeyPermissions":{"type":"object","description":"The permissions that should be applied to users accessing this dataset through a protecte application key of this application","default":{"classes":["read"]},"properties":{"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}}}}}}},"url":{"type":"string","deprecated":true,"description":"The URL the base application is located at (replaced by baseApp.url)"},"urlDraft":{"type":"string","description":"The URL the base application for the draft configuration is located at (replaced by baseAppDraft.url)"},"baseApp":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"meta":{"type":"object"}}},"baseAppDraft":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"meta":{"type":"object"}}},"errorMessage":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"}}}]},"errorMessageDraft":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"}}}]},"publications":{"type":"array","description":"References to all the catalogs the application metadata is published too","items":{"type":"object","required":["catalog","status"],"additionalProperties":false,"properties":{"id":{"type":"string"},"catalog":{"type":"string","description":"L'identifiant du catalogue de destination de cette publication."},"status":{"type":"string","description":"Statut indiquant clairement si la publication a réussi. Si \"published\", la propriété targetUrl doit être renseignée. Si \"error\", la propriété error doit être renseignée.","enum":["waiting","published","error","deleted"]},"publishedAt":{"type":"string","description":"Date de la dernière mise à jour de cette publication.","format":"date-time"},"error":{"type":"string"},"targetUrl":{"type":"string"},"result":{"type":"object","description":"Résultat de la publication. La structure de cet objet est libre et dépend du type de catalogue."}}}},"publicationSites":{"type":"array","description":"References to all sites the application is exposed in.","items":{"type":"string"}},"requestedPublicationSites":{"type":"array","description":"References to all sites the application would be exposed in if validated by an admin.","items":{"type":"string"}},"topics":{"type":"array","title":"Liste de thématiques","layout":{"itemTitle":"item.title"},"items":{"title":"Topic","x-exports":["types","schema"],"type":"object","required":["title"],"additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","title":"Title","x-i18n-title":{"fr":"Titre"},"layout":{"cols":{"md":5}}},"icon":{"type":"object","title":"Icon","x-i18n-title":{"fr":"Icône"},"description":"Il est possible de consulter plus facilement la liste des icônes disponibles sur ce site .
Commencez à taper pour rechercher dans la collection complète d'icônes. Seuls quelques icônes sont chargées initialement pour de meilleures performances.","x-i18n-description":{"en":"You can easily browse the list of available icons on this this website.
Start typing to search through the complete collection of icons. Only a few icons are loaded initially for better performance."},"layout":{"getItems":{"url":"https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25","itemsResults":"data.results","itemTitle":"item.name","itemIcon":"item.svg","itemKey":"item.name"},"cols":{"md":5,"sm":6}},"required":["name"],"properties":{"name":{"type":"string"},"svg":{"type":"string"},"svgPath":{"type":"string"}}},"color":{"type":"string","title":"Color","x-i18n-title":{"fr":"Couleur"},"layout":{"comp":"color-picker","cols":{"md":2,"sm":6}}}}}},"extras":{"type":"object","description":"An object for extra content from client services of data-fair"},"preferLargeDisplay":{"type":"boolean","default":false},"attachments":{"type":"array","items":{"type":"object","required":["title","name"],"properties":{"title":{"type":"string","title":"Titre","layout":{"props":{"outlined":true,"dense":true}}},"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"}}}},"permissions":{"title":"Permissions","x-exports":["types","validate","resolvedSchema"],"type":"array","items":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}},"$defs":{"permission":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}}}}}},"applicationPatch":{"$id":"https://github.com/data-fair/data-fair/application-patch","title":"Application patch","x-exports":["types","validate","resolvedSchema"],"type":"object","additionalProperties":false,"properties":{"slug":{"type":"string","description":"Identifier of the application, usually a slug for URL readability (unique inside the tenant)","pattern":"^[a-z0-9]{1}[a-z0-9_\\-]*[a-z0-9]{1}$"},"title":{"type":"string","description":"Short title of the application"},"summary":{"anyOf":[{"type":"string","description":"Short description of the application"},{"type":"null"}]},"description":{"anyOf":[{"type":"string","description":"Detailed description of the application"},{"type":"null"}]},"image":{"anyOf":[{"type":"string","description":"URL d'une image, illustration du jeu de données"},{"type":"null"}]},"configuration":{"anyOf":[{"x-exports":["types","validate","resolvedSchema"],"title":"App config","type":"object","description":"A free format configuration object used by applications. A minimal common structure is used to ensure proper linking between applications and datasets and remote services","additionalProperties":true,"properties":{"datasets":{"type":"array","items":{"type":["object","null"],"required":["href"],"properties":{"href":{"type":"string"},"key":{"type":"string","description":"Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context."},"name":{"type":"string"},"applicationKeyPermissions":{"type":"object","description":"The permissions that should be applied to users accessing this dataset through a protecte application key of this application","default":{"classes":["read"]},"properties":{"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}}}}}}},{"type":"null"}]},"url":{"type":"string","deprecated":true,"description":"The URL the base application is located at (replaced by baseApp.url)"},"urlDraft":{"anyOf":[{"type":"string","description":"The URL the base application for the draft configuration is located at (replaced by baseAppDraft.url)"},{"type":"null"}]},"publications":{"anyOf":[{"type":"array","description":"References to all the catalogs the application metadata is published too","items":{"type":"object","required":["catalog","status"],"additionalProperties":false,"properties":{"id":{"type":"string"},"catalog":{"type":"string","description":"L'identifiant du catalogue de destination de cette publication."},"status":{"type":"string","description":"Statut indiquant clairement si la publication a réussi. Si \"published\", la propriété targetUrl doit être renseignée. Si \"error\", la propriété error doit être renseignée.","enum":["waiting","published","error","deleted"]},"publishedAt":{"type":"string","description":"Date de la dernière mise à jour de cette publication.","format":"date-time"},"error":{"type":"string"},"targetUrl":{"type":"string"},"result":{"type":"object","description":"Résultat de la publication. La structure de cet objet est libre et dépend du type de catalogue."}}}},{"type":"null"}]},"publicationSites":{"anyOf":[{"type":"array","description":"References to all sites the application is exposed in.","items":{"type":"string"}},{"type":"null"}]},"requestedPublicationSites":{"anyOf":[{"type":"array","description":"References to all sites the application would be exposed in if validated by an admin.","items":{"type":"string"}},{"type":"null"}]},"topics":{"anyOf":[{"type":"array","title":"Liste de thématiques","layout":{"itemTitle":"item.title"},"items":{"title":"Topic","x-exports":["types","schema"],"type":"object","required":["title"],"additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","title":"Title","x-i18n-title":{"fr":"Titre"},"layout":{"cols":{"md":5}}},"icon":{"type":"object","title":"Icon","x-i18n-title":{"fr":"Icône"},"description":"Il est possible de consulter plus facilement la liste des icônes disponibles sur ce site .
Commencez à taper pour rechercher dans la collection complète d'icônes. Seuls quelques icônes sont chargées initialement pour de meilleures performances.","x-i18n-description":{"en":"You can easily browse the list of available icons on this this website.
Start typing to search through the complete collection of icons. Only a few icons are loaded initially for better performance."},"layout":{"getItems":{"url":"https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25","itemsResults":"data.results","itemTitle":"item.name","itemIcon":"item.svg","itemKey":"item.name"},"cols":{"md":5,"sm":6}},"required":["name"],"properties":{"name":{"type":"string"},"svg":{"type":"string"},"svgPath":{"type":"string"}}},"color":{"type":"string","title":"Color","x-i18n-title":{"fr":"Couleur"},"layout":{"comp":"color-picker","cols":{"md":2,"sm":6}}}}}},{"type":"null"}]},"extras":{"anyOf":[{"type":"object","description":"An object for extra content from client services of data-fair"},{"type":"null"}]},"preferLargeDisplay":{"anyOf":[{"type":"boolean","default":false},{"type":"null"}]},"attachments":{"anyOf":[{"type":"array","items":{"type":"object","required":["title","name"],"properties":{"title":{"type":"string","title":"Titre","layout":{"props":{"outlined":true,"dense":true}}},"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"}}}},{"type":"null"}]}}}},"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-apiKey"},"sdCookie":{"type":"apiKey","in":"cookie","name":"id_token"}},"responses":{"BadRequest":{"description":"Requête invalide : corps de requête mal formé, paramètres manquants ou contraintes métier non respectées.","content":{"text/plain":{"schema":{"type":"string"}}}},"Unauthorized":{"description":"Non authentifié : aucune session ni clé d'API valide n'a été fournie.","content":{"text/plain":{"schema":{"type":"string"}}}},"Forbidden":{"description":"Permissions insuffisantes pour effectuer cette opération.","content":{"text/plain":{"schema":{"type":"string"}}}},"NotFound":{"description":"La ressource demandée n'existe pas.","content":{"text/plain":{"schema":{"type":"string"}}}}}},"security":[{"apiKey":[]},{"sdCookie":[]}],"paths":{"/ping":{"get":{"summary":"Obtenir l'état de santé du service","description":"Vérifier que le service est opérationnel.","operationId":"ping","tags":["Administration"],"x-operationType":"http://schema.org/CheckAction","responses":{"200":{"description":"Service ok.","content":{"text/plain":{"schema":{"type":"string"}}}},"500":{"description":"Service ko.","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/api-docs.json":{"get":{"summary":"Obtenir la documentation OpenAPI","description":"Accéder à cette documentation au format OpenAPI v3.","operationId":"getApiDoc","tags":["Administration"],"responses":{"200":{"description":"La documentation de l'API.","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/vocabulary":{"get":{"summary":"Lister les concepts","description":"Récupérer la liste des concepts utilisables pour annoter la donnée sur ce service.","operationId":"getVocabulary","tags":["Administration"],"responses":{"200":{"description":"La liste des concepts.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"identifiers":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"tag":{"type":"string"}}}}}}}}}},"/datasets":{"get":{"summary":"Lister les jeux de données","description":"Récupérer la liste des jeux de données.","operationId":"listDatasets","tags":["Jeux de données (JDD)"],"parameters":[{"in":"query","name":"q","description":"Recherche textuelle","required":false,"schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"mine","description":"Voir uniquement les ressources de mon compte actif","required":false,"schema":{"type":"boolean","default":true}},{"in":"query","name":"owner","description":"Restreindre par propriétaire","required":false,"schema":{"title":"Restreindre par propriétaire","type":"array","items":{"type":"string","examples":["organization:myorg","user:myuser"]}},"style":"form","explode":false},{"in":"query","name":"raw","description":"Ne pas inclure les champs calculés","required":false,"schema":{"title":"Ne pas inclure les champs calculés","type":"boolean"}},{"in":"query","name":"select","description":"La liste des colonnes à retourner","required":false,"schema":{"title":"La liste des colonnes à retourner","type":"array","items":{"type":"string","enum":["id","slug","href","page","title","summary","description","image","spatial","temporal","keywords","frequency","creator","modified","visibility","file","originalFile","attachments","storage","createdAt","createdBy","updatedAt","updatedBy","dataUpdatedAt","dataUpdatedBy","finalizedAt","owner","status","errorStatus","errorRetry","integrity","primaryKey","schema","count","bbox","timePeriod","timeZone","projection","conformsTo","license","origin","constraints","extensions","masterData","publications","publicationSites","requestedPublicationSites","hasFiles","attachmentsAsImage","isVirtual","virtual","isRest","rest","isMetaOnly","topics","relatedDatasets","thumbnails","extras","customMetadata","analysis","permissions","previews","readApiKey","esWarning","draftReason","nonBlockingValidation","draft"]}},"style":"form","explode":false},{"in":"query","name":"ids","description":"Restreindre sur un ou plusieurs identifiants de jeux de données.","required":false,"schema":{"title":"Identifiants de jeux de données","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filename","description":"Restreindre sur les noms de fichier","required":false,"schema":{"title":"Restreindre sur les noms de fichier","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"concepts","description":"Restreindre les jeux de données sur un ou plusieurs identifiants de concepts.","required":false,"schema":{"title":"Identifiants de concepts","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"topics","description":"Restreindre les jeux de données sur un ou plusieurs identifiants de thématiques.","required":false,"schema":{"title":"Identifiants de thématiques","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"field-type","description":"Restreindre sur les types de colonnes","required":false,"schema":{"title":"Restreindre sur les types de colonnes","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"field-format","description":"Restreindre sur les formats des colonnes textes","required":false,"schema":{"title":"Restreindre sur les formats des colonnes textes","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"file","description":"Restreindre aux jeux avec fichiers attachés","required":false,"schema":{"title":"Restreindre aux jeux avec fichiers attachés","type":"boolean"}},{"in":"query","name":"rest","description":"Restreindre aux jeux éditables","required":false,"schema":{"title":"Restreindre aux jeux éditables","type":"boolean"}},{"in":"query","name":"bbox","description":"Restreindre aux jeux géographiques","required":false,"schema":{"title":"Restreindre aux jeux géographiques","type":"boolean"}},{"in":"query","name":"queryable","description":"Restreindre aux jeux requêtables et utilisables dans des applications","required":false,"schema":{"title":"Restreindre aux jeux requêtables et utilisables dans des applications","type":"boolean"}},{"in":"query","name":"page","description":"Numéro de page","required":false,"schema":{"title":"Numéro de page","type":"integer","default":1,"min":1}},{"in":"query","name":"size","description":"Taille de la page","required":false,"schema":{"title":"Taille de la page","type":"integer","default":12,"min":1}},{"in":"query","name":"visibility","description":"Filtrer sur la visibilité de la ressource.\n\"public\" = voir les ressources publiques\n\"private\" = voir les ressources privées (celles sur lesquelles aucune permission particulière n'a été appliquée)\n\"protected\" = voir les ressources protégées (celles sur lesquelles une permission a été donnée à des utilisateurs).","required":false,"schema":{"title":"Filtrer sur la visibilité de la ressource.","type":"array","items":{"type":"string","oneOf":[{"const":"public","title":"Ressources publiques"},{"const":"private","title":"Ressources privées"},{"const":"protected","title":"Ressources protégées"}]}},"style":"form","explode":false}],"responses":{"200":{"description":"Liste des jeux de données que l'utilisateur est autorisé à voir.","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","description":"Nombre total de jeux de données."},"results":{"type":"array","items":{"$ref":"#/components/schemas/dataset"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"summary":"Créer un jeu de données","description":"Créer un nouveau jeu de données.","operationId":"postDataset","tags":["Jeux de données (JDD)"],"requestBody":{"description":"Fichier à charger et autres informations.","required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/datasetPost"}}}},"responses":{"201":{"description":"Le 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"}}}}}}},"/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","property"],"properties":{"type":{"type":"string","const":"date-in-interval"},"property":{"type":"object","title":"Date à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://schema.org/Date"},"key":{"type":"string","const":"_date"},"type":{"type":"string","const":"string"},"format":{"type":"string","const":"date-time"}}}},"layout":{"if":{"type":"js-eval","expr":"context.hasDateIntervalConcepts","pure":true}}},{"title":"Coordonnée géographique à proximité","required":["type","distance"],"properties":{"type":{"type":"string","const":"geo-distance"},"distance":{"type":"integer","title":"Distance","default":0},"property":{"type":"object","title":"Point à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://www.w3.org/2003/01/geo/wgs84_pos#lat_long"},"key":{"type":"string","const":"_geopoint"},"type":{"type":"string","const":"string"}}}},"layout":{"if":{"type":"js-eval","expr":"context.dataset.bbox","pure":true}}}],"oneOfLayout":{"label":"Type de méthode de correspondance"}}},"sort":{"type":"string","title":"Tri pour choisir parmi des résultats ambigus","description":"\nRemarque : ce paramètre est optionnel et utile uniquement si la manière d'établir une correspondance est susceptible de retourner plusieurs résultats par ligne.\n\nLe tri est exprimé sous forme d'une liste de clés de colonnes séparées par des virgules. Par défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple: ma_colonne,-ma_colonne2"}}},"layout":{"itemTitle":"data.title"}},"singleSearchs":{"type":"array","title":"Recherche de paires code / libellé","description":"Permettez à vos utilisateurs de récupérer une liste de résultats à partir d'une recherche textuelle sur une colonne de libellés. Cette fonctionnalité permet de créer des champs de recherche dans les formulaires d'édition de ligne des jeux éditables.","items":{"type":"object","required":["title","output"],"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 \"Recherche d'un produit\""}}},"description":{"type":"string","title":"Description","layout":{"comp":"textarea","props":{"placeholder":"Exemple \"Récupérez un code produit en effectuant une recherche dans son code ou son libellé\""}}},"output":{"type":"object","title":"Propriété à retourner (code)","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\"]"}}},"label":{"type":"object","title":"Propriété affichée lors de la saisie (libellé)","description":"Propriété affichée à côté du code dans la liste des suggestions, sous la forme « code (libellé) », pour aider l'utilisateur à identifier la bonne valeur. La recherche s'effectue sur toutes les colonnes textuelles du jeu de données.","layout":{"props":{"noDataText":"Aucune colonne textuelle dans ce jeu de données."},"getItems":{"type":"js-eval","expr":"context.stringProperties","pure":true,"itemKey":"data[\"key\"]","itemTitle":"data[\"title\"]"}}},"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"}}}}}}},"layout":{"itemTitle":"data.title"}},"virtualDatasets":{"type":"object","description":"Proposez à vos utilisateurs de créer des jeux virtuels à partir de ce jeu de données. C'est une option intéressante pour faciliter la création de vues filtrées de cette donnée.","properties":{"active":{"type":"boolean","title":"Création de jeux virtuels"}}},"standardSchema":{"type":"object","description":"Proposez à vos utilisateurs d'initialiser des jeux éditables à partir des métadonnées et des données de ce jeu de données.","properties":{"active":{"type":"boolean","title":"Initialisation de jeux éditables"}}}}},{"type":"null"}]},"publications":{"anyOf":[{"type":"array","description":"References to all the catalogs the dataset metadata is published too","items":{"type":"object","required":["catalog","status"],"additionalProperties":false,"properties":{"id":{"type":"string"},"catalog":{"type":"string","description":"L'identifiant du catalogue de destination de cette publication."},"status":{"type":"string","description":"Statut indiquant clairement si la publication a réussi. Si \"published\", la propriété targetUrl doit être renseignée. Si \"error\", la propriété error doit être renseignée.","enum":["waiting","published","error","deleted"]},"publishedAt":{"type":"string","description":"Date de la dernière mise à jour de cette publication.","format":"date-time"},"error":{"type":"string"},"targetUrl":{"type":"string"},"result":{"type":"object","description":"Résultat de la publication. La structure de cet objet est libre et dépend du type de catalogue."},"addToDataset":{"type":"object","description":"Fill this object to create a new resource (or community resource) to an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"replaceDataset":{"type":"object","description":"Fill this object to overwrite an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}},{"type":"null"}]},"publicationSites":{"anyOf":[{"type":"array","description":"References to all sites the dataset is exposed in.","items":{"type":"string"}},{"type":"null"}]},"requestedPublicationSites":{"anyOf":[{"type":"array","description":"References to all sites the dataset would be exposed in if validated by an admin.","items":{"type":"string"}},{"type":"null"}]},"attachmentsAsImage":{"anyOf":[{"type":"boolean","default":false,"description":"Set to true to use attached files as illustrations of the line"},{"type":"null"}]},"virtual":{"anyOf":[{"type":"object","description":"A configuration object dedicated to virtual datasets.","required":["children"],"properties":{"children":{"type":"array","description":"Array of ids of the children datasets","items":{"type":"string"}},"filters":{"type":"array","description":"Array of static filters to always apply when querying the dataset","items":{"type":"object","required":["key","values"],"properties":{"key":{"type":"string","description":"Key of the field in the schema"},"operator":{"type":"string","enum":["in","nin"],"default":"in"},"values":{"type":"array","items":{"type":"string"}}}}},"filterActiveAccount":{"type":"boolean"}}},{"type":"null"}]},"rest":{"anyOf":[{"type":"object","description":"A configuration object dedicated to REST datasets.","properties":{"ttl":{"type":"object","required":["prop","delay"],"properties":{"active":{"type":"boolean"},"prop":{"type":"string"},"checkedAt":{"type":"string","format":"date-time","readOnly":true},"delay":{"type":"object","properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"history":{"type":"boolean","default":false,"description":"Set to true to let data-fair store revisions of the lines in the dataset."},"historyTTL":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean"},"delay":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"lineOwnership":{"type":"boolean"},"storeUpdatedBy":{"type":"boolean"},"primaryKeyMode":{"type":"string","enum":["base64","sha256"]},"indiceMode":{"type":"string","enum":["timestamp1","timestamp2","timestamp3"]}}},{"type":"null"}]},"topics":{"anyOf":[{"type":"array","title":"Liste de thématiques","layout":{"itemTitle":"item.title"},"items":{"title":"Topic","x-exports":["types","schema"],"type":"object","required":["title"],"additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","title":"Title","x-i18n-title":{"fr":"Titre"},"layout":{"cols":{"md":5}}},"icon":{"type":"object","title":"Icon","x-i18n-title":{"fr":"Icône"},"description":"Il est possible de consulter plus facilement la liste des icônes disponibles sur ce site .
Commencez à taper pour rechercher dans la collection complète d'icônes. Seuls quelques icônes sont chargées initialement pour de meilleures performances.","x-i18n-description":{"en":"You can easily browse the list of available icons on this this website.
Start typing to search through the complete collection of icons. Only a few icons are loaded initially for better performance."},"layout":{"getItems":{"url":"https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25","itemsResults":"data.results","itemTitle":"item.name","itemIcon":"item.svg","itemKey":"item.name"},"cols":{"md":5,"sm":6}},"required":["name"],"properties":{"name":{"type":"string"},"svg":{"type":"string"},"svgPath":{"type":"string"}}},"color":{"type":"string","title":"Color","x-i18n-title":{"fr":"Couleur"},"layout":{"comp":"color-picker","cols":{"md":2,"sm":6}}}}}},{"type":"null"}]},"relatedDatasets":{"anyOf":[{"type":"array","title":"Autres jeux de données à recommender","items":{"type":"object","additionalProperties":false,"required":["id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"}}}},{"type":"null"}]},"thumbnails":{"anyOf":[{"type":"object","properties":{"resizeMode":{"type":"string","description":"Define how the thumbnails will be adapted to the size requested by visualizations","enum":["crop","smartCrop","fitIn"],"default":"crop"}}},{"type":"null"}]},"extras":{"anyOf":[{"type":"object","description":"An object for extra content from client services of data-fair"},{"type":"null"}]},"customMetadata":{"anyOf":[{"type":"object","patternProperties":{"^(.*)$":{"type":"string"}}},{"type":"null"}]},"analysis":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"escapeKeyAlgorithm":{"type":"string","default":"slug","enum":["legacy","slug","compat-ods"]}}},{"type":"null"}]},"readApiKey":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean","title":"Activer l'accès par clé d'API"},"interval":{"type":"string","title":"Durée de validité des clés","oneOf":[{"const":"P1W","title":"1 semaine"},{"const":"P1M","title":"1 mois"},{"const":"P1Y","title":"1 année"}]},"expiresAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"},"renewAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"}}},{"type":"null"}]},"nonBlockingValidation":{"anyOf":[{"type":"boolean"},{"type":"null"}]}}}}}},"responses":{"200":{"description":"Le jeu de données mis à jour.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"summary":"Supprimer le jeu de données","description":"Supprimer ce jeu de données.","operationId":"delete","x-permissionClass":"admin","tags":["JDD / Métadonnées"],"responses":{"204":{"description":"Jeu de données supprimé."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"summary":"Mettre à jour les données","description":"Mettre à jour le fichier de données du jeu de données. La nouvelle version est créée en brouillon, à valider via la route `validateDraft`.","operationId":"writeData","x-permissionClass":"write","tags":["JDD / Données"],"requestBody":{"description":"Le fichier à charger et autres informations.","required":true,"content":{"multipart/form-data":{"schema":{"title":"Post dataset body","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","property"],"properties":{"type":{"type":"string","const":"date-in-interval"},"property":{"type":"object","title":"Date à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://schema.org/Date"},"key":{"type":"string","const":"_date"},"type":{"type":"string","const":"string"},"format":{"type":"string","const":"date-time"}}}},"layout":{"if":{"type":"js-eval","expr":"context.hasDateIntervalConcepts","pure":true}}},{"title":"Coordonnée géographique à proximité","required":["type","distance"],"properties":{"type":{"type":"string","const":"geo-distance"},"distance":{"type":"integer","title":"Distance","default":0},"property":{"type":"object","title":"Point à renseigner","properties":{"x-refersTo":{"type":"string","const":"http://www.w3.org/2003/01/geo/wgs84_pos#lat_long"},"key":{"type":"string","const":"_geopoint"},"type":{"type":"string","const":"string"}}}},"layout":{"if":{"type":"js-eval","expr":"context.dataset.bbox","pure":true}}}],"oneOfLayout":{"label":"Type de méthode de correspondance"}}},"sort":{"type":"string","title":"Tri pour choisir parmi des résultats ambigus","description":"\nRemarque : ce paramètre est optionnel et utile uniquement si la manière d'établir une correspondance est susceptible de retourner plusieurs résultats par ligne.\n\nLe tri est exprimé sous forme d'une liste de clés de colonnes séparées par des virgules. Par défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple: ma_colonne,-ma_colonne2"}}},"layout":{"itemTitle":"data.title"}},"singleSearchs":{"type":"array","title":"Recherche de paires code / libellé","description":"Permettez à vos utilisateurs de récupérer une liste de résultats à partir d'une recherche textuelle sur une colonne de libellés. Cette fonctionnalité permet de créer des champs de recherche dans les formulaires d'édition de ligne des jeux éditables.","items":{"type":"object","required":["title","output"],"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 \"Recherche d'un produit\""}}},"description":{"type":"string","title":"Description","layout":{"comp":"textarea","props":{"placeholder":"Exemple \"Récupérez un code produit en effectuant une recherche dans son code ou son libellé\""}}},"output":{"type":"object","title":"Propriété à retourner (code)","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\"]"}}},"label":{"type":"object","title":"Propriété affichée lors de la saisie (libellé)","description":"Propriété affichée à côté du code dans la liste des suggestions, sous la forme « code (libellé) », pour aider l'utilisateur à identifier la bonne valeur. La recherche s'effectue sur toutes les colonnes textuelles du jeu de données.","layout":{"props":{"noDataText":"Aucune colonne textuelle dans ce jeu de données."},"getItems":{"type":"js-eval","expr":"context.stringProperties","pure":true,"itemKey":"data[\"key\"]","itemTitle":"data[\"title\"]"}}},"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"}}}}}}},"layout":{"itemTitle":"data.title"}},"virtualDatasets":{"type":"object","description":"Proposez à vos utilisateurs de créer des jeux virtuels à partir de ce jeu de données. C'est une option intéressante pour faciliter la création de vues filtrées de cette donnée.","properties":{"active":{"type":"boolean","title":"Création de jeux virtuels"}}},"standardSchema":{"type":"object","description":"Proposez à vos utilisateurs d'initialiser des jeux éditables à partir des métadonnées et des données de ce jeu de données.","properties":{"active":{"type":"boolean","title":"Initialisation de jeux éditables"}}}}},{"type":"null"}]},"publications":{"anyOf":[{"type":"array","description":"References to all the catalogs the dataset metadata is published too","items":{"type":"object","required":["catalog","status"],"additionalProperties":false,"properties":{"id":{"type":"string"},"catalog":{"type":"string","description":"L'identifiant du catalogue de destination de cette publication."},"status":{"type":"string","description":"Statut indiquant clairement si la publication a réussi. Si \"published\", la propriété targetUrl doit être renseignée. Si \"error\", la propriété error doit être renseignée.","enum":["waiting","published","error","deleted"]},"publishedAt":{"type":"string","description":"Date de la dernière mise à jour de cette publication.","format":"date-time"},"error":{"type":"string"},"targetUrl":{"type":"string"},"result":{"type":"object","description":"Résultat de la publication. La structure de cet objet est libre et dépend du type de catalogue."},"addToDataset":{"type":"object","description":"Fill this object to create a new resource (or community resource) to an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}},"replaceDataset":{"type":"object","description":"Fill this object to overwrite an existing dataset.","properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}},{"type":"null"}]},"publicationSites":{"anyOf":[{"type":"array","description":"References to all sites the dataset is exposed in.","items":{"type":"string"}},{"type":"null"}]},"requestedPublicationSites":{"anyOf":[{"type":"array","description":"References to all sites the dataset would be exposed in if validated by an admin.","items":{"type":"string"}},{"type":"null"}]},"attachmentsAsImage":{"anyOf":[{"type":"boolean","default":false,"description":"Set to true to use attached files as illustrations of the line"},{"type":"null"}]},"virtual":{"anyOf":[{"type":"object","description":"A configuration object dedicated to virtual datasets.","required":["children"],"properties":{"children":{"type":"array","description":"Array of ids of the children datasets","items":{"type":"string"}},"filters":{"type":"array","description":"Array of static filters to always apply when querying the dataset","items":{"type":"object","required":["key","values"],"properties":{"key":{"type":"string","description":"Key of the field in the schema"},"operator":{"type":"string","enum":["in","nin"],"default":"in"},"values":{"type":"array","items":{"type":"string"}}}}},"filterActiveAccount":{"type":"boolean"}}},{"type":"null"}]},"rest":{"anyOf":[{"type":"object","description":"A configuration object dedicated to REST datasets.","properties":{"ttl":{"type":"object","required":["prop","delay"],"properties":{"active":{"type":"boolean"},"prop":{"type":"string"},"checkedAt":{"type":"string","format":"date-time","readOnly":true},"delay":{"type":"object","properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"history":{"type":"boolean","default":false,"description":"Set to true to let data-fair store revisions of the lines in the dataset."},"historyTTL":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean"},"delay":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"integer","default":0},"unit":{"type":"string","enum":["hours","days","weeks","months"],"default":"days"}}}}},"lineOwnership":{"type":"boolean"},"storeUpdatedBy":{"type":"boolean"},"primaryKeyMode":{"type":"string","enum":["base64","sha256"]},"indiceMode":{"type":"string","enum":["timestamp1","timestamp2","timestamp3"]}}},{"type":"null"}]},"topics":{"anyOf":[{"type":"array","title":"Liste de thématiques","layout":{"itemTitle":"item.title"},"items":{"title":"Topic","x-exports":["types","schema"],"type":"object","required":["title"],"additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true},"title":{"type":"string","title":"Title","x-i18n-title":{"fr":"Titre"},"layout":{"cols":{"md":5}}},"icon":{"type":"object","title":"Icon","x-i18n-title":{"fr":"Icône"},"description":"Il est possible de consulter plus facilement la liste des icônes disponibles sur ce site .
Commencez à taper pour rechercher dans la collection complète d'icônes. Seuls quelques icônes sont chargées initialement pour de meilleures performances.","x-i18n-description":{"en":"You can easily browse the list of available icons on this this website.
Start typing to search through the complete collection of icons. Only a few icons are loaded initially for better performance."},"layout":{"getItems":{"url":"https://koumoul.com/data-fair/api/v1/datasets/icons-mdi-latest/lines?q={q}&select=name,svg,svgPath&size=25","itemsResults":"data.results","itemTitle":"item.name","itemIcon":"item.svg","itemKey":"item.name"},"cols":{"md":5,"sm":6}},"required":["name"],"properties":{"name":{"type":"string"},"svg":{"type":"string"},"svgPath":{"type":"string"}}},"color":{"type":"string","title":"Color","x-i18n-title":{"fr":"Couleur"},"layout":{"comp":"color-picker","cols":{"md":2,"sm":6}}}}}},{"type":"null"}]},"relatedDatasets":{"anyOf":[{"type":"array","title":"Autres jeux de données à recommender","items":{"type":"object","additionalProperties":false,"required":["id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"}}}},{"type":"null"}]},"thumbnails":{"anyOf":[{"type":"object","properties":{"resizeMode":{"type":"string","description":"Define how the thumbnails will be adapted to the size requested by visualizations","enum":["crop","smartCrop","fitIn"],"default":"crop"}}},{"type":"null"}]},"extras":{"anyOf":[{"type":"object","description":"An object for extra content from client services of data-fair"},{"type":"null"}]},"customMetadata":{"anyOf":[{"type":"object","patternProperties":{"^(.*)$":{"type":"string"}}},{"type":"null"}]},"analysis":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"escapeKeyAlgorithm":{"type":"string","default":"slug","enum":["legacy","slug","compat-ods"]}}},{"type":"null"}]},"readApiKey":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean","title":"Activer l'accès par clé d'API"},"interval":{"type":"string","title":"Durée de validité des clés","oneOf":[{"const":"P1W","title":"1 semaine"},{"const":"P1M","title":"1 mois"},{"const":"P1Y","title":"1 année"}]},"expiresAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"},"renewAt":{"type":"string","format":"date-time","readOnly":true,"layout":"none"}}},{"type":"null"}]},"nonBlockingValidation":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"initFrom":{"type":"object","title":"Init from","additionalProperties":false,"required":["dataset","parts"],"properties":{"dataset":{"type":"string"},"parts":{"type":"array","items":{"type":"string","enum":["data","description","schema","metadataAttachments","primaryKey","extensions"]}}}},"isVirtual":{"type":"boolean","default":false,"description":"Used to identify virtual datasets. A virtual datasets does not have data, only references to other datasets."},"isRest":{"type":"boolean","default":false,"description":"Used to identify REST datasets. A REST dataset is not created from a data file, but instead is based on a dynamic collection in a database."},"isMetaOnly":{"type":"boolean","default":false,"description":"Used to identify datasets without any local data and only some metadata."},"owner":{"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"],"description":"Indique si le propriétaire est un utilisateur ou une organisation."},"id":{"type":"string","description":"Identifiant unique de l'utilisateur ou de l'organisation."},"name":{"type":"string","description":"Nom affiché de l'utilisateur ou de l'organisation."},"role":{"type":"string","deprecated":true,"description":"DÉPRÉCIÉ - Si cette propriété est renseignée et que le propriétaire est une organisation, restreint la propriété aux utilisateurs de cette organisation ayant ce rôle ou le rôle administrateur."},"department":{"type":"string","description":"Si cette propriété est renseignée et que le propriétaire est une organisation, restreint la propriété aux utilisateurs de cette organisation appartenant à ce département."},"departmentName":{"type":"string","description":"Nom affiché du département."}}}}}}}},"responses":{"200":{"description":"Le jeu de données après mise à jour.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Conflit : le jeu de données est verrouillé ou se trouve dans un état incompatible avec cette opération.","content":{"text/plain":{"schema":{"type":"string"}}}},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/applications":{"get":{"summary":"Lister les applications","description":"Récupérer la liste des applications.","operationId":"listApplications","tags":["Applications"],"parameters":[{"in":"query","name":"q","description":"Recherche textuelle","required":false,"schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"mine","description":"Voir uniquement les ressources de mon compte actif","required":false,"schema":{"type":"boolean","default":true}},{"in":"query","name":"owner","description":"Restreindre par propriétaire","required":false,"schema":{"title":"Restreindre par propriétaire","type":"array","items":{"type":"string","examples":["organization:myorg","user:myuser"]}},"style":"form","explode":false},{"in":"query","name":"raw","description":"Ne pas inclure les champs calculés","required":false,"schema":{"title":"Ne pas inclure les champs calculés","type":"boolean"}},{"in":"query","name":"select","description":"La liste des colonnes à retourner","required":false,"schema":{"title":"La liste des colonnes à retourner","type":"array","items":{"type":"string","enum":["id","slug","href","page","title","summary","description","image","applicationName","createdBy","updatedBy","createdAt","updatedAt","lastConfigured","status","owner","configuration","configurationDraft","url","urlDraft","baseApp","baseAppDraft","errorMessage","errorMessageDraft","publications","publicationSites","requestedPublicationSites","topics","extras","preferLargeDisplay","attachments","permissions"]}},"style":"form","explode":false},{"in":"query","name":"ids","description":"Restreindre sur les identifiants","required":false,"schema":{"title":"Restreindre sur les identifiants","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"dataset","description":"Restreindre sur les jeux de données utilisés","required":false,"schema":{"title":"Restreindre sur les jeux de données utilisés","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"service","description":"Restreindre sur les services distants utilisés","required":false,"schema":{"title":"Restreindre sur les services distants utilisés","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"page","description":"Numéro de page","required":false,"schema":{"title":"Numéro de page","type":"integer","default":1,"min":1}},{"in":"query","name":"size","description":"Taille de la page","required":false,"schema":{"title":"Taille de la page","type":"integer","default":12,"min":1}},{"in":"query","name":"visibility","description":"Filtrer sur la visibilité de la ressource.\n\"public\" = voir les ressources publiques\n\"private\" = voir les ressources privées (celles sur lesquelles aucune permission particulière n'a été appliquée)\n\"protected\" = voir les ressources protégées (celles sur lesquelles une permission a été donnée à des utilisateurs).","required":false,"schema":{"title":"Filtrer sur la visibilité de la ressource.","type":"array","items":{"type":"string","oneOf":[{"const":"public","title":"Ressources publiques"},{"const":"private","title":"Ressources privées"},{"const":"protected","title":"Ressources protégées"}]}},"style":"form","explode":false}],"responses":{"200":{"description":"Liste des applications que l'utilisateur est autorisé à voir.","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"number","description":"Nombre total d'applications."},"results":{"type":"array","items":{"$ref":"#/components/schemas/application"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"summary":"Configurer une application","description":"Créer une nouvelle application.","operationId":"postApplication","tags":["Applications"],"requestBody":{"description":"Les informations de configuration de l'application.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application"}}}},"responses":{"201":{"description":"Les informations de configuration de l'application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/application"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/applications/{id}":{"parameters":[{"in":"path","name":"id","description":"Identifiant de l'application. L'identifiant de publication (`slug`) fonctionne aussi lorsque l'API est appelée depuis un portail.","required":true,"schema":{"type":"string","title":"Identifiant de l'application"}}],"get":{"summary":"Lire les informations d'une application","description":"Récupérer les informations d'une application.","operationId":"getApplication","tags":["Applications"],"responses":{"200":{"description":"Informations d'une application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/application"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"summary":"Créer ou mettre à jour une application","description":"Créer ou mettre à jour une application en spécifiant son identifiant.","operationId":"putApplication","tags":["Applications"],"requestBody":{"description":"Informations de l'application.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/application"}}}},"responses":{"200":{"description":"Application modifiée.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/application"}}}},"201":{"description":"Application créée.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/application"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"patch":{"summary":"Modifier une application","description":"Modifier seulement certaines informations d'une application.","operationId":"patchApplication","tags":["Applications"],"requestBody":{"description":"Informations à modifier.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/applicationPatch"}}}},"responses":{"200":{"description":"Informations de l'application modifiée.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/application"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"summary":"Supprimer une application","description":"Supprimer cette application.","operationId":"deleteApplication","tags":["Applications"],"responses":{"204":{"description":"Application supprimée."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/lines":{"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"}}],"get":{"summary":"Lire les lignes","description":"Requêter les lignes du jeu de données.","operationId":"readLines","x-permissionClass":"read","tags":["JDD / Données"],"parameters":[{"in":"query","name":"after","description":"Pagination en profondeur.\n\n*Automatiquement renseigné par la propriété **next** du résultat de la requête précédente.*","schema":{"title":"Pagination en profondeur","type":"integer"}},{"in":"query","name":"page","description":"Le numéro de la page (indice de la pagination). Débute à 1.\n\n*Pour paginer sur de gros volumes de données utilisez plutôt le paramètre **after***.","schema":{"title":"Numéro de la page","type":"integer","default":1}},{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination).","schema":{"title":"Taille de la pagination","default":12,"type":"integer","maximum":10000}},{"in":"query","name":"sort","description":"\nLe tri à effectuer sous forme d'une liste de clés de colonnes séparées par des virgules.\n\nPar défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple : `ma_colonne,-ma_colonne2`","schema":{"title":"Ordre des résultats","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"select","description":"La liste des clés de colonnes à retourner.","schema":{"title":"La liste des colonnes à retourner","type":"array","items":{"type":"string"},"default":"all"},"style":"form","explode":false},{"in":"query","name":"highlight","description":"\nDemande à retourner des extraits du document qui contiennent les mots utilisés en filtre (paramètres q et qs).\n\nLa valeur est une liste de clés de colonnes séparées par des virgules.\n ","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"thumbnail","description":"\nDemande à retourner un lien de vignette d'une dimension déterminée à partir d'une colonne image.\n\nPour que ce paramètre soit accepté le concept \"Image\" doit être associé à une colonne du jeu de données.\n\nLa valeur du paramètre est la dimension passée sous la form largeurxhauteur (300x200 par exemple) où un 0 sur la largeur ou la hauteur signifie que l'autre valeur est prise en compte et les proportions conservées.\n ","schema":{"type":"string"}},{"in":"query","name":"sampling","description":"\n **Uniquement avec le paramètre de tuilage xyz**. Configure le mode d'échantillonnage des résultats pour privilégier soit l'exhaustivité des données soit une densité plus homogène sur la carte.\n\n - **neighbors** (défaut) : utilise la densité maximale parmi les tuiles voisines pour réduire la densité de la tuile courante au même niveau d'échantillonnage (coûteux en performance).\n - **max** : retourne le maximum (limité par le paramètre size) de résultat pour chaque tuile.\n ","schema":{"type":"string","enum":[null,"neighbors","max"]}},{"in":"query","name":"format","description":"Le format de sérialisation de la donnée.\n\n - **json** (défaut)\n - **csv**, **xlsx**, **ods** pour formats compatibles tableurs\n - **pbf** pour tuiles vectorielles\n - **geojson**, **shp**, **wkt** pour formats géographiques","schema":{"title":"Format de sérialisation","default":"json","type":"string","enum":["json","csv","xlsx","ods","pbf","geojson","shp","wkt"]}},{"in":"query","name":"html","description":"Effectuer le rendu des contenus formatés de **markdown** vers **HTML**.","schema":{"title":"Rendu HTML des contenus markdown","type":"boolean"}},{"in":"query","name":"hint","description":"Ajouter un champ `hint` au corps de la réponse avec un conseil de performance le cas échéant.\n\n - **auto** (défaut) : seulement si la requête est lente.\n - **true** : dès qu'un conseil s'applique.\n - **false** : jamais.","schema":{"title":"Conseil de performance","type":"string","default":"auto","enum":["auto","true","false"]}},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}},{"in":"query","name":"collapse","description":"Afficher une ligne de résultat par valeur distincte d'une colonne.","schema":{"type":"string"}}],"responses":{"200":{"description":"Le résultat de la requête.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"Le nombre total de résultat si on ignore la pagination."},"results":{"type":"array","description":"Le tableau de résultats.","items":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}},"next":{"type":"string","description":"URL pour continuer la pagination."}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"summary":"Ajouter une ligne","description":"Ajouter une nouvelle ligne au jeu de données.","operationId":"createLine","x-permissionClass":"write","tags":["JDD / Éditable"],"requestBody":{"description":"Le contenu d'une ligne de données.","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"responses":{"201":{"description":"La ligne de données ajoutée.","content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Supprimer toutes les lignes","description":"Supprimer toutes les lignes du jeu de données.","operationId":"deleteAllLines","x-permissionClass":"write","tags":["JDD / Éditable"],"responses":{"204":{"description":"Toutes les lignes de données ont été supprimées."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/values/{field}":{"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"}},{"in":"path","name":"field","description":"La clé de la colonne pour laquelle récupérer les valeurs distinctes.","required":true,"schema":{"title":"Colonne","type":"string"}}],"get":{"summary":"Lister les valeurs distinctes","description":"Récupérer la liste des valeurs distinctes d'une colonne.","operationId":"getValues","x-permissionClass":"read","tags":["JDD / Données"],"parameters":[{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination). 10 par défaut.","schema":{"title":"Taille de la pagination","default":10,"type":"integer","maximum":10000}},{"in":"query","name":"sort","description":"Tri des valeurs (\"**asc**\" ou \"**desc**\").","schema":{"title":"Ordre de tri","type":"string","default":"asc","oneOf":[{"const":"asc","title":"Ascendant"},{"const":"desc","title":"Descendant"}]}},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}}],"responses":{"200":{"description":"Les valeurs distinctes de la colonne.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/values-labels/{field}":{"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"}},{"in":"path","name":"field","description":"La clé de la colonne pour laquelle récupérer les valeurs avec leurs libellés.","required":true,"schema":{"title":"Colonne","type":"string"}}],"get":{"summary":"Lister les valeurs avec libellés","description":"Récupérer la liste des valeurs distinctes d'une colonne avec leurs libellés associés (`x-labels`). Utile pour des champs de type select/autocomplete.","operationId":"getValuesLabels","x-permissionClass":"read","tags":["JDD / Données"],"parameters":[{"in":"query","name":"size","description":"Le nombre de résultats à retourner. 1000 par défaut.","schema":{"title":"Taille de la pagination","default":1000,"type":"integer","maximum":10000}},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}}],"responses":{"200":{"description":"Les valeurs distinctes accompagnées de leurs libellés.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/values_agg":{"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"}}],"get":{"summary":"Agréger les valeurs","description":"Récupérer des informations agrégées en fonction des valeurs de colonnes.","operationId":"getValuesAgg","x-permissionClass":"read","tags":["JDD / Données"],"parameters":[{"in":"query","name":"field","description":"La ou les clés de colonnes en fonction des valeurs desquelles grouper les lignes du jeu de données.","required":true,"explode":false,"schema":{"title":"Colonne(s) de groupement","type":"array","items":{"type":"string"}}},{"in":"query","name":"interval","description":"La manière de grouper les valeurs par niveau d'agrégation.\n\nPour grouper par valeur distincte utilisez \"value\" (comportement par défaut).\n\nSi la colonne de groupement est de type date vous pouvez utiliser un intervalle de calendrier comme \"year\", \"month\", etc ([voir la documentation Elasticsearch](https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation#calendar_intervals)).\n\nSi la colonne est numérique vous pouvez saisir un nombre qui sera utilisé comme intervalle de groupement des valeurs.","required":false,"explode":false,"schema":{"title":"Interval(s) de groupement","type":"array","items":{"type":"string"}}},{"in":"query","name":"html","description":"Effectuer le rendu des contenus formatés de **markdown** vers **HTML**.","schema":{"title":"Rendu HTML des contenus markdown","type":"boolean"}},{"in":"query","name":"metric","description":"La métrique à appliquer par niveau de groupement :\n - `avg` : moyenne\n - `sum` : somme\n - `min` : valeur minimale\n - `max` : valeur maximale\n - `value_count` : nombre de valeurs\n - `cardinality` : nombre de valeurs distinctes (approximatif à partir de 40 000)\n ","explode":false,"schema":{"title":"Métrique","type":"string","enum":["avg","sum","min","max","cardinality","value_count"]}},{"in":"query","name":"metric_field","description":"La clé de la colonne sur laquelle effectuer le calcul de métrique par niveau de groupement.","schema":{"type":"string"}},{"in":"query","name":"missing","description":"Nom du groupe des lignes pour lesquelles la colonne de groupement est vide.","explode":false,"schema":{"title":"Groupe des valeurs manquantes","type":"array","items":{"type":"string"}}},{"in":"query","name":"agg_size","description":"Le nombre de groupes par niveau de groupement.","explode":false,"schema":{"type":"array","items":{"default":20,"type":"integer","maximum":10000}}},{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination).","schema":{"title":"Taille de la pagination","default":0,"type":"integer","maximum":100}},{"in":"query","name":"sort","description":"\nLe tri à effectuer sous forme d'une liste de clés séparées par des virgules.\n\nPour chaque niveau d'agrégation il est possible de trier par le nombre d'éléments dans le groupe (\"count\" et \"-count\") ou par la clé du groupe (\"key\" et \"-key\").\n\nEnsuite il est possible d'ajouter des instructions de tri pour les résultats imbriqués dans le dernier niveau d'agrégation sous forme d'une liste de clés de colonnes.\n\nExemple : `-count,key,ma_colonne,-ma_colonne2`","schema":{"title":"Ordre des résultats","type":"array","items":{"type":"string","enum":["metric","-metric","count","-count","key","-key"]}},"style":"form","explode":false},{"in":"query","name":"select","description":"La liste des clés de colonnes à retourner.","schema":{"title":"La liste des colonnes à retourner","type":"array","items":{"type":"string"},"default":"all"},"style":"form","explode":false},{"in":"query","name":"highlight","description":"\nDemande à retourner des extraits du document qui contiennent les mots utilisés en filtre (paramètres q et qs).\n\nLa valeur est une liste de clés de colonnes séparées par des virgules.\n ","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"thumbnail","description":"\nDemande à retourner un lien de vignette d'une dimension déterminée à partir d'une colonne image.\n\nPour que ce paramètre soit accepté le concept \"Image\" doit être associé à une colonne du jeu de données.\n\nLa valeur du paramètre est la dimension passée sous la form largeurxhauteur (300x200 par exemple) où un 0 sur la largeur ou la hauteur signifie que l'autre valeur est prise en compte et les proportions conservées.\n ","schema":{"type":"string"}},{"in":"query","name":"sampling","description":"\n **Uniquement avec le paramètre de tuilage xyz**. Configure le mode d'échantillonnage des résultats pour privilégier soit l'exhaustivité des données soit une densité plus homogène sur la carte.\n\n - **neighbors** (défaut) : utilise la densité maximale parmi les tuiles voisines pour réduire la densité de la tuile courante au même niveau d'échantillonnage (coûteux en performance).\n - **max** : retourne le maximum (limité par le paramètre size) de résultat pour chaque tuile.\n ","schema":{"type":"string","enum":[null,"neighbors","max"]}},{"in":"query","name":"hint","description":"Ajouter un champ `hint` au corps de la réponse avec un conseil de performance le cas échéant.\n\n - **auto** (défaut) : seulement si la requête est lente.\n - **true** : dès qu'un conseil s'applique.\n - **false** : jamais.","schema":{"title":"Conseil de performance","type":"string","default":"auto","enum":["auto","true","false"]}},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}}],"responses":{"200":{"description":"Les informations du jeu de données agrégées par valeurs d'une colonne.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/metric_agg":{"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"}}],"get":{"summary":"Calculer une métrique","description":"Calculer une métrique sur une colonne.","operationId":"getMetricAgg","x-permissionClass":"read","tags":["JDD / Données"],"parameters":[{"in":"query","name":"metric","description":"La métrique à calculer.","required":true,"schema":{"title":"Métrique à calculer","type":"string","enum":["avg","sum","min","max","stats","value_count","percentiles","cardinality"]}},{"in":"query","name":"field","description":"La clé de la colonne sur laquelle calculer la métrique.","schema":{"title":"Colonne pour le calcul de métrique","type":"string"},"required":true},{"in":"query","name":"percents","description":"Les pourcentages sur lesquels calculer la métrique percentiles (inutile pour les autres métriques).","required":false,"schema":{"title":"Pourcentages sur lesquels calculer la métrique percentiles","type":"string","default":"1,5,25,50,75,95,99"}},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}}],"responses":{"200":{"description":"Le résultat du calcul.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/simple_metrics_agg":{"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"}}],"get":{"summary":"Calculer des métriques simples","description":"Calculer des métriques simples standards sur toutes les colonnes possibles ou sur une liste de colonnes.","operationId":"getSimpleMetricsAgg","x-permissionClass":"read","tags":["JDD / Données"],"parameters":[{"in":"query","name":"metrics","description":"Les métriques à appliquer. Des métriques par défaut sont appliquées en fonction du type de champ.","schema":{"title":"Métriques à appliquer","type":"array","items":{"type":"string","enum":["avg","sum","min","max","stats","value_count","percentiles","cardinality"]}}},{"in":"query","name":"fields","description":"Les clés de colonnes sur lesquelles calculer les métriques.","schema":{"title":"Colonnes sur lesquelles calculer les métriques","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}}],"responses":{"200":{"description":"Le résultat du calcul.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/words_agg":{"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"}}],"get":{"summary":"Lister les mots significatifs","description":"Récupérer des mots significatifs d'une colonne dans un jeu de données.","operationId":"getWordsAgg","x-permissionClass":"read","tags":["JDD / Données"],"parameters":[{"in":"query","name":"field","description":"La clé de la colonne sur laquelle effectuer l'analyse.","required":true,"schema":{"title":"Colonne pour l'analyse","type":"string"}},{"in":"query","name":"analysis","description":"Le type d'analyse textuelle effectuée sur la colonne.\n\nL'analyse \"**lang**\" est intelligente en fonction de la langue, elle calcule la racine grammaticale des mots et ignore les mots les moins significatifs.\n\nL'analyse \"**standard**\" effectue un travail plus basique d'extraction de mots bruts depuis le texte.","schema":{"title":"Type d'analyse à effectuer","type":"string","default":"lang","enum":["lang","standard"]}},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}}],"responses":{"200":{"description":"Le résultat de l'analyse.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/raw":{"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"}}],"get":{"summary":"Télécharger","description":"Télécharger le jeu de données dans son format d'origine.","operationId":"downloadOriginalData","x-permissionClass":"read","tags":["JDD / Données"],"responses":{"200":{"description":"Le fichier de données.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/convert":{"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"}}],"get":{"summary":"Télécharger (format converti)","description":"Télécharger le jeu de données après conversion automatique vers un format standard (CSV typiquement).","operationId":"downloadConvertedData","x-permissionClass":"read","tags":["JDD / Données"],"responses":{"200":{"description":"Le fichier de données converti.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/full":{"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"}}],"get":{"summary":"Télécharger (données enrichies)","description":"Télécharger le jeu de données enrichi avec les colonnes calculées et les extensions.","operationId":"downloadFullData","x-permissionClass":"read","tags":["JDD / Données"],"responses":{"200":{"description":"Le fichier de données enrichi.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/data-files":{"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"}}],"get":{"summary":"Lister les fichiers","description":"Récupérer la liste des fichiers de données disponibles (original, converti, enrichi, etc.).","operationId":"listDataFiles","x-permissionClass":"read","tags":["JDD / Données"],"responses":{"200":{"description":"La liste des fichiers de données.","content":{"application/json":{"schema":{"type":"array","description":"Le tableau de résultats.","items":{"type":"object","properties":{"key":{"type":"string"},"size":{"type":"number"},"name":{"type":"string"},"mimetype":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"title":{"type":"string"},"url":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/data-files/{filePath}":{"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"}},{"in":"path","name":"filePath","description":"Chemin relatif du fichier de données.","required":true,"schema":{"title":"Chemin du fichier","type":"string"}}],"get":{"summary":"Télécharger un fichier","description":"Télécharger un fichier de données spécifique.","operationId":"downloadDataFile","x-permissionClass":"read","tags":["JDD / Données"],"responses":{"200":{"description":"Le fichier de données.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/schema":{"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"}}],"get":{"summary":"Lire le schéma","description":"Récupérer la liste des colonnes et leurs détails, incluant la cardinalité (`x-cardinality`) et les énumérations de valeurs distinctes (`enum`).","operationId":"readSchema","x-permissionClass":"read","tags":["JDD / Métadonnées"],"parameters":[{"in":"query","name":"mimeType","description":"Définir le format du schéma.","required":false,"schema":{"title":"Format du schéma","type":"string","default":"application/json","enum":["application/json","application/tableschema+json","application/schema+json"]}},{"in":"query","name":"type","description":"Filtre sur le type de colonne","required":false,"schema":{"title":"Filtre sur le type de colonne","type":"array","items":{"type":"string","enum":["string","boolean","integer","number"]}},"style":"form","explode":false},{"in":"query","name":"format","description":"Filtre sur le format d'une colonne de type chaîne de caractères","required":false,"schema":{"title":"Filtre sur le format d'une colonne","type":"array","items":{"type":"string","enum":["uri-reference","date","date-time"]}},"style":"form","explode":false},{"in":"query","name":"capability","description":"Restreindre aux colonnes ayant une capacité particulière.\n\n- `index` — **Filtrable sur valeur exacte** : 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.\n- `values` — **Triable et groupable** : 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.\n- `textStandard` — **Texte analysé pour recherche textuelle** : 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.\n- `text` — **Texte analysé spécifiquement pour la langue française** : 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.\n- `textAgg` — **Statistiques de mots** : Activez cette capacité si avez l'intention d'obtenir des statistiques sur les occurrences de mots (par exemple pour construire un nuage de mot).\n- `wildcard` — **Texte filtrable sur groupe de caractères** : 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).\n- `insensitive` — **Tri amélioré avec casse et accents** : 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.\n- `geoShape` — **Formes géométriques complexes** : 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.\n- `vtPrepare` — **Tuiles vectorielles préparées** : 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.\n- `indexAttachment` — **Contenu des pièces jointes analysé pour recherche textuelle** : 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.","required":false,"schema":{"title":"Restreindre par capacité de la colonne","type":"string","enum":["index","values","textStandard","text","textAgg","wildcard","insensitive","geoShape","vtPrepare","indexAttachment"]}},{"in":"query","name":"enum","description":"Restreindre aux colonnes ayant une énumération de valeurs (moins de 50 valeurs distinctes).","required":false,"schema":{"title":"Restreindre par colonnes énumérables","type":"string","enum":["false","true"]}},{"in":"query","name":"calculated","description":"Inclure ou non les colonnes calculées par Data Fair, c'est-à-dire les colonnes qui ne sont pas issues du fichier d'origine.\n\nPar défaut ces colonnes sont **incluses**. Mettre `false` pour les exclure.\n\n*Exception : avec le format `mimeType=application/schema+json` elles sont par défaut exclues.*","required":false,"schema":{"title":"Inclure les colonnes calculées","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"La liste des colonnes.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/safe-schema":{"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"}}],"get":{"summary":"Lire le schéma réduit","description":"Récupérer la liste des colonnes et leurs détails.\n*Les valeurs distinctes (`enum`) et la cardinalité (`x-cardinality`) ne sont pas exposées.*","operationId":"readSafeSchema","x-permissionClass":"read","tags":["JDD / Métadonnées"],"parameters":[{"in":"query","name":"mimeType","description":"Définir le format du schéma.","required":false,"schema":{"title":"Format du schéma","type":"string","default":"application/json","enum":["application/json","application/tableschema+json","application/schema+json"]}},{"in":"query","name":"type","description":"Filtre sur le type de colonne","required":false,"schema":{"title":"Filtre sur le type de colonne","type":"array","items":{"type":"string","enum":["string","boolean","integer","number"]}},"style":"form","explode":false},{"in":"query","name":"format","description":"Filtre sur le format d'une colonne de type chaîne de caractères","required":false,"schema":{"title":"Filtre sur le format d'une colonne","type":"array","items":{"type":"string","enum":["uri-reference","date","date-time"]}},"style":"form","explode":false},{"in":"query","name":"capability","description":"Restreindre aux colonnes ayant une capacité particulière.\n\n- `index` — **Filtrable sur valeur exacte** : 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.\n- `values` — **Triable et groupable** : 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.\n- `textStandard` — **Texte analysé pour recherche textuelle** : 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.\n- `text` — **Texte analysé spécifiquement pour la langue française** : 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.\n- `textAgg` — **Statistiques de mots** : Activez cette capacité si avez l'intention d'obtenir des statistiques sur les occurrences de mots (par exemple pour construire un nuage de mot).\n- `wildcard` — **Texte filtrable sur groupe de caractères** : 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).\n- `insensitive` — **Tri amélioré avec casse et accents** : 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.\n- `geoShape` — **Formes géométriques complexes** : 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.\n- `vtPrepare` — **Tuiles vectorielles préparées** : 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.\n- `indexAttachment` — **Contenu des pièces jointes analysé pour recherche textuelle** : 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.","required":false,"schema":{"title":"Restreindre par capacité de la colonne","type":"string","enum":["index","values","textStandard","text","textAgg","wildcard","insensitive","geoShape","vtPrepare","indexAttachment"]}},{"in":"query","name":"enum","description":"Restreindre aux colonnes ayant une énumération de valeurs (moins de 50 valeurs distinctes).","required":false,"schema":{"title":"Restreindre par colonnes énumérables","type":"string","enum":["false","true"]}},{"in":"query","name":"calculated","description":"Inclure ou non les colonnes calculées par Data Fair, c'est-à-dire les colonnes qui ne sont pas issues du fichier d'origine.\n\nPar défaut ces colonnes sont **incluses**. Mettre `false` pour les exclure.\n\n*Exception : avec le format `mimeType=application/schema+json` elles sont par défaut exclues.*","required":false,"schema":{"title":"Inclure les colonnes calculées","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"La liste des colonnes.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/api-docs.json":{"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"}}],"get":{"summary":"Obtenir la documentation OpenAPI","description":"Accéder à la documentation publique du jeu de données au format OpenAPI v3.","operationId":"readApiDoc","x-permissionClass":"read","tags":["JDD / Métadonnées"],"responses":{"200":{"description":"La documentation publique de l'API.","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/private-api-docs.json":{"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"}}],"get":{"summary":"Obtenir la documentation privée OpenAPI","description":"Accéder à la documentation privée du jeu de données au format OpenAPI v3.","operationId":"readPrivateApiDoc","x-permissionClass":"readAdvanced","tags":["JDD / Métadonnées"],"responses":{"200":{"description":"La documentation privée de l'API.","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/thumbnail":{"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"}}],"get":{"summary":"Récupérer la vignette","description":"Récupérer la vignette de l'image de couverture du jeu de données, redimensionnée pour servir d'aperçu.","operationId":"readThumbnail","x-permissionClass":"read","tags":["JDD / Métadonnées"],"responses":{"200":{"description":"La vignette du jeu de données.","content":{"image/*":{}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"Le jeu de données n'existe pas ou ne possède pas d'image associée.","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/attachments/{attachmentId}":{"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"}},{"in":"path","name":"attachmentId","description":"Identifiant (chemin relatif) de la pièce jointe de données.","required":true,"schema":{"title":"Identifiant de la pièce jointe","type":"string"}}],"get":{"summary":"Télécharger une pièce jointe","description":"Télécharger une pièce jointe de données référencée par une colonne de type *DigitalDocument*.","operationId":"downloadAttachment","x-permissionClass":"read","tags":["JDD / Données"],"responses":{"200":{"description":"Le fichier de la pièce jointe."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/master-data/single-searchs/{singleSearchId}":{"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"}}],"get":{"tags":["JDD / Données"],"summary":"Recherche unitaire","description":"Récupérer une ligne par recherche unitaire","operationId":"masterData_singleSearch_{singleSearchId}","x-operationType":"http://schema.org/SearchAction","x-permissionClass":"read","parameters":[{"in":"query","name":"q","description":"La recherche textuelle à effectuer","schema":{"type":"string"}},{"in":"query","name":"size","description":"Nombre de résultats candidats à retourner","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"Réponse en cas de succès de la requête","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string","title":"Propriété à retourner","x-refersTo":"http://schema.org/name"},"_score":{"type":"number","title":"Pertinence du résultat"},"label":{"type":"string","title":"Propriété utilisée pour représenter les résultats","x-refersTo":"http://www.w3.org/2000/01/rdf-schema#label"}}}}}}}}},"/datasets/{id}/master-data/bulk-searchs/{bulkSearchId}":{"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"}}],"post":{"tags":["JDD / Données"],"summary":"Recherche en masse","description":"Récupérer en masse des lignes par lots","operationId":"masterData_bulkSearch_{bulkSearchId}","x-operationType":"http://schema.org/SearchAction","x-permissionClass":"read","parameters":[{"in":"query","name":"select","description":"La liste des colonnes à retourner","schema":{"type":"array","items":{"type":"string","enum":["name","description","category","value","siret","image","document"]}},"style":"form","explode":false}],"requestBody":{"description":"Ensemble de filtres à appliquer","required":true,"content":{"application/x-ndjson":{"schema":{"title":"Filtre pour une ligne","type":"object","properties":{"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret","description":""},"_key":{"description":"Identifiant de la ligne de requête","type":"string","x-refersTo":"http://schema.org/identifier"}}}},"application/json":{"schema":{"title":"Filtre pour une ligne","type":"object","properties":{"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret","description":""},"_key":{"description":"Identifiant de la ligne de requête","type":"string","x-refersTo":"http://schema.org/identifier"}}}},"text/csv":{"schema":{"title":"Filtre pour une ligne","type":"object","properties":{"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret","description":""},"_key":{"description":"Identifiant de la ligne de requête","type":"string","x-refersTo":"http://schema.org/identifier"}}}}}},"responses":{"200":{"description":"Réponse en cas de succès de la requête","content":{"application/x-ndjson":{"schema":{"type":"object","properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name","description":""},"description":{"type":"string","title":"Description","description":""},"category":{"type":"string","title":"Catégorie","description":""},"value":{"type":"number","title":"Valeur","description":""},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret","description":""},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image","description":""},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument","description":""},"_key":{"title":"Identifiant de la ligne de requête","type":"string","x-refersTo":"http://schema.org/identifier"},"_error":{"type":"string","title":"Erreur de récupération de données de référence"}}}},"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name","description":""},"description":{"type":"string","title":"Description","description":""},"category":{"type":"string","title":"Catégorie","description":""},"value":{"type":"number","title":"Valeur","description":""},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret","description":""},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image","description":""},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument","description":""},"_key":{"title":"Identifiant de la ligne de requête","type":"string","x-refersTo":"http://schema.org/identifier"},"_error":{"type":"string","title":"Erreur de récupération de données de référence"}}}},"text/csv":{"schema":{"type":"object","properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name","description":""},"description":{"type":"string","title":"Description","description":""},"category":{"type":"string","title":"Catégorie","description":""},"value":{"type":"number","title":"Valeur","description":""},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret","description":""},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image","description":""},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument","description":""},"_key":{"title":"Identifiant de la ligne de requête","type":"string","x-refersTo":"http://schema.org/identifier"},"_error":{"type":"string","title":"Erreur de récupération de données de référence"}}}}}},"400":{"description":"Mauvais formatage de la requête","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/geo_agg":{"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"}}],"get":{"summary":"Agréger spatialement","description":"Récupérer des informations agrégées spatialement sur le jeu de données.","operationId":"getGeoAgg","x-permissionClass":"read","tags":["JDD / Données"],"parameters":[{"in":"query","name":"agg_size","description":"Le nombre de buckets pour l'agrégation.","schema":{"default":20,"type":"integer","maximum":10000}},{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination).","schema":{"title":"Taille de la pagination","default":0,"type":"integer","maximum":100}},{"in":"query","name":"sort","description":"\nLe tri à effectuer sous forme d'une liste de clés de colonnes séparées par des virgules.\n\nPar défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple : `ma_colonne,-ma_colonne2`","schema":{"title":"Ordre des résultats","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"select","description":"La liste des clés de colonnes à retourner.","schema":{"title":"La liste des colonnes à retourner","type":"array","items":{"type":"string"},"default":"all"},"style":"form","explode":false},{"in":"query","name":"highlight","description":"\nDemande à retourner des extraits du document qui contiennent les mots utilisés en filtre (paramètres q et qs).\n\nLa valeur est une liste de clés de colonnes séparées par des virgules.\n ","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"thumbnail","description":"\nDemande à retourner un lien de vignette d'une dimension déterminée à partir d'une colonne image.\n\nPour que ce paramètre soit accepté le concept \"Image\" doit être associé à une colonne du jeu de données.\n\nLa valeur du paramètre est la dimension passée sous la form largeurxhauteur (300x200 par exemple) où un 0 sur la largeur ou la hauteur signifie que l'autre valeur est prise en compte et les proportions conservées.\n ","schema":{"type":"string"}},{"in":"query","name":"sampling","description":"\n **Uniquement avec le paramètre de tuilage xyz**. Configure le mode d'échantillonnage des résultats pour privilégier soit l'exhaustivité des données soit une densité plus homogène sur la carte.\n\n - **neighbors** (défaut) : utilise la densité maximale parmi les tuiles voisines pour réduire la densité de la tuile courante au même niveau d'échantillonnage (coûteux en performance).\n - **max** : retourne le maximum (limité par le paramètre size) de résultat pour chaque tuile.\n ","schema":{"type":"string","enum":[null,"neighbors","max"]}},{"in":"query","name":"format","description":"Le format de sérialisation de la donnée.\n\n - **json** (défaut)\n - **csv**, **xlsx**, **ods** pour formats compatibles tableurs\n - **pbf** pour tuiles vectorielles\n - **geojson**, **shp**, **wkt** pour formats géographiques","schema":{"title":"Format de sérialisation","default":"json","type":"string","enum":["json","csv","xlsx","ods","pbf","geojson","shp","wkt"]}},{"in":"query","name":"html","description":"Effectuer le rendu des contenus formatés de **markdown** vers **HTML**.","schema":{"title":"Rendu HTML des contenus markdown","type":"boolean"}},{"in":"query","name":"hint","description":"Ajouter un champ `hint` au corps de la réponse avec un conseil de performance le cas échéant.\n\n - **auto** (défaut) : seulement si la requête est lente.\n - **true** : dès qu'un conseil s'applique.\n - **false** : jamais.","schema":{"title":"Conseil de performance","type":"string","default":"auto","enum":["auto","true","false"]}},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}}],"responses":{"200":{"description":"Les informations du jeu de données agrégées spatialement.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/revisions":{"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"}}],"get":{"summary":"Récupérer les révisions","description":"Récupérer les révisions de lignes triées du plus récent au plus ancien.","operationId":"readRevisions","x-permissionClass":"read","tags":["JDD / Éditable"],"parameters":[{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination).","schema":{"title":"Taille de la pagination","default":12,"type":"integer","maximum":10000}},{"in":"query","name":"before","description":"Pagination pour remonter dans l'historique.\n\n*Automatiquement renseigné par la propriété **next** du résultat de la requête précédente.*","schema":{"title":"Pagination pour remonter dans l'historique","default":1,"type":"integer"}}],"responses":{"200":{"description":"Les révisions.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"Le nombre total de résultat si on ignore la pagination."},"results":{"type":"array","items":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"},"_action":{"type":"string","title":"Action","enum":["create","delete","update","createOrUpdate","patch"],"description":"\n- create: crée la ligne\n- delete: supprime la ligne, nécessite la présence de _id\n- update: remplace la ligne, nécessite la présence de _id\n- createOrUpdate: crée la ligne si elle n'existe pas, sinon la remplace\n- patch: modifie la ligne, nécessite la présence de _id\n "}}}},"next":{"type":"string","description":"URL pour continuer la pagination."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/lines/{lineId}/revisions":{"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"}},{"in":"path","name":"lineId","description":"Identifiant de la ligne.","required":true,"schema":{"title":"Identifiant de la ligne","type":"string"}}],"get":{"summary":"Récupérer les révisions d'une ligne","description":"Récupérer les révisions d'une ligne triées du plus récent au plus ancien.","operationId":"readLineRevisions","x-permissionClass":"read","tags":["JDD / Éditable"],"parameters":[{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination).","schema":{"title":"Taille de la pagination","default":12,"type":"integer","maximum":10000}},{"in":"query","name":"before","description":"Pagination pour remonter dans l'historique.\n\n*Automatiquement renseigné par la propriété **next** du résultat de la requête précédente.*","schema":{"title":"Pagination pour remonter dans l'historique","default":1,"type":"integer"}}],"responses":{"200":{"description":"Les révisions.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"Le nombre total de résultat si on ignore la pagination."},"results":{"type":"array","items":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"},"_action":{"type":"string","title":"Action","enum":["create","delete","update","createOrUpdate","patch"],"description":"\n- create: crée la ligne\n- delete: supprime la ligne, nécessite la présence de _id\n- update: remplace la ligne, nécessite la présence de _id\n- createOrUpdate: crée la ligne si elle n'existe pas, sinon la remplace\n- patch: modifie la ligne, nécessite la présence de _id\n "}}}},"next":{"type":"string","description":"URL pour continuer la pagination."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/metadata-attachments":{"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"}}],"post":{"summary":"Charger une pièce jointe","description":"Charger une pièce jointe dans les métadonnées.\n\n**Attention** : il faut ensuite ajouter la pièce jointe aux informations du jeu de données via l'opération `writeDescription` (`PATCH /`) pour qu'elle soit répertoriée.","operationId":"postMetadataAttachment","x-permissionClass":"write","tags":["JDD / Métadonnées"],"requestBody":{"description":"La pièce jointe à charger.","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"La pièce jointe a correctement été chargée.","content":{"application/json":{"schema":{"type":"object","properties":{"mimetype":{"type":"string"},"name":{"type":"string"},"size":{"type":"integer"},"updatedAt":{"type":"string","format":"date-time"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/metadata-attachments/{attachmentId}":{"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"}},{"in":"path","name":"attachmentId","description":"Identifiant (chemin relatif) de la pièce jointe.","required":true,"schema":{"title":"Identifiant de la pièce jointe","type":"string"}}],"get":{"summary":"Télécharger une pièce jointe","description":"Télécharger une pièce jointe des métadonnées.","operationId":"downloadMetadataAttachment","x-permissionClass":"read","tags":["JDD / Métadonnées"],"responses":{"200":{"description":"Le fichier de la pièce jointe."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"summary":"Supprimer une pièce jointe","description":"Supprimer une pièce jointe des métadonnées.\n\n**Attention** : il faut ensuite supprimer la pièce jointe des informations du jeu de données via l'opération `writeDescription` (`PATCH /`) pour qu'elle ne soit plus répertoriée.","operationId":"deleteMetadataAttachment","x-permissionClass":"write","tags":["JDD / Métadonnées"],"responses":{"204":{"description":"La pièce jointe a été supprimée."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/journal":{"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"}}],"get":{"summary":"Lister les événements","description":"Lister les événements du journal du jeu de données.","operationId":"readJournal","x-permissionClass":"readAdvanced","tags":["JDD / Métadonnées"],"responses":{"200":{"description":"Le journal d'événements du jeu de données.","content":{"application/json":{"schema":{"type":"object","title":"Journal","description":"Journal d'événements d'une ressource.","required":["id","type","events"],"properties":{"id":{"type":"string","description":"Identifiant de la ressource."},"type":{"type":"string","description":"Type de ressource concernée par l'événement.","enum":["dataset","application","remote-service","catalog"]},"events":{"type":"array","items":{"type":"object","required":["type","date"],"properties":{"type":{"type":"string"},"date":{"type":"string","format":"date-time"},"data":{"type":"string"},"draft":{"type":"boolean"}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/user-notification":{"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"}}],"post":{"summary":"Envoyer une notification","description":"Envoyer une notification relative au jeu de données à la visibilité interne au compte.","operationId":"sendUserNotification","x-permissionClass":"write","tags":["JDD / Métadonnées"],"requestBody":{"description":"Le contenu de la notification.","content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"La notification envoyée.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/draft":{"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"}}],"post":{"summary":"Valider le brouillon","description":"Valider la version brouillon du jeu de données pour la rendre courante.","operationId":"validateDraft","x-permissionClass":"write","tags":["JDD / Données"],"responses":{"200":{"description":"Le jeu de données après validation du brouillon.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Conflit : le jeu de données est verrouillé ou se trouve dans un état incompatible avec cette opération.","content":{"text/plain":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Annuler le brouillon","description":"Annuler la version brouillon du jeu de données et revenir à la version courante.","operationId":"cancelDraft","x-permissionClass":"write","tags":["JDD / Données"],"responses":{"200":{"description":"Le jeu de données après annulation du brouillon.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dataset"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Conflit : le jeu de données est verrouillé ou se trouve dans un état incompatible avec cette opération.","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/lines/{lineId}":{"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"}},{"in":"path","name":"lineId","description":"L'identifiant de la ligne.","required":true,"schema":{"title":"Identifiant de la ligne","type":"string"}}],"get":{"summary":"Récupérer une ligne","description":"Récupérer le contenu complet d'une ligne par son identifiant.","operationId":"readLine","x-permissionClass":"read","tags":["JDD / Éditable"],"responses":{"200":{"description":"Le contenu d'une ligne de données.","content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"summary":"Remplacer une ligne","description":"Remplacer entièrement le contenu d'une ligne par son identifiant.","operationId":"updateLine","x-permissionClass":"write","tags":["JDD / Éditable"],"requestBody":{"description":"Le contenu d'une ligne de données.","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"responses":{"200":{"description":"La ligne de données modifiée.","content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}},"patch":{"summary":"Modifier une ligne","description":"Modifier partiellement le contenu d'une ligne par son identifiant.","operationId":"patchLine","x-permissionClass":"write","tags":["JDD / Éditable"],"requestBody":{"description":"Le contenu partiel d'une ligne de données.","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"responses":{"200":{"description":"La ligne de données après modification.","content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Supprimer une ligne","description":"Supprimer une ligne par son identifiant.","operationId":"deleteLine","x-permissionClass":"write","tags":["JDD / Éditable"],"responses":{"204":{"description":"La ligne de données a été supprimée."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/_bulk_lines":{"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"}}],"post":{"summary":"Effectuer des opérations en masse","description":"Créer/modifier/supprimer de multiples lignes en une seule opération.","operationId":"bulkLines","x-permissionClass":"write","tags":["JDD / Éditable"],"requestBody":{"description":"Les opérations à appliquer.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"},"_action":{"type":"string","title":"Action","enum":["create","delete","update","createOrUpdate","patch"],"description":"\n- create: crée la ligne\n- delete: supprime la ligne, nécessite la présence de _id\n- update: remplace la ligne, nécessite la présence de _id\n- createOrUpdate: crée la ligne si elle n'existe pas, sinon la remplace\n- patch: modifie la ligne, nécessite la présence de _id\n "}}}}},"application/x-ndjson":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"},"_action":{"type":"string","title":"Action","enum":["create","delete","update","createOrUpdate","patch"],"description":"\n- create: crée la ligne\n- delete: supprime la ligne, nécessite la présence de _id\n- update: remplace la ligne, nécessite la présence de _id\n- createOrUpdate: crée la ligne si elle n'existe pas, sinon la remplace\n- patch: modifie la ligne, nécessite la présence de _id\n "}}}}}},"responses":{"200":{"description":"Le résultat des opérations.","content":{"application/json":{"schema":{"type":"object","properties":{"nbOk":{"type":"integer"},"nbNotModified":{"type":"integer"},"nbErrors":{"type":"integer"},"errors":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer"},"error":{"type":"string"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/own/{owner}/lines":{"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"}},{"in":"path","name":"owner","description":"Le propriétaire des lignes.","required":true,"schema":{"title":"Propriétaire des lignes","type":"string"}}],"get":{"summary":"Lire les lignes (par propriétaire)","description":"Requêter les lignes du jeu de données. (restreint par propriétaire de ligne)","operationId":"readOwnLines","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"parameters":[{"in":"query","name":"after","description":"Pagination en profondeur.\n\n*Automatiquement renseigné par la propriété **next** du résultat de la requête précédente.*","schema":{"title":"Pagination en profondeur","type":"integer"}},{"in":"query","name":"page","description":"Le numéro de la page (indice de la pagination). Débute à 1.\n\n*Pour paginer sur de gros volumes de données utilisez plutôt le paramètre **after***.","schema":{"title":"Numéro de la page","type":"integer","default":1}},{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination).","schema":{"title":"Taille de la pagination","default":12,"type":"integer","maximum":10000}},{"in":"query","name":"sort","description":"\nLe tri à effectuer sous forme d'une liste de clés de colonnes séparées par des virgules.\n\nPar défaut le tri est ascendant, si un nom de colonne est préfixé par un \"-\" alors le tri sera descendant.\n\nExemple : `ma_colonne,-ma_colonne2`","schema":{"title":"Ordre des résultats","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"select","description":"La liste des clés de colonnes à retourner.","schema":{"title":"La liste des colonnes à retourner","type":"array","items":{"type":"string"},"default":"all"},"style":"form","explode":false},{"in":"query","name":"highlight","description":"\nDemande à retourner des extraits du document qui contiennent les mots utilisés en filtre (paramètres q et qs).\n\nLa valeur est une liste de clés de colonnes séparées par des virgules.\n ","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"thumbnail","description":"\nDemande à retourner un lien de vignette d'une dimension déterminée à partir d'une colonne image.\n\nPour que ce paramètre soit accepté le concept \"Image\" doit être associé à une colonne du jeu de données.\n\nLa valeur du paramètre est la dimension passée sous la form largeurxhauteur (300x200 par exemple) où un 0 sur la largeur ou la hauteur signifie que l'autre valeur est prise en compte et les proportions conservées.\n ","schema":{"type":"string"}},{"in":"query","name":"sampling","description":"\n **Uniquement avec le paramètre de tuilage xyz**. Configure le mode d'échantillonnage des résultats pour privilégier soit l'exhaustivité des données soit une densité plus homogène sur la carte.\n\n - **neighbors** (défaut) : utilise la densité maximale parmi les tuiles voisines pour réduire la densité de la tuile courante au même niveau d'échantillonnage (coûteux en performance).\n - **max** : retourne le maximum (limité par le paramètre size) de résultat pour chaque tuile.\n ","schema":{"type":"string","enum":[null,"neighbors","max"]}},{"in":"query","name":"format","description":"Le format de sérialisation de la donnée.\n\n - **json** (défaut)\n - **csv**, **xlsx**, **ods** pour formats compatibles tableurs\n - **pbf** pour tuiles vectorielles\n - **geojson**, **shp**, **wkt** pour formats géographiques","schema":{"title":"Format de sérialisation","default":"json","type":"string","enum":["json","csv","xlsx","ods","pbf","geojson","shp","wkt"]}},{"in":"query","name":"html","description":"Effectuer le rendu des contenus formatés de **markdown** vers **HTML**.","schema":{"title":"Rendu HTML des contenus markdown","type":"boolean"}},{"in":"query","name":"hint","description":"Ajouter un champ `hint` au corps de la réponse avec un conseil de performance le cas échéant.\n\n - **auto** (défaut) : seulement si la requête est lente.\n - **true** : dès qu'un conseil s'applique.\n - **false** : jamais.","schema":{"title":"Conseil de performance","type":"string","default":"auto","enum":["auto","true","false"]}},{"in":"query","name":"q","description":"\n Colonne de recherche simple. Ce paramètre peut être utilisé pour exposer une fonctionnalité de recherche textuelle riche aux utilisateurs sans risque de créer des erreurs de syntaxe.\n\n Exemple : `\"open data\" | \"open source\"`\n\n Pour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle","type":"string"}},{"in":"query","name":"q_mode","description":"\n Ce paramètre permet d'altérer le comportement du paramètre \"q\".\n\n Le mode par défaut \"simple\" expose directement la fonctionnalité [simple-query-string de Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)\n\n Le mode \"complete\" permet d'enrichir automatiquement la requête soumise par l'utilisateur pour un résultat intuitif dans le contexte d'un champ de type autocomplete. Attention ce mode est potentiellement moins performant et à limiter à des jeux de données au volume raisonnable.\n ","schema":{"title":"Mode de recherche","type":"string","default":"simple","enum":["simple","complete"]}},{"in":"query","name":"q_fields","description":"\n Ce paramètre permet de spécifier les clés de colonnes sur lesquelles appliquer le paramètre \"q\".\n\n Par défaut toutes les colonnes supportant une recherche textuelle sont utilisées.\n ","schema":{"title":"Colonnes de recherche","type":"array","items":{"type":"string"}},"style":"form","explode":false},{"in":"query","name":"filters","schema":{"type":"object","title":"Filtres sur colonnes","patternPropertiesLayout":{"messages":{"addItem":"Ajouter un filtre"},"help":"Filtres structurés sur colonne.\n\nLe nom est constitué de la clé de la colonne concaténée avec un suffixe par type de filtre (par exemple `ma_colonne_eq`, `ma_colonne_in`, etc.).\n\nLes types de filtres disponibles peuvent varier par colonne.\n\n - `_eq` : égal à une valeur\n - `_neq` : différent d'une valeur\n - `_in` : appartient à une liste de valeurs (séparées par des virgules)\n - `_nin` : n'appartient pas à une liste de valeurs (séparées par des virgules)\n - `_gt` : strictement supérieur à une valeur\n - `_gte` : supérieur ou égal à une valeur\n - `_lt` : strictement inférieur à une valeur\n - `_lte` : inférieur ou égal à une valeur\n - `_starts` : commence par une série de caractères\n - `_contains` : contient une série de caractères\n - `_search` : effectue une recherche textuelle simple\n - `_exists` : la colonne contient une valeur\n - `_nexists` : la colonne ne contient pas une valeur\n "},"patternProperties":{".*":{"type":"string","default":"","layout":{"placeholder":"saisissez la valeur du filtre"}}}}},{"in":"query","name":"qs","description":"\nColonne de filtre et recherche textuelle avancée. Ce paramètre permet d'effectuer des requêtes complexes sur la source de données. Vous pouvez spécifier des filtres par colonne, créer des combinaisons logiques à volonté, etc.\n\n**Attention**, ce paramètre est d'utilisation technique et n'est vraiment nécessaire que pour effectuer des combinaisons logiques particulières. Dans la majorité des cas il est recommandé d'utiliser \"Filtres sur colonnes\" ci-dessus.\n\nExemple : `ma_colonne:\"du texte\" AND ma_colonne2:valeur`\n\nPour plus d'information voir la documentation [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) correspondante.\n ","schema":{"title":"Recherche textuelle avancée","type":"string"}},{"in":"query","name":"bbox","description":"Un filtre pour restreindre les résultats à une zone géographique. Le format est 'gauche,bas,droite,haut' autrement dit 'lonMin,latMin,lonMax,latMax'.","schema":{"title":"Filtre par zone géographique","type":"string","examples":["2.2241,48.8156,2.4699,48.9022"]}},{"in":"query","name":"xyz","description":"\n Un filtre pour restreindre les résultats à une zone géographique avec les paramètres standards de tuiles géographiques x,y et z.\n\n Le format est 'x,y,z'.\n ","schema":{"title":"Filtre par tuile géographique","type":"string"}},{"in":"query","name":"geo_distance","description":"\n Un filtre pour restreindre les résultats à moins d'une certaine distance du point passé en paramètre.\n\n Le format est 'lon:lat:distance'. La distance optionnelle (0 par défaut) et est exprimée en mètres.\n\n Si les documents contiennent des géométries la distance est calculée à partir de leurs centroïdes à moins que la distance soit 0 auquel cas le filtre retourne tous les documents dont la géométrie contient le point passé en paramètre.\n ","schema":{"title":"Filtre par distance géographique","type":"string"}},{"in":"query","name":"collapse","description":"Afficher une ligne de résultat par valeur distincte d'une colonne.","schema":{"type":"string"}}],"responses":{"200":{"description":"Le résultat de la requête.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"Le nombre total de résultat si on ignore la pagination."},"results":{"type":"array","description":"Le tableau de résultats.","items":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}},"next":{"type":"string","description":"URL pour continuer la pagination."}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"post":{"summary":"Ajouter une ligne (par propriétaire)","description":"Ajouter une nouvelle ligne au jeu de données. (restreint par propriétaire de ligne)","operationId":"createOwnLine","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"requestBody":{"description":"Le contenu d'une ligne de données.","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"responses":{"201":{"description":"La ligne de données ajoutée.","content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/own/{owner}/lines/{lineId}":{"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"}},{"in":"path","name":"owner","description":"Le propriétaire des lignes.","required":true,"schema":{"title":"Propriétaire des lignes","type":"string"}},{"in":"path","name":"lineId","description":"L'identifiant de la ligne.","required":true,"schema":{"title":"Identifiant de la ligne","type":"string"}}],"get":{"summary":"Récupérer une ligne (par propriétaire)","description":"Récupérer le contenu complet d'une ligne par son identifiant. (restreint par propriétaire de ligne)","operationId":"readOwnLine","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"responses":{"200":{"description":"Le contenu d'une ligne de données.","content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}},"put":{"summary":"Remplacer une ligne (par propriétaire)","description":"Remplacer entièrement le contenu d'une ligne par son identifiant. (restreint par propriétaire de ligne)","operationId":"updateOwnLine","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"requestBody":{"description":"Le contenu d'une ligne de données.","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"responses":{"200":{"description":"La ligne de données modifiée.","content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}},"patch":{"summary":"Modifier une ligne (par propriétaire)","description":"Modifier partiellement le contenu d'une ligne par son identifiant. (restreint par propriétaire de ligne)","operationId":"patchOwnLine","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"requestBody":{"description":"Le contenu partiel d'une ligne de données.","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"responses":{"200":{"description":"La ligne de données après modification.","content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Supprimer une ligne (par propriétaire)","description":"Supprimer une ligne par son identifiant. (restreint par propriétaire de ligne)","operationId":"deleteOwnLine","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"responses":{"204":{"description":"La ligne de données a été supprimée."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/own/{owner}/_bulk_lines":{"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"}},{"in":"path","name":"owner","description":"Le propriétaire des lignes.","required":true,"schema":{"title":"Propriétaire des lignes","type":"string"}}],"post":{"summary":"Effectuer des opérations en masse (par propriétaire)","description":"Créer/modifier/supprimer de multiples lignes en une seule opération. (restreint par propriétaire de ligne)","operationId":"bulkOwnLines","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"requestBody":{"description":"Les opérations à appliquer.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"},"_action":{"type":"string","title":"Action","enum":["create","delete","update","createOrUpdate","patch"],"description":"\n- create: crée la ligne\n- delete: supprime la ligne, nécessite la présence de _id\n- update: remplace la ligne, nécessite la présence de _id\n- createOrUpdate: crée la ligne si elle n'existe pas, sinon la remplace\n- patch: modifie la ligne, nécessite la présence de _id\n "}}}}},"application/x-ndjson":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"},"_action":{"type":"string","title":"Action","enum":["create","delete","update","createOrUpdate","patch"],"description":"\n- create: crée la ligne\n- delete: supprime la ligne, nécessite la présence de _id\n- update: remplace la ligne, nécessite la présence de _id\n- createOrUpdate: crée la ligne si elle n'existe pas, sinon la remplace\n- patch: modifie la ligne, nécessite la présence de _id\n "}}}}}},"responses":{"200":{"description":"Le résultat des opérations.","content":{"application/json":{"schema":{"type":"object","properties":{"nbOk":{"type":"integer"},"nbNotModified":{"type":"integer"},"nbErrors":{"type":"integer"},"errors":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer"},"error":{"type":"string"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"413":{"description":"Quota de stockage dépassé ou fichier trop volumineux.","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/datasets/{id}/own/{owner}/revisions":{"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"}},{"in":"path","name":"owner","description":"Le propriétaire des lignes.","required":true,"schema":{"title":"Propriétaire des lignes","type":"string"}}],"get":{"summary":"Récupérer les révisions (par propriétaire)","description":"Récupérer les révisions de lignes triées du plus récent au plus ancien. (restreint par propriétaire de ligne)","operationId":"readRevisions","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"parameters":[{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination).","schema":{"title":"Taille de la pagination","default":12,"type":"integer","maximum":10000}},{"in":"query","name":"before","description":"Pagination pour remonter dans l'historique.\n\n*Automatiquement renseigné par la propriété **next** du résultat de la requête précédente.*","schema":{"title":"Pagination pour remonter dans l'historique","default":1,"type":"integer"}}],"responses":{"200":{"description":"Les révisions.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"Le nombre total de résultat si on ignore la pagination."},"results":{"type":"array","items":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"},"_action":{"type":"string","title":"Action","enum":["create","delete","update","createOrUpdate","patch"],"description":"\n- create: crée la ligne\n- delete: supprime la ligne, nécessite la présence de _id\n- update: remplace la ligne, nécessite la présence de _id\n- createOrUpdate: crée la ligne si elle n'existe pas, sinon la remplace\n- patch: modifie la ligne, nécessite la présence de _id\n "}}}},"next":{"type":"string","description":"URL pour continuer la pagination."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/own/{owner}/lines/{lineId}/revisions":{"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"}},{"in":"path","name":"owner","description":"Le propriétaire des lignes.","required":true,"schema":{"title":"Propriétaire des lignes","type":"string"}},{"in":"path","name":"lineId","description":"Identifiant de la ligne.","required":true,"schema":{"title":"Identifiant de la ligne","type":"string"}}],"get":{"summary":"Récupérer les révisions d'une ligne (par propriétaire)","description":"Récupérer les révisions d'une ligne triées du plus récent au plus ancien. (restreint par propriétaire de ligne)","operationId":"readOwnLineRevisions","x-permissionClass":"manageOwnLines","tags":["JDD / Éditable"],"parameters":[{"in":"query","name":"size","description":"Le nombre de résultats à retourner (taille de la pagination).","schema":{"title":"Taille de la pagination","default":12,"type":"integer","maximum":10000}},{"in":"query","name":"before","description":"Pagination pour remonter dans l'historique.\n\n*Automatiquement renseigné par la propriété **next** du résultat de la requête précédente.*","schema":{"title":"Pagination pour remonter dans l'historique","default":1,"type":"integer"}}],"responses":{"200":{"description":"Les révisions.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"Le nombre total de résultat si on ignore la pagination."},"results":{"type":"array","items":{"type":"object","required":[],"properties":{"name":{"type":"string","title":"Nom","x-refersTo":"http://schema.org/name"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Catégorie"},"value":{"type":"number","title":"Valeur"},"siret":{"type":"string","title":"SIRET","x-refersTo":"http://dbpedia.org/ontology/siret"},"image":{"type":"string","title":"Image","x-refersTo":"http://schema.org/image"},"document":{"type":"string","title":"Document","x-refersTo":"http://schema.org/DigitalDocument"},"_action":{"type":"string","title":"Action","enum":["create","delete","update","createOrUpdate","patch"],"description":"\n- create: crée la ligne\n- delete: supprime la ligne, nécessite la présence de _id\n- update: remplace la ligne, nécessite la présence de _id\n- createOrUpdate: crée la ligne si elle n'existe pas, sinon la remplace\n- patch: modifie la ligne, nécessite la présence de _id\n "}}}},"next":{"type":"string","description":"URL pour continuer la pagination."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/datasets/{id}/permissions":{"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"}}],"get":{"summary":"Liste des permissions","description":"Récupérer la liste des permissions.","operationId":"getPermissions","x-permissionClass":"admin","tags":["JDD / Métadonnées"],"responses":{"200":{"description":"Liste des permissions.","content":{"application/json":{"schema":{"$id":"https://github.com/data-fair/data-fair/permissions-resolved","title":"Permissions","x-exports":["types","validate","resolvedSchema"],"type":"array","items":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}},"$defs":{"permission":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}}}}}}}}},"put":{"summary":"Définir les permissions","description":"Définir la liste des permissions.","operationId":"setPermissions","x-permissionClass":"admin","tags":["JDD / Métadonnées"],"requestBody":{"description":"Liste des permissions.","required":true,"content":{"application/json":{"schema":{"$id":"https://github.com/data-fair/data-fair/permissions-resolved","title":"Permissions","x-exports":["types","validate","resolvedSchema"],"type":"array","items":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}},"$defs":{"permission":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}}}}}}},"responses":{"200":{"description":"Liste des permissions.","content":{"application/json":{"schema":{"$id":"https://github.com/data-fair/data-fair/permissions-resolved","title":"Permissions","x-exports":["types","validate","resolvedSchema"],"type":"array","items":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}},"$defs":{"permission":{"title":"Permission","type":"object","description":"Permission to do the operations (identified by their id). If type and id are not set, then the operation is set to public. roles array is used only with type organization","additionalProperties":false,"properties":{"type":{"type":"string","enum":["user","organization"],"description":"If the entity is a user or an organization"},"id":{"type":"string","description":"Identifier of the entity"},"name":{"type":"string","description":"Name of the entity"},"email":{"type":"string","description":"Email of the user"},"department":{"type":"string","description":"Identifier of the department or \"*\" for any department (same as empty) or \"-\" for no department"},"departmentName":{"type":"string","description":"Name of the department"},"roles":{"type":"array","items":{"type":"string","description":"Role name"}},"operations":{"type":"array","items":{"type":"string","description":"API operation that can be used"}},"classes":{"type":"array","items":{"type":"string","description":"API permission classes that can be used"}}}}}}}}}}}},"/datasets/{id}/read-api-key":{"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"}}],"get":{"summary":"Obtenir la clé d'API","description":"Récupérer la clé d'API de lecture configurée sur le jeu de données.","operationId":"getReadApiKey","x-permissionClass":"read","tags":["JDD / Métadonnées"],"responses":{"200":{"description":"La clé d'API de lecture.","content":{"application/json":{"schema":{"type":"object","properties":{"current":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}}},"externalDocs":{"description":"Documentation sur GitHub","url":"https://data-fair.github.io/master/"},"tags":[{"name":"Administration"},{"name":"Jeux de données (JDD)"},{"name":"JDD / Métadonnées"},{"name":"JDD / Données"},{"name":"JDD / Éditable"},{"name":"Applications"}]}