link
LINK : contrat de donnees, gabarit, depot de fichier CSV, pre-validation, import confirme, provenance et qualite.
Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.
GET /api/v1/link/applications/{application_id}/provenance
Provenance des valeurs d'un dossier importe
Lot, ligne, colonne, transformations et instant d'acquisition de chaque valeur. Un dossier saisi dans DESK n'a pas de provenance d'import : la liste est vide.
linkApplicationProvenance
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
application_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<ProvenanceOut> |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/batches
Lots d'import
Lots de l'institution, les plus recents d'abord.
linkBatchList
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
limit | query | integer | non | minimum: 1 ; maximum: 1000 ; default: 50 |
offset | query | integer | non | minimum: 0 ; default: 0 |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<BatchSummaryOut> |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/link/batches
Pre-valider un fichier (aucun dossier cree)
Lecture, correspondance, verification ligne a ligne, rapport ; rien n'est importe.
linkBatchPrevalidate
Paramètres
Aucun paramètre.
Corps de la requête
- Type de contenu
application/json- Type
PrevalidationIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
201 | Successful Response | application/json | BatchOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/batches/{batch_id}
Lot et rapport
Lot, etat et rapport de pre-validation.
linkBatchGet
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
batch_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | BatchOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/link/batches/{batch_id}/confirm
Confirmer l'import (asynchrone, idempotent)
Met le lot en file ; le traitement commence apres la reponse.
linkBatchConfirm
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
batch_id | path | string (uuid) | oui |
Corps de la requête
- Type de contenu
application/json- Type
BatchConfirmIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | BatchOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/batches/{batch_id}/error-report
Rapport d'erreurs CSV (valeurs citees, neutralisees)
Une ligne par probleme ; toute cellule pouvant former une formule est neutralisee.
linkBatchErrorReport
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
batch_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | text/csv | string (binary) |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/batches/{batch_id}/quality
Qualite d'un lot (donnees enregistrees)
Completude, validite, unicite : numerateurs, denominateurs, regles versionnees.
linkBatchQuality
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
batch_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | QualityOut |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/link/batches/{batch_id}/requeue
Reprendre un lot en echec
Remet le lot en file ; les lignes deja creees ne le seront pas deux fois.
linkBatchRequeue
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
batch_id | path | string (uuid) | oui |
Corps de la requête
- Type de contenu
application/json- Type
BatchRequeueIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | BatchOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/batches/{batch_id}/rows
Lignes d'un lot
Lignes dans l'ordre du fichier : verdict, problemes sans valeur, dossier cree.
linkBatchRows
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
batch_id | path | string (uuid) | oui | |
issues_only | query | boolean | non | default: false |
limit | query | integer | non | minimum: 1 ; maximum: 1000 ; default: 100 |
offset | query | integer | non | minimum: 0 ; default: 0 |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<ImportRowOut> |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/contract
Enveloppe du contrat LINK
Champs communs a tous les produits, versions acceptees, jetons d'absence.
linkContract
Paramètres
Aucun paramètre.
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | ContractOut |
POST /api/v1/link/files
Deposer un fichier CSV
Controles de surface puis enregistrement ; aucun dossier, aucune lecture metier.
linkFileUpload
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
filename | query | string | oui | minLength: 1 ; maxLength: 255 |
Corps de la requête
- Type de contenu
application/octet-stream, text/csv- Type
string (binary)- Requis
- oui
- Description
- Contenu brut du fichier CSV (UTF-8, avec ou sans marque d'ordre).
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
201 | Successful Response | application/json | FileOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/files/{file_id}
Fichier depose
Metadonnees d'un fichier depose ; jamais son contenu.
linkFileGet
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
file_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | FileOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/products/{product_id}/contract
Dictionnaire de donnees d'un produit
Enveloppe et entrees de la politique en vigueur : le dictionnaire de donnees.
linkProductContract
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
product_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | ProductContractOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/products/{product_id}/mappings
Correspondances d'un produit
Versions enregistrees, les plus recentes d'abord par code.
linkMappingList
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
product_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | application/json | array<MappingProfileOut> |
422 | Validation Error | application/json | HTTPValidationError |
POST /api/v1/link/products/{product_id}/mappings
Enregistrer une version de correspondance
Nouvelle version ; les cibles sont verifiees contre le contrat du produit.
linkMappingSave
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
product_id | path | string (uuid) | oui |
Corps de la requête
- Type de contenu
application/json- Type
MappingProfileIn- Requis
- oui
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
201 | Successful Response | application/json | MappingProfileOut |
422 | Validation Error | application/json | HTTPValidationError |
GET /api/v1/link/products/{product_id}/template
Gabarit CSV d'un produit
Gabarit genere : metadonnees du contrat, puis en-tete des colonnes.
linkProductTemplate
Paramètres
| Paramètre | Emplacement | Type | Requis | Contraintes |
|---|---|---|---|---|
product_id | path | string (uuid) | oui |
Corps de la requête
Aucun corps de requête.
Réponses
| Statut | Description | Type de contenu | Type |
|---|---|---|---|
200 | Successful Response | text/csv | string (binary) |
422 | Validation Error | application/json | HTTPValidationError |