---
title: Project
slug: oip-next/q-b3h91cffgxeacltbpuq
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.000Z
---

# Project

## Description

L'entité Project est l'entité principale qui porte l'ensemble des autres entités.

## Relations

### Ascendantes

Aucune relation ascendante.

### Descendantes

| Entité             | Propriété           |
| ------------------ | ------------------- |
| Address            | addresses           |
| BankAccount        | bankAccounts        |
| ChosenRiskAndRange | chosenRiskAndRanges |
| CollectionNeed     | collectionNeeds     |
| Company            | companies           |
| Contact            | contacts            |
| Customer           | customers           |
| Demography         | demographies        |
| Document           | documents           |
| ErrorHistory       | errorHistory        |
| FollowUpHistory    | followUpHistory     |
| Funeral            | funerals            |
| Grantee            | grantees            |
| History            | history             |
| Markup             | markups             |
| OfferNode          | offerNodes          |
| Offer              | offers              |
| Pension            | pensions            |
| Product            | products            |
| Signature          | signatures          |
| StatusHistory      | statusHistory       |
| Svc                | svcs                |
| Tns                | tns                 |
| Turnover           | turnovers           |
| User               | users               |

## Propriétés

| Nom           | Type                | Description                                                                        | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------- | ------------------- | ---------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| name          | `String`            | Nom du projet                                                                      |            |                 |             | 1.5.0                     |
| projectNumber | `Number`            | Utilisé pour définir le numéro d'un contrat lisible par des utilisateurs finaux    |            | X               |             | 2.0.0                     |
| status        | `ProjectStatusEnum` | Statut du projet [ProjectStatusEnum](https://doc.fasst.tech/oip/projectstatusenum) |            |                 |             | 2.0.0                     |
| step          | `String`            | Étape du projet                                                                    |            |                 |             | 1.6.0                     |
| id            | `String`            | Identifiant de l'entité `Project`                                                  |            | X               |             |                           |
| code          | `String`            | Codification fonctionnelle de l'entité `Project`                                   |            |                 |             |                           |
| externalId    | `String`            | Identifiant de l'entité `Project` dans le système client                           |            |                 |             |                           |
| externalCode  | `String`            | Codification fonctionnelle de l'entité `Project` dans le système client            |            |                 |             |                           |
| projectId     | `String`            | Identifiant public de l'entité `Project` dans l'OIP                                |            |                 |             |                           |
| label         | `String`            | Information relative au nom de l'entité `Project` dans son contexte d'utilisation  |            |                 |             |                           |
| createdAt     | `Date`              | Date de création de l'entité `Project`                                             |            | X               |             |                           |
| createdBy     | `String`            | Responsable de la création de l'entité `Project`                                   |            |                 |             |                           |
| updatedAt     | `Date`              | Date de modification de l'entité `Project`                                         |            | X               |             |                           |
| updatedBy     | `String`            | Responsable de la dernière mise à jour de l'entité `Project`                       |            |                 |             |                           |

## Enumérations

Aucune enumération.

## Enumérations génériques

- ProjectStatusEnum

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getProjectCode, getProjectCreatedBy, getProjectExternalCode, getProjectExternalId, getProjectLabel, getProjectName, getProjectProjectId, getProjectStatus, getProjectStep, getProjectUpdatedBy, setProjectCode, setProjectCreatedBy, setProjectExternalCode, setProjectExternalId, setProjectLabel, setProjectName, setProjectProjectId, setProjectStatus, setProjectStep, setProjectUpdatedBy } from '@fasstech/oip-core/entities/Project';
import { ProjectStatusEnum } from '@fasstech/oip-core/entities/enums';

(async () => {
  const project = await Entities('Project').create();
  
  setProjectName('name', project);
  setProjectStatus(ProjectStatusEnum.DIGITAL_SERVICE_STARTED, project);
  setProjectStep('step', project);
  setProjectCode('code', project);
  setProjectExternalId('externalId', project);
  setProjectExternalCode('externalCode', project);
  setProjectProjectId('projectId', project);
  setProjectLabel('label', project);
  setProjectCreatedBy('createdBy', project);
  setProjectUpdatedBy('updatedBy', project);
  
  await Entities('Project').save(project);
  
  getProjectName(project); // 'name'
  getProjectStatus(project); // ProjectStatusEnum.DIGITAL_SERVICE_STARTED
  getProjectStep(project); // 'step'
  getProjectCode(project); // 'code'
  getProjectExternalId(project); // 'externalId'
  getProjectExternalCode(project); // 'externalCode'
  getProjectProjectId(project); // 'projectId'
  getProjectLabel(project); // 'label'
  getProjectCreatedBy(project); // 'createdBy'
  getProjectUpdatedBy(project); // 'updatedBy'
})();
```
