---
title: Relation
slug: oip-next/iavae2misnq-t6dur6s88
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.000Z
---

# Relation

## Description

L'entité Relation indique la relation vers une autre entité basé sur son id.

## Relations

### Ascendantes

| Entité         | Propriété                    |
| -------------- | ---------------------------- |
| CollectionNeed | relations                    |
| Grantee        | attachedSocialSecurityNumber |
| Pack           | relation                     |
| Payment        | relations                    |

### Descendantes

| Entité  | Propriété |
| ------- | --------- |
| History | history   |

## Propriétés

| Nom          | Type     | Description                                                                        | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------ | -------- | ---------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| entityId     | `String` | id de l'entité cible                                                               |            |                 |             |                           |
| type         | `String` | type d'entité cible                                                                |            |                 |             |                           |
| id           | `String` | Identifiant de l'entité `Relation`                                                 |            | X               |             |                           |
| code         | `String` | Codification fonctionnelle de l'entité `Relation`                                  |            |                 |             |                           |
| externalId   | `String` | Identifiant de l'entité `Relation` dans le système client                          |            |                 |             |                           |
| externalCode | `String` | Codification fonctionnelle de l'entité `Relation` dans le système client           |            |                 |             |                           |
| relationId   | `String` | Identifiant public de l'entité `Relation` dans l'OIP                               |            |                 |             |                           |
| label        | `String` | Information relative au nom de l'entité `Relation` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt    | `Date`   | Date de création de l'entité `Relation`                                            |            | X               |             |                           |
| updatedAt    | `Date`   | Date de modification de l'entité `Relation`                                        |            | X               |             |                           |

## Enumérations

Aucune enumération.

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCollectionNeedId } from '@fasstech/oip-core/entities/CollectionNeed';
import { getProjectId } from '@fasstech/oip-core/entities/Project';
import { getRelationCode, getRelationEntityId, getRelationExternalCode, getRelationExternalId, getRelationId, getRelationLabel, getRelationRelationId, getRelationType, setRelationCode, setRelationEntityId, setRelationExternalCode, setRelationExternalId, setRelationLabel, setRelationRelationId, setRelationType } from '@fasstech/oip-core/entities/Relation';

(async () => {
  let project = await Entities('Project').create();
  let collectionNeed = await Entities('CollectionNeed').create();
  const relation = await Entities('Relation').create();
  
  setRelationEntityId('entityId', relation);
  setRelationType('type', relation);
  setRelationCode('code', relation);
  setRelationExternalId('externalId', relation);
  setRelationExternalCode('externalCode', relation);
  setRelationRelationId('relationId', relation);
  setRelationLabel('label', relation);
  
  collectionNeed = await Entities('Relation').save(collectionNeed, relation);
  project = await Entities('CollectionNeed').save(project, collectionNeed);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const collectionNeedToTest = await Entities('CollectionNeed').get(projectToTest, { filter: ({ id }) => id === getCollectionNeedId(collectionNeed) });
  const relationToTest = await Entities('Relation').get(collectionNeedToTest, { filter: ({ id }) => id === getRelationId(relation) });
  
  getRelationEntityId(relationToTest); // 'entityId'
  getRelationType(relationToTest); // 'type'
  getRelationCode(relationToTest); // 'code'
  getRelationExternalId(relationToTest); // 'externalId'
  getRelationExternalCode(relationToTest); // 'externalCode'
  getRelationRelationId(relationToTest); // 'relationId'
  getRelationLabel(relationToTest); // 'label'
})();
```
