Schemas: link

Schemas whose first using operation belongs to the link family. A shared schema is described once, here, and linked from every operation that uses it.

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

`BatchConfirmIn`

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

Type : object

Property	Type	Required	Description	Constraints
`idempotency_key`	`string`	yes		minLength: 8 ; maxLength: 64
`row_version`	`integer`	yes		minimum: 1

Used by : linkBatchConfirm

`BatchOut`

Lot et son rapport de pre-validation.

Type : object

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

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`BatchRequeueIn`

Remise en file d'un lot en echec.

Type : object

Property	Type	Required	Description	Constraints
`row_version`	`integer`	yes		minimum: 1

Used by : linkBatchRequeue

`BatchSummaryOut`

Lot, sans son rapport.

Type : object

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

Used by : linkBatchList

`ContractFieldOut`

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

Type : object

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

Used by : linkContract, linkProductContract

`ContractOut`

Enveloppe du contrat courant et versions acceptees.

Type : object

Property	Type	Required
`absence_tokens`	`map<string, string>`	yes
`contract_id`	`string`	yes
`fields`	`array<ContractFieldOut>`	yes
`ruleset_version`	`integer`	yes
`supported_versions`	`array<integer>`	yes
`version`	`integer`	yes

Used by : linkContract

`FileOut`

Fichier depose : metadonnees seulement, jamais le contenu.

Type : object

Property	Type	Required
`expires_at`	`string (date-time)`	yes
`id`	`string (uuid)`	yes
`original_name`	`string`	yes
`purged_at`	`string (date-time) \| null`	yes
`sha256`	`string`	yes
`size_bytes`	`integer`	yes
`uploaded_at`	`string (date-time)`	yes
`uploaded_by`	`string (uuid)`	yes

Used by : linkFileGet, linkFileUpload

`ImportRowOut`

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

Type : object

Property	Type	Required
`application_id`	`string (uuid) \| null`	yes
`external_reference`	`string \| null`	yes
`issues`	`array<IssueExampleOut>`	yes
`line_number`	`integer`	yes
`row_number`	`integer`	yes
`status`	`"valid" \| "rejected" \| "created"`	yes

Used by : linkBatchRows

`IssueExampleOut`

Position d'un probleme. Jamais la valeur.

Type : object

Property	Type	Required
`code`	`string`	yes
`column`	`string \| null`	yes
`column_index`	`integer \| null`	yes
`field`	`string \| null`	yes
`line`	`integer`	yes
`row`	`integer`	yes
`rule`	`string`	yes
`severity`	`"blocking" \| "warning"`	yes

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue, linkBatchRows

`IssueSummaryOut`

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

Type : object

Property	Type	Required
`category`	`string`	yes
`code`	`string`	yes
`count`	`integer`	yes
`examples`	`array<IssueExampleOut>`	yes
`severity`	`"blocking" \| "warning"`	yes

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`MappingDefinitionIn`

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

Type : object

Property	Type	Required	Constraints
`boolean_tokens`	`boolean`	no	default: false
`columns`	`map<string, string>`	no	maxProperties: 512
`decimal_comma`	`boolean`	no	default: false
`ignored`	`array<string>`	no	maxItems: 512

Used by : linkBatchPrevalidate, linkMappingList, linkMappingSave

`MappingProfileIn`

Nouvelle version d'une correspondance.

Type : object

Property	Type	Required	Description	Constraints
`code`	`string`	yes		minLength: 2 ; maxLength: 32
`definition`	`MappingDefinitionIn`	yes

Used by : linkMappingSave

`MappingProfileOut`

Version de correspondance enregistree.

Type : object

Property	Type	Required
`code`	`string`	yes
`created_at`	`string (date-time)`	yes
`created_by`	`string (uuid)`	yes
`definition`	`MappingDefinitionIn`	yes
`id`	`string (uuid)`	yes
`product_id`	`string (uuid)`	yes
`version`	`integer`	yes

Used by : linkMappingList, linkMappingSave

`PrevalidationIn`

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

Type : object

Property	Type	Required	Constraints
`contract_version`	`integer \| null`	no	minimum: 1 ; maximum: 1000
`delimiter`	`";" \| "," \| "\t" \| null`	no
`extracted_on`	`string (date) \| null`	no
`file_id`	`string (uuid)`	yes
`mapping`	`MappingDefinitionIn \| null`	no
`mapping_profile_id`	`string (uuid) \| null`	no
`product_id`	`string (uuid)`	yes

Used by : linkBatchPrevalidate

`ProductContractOut`

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

Type : object

Property	Type	Required
`absence_tokens`	`map<string, string>`	yes
`contract_id`	`string`	yes
`currency`	`string`	yes
`fields`	`array<ContractFieldOut>`	yes
`policy_code`	`string`	yes
`policy_id`	`string (uuid)`	yes
`policy_version`	`integer`	yes
`product_code`	`string`	yes
`product_id`	`string (uuid)`	yes
`ruleset_version`	`integer`	yes
`supported_versions`	`array<integer>`	yes
`version`	`integer`	yes

Used by : linkProductContract

`ProvenanceOut`

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

Type : object

Property	Type	Required
`absence`	`string \| null`	yes
`acquired_at`	`string (date-time)`	yes
`batch_id`	`string (uuid)`	yes
`column`	`string \| null`	yes
`column_index`	`integer \| null`	yes
`contract_version`	`integer`	yes
`extracted_on`	`string (date) \| null`	yes
`field`	`string`	yes
`line_number`	`integer`	yes
`row_number`	`integer`	yes
`transformations`	`array<string>`	yes

Used by : linkApplicationProvenance

`QualityOut`

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

Type : object

Property	Type	Required
`batch_id`	`string (uuid)`	yes
`completeness`	`RatioOut`	yes
`completeness_by_field`	`map<string, RatioOut>`	yes
`contract_version`	`integer`	yes
`dossiers_still_valid`	`RatioOut`	yes
`duplicates_existing`	`integer`	yes
`not_applicable`	`integer`	yes
`policy_id`	`string (uuid)`	yes
`rows_valid`	`RatioOut`	yes
`rules`	`array<string>`	yes
`ruleset_version`	`integer`	yes
`uniqueness`	`RatioOut`	yes
`uniqueness_key`	`string`	yes

Used by : linkBatchQuality

`RatioOut`

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

Type : object

Property	Type	Required
`denominator`	`integer`	yes
`numerator`	`integer`	yes
`value`	`string \| null`	yes

Used by : linkBatchQuality

`RecognizedColumnOut`

Colonne reconnue et le champ qu'elle alimente.

Type : object

Property	Type	Required
`column`	`string`	yes
`field`	`string`	yes
`index`	`integer`	yes

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportColumnsOut`

Colonnes reconnues, inconnues, ignorees ; champs sans colonne.

Type : object

Property	Type	Required
`ignored`	`array<string>`	yes
`missing_optional`	`array<string>`	yes
`missing_required`	`array<string>`	yes
`recognized`	`array<RecognizedColumnOut>`	yes
`unknown`	`array<string>`	yes

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportContractOut`

Versions sous lesquelles la pre-validation a ete faite.

Type : object

Property	Type	Required
`id`	`string`	yes
`policy_code`	`string`	yes
`policy_version`	`integer`	yes
`ruleset_version`	`integer`	yes
`version`	`integer`	yes

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportFileOut`

Lecture du fichier.

Type : object

Property	Type	Required
`delimiter`	`string`	yes
`encoding`	`string`	yes
`sha256`	`string`	yes

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportOut`

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

Type : object

Property	Type	Required
`absence_by_field`	`map<string, map<string, integer>>`	yes
`blank_rows_skipped`	`integer`	yes
`columns`	`ReportColumnsOut`	yes
`contract`	`ReportContractOut`	yes
`conversions_allowed`	`array<string>`	yes
`conversions_applied`	`map<string, integer>`	yes
`file`	`ReportFileOut`	yes
`issues`	`array<IssueSummaryOut>`	yes
`issues_by_category`	`map<string, integer>`	yes
`rows_read`	`integer`	yes
`rows_rejected`	`integer`	yes
`rows_valid`	`integer`	yes
`rows_with_warnings`	`integer`	yes
`template`	`ReportTemplateOut`	yes
`would_create`	`integer`	yes

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue

`ReportTemplateOut`

Gabarit NEXCLARA reconnu, et structure conforme.

Type : object

Property	Type	Required	Description	Constraints
`columns_match`	`boolean \| null`	yes
`detected`	`boolean`	yes

Used by : linkBatchConfirm, linkBatchGet, linkBatchPrevalidate, linkBatchRequeue