---
title: Read
slug: oip-next/v3/core/crud/read
icon: {"lucideIcon":"📘"}
createdAt: 2025-10-13T13:37:25.000Z
---

# Entités autres que Project

Deux fonctions sont disponibles pour récupérer une entitié : `findAll` et `get`.

- `findAll` retourne un tableau d'entités ; ce tableau peut être vide si aucune correspondance n'existe.
- `get` retourne une entité ; cette entité peut être nulle si aucune correspondance n'existe.

Ces deux fonctions effectuent leur recherche sur l'entité parente passée en paramètre.&#x20;

Des variantes de ces deux fonctions sont également disponibles : `findAllOrCreate`, `getOrCreate`.

## findAll

La fonction `findAll` récupère un tableau d'entités.

Signature : `<S,T>(parentEntity: S, args?: { filter?: (val: T) => boolean; sort?: [string, 1 | -1][] }) => T[]`

### Filtre

La fonction `findAll` permet de filtrer les résultats.

Le type du paramètre `filter` est `(val: T) => boolean` ; un prédicat.

```javascript
Entities('Email').findAll(
  company,
  { filter: ({ value }) => value === 'foo@fasst.io' }
);
// Le résultat est un tableau filtré
// contenant uniquement des éléments
// dont la propriété 'value' est égale à 'foo@fasst.io'
```

### Tri

La fonction `findAll` permet de trier les résultats.

Le type du paramètre `sort` est `[string, 1 | -1][]` ; un tableau de tuples. La première valeur d'un tuple est le nom d'une propriété de l'objet à trier, et la seconde valeur est un entier indiquant si le tri est ascendant (`1`) ou descendant (`-1`). L'ordre du tableau `sort` définit l'ordre de tri.

```javascript
Entities('Email').findAll(
  company,
  { sort: [['type', -1], ['value', 1]]}
);
// Le résultat est un tableau trié
// d'abord par la propriété 'type' (descendant)
// puis par la propriété 'value' (ascendant)
```

## findAllOrCreate

La fonction `findAllOrCreate` récupère un tableau d'entités. Si aucune correspondance n'est trouvée, `findAllOrCreate` crée une nouvelle entité et retourne un tableau la contenant.

Signature : `<S,T>(parentEntity: S, args?: { filter?: (val: T) => boolean; sort?: [string, 1 | -1][] }) => T[]`

### Filtre

Voir la section filtre ci-dessus de la fonction `findAll`.

### Tri

Voir la secion tri ci-dessus de la fonction `findAll`.

## get

La fonction `get` récupère une entité. Si plusieurs entités correspondent (e.g. l'entité `Project` possède plusieurs entités `Company`), la première est retournée. Si aucune entité ne correspond, la valeur `null` est retournée.

Signature : `<S,T>(parentEntity: S, args?: { filter?: Record<string, unknown> }) => T | null`

### Filtre

Voir la section filtre ci-dessus de la fonction `findAll`.

## getOrCreate

La fonction `getOrCreate` récupère une entité. Si aucune correspondance n'est trouvée, `getOrCreate` crée une nouvelle entité et la retourne.

Signature : `<S,T>(parentEntity: S, args?: { filter?: Record<string, unknown> }) => T`

### Filtre

Voir la section filtre ci-dessus de la fonction `get`.

## Path

La fonction `Entities` accepte en paramètre un *path* pour récupérer facilement une ou plusieurs entités imbriquées.

Le *path* est divisé en segments dont chacun représente une entité.

Le *path* doit respecter les règles :

- Les segments sont séparés par le caractère `.`.
- La résolution d'un segment doit correspondre à exactement une entité. La seule exception est le dernier segment.
- Le critère pour sélectionner une entité parmi plusieurs est spécifié entre crochets, et doit respecter la syntaxe: `[PROPERTY_NAME=VALUE]`, où `PROPERTY_NAME` est le nom d'une des propriétés de l'entité.

```javascript
// Exemple 1
// A partir de l'entité `project`
// récupération d'une entité `Contact`
// dont la propriété `isRecipient` est `false`
await Entities('Contact[isRecipient=false]').get(project);

// Exemple 2
// A partir de l'entité `project`
// récupération de toutes les entités `Contact`
// dont la propriété `isRecipient` est `false`
await Entities('Contact[isRecipient=false]').findAll(project);

// Exemple 3
// A partir de l'entité `project`
// récupération de toutes les entités `BankAccount`
// dont la propriété `type` est `VIREMENT`
// et qui sont rattachés à la deuxième entité `Contact`
await Entities('Contact[1].BankAccount[type=VIREMENT]').findAll(project);
```

***Le path donné à la fonction&#x20;***`Entities`***&#x20;doit être relatif à l'entité passée à la fonction de récupération (***`findAll`***,&#x20;***`findAllOrCreate`***,&#x20;***`get`***, ou&#x20;***`getOrCreate`***).***

# Entité Project

## get

La fonction `get` récupère une entité `Project`.

Signature : `<T>(args: { externalId?: string; id?: string; signature?: { signatureId: string; status?: string } }) => Promise<T | null>`

```javascript
// Récupération via `externalId`
await Entities('Project').get({ externalId: '1234' });
// Récupération via `id`
await Entities('Project').get({ id: '1234' });
// Récupération via `status` et `signatureId`
await Entities('Project').get({ signature: { signatureId: '1', status: 'CREATED' }});
```

## findAll

La fonction findAll récupère une liste d'entités Project.

Signature : `<T>(status: string | string[], args?: { signatureMode?: string }) => Promise<T[]>`

```javascript
// Récupération via `status`
await Entities('Project').findAll('CREATED');
// Récupération via `status`
await Entities('Project').findAll(['CREATED', 'DELETED']);
// Récupération via `status` et `signatureMode`
await Entities('Project').findAll('CREATED', { signatureMode: 'ELECTRONIC' });
```
