---
title: "workspaceRecordQueryBinding"
url: https://developers.dagio.ai/fr/reference/workspace-record-query-binding/
---

# workspaceRecordQueryBinding

   
                                    
                                                                                      
                                                
                  
           
          
   

Cette référence décrit la structure complète de `workspaceRecordQueryBinding`. 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é. |
| `queryKey` | `string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u` | **Requis.** Référence à une Query déclarée; le moteur de données applique le périmètre et les droits. |
| `parameters` | `Record<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, closed object OR closed object OR closed object>; semantic validation` | **Requis.** Paramètres nommés de l’opération ou de la Query et valeurs associées. |
| `parameters{key}.[kind=entity-id].kind` | `"entity-id"` | **Requis.** Sélectionne la variante et les propriétés admises dans cette branche. |
| `parameters{key}.[kind=entity-id].definitionPath` | `string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u` | **Requis.** Chemin exact d’une définition du Model; il ne désigne pas l’ID d’une fiche. |
| `parameters{key}.[kind=field].kind` | `"field"` | **Requis.** Sélectionne la variante et les propriétés admises dans cette branche. |
| `parameters{key}.[kind=field].field` | `closed object` | **Requis.** Définit « field » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
| `parameters{key}.[kind=field].field.definitionPath` | `string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u` | **Requis.** Chemin exact d’une définition du Model; il ne désigne pas l’ID d’une fiche. |
| `parameters{key}.[kind=field].field.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. |
| `parameters{key}.[kind=literal].kind` | `"literal"` | **Requis.** Sélectionne la variante et les propriétés admises dans cette branche. |
| `parameters{key}.[kind=literal].value` | `string; max length 4000 OR number OR true \| false OR null` | **Requis.** Valeur effective interprétée selon le type et le discriminant du contexte parent. |

## 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.

```json
{
  "key": "character-chapters",
  "queryKey": "character-chapters",
  "parameters": {
    "characterId": {
      "kind": "entity-id",
      "definitionPath": "workspace/reference/surface/character"
    }
  }
}
```

## Références associées

[Index complet du Model](https://developers.dagio.ai/fr/reference/) · [Construire un Model](https://developers.dagio.ai/fr/models/)

<!-- surface-examples:start -->

## 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 `workspaceRecordQueryBinding`. [Propriétés et valeurs admises](https://developers.dagio.ai/fr/reference/workspace-record-query-binding/).

```json
{
  "key": "client-quotes",
  "queryKey": "client-quotes",
  "parameters": {
    "clientId": {
      "kind": "entity-id",
      "definitionPath": "workspace/clients/surface/client"
    }
  }
}
```

### Variante et raccordement

Fragment à placer dans `queries[]`. [Propriétés et valeurs admises](https://developers.dagio.ai/fr/reference/workspace-model-foundation/).

```json
{
  "contract": "WorkspaceQuery@1",
  "key": "client-quotes",
  "label": "Soumissions du client",
  "spaceKeys": [
    "quotes"
  ],
  "definitionPaths": [
    "workspace/quotes/surface/quote"
  ],
  "parameters": [
    {
      "key": "clientId",
      "type": "node-id",
      "required": true
    }
  ],
  "predicates": [],
  "relations": [
    {
      "linkTypePath": "application/client",
      "direction": "outgoing",
      "parameterKey": "clientId",
      "distinct": true
    }
  ],
  "orderBy": [
    {
      "fieldKey": "updatedAt",
      "direction": "descending"
    }
  ],
  "aggregate": "none",
  "pageSize": 25,
  "maximumDepth": 1
}
```

### 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.

1. Numéro
2. État
3. Montant
4. Dernière mise à jour

<!-- surface-examples:end -->