workspaceQuery
Propriétés, variantes, types et limites de workspaceQuery.
Cette référence décrit la structure complète de workspaceQuery. Chaque chemin représente une propriété, y compris les objets imbriqués, les éléments de listes et les branches conditionnelles. Une branche identifiée par kind, contract ou mode n’admet que ses propres propriétés.
Structure et valeurs
| Champ | Options / valeurs attendues | Description |
|---|---|---|
key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
projection |
closed object; optional |
Facultatif. Définit « projection » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
projection.contract |
"WorkspaceQueryProjection@1" |
Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée. |
projection.anchors |
true | false |
Requis. Prototypes de sections documentaires avec identité, protection et cardinalité. |
projection.calculations |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u>; max length 20 |
Requis. Définit « calculations » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
evidenceEvaluation |
closed object; semantic validation; optional |
Facultatif. Définit « evidence Evaluation » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
evidenceEvaluation.contract |
"WorkspaceQueryEvidenceEvaluation@1" | "WorkspaceQueryEvidenceEvaluation@2" | "WorkspaceQueryEvidenceEvaluation@3" |
Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée. |
evidenceEvaluation.sourceParameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
evidenceEvaluation.sourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
evidenceEvaluation.evidenceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
evidenceEvaluation.evidencePredicates |
Array<closed object>; max length 30 |
Requis. Définit « evidence Predicates » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
evidenceEvaluation.evidencePredicates[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé d’un Field déclaré sur la définition de Surface référencée. |
evidenceEvaluation.evidencePredicates[].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "exists" |
Requis. Comparaison ou opération de la variante; la valeur doit correspondre au type attendu. |
evidenceEvaluation.evidencePredicates[].value |
string; max length 4000 OR number OR true | false OR null OR Array<string; max length 4000 OR number OR true | false OR null>; max length 100 |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
evidenceEvaluation.resultDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
evidenceEvaluation.resultLinkTypePath |
string; min length 1; max length 4000 |
Requis. Type de relation déclaré, avec sources, cibles et direction compatibles avec ce parcours. |
evidenceEvaluation.requiredSourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
evidenceEvaluation.coveredSourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; max length 100; optional |
Facultatif. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
evidenceEvaluation.minimumResults |
integer; ≥ 1; ≤ 1000 |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
evidenceEvaluation.maximumResults |
integer; ≥ 1; ≤ 1000 |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
evidenceEvaluation.maximumPages |
integer; ≥ 1; ≤ 100 |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
evidenceEvaluation.maximumOutputBytes |
integer; ≥ 1000; ≤ 2000000 |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
evidenceEvaluation.blockingSources |
closed object; optional |
Facultatif. Définit « blocking Sources » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
evidenceEvaluation.blockingSources.definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Définit « definition Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
evidenceEvaluation.blockingSources.predicates |
Array<closed object>; min length 1; max length 30 |
Requis. Conditions typées limitant les objets dans le périmètre déclaré. |
evidenceEvaluation.blockingSources.predicates[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé d’un Field déclaré sur la définition de Surface référencée. |
evidenceEvaluation.blockingSources.predicates[].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "exists" |
Requis. Comparaison ou opération de la variante; la valeur doit correspondre au type attendu. |
evidenceEvaluation.blockingSources.predicates[].value |
string; max length 4000 OR number OR true | false OR null OR Array<string; max length 4000 OR number OR true | false OR null>; max length 100 |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
evidenceEvaluation.additionalBlockingSources |
Array<closed object>; min length 1; max length 20; optional |
Facultatif. Définit « additional Blocking Sources » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
evidenceEvaluation.additionalBlockingSources[].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Définit « definition Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
evidenceEvaluation.additionalBlockingSources[].predicates |
Array<closed object>; min length 1; max length 30 |
Requis. Conditions typées limitant les objets dans le périmètre déclaré. |
evidenceEvaluation.additionalBlockingSources[].predicates[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé d’un Field déclaré sur la définition de Surface référencée. |
evidenceEvaluation.additionalBlockingSources[].predicates[].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "exists" |
Requis. Comparaison ou opération de la variante; la valeur doit correspondre au type attendu. |
evidenceEvaluation.additionalBlockingSources[].predicates[].value |
string; max length 4000 OR number OR true | false OR null OR Array<string; max length 4000 OR number OR true | false OR null>; max length 100 |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
search |
closed object; null; optional |
Facultatif. Politique ou configuration de recherche selon le contexte parent. |
search.parameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
search.mode |
"lexical" | "phrase" | "prefix" |
Requis. Définit « mode » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
spaceKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 20 |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Définit « definition Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters |
Array<closed object OR closed object OR closed object OR closed object OR closed object; semantic validation>; max length 20 |
Requis. Paramètres nommés de l’opération ou de la Query et valeurs associées. |
parameters[].[variant 1].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 1].type |
"text" | "number" | "boolean" | "node-id" |
Requis. Définit « type » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 1].required |
true | false |
Requis. Indique si cette déclaration exige une valeur. |
parameters[].[variant 2].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 2].type |
"decimal" |
Requis. Définit « type » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 2].required |
true | false |
Requis. Indique si cette déclaration exige une valeur. |
parameters[].[variant 2].format |
closed object; semantic validation |
Requis. Format de présentation compatible avec le type de la valeur. |
parameters[].[variant 2].format.precision |
integer; ≥ 1; ≤ 1000 |
Requis. Définit « precision » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 2].format.scale |
integer; ≥ 0; ≤ 1000 |
Requis. Définit « scale » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 2].unit |
closed object OR closed object OR closed object |
Requis. Définit « unit » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 2].unit.[kind=dimensionless].kind |
"dimensionless" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 2].unit.[kind=unit].kind |
"unit" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 2].unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 2].unit.[kind=currency].kind |
"currency" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 2].unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 3].[variant 1].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 3].[variant 1].type |
"integer" |
Requis. Définit « type » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 1].required |
true | false |
Requis. Indique si cette déclaration exige une valeur. |
parameters[].[variant 3].[variant 1].schema |
closed object |
Requis. Définit « schema » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 1].schema.kind |
"integer" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 3].[variant 1].schema.minimum |
string; max length 1001; /^(?:0|-?[1-9][0-9]{0,999})(?![\s\S])/u |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
parameters[].[variant 3].[variant 1].schema.maximum |
string; max length 1001; /^(?:0|-?[1-9][0-9]{0,999})(?![\s\S])/u |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
parameters[].[variant 3].[variant 1].schema.unit |
closed object OR closed object OR closed object |
Requis. Définit « unit » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 1].schema.unit.[kind=dimensionless].kind |
"dimensionless" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 3].[variant 1].schema.unit.[kind=unit].kind |
"unit" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 3].[variant 1].schema.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 3].[variant 1].schema.unit.[kind=currency].kind |
"currency" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 3].[variant 1].schema.unit.[kind=currency].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 3].[variant 2].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 3].[variant 2].type |
"real" |
Requis. Définit « type » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 2].required |
true | false |
Requis. Indique si cette déclaration exige une valeur. |
parameters[].[variant 3].[variant 2].schema |
closed object |
Requis. Définit « schema » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 2].schema.kind |
"real" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 3].[variant 2].schema.representation |
"binary64" |
Requis. Définit « representation » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 2].schema.precisionBits |
53 |
Requis. Définit « precision Bits » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 2].schema.minimum |
number |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
parameters[].[variant 3].[variant 2].schema.maximum |
number |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
parameters[].[variant 3].[variant 2].schema.tolerance |
closed object |
Requis. Définit « tolerance » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 2].schema.tolerance.absolute |
number; ≥ 0 |
Requis. Définit « absolute » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 2].schema.tolerance.relative |
number; ≥ 0 |
Requis. Définit « relative » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 2].schema.unit |
closed object OR closed object |
Requis. Définit « unit » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 2].schema.unit.[kind=dimensionless].kind |
"dimensionless" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 3].[variant 2].schema.unit.[kind=unit].kind |
"unit" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 3].[variant 2].schema.unit.[kind=unit].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 3].[variant 3].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 3].[variant 3].type |
"choice" |
Requis. Définit « type » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 3].required |
true | false |
Requis. Indique si cette déclaration exige une valeur. |
parameters[].[variant 3].[variant 3].schema |
closed object |
Requis. Définit « schema » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 3].schema.kind |
"choice" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
parameters[].[variant 3].[variant 3].schema.labelLocale |
string; min length 2; max length 100; /^[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*(?![\s\S])/u |
Requis. Définit « label Locale » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 3].schema.choices |
Array<closed object>; min length 1; max length 1000 |
Requis. Définit « choices » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
parameters[].[variant 3].[variant 3].schema.choices[].key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*(?![\s\S])/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
parameters[].[variant 3].[variant 3].schema.choices[].labels |
Record<string; min length 2; max length 100; /^[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*(?![\s\S])/u, string; min length 1; max length 4000> |
Requis. Définit « labels » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
predicates |
Array<closed object>; max length 30 |
Requis. Conditions typées limitant les objets dans le périmètre déclaré. |
predicates[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé d’un Field déclaré sur la définition de Surface référencée. |
predicates[].operator |
"eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "exists" |
Requis. Comparaison ou opération de la variante; la valeur doit correspondre au type attendu. |
predicates[].parameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u; null |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
predicates[].value |
string; max length 4000 OR number OR true | false OR null OR Array<string; max length 4000 OR number OR true | false OR null>; max length 100 |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
relations |
Array<closed object>; max length 8 |
Requis. Parcours de relations qui restreint ou développe le résultat de lecture. |
relations[].linkTypePath |
string; min length 1; max length 4000 |
Requis. Définit « link Type Path » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
relations[].direction |
"incoming" | "outgoing" |
Requis. Sens du parcours ou de présentation; respecter les valeurs fermées de ce contrat. |
relations[].parameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
relations[].distinct |
true | false |
Requis. Élimine les identités répétées lorsque l’opération admet cette option. |
orderBy |
Array<closed object>; max length 5 |
Requis. Ordre de tri déclaré; les clés doivent appartenir au périmètre autorisé. |
orderBy[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé d’un Field déclaré sur la définition de Surface référencée. |
orderBy[].direction |
"ascending" | "descending" |
Requis. Sens du parcours ou de présentation; respecter les valeurs fermées de ce contrat. |
aggregate |
"none" | "count" | "count-distinct" |
Requis. Réduction calculée sur le périmètre complet de la Query, distincte de la page affichée. |
pageSize |
integer; ≥ 1; ≤ 100 |
Requis. Nombre demandé d’éléments par page dans les limites de la Query. |
maximumDepth |
integer; ≥ 0; ≤ 8 |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
traversal |
closed object; semantic validation; optional |
Facultatif. Définit « traversal » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
traversal.contract |
"WorkspaceQueryTraversal@1" | "WorkspaceQueryTraversal@2" |
Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée. |
traversal.sourceParameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
traversal.sourceDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
traversal.within |
closed object; optional |
Facultatif. Définit « within » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
traversal.within.parameterKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
traversal.within.definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Définit « definition Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
traversal.within.maximumDepth |
integer; ≥ 1; ≤ 8 |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
traversal.paths |
Array<closed object>; min length 1; max length 8 |
Requis. Définit « paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
traversal.paths[].steps |
Array<closed object OR closed object>; min length 1; max length 8 |
Requis. Étapes de la composition dans leur organisation déclarée. |
traversal.paths[].steps[].[kind=links].kind |
"links" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
traversal.paths[].steps[].[kind=links].direction |
"incoming" | "outgoing" |
Requis. Sens du parcours ou de présentation; respecter les valeurs fermées de ce contrat. |
traversal.paths[].steps[].[kind=links].linkTypePaths |
Array<string; min length 1; max length 4000>; min length 1; max length 20 |
Requis. Définit « link Type Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
traversal.paths[].steps[].[kind=links].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Définit « definition Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
traversal.paths[].steps[].[variant 2].kind |
"parent" | "children" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
traversal.paths[].steps[].[variant 2].definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Définit « definition Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
nativeReview |
closed object; optional |
Facultatif. Configuration de la revue canonique, avec ses champs de décision et ses références. |
nativeReview.contract |
"WorkspaceQueryNativeReview@1" |
Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée. |
nativeReview.lifecycleKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
nativeReview.stateValue |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Définit « state Value » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
controls |
closed object; optional |
Facultatif. Contrôles de recherche, filtre et tri reliés aux paramètres déclarés. |
controls.contract |
"WorkspaceQueryControls@1" |
Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée. |
controls.filters |
Array<closed object OR closed object>; max length 20 |
Requis. Définit « filters » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
controls.filters[].[variant 1].parameterKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
controls.filters[].[variant 1].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
controls.filters[].[variant 1].input |
"choice" |
Requis. Contrôle ou entrée sélectionné par la variante; doit rester compatible avec son binding. |
controls.filters[].[variant 1].options |
Array<closed object>; min length 1; max length 100 |
Requis. Valeurs proposées et admises pour un choix déclaré. |
controls.filters[].[variant 1].options[].value |
string; max length 4000 OR number OR true | false |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
controls.filters[].[variant 1].options[].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
controls.filters[].[variant 2].parameterKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
controls.filters[].[variant 2].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
controls.filters[].[variant 2].input |
"text" | "number" | "decimal" | "integer" | "real" |
Requis. Contrôle ou entrée sélectionné par la variante; doit rester compatible avec son binding. |
controls.sort |
closed object; null |
Requis. Définit « sort » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
controls.sort.parameterKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
controls.sort.label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
controls.sort.options |
Array<closed object>; min length 1; max length 30 |
Requis. Valeurs proposées et admises pour un choix déclaré. |
controls.sort.options[].value |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9-]*$/u |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
controls.sort.options[].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
controls.sort.options[].orderBy |
Array<closed object>; min length 1; max length 5 |
Requis. Ordre de tri déclaré; les clés doivent appartenir au périmètre autorisé. |
controls.sort.options[].orderBy[].fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé d’un Field déclaré sur la définition de Surface référencée. |
controls.sort.options[].orderBy[].direction |
"ascending" | "descending" |
Requis. Sens du parcours ou de présentation; respecter les valeurs fermées de ce contrat. |
contract |
"WorkspaceQuery@1" |
Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée. |
Règles de lecture
Les chemins suffixés par [] décrivent chaque élément d’une liste; {key} décrit chaque valeur d’un dictionnaire. Le symbole ↻ renvoie à la même expression récursive. Un objet fermé refuse les propriétés supplémentaires. Les mentions de validation sémantique signalent un contrôle complémentaire : la conformité des types ne suffit pas à rendre une référence, une permission ou une transition valide. Les références doivent être résolues dans le Model et le contexte de l’usager.
La présence d’une ancienne variante ne permet pas d’y ajouter une propriété d’une variante plus récente. Le compilateur contrôle la version et la cohérence du Model complet.
Exemple de structure
Ce fragment respecte le schéma de cette section. Ses références métier doivent être définies dans le Model qui l’utilise.
{
"key": "context-step-work",
"label": "Travail parent de l’étape",
"spaceKeys": [
"work"
],
"definitionPaths": [
"workspace/workshop/surface/work"
],
"parameters": [
{
"key": "selectedId",
"type": "node-id",
"required": true
}
],
"predicates": [],
"relations": [],
"orderBy": [
{
"fieldKey": "title",
"direction": "ascending"
}
],
"aggregate": "none",
"pageSize": 30,
"maximumDepth": 1,
"traversal": {
"contract": "WorkspaceQueryTraversal@2",
"sourceParameterKey": "selectedId",
"sourceDefinitionPaths": [
"workspace/workshop/surface/work/surface/step"
],
"paths": [
{
"steps": [
{
"kind": "parent",
"definitionPaths": [
"workspace/workshop/surface/work"
]
}
]
}
]
},
"contract": "WorkspaceQuery@1"
}
Références associées
Index complet du Model · Construire un Model
Exemples appliqués : Les soumissions du client courant
La Query déclare clientId; le binding fournit l’identité de la fiche ouverte.
Configuration
Objet du contrat workspaceQuery. Propriétés et valeurs admises.
{
"key": "context-step-work",
"label": "Travail parent de l’étape",
"spaceKeys": [
"work"
],
"definitionPaths": [
"workspace/workshop/surface/work"
],
"parameters": [
{
"key": "selectedId",
"type": "node-id",
"required": true
}
],
"predicates": [],
"relations": [],
"orderBy": [
{
"fieldKey": "title",
"direction": "ascending"
}
],
"aggregate": "none",
"pageSize": 30,
"maximumDepth": 1,
"traversal": {
"contract": "WorkspaceQueryTraversal@2",
"sourceParameterKey": "selectedId",
"sourceDefinitionPaths": [
"workspace/workshop/surface/work/surface/step"
],
"paths": [
{
"steps": [
{
"kind": "parent",
"definitionPaths": [
"workspace/workshop/surface/work"
]
}
]
}
]
},
"contract": "WorkspaceQuery@1"
}
Variante et raccordement
Fragment à placer dans presentation.recordProfiles[].queryBindings[]. Propriétés et valeurs admises.
{
"key": "client-quotes",
"queryKey": "client-quotes",
"parameters": {
"clientId": {
"kind": "entity-id",
"definitionPath": "workspace/clients/surface/client"
}
}
}
Exemple de disposition UI
La disposition illustrative ci-dessous situe cette configuration dans l’app Clients/Soumissions. Chaque fragment s’insère à l’emplacement indiqué; ses références aux Fields, Queries et Actions correspondent aux déclarations du Model.
- Numéro
- État
- Montant
- Dernière mise à jour
key- context-step-work
label- Travail parent de l’étape
spaceKeys- 1 élément
definitionPaths- 1 élément
parameters- 1 élément
Les valeurs ci-dessus reprennent le fragment de configuration; les références se résolvent dans le Model complet.