Schémas : link

Schémas dont la première opération qui les emploie appartient à la famille link. Un schéma partagé est décrit une seule fois, ici, et lié depuis toutes les opérations qui l'emploient.

Les descriptions viennent du contrat, rédigé en français. Elles sont reproduites telles quelles pour rester la source de vérité.

`BatchConfirmIn`

Confirmation : version lue du lot et cle d'idempotence choisie par le client.

Type : object

Propriété	Type	Requis	Description	Contraintes
`idempotency_key`	`string`	oui		minLength: 8 ; maxLength: 64
`row_version`	`integer`	oui		minimum: 1

Employé par : linkBatchConfirm

`BatchOut`

Lot et son rapport de pre-validation.

Type : object

Propriété	Type	Requis
`attempts`	`integer`	oui
`confirmed_at`	`string (date-time) \| null`	oui
`confirmed_by`	`string (uuid) \| null`	oui
`contract_version`	`integer`	oui
`created_at`	`string (date-time)`	oui
`created_by`	`string (uuid)`	oui
`extracted_on`	`string (date) \| null`	oui
`failure_code`	`string \| null`	oui
`file_id`	`string (uuid)`	oui
`finished_at`	`string (date-time) \| null`	oui
`id`	`string (uuid)`	oui
`mapping_profile_id`	`string (uuid) \| null`	oui
`policy_id`	`string (uuid)`	oui
`product_id`	`string (uuid)`	oui
`report`	`ReportOut`	oui
`row_version`	`integer`	oui
`rows_created`	`integer`	oui
`rows_rejected`	`integer`	oui
`rows_total`	`integer`	oui
`rows_valid`	`integer`	oui
`rows_warning`	`integer`	oui
`ruleset_version`	`integer`	oui
`started_at`	`string (date-time) \| null`	oui
`status`	`"validated" \| "rejected" \| "queued" \| "running" \| "completed" \| "failed"`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`BatchRequeueIn`

Remise en file d'un lot en echec.

Type : object

Propriété	Type	Requis	Description	Contraintes
`row_version`	`integer`	oui		minimum: 1

Employé par : linkBatchRequeue

`BatchSummaryOut`

Lot, sans son rapport.

Type : object

Propriété	Type	Requis
`attempts`	`integer`	oui
`confirmed_at`	`string (date-time) \| null`	oui
`confirmed_by`	`string (uuid) \| null`	oui
`contract_version`	`integer`	oui
`created_at`	`string (date-time)`	oui
`created_by`	`string (uuid)`	oui
`extracted_on`	`string (date) \| null`	oui
`failure_code`	`string \| null`	oui
`file_id`	`string (uuid)`	oui
`finished_at`	`string (date-time) \| null`	oui
`id`	`string (uuid)`	oui
`mapping_profile_id`	`string (uuid) \| null`	oui
`policy_id`	`string (uuid)`	oui
`product_id`	`string (uuid)`	oui
`row_version`	`integer`	oui
`rows_created`	`integer`	oui
`rows_rejected`	`integer`	oui
`rows_total`	`integer`	oui
`rows_valid`	`integer`	oui
`rows_warning`	`integer`	oui
`ruleset_version`	`integer`	oui
`started_at`	`string (date-time) \| null`	oui
`status`	`"validated" \| "rejected" \| "queued" \| "running" \| "completed" \| "failed"`	oui

Employé par : linkBatchList

`ContractFieldOut`

Entree du dictionnaire de donnees. Le libelle se traduit par `label_key`.

Type : object

Propriété	Type	Requis
`allowed`	`array<string>`	oui
`code`	`string`	oui
`conditional`	`boolean`	oui
`currency`	`boolean`	oui
`decision_variable`	`boolean`	oui
`example`	`string`	oui
`field_class`	`string`	oui
`format`	`string`	oui
`label_key`	`string`	oui
`max_length`	`integer \| null`	oui
`maximum`	`string \| null`	oui
`minimum`	`string \| null`	oui
`required`	`boolean`	oui
`rule`	`string`	oui
`scale`	`integer`	oui
`section`	`string \| null`	oui
`sensitivity`	`string`	oui
`source`	`"file" \| "batch" \| "system"`	oui
`type`	`string`	oui
`unit`	`string`	oui

Employé par : linkContract, linkProductContract

`ContractOut`

Enveloppe du contrat courant et versions acceptees.

Type : object

Propriété	Type	Requis
`absence_tokens`	`map<string, string>`	oui
`contract_id`	`string`	oui
`fields`	`array<ContractFieldOut>`	oui
`ruleset_version`	`integer`	oui
`supported_versions`	`array<integer>`	oui
`version`	`integer`	oui

Employé par : linkContract

`FileOut`

Fichier depose : metadonnees seulement, jamais le contenu.

Type : object

Propriété	Type	Requis
`expires_at`	`string (date-time)`	oui
`id`	`string (uuid)`	oui
`original_name`	`string`	oui
`purged_at`	`string (date-time) \| null`	oui
`sha256`	`string`	oui
`size_bytes`	`integer`	oui
`uploaded_at`	`string (date-time)`	oui
`uploaded_by`	`string (uuid)`	oui

Employé par : linkFileGet, linkFileUpload

`ImportRowOut`

Ligne d'un lot : position, verdict, problemes (sans valeur), dossier cree.

Type : object

Propriété	Type	Requis
`application_id`	`string (uuid) \| null`	oui
`external_reference`	`string \| null`	oui
`issues`	`array<IssueExampleOut>`	oui
`line_number`	`integer`	oui
`row_number`	`integer`	oui
`status`	`"valid" \| "rejected" \| "created"`	oui

Employé par : linkBatchRows

`IssueExampleOut`

Position d'un probleme. Jamais la valeur.

Type : object

Propriété	Type	Requis
`code`	`string`	oui
`column`	`string \| null`	oui
`column_index`	`integer \| null`	oui
`field`	`string \| null`	oui
`line`	`integer`	oui
`row`	`integer`	oui
`rule`	`string`	oui
`severity`	`"blocking" \| "warning"`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue, linkBatchRows

`IssueSummaryOut`

Un code de probleme : categorie, niveau, nombre, exemples.

Type : object

Propriété	Type	Requis
`category`	`string`	oui
`code`	`string`	oui
`count`	`integer`	oui
`examples`	`array<IssueExampleOut>`	oui
`severity`	`"blocking" \| "warning"`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`MappingDefinitionIn`

Correspondance : colonne du fichier -> code de champ, colonnes ignorees, options.

Type : object

Propriété	Type	Requis	Contraintes
`boolean_tokens`	`boolean`	non	default: false
`columns`	`map<string, string>`	non	maxProperties: 512
`decimal_comma`	`boolean`	non	default: false
`ignored`	`array<string>`	non	maxItems: 512

Employé par : linkBatchPrevalidate, linkMappingList, linkMappingSave

`MappingProfileIn`

Nouvelle version d'une correspondance.

Type : object

Propriété	Type	Requis	Description	Contraintes
`code`	`string`	oui		minLength: 2 ; maxLength: 32
`definition`	`MappingDefinitionIn`	oui

Employé par : linkMappingSave

`MappingProfileOut`

Version de correspondance enregistree.

Type : object

Propriété	Type	Requis
`code`	`string`	oui
`created_at`	`string (date-time)`	oui
`created_by`	`string (uuid)`	oui
`definition`	`MappingDefinitionIn`	oui
`id`	`string (uuid)`	oui
`product_id`	`string (uuid)`	oui
`version`	`integer`	oui

Employé par : linkMappingList, linkMappingSave

`PrevalidationIn`

Pre-validation d'un fichier depose, pour un produit.

Type : object

Propriété	Type	Requis	Contraintes
`contract_version`	`integer \| null`	non	minimum: 1 ; maximum: 1000
`delimiter`	`";" \| "," \| "\t" \| null`	non
`extracted_on`	`string (date) \| null`	non
`file_id`	`string (uuid)`	oui
`mapping`	`MappingDefinitionIn \| null`	non
`mapping_profile_id`	`string (uuid) \| null`	non
`product_id`	`string (uuid)`	oui

Employé par : linkBatchPrevalidate

`ProductContractOut`

Contrat complet d'un produit : enveloppe et entrees de sa politique en vigueur.

Type : object

Propriété	Type	Requis
`absence_tokens`	`map<string, string>`	oui
`contract_id`	`string`	oui
`currency`	`string`	oui
`fields`	`array<ContractFieldOut>`	oui
`policy_code`	`string`	oui
`policy_id`	`string (uuid)`	oui
`policy_version`	`integer`	oui
`product_code`	`string`	oui
`product_id`	`string (uuid)`	oui
`ruleset_version`	`integer`	oui
`supported_versions`	`array<integer>`	oui
`version`	`integer`	oui

Employé par : linkProductContract

`ProvenanceOut`

Provenance d'une valeur d'un dossier importe (P12).

Type : object

Propriété	Type	Requis
`absence`	`string \| null`	oui
`acquired_at`	`string (date-time)`	oui
`batch_id`	`string (uuid)`	oui
`column`	`string \| null`	oui
`column_index`	`integer \| null`	oui
`contract_version`	`integer`	oui
`extracted_on`	`string (date) \| null`	oui
`field`	`string`	oui
`line_number`	`integer`	oui
`row_number`	`integer`	oui
`transformations`	`array<string>`	oui

Employé par : linkApplicationProvenance

`QualityOut`

Qualite d'un lot, mesuree sur les donnees enregistrees.

Type : object

Propriété	Type	Requis
`batch_id`	`string (uuid)`	oui
`completeness`	`RatioOut`	oui
`completeness_by_field`	`map<string, RatioOut>`	oui
`contract_version`	`integer`	oui
`dossiers_still_valid`	`RatioOut`	oui
`duplicates_existing`	`integer`	oui
`not_applicable`	`integer`	oui
`policy_id`	`string (uuid)`	oui
`rows_valid`	`RatioOut`	oui
`rules`	`array<string>`	oui
`ruleset_version`	`integer`	oui
`uniqueness`	`RatioOut`	oui
`uniqueness_key`	`string`	oui

Employé par : linkBatchQuality

`RatioOut`

Numerateur, denominateur, quotient (null si le denominateur est nul).

Type : object

Propriété	Type	Requis
`denominator`	`integer`	oui
`numerator`	`integer`	oui
`value`	`string \| null`	oui

Employé par : linkBatchQuality

`RecognizedColumnOut`

Colonne reconnue et le champ qu'elle alimente.

Type : object

Propriété	Type	Requis
`column`	`string`	oui
`field`	`string`	oui
`index`	`integer`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportColumnsOut`

Colonnes reconnues, inconnues, ignorees ; champs sans colonne.

Type : object

Propriété	Type	Requis
`ignored`	`array<string>`	oui
`missing_optional`	`array<string>`	oui
`missing_required`	`array<string>`	oui
`recognized`	`array<RecognizedColumnOut>`	oui
`unknown`	`array<string>`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportContractOut`

Versions sous lesquelles la pre-validation a ete faite.

Type : object

Propriété	Type	Requis
`id`	`string`	oui
`policy_code`	`string`	oui
`policy_version`	`integer`	oui
`ruleset_version`	`integer`	oui
`version`	`integer`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportFileOut`

Lecture du fichier.

Type : object

Propriété	Type	Requis
`delimiter`	`string`	oui
`encoding`	`string`	oui
`sha256`	`string`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportOut`

Rapport de pre-validation : rien n'a ete cree.

Type : object

Propriété	Type	Requis
`absence_by_field`	`map<string, map<string, integer>>`	oui
`blank_rows_skipped`	`integer`	oui
`columns`	`ReportColumnsOut`	oui
`contract`	`ReportContractOut`	oui
`conversions_allowed`	`array<string>`	oui
`conversions_applied`	`map<string, integer>`	oui
`file`	`ReportFileOut`	oui
`issues`	`array<IssueSummaryOut>`	oui
`issues_by_category`	`map<string, integer>`	oui
`rows_read`	`integer`	oui
`rows_rejected`	`integer`	oui
`rows_valid`	`integer`	oui
`rows_with_warnings`	`integer`	oui
`template`	`ReportTemplateOut`	oui
`would_create`	`integer`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportTemplateOut`

Gabarit NEXCLARA reconnu, et structure conforme.

Type : object

Propriété	Type	Requis	Description	Contraintes
`columns_match`	`boolean \| null`	oui
`detected`	`boolean`	oui

Employé par : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue