---
title: Parameter
slug: oip-next/2w0g-parameter
icon: {"lucideIcon":"📘"}
createdAt: 2024-10-16T07:12:35.000Z
---

# Parameter

## Description

L'entité Parameter permet de lister les paramètres associés au nœud OfferNode. Peut concerner des options ou des composants.

## Relations

### Ascendantes

| Entité    | Propriété  |
| --------- | ---------- |
| OfferNode | parameters |

### Descendantes

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

## Propriétés

| Nom          | Type                | Description                                                                         | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ------------ | ------------------- | ----------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| description  | `String`            | Description fonctionnelle du paramètre                                              |            |                 |             | 3.1.0                     |
| isArray      | `Boolean`           | Indique si une ou plusieurs valeurs sont attendues                                  |            |                 |             | 3.1.0                     |
| options      | `String[]`          | Valeurs possibles du paramètre pour une liste déroulante.                           |            |                 |             | 3.1.0                     |
| type         | `ParameterTypeEnum` | Type de paramètre                                                                   |            |                 |             | 3.1.0                     |
| values       | `String[]`          | Valeurs du paramètre                                                                |            |                 |             | 3.1.0                     |
| id           | `String`            | Identifiant de l'entité `Parameter`                                                 |            | X               |             |                           |
| code         | `String`            | Codification fonctionnelle de l'entité `Parameter`                                  |            |                 |             |                           |
| externalId   | `String`            | Identifiant de l'entité `Parameter` dans le système client                          |            |                 |             |                           |
| externalCode | `String`            | Codification fonctionnelle de l'entité `Parameter` dans le système client           |            |                 |             |                           |
| parameterId  | `String`            | Identifiant public de l'entité `Parameter` dans l'OIP                               |            |                 |             |                           |
| label        | `String`            | Information relative au nom de l'entité `Parameter` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt    | `Date`              | Date de création de l'entité `Parameter`                                            |            | X               |             |                           |
| updatedAt    | `Date`              | Date de modification de l'entité `Parameter`                                        |            | X               |             |                           |

## Enumérations

### ParameterTypeEnum

- `BOOLEAN`
- `NUMBER`
- `STRING`
- `DATE`
- `URI`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getCompanyId } from '@fasstech/oip-core/entities/Company';
import { getOfferNodeId } from '@fasstech/oip-core/entities/OfferNode';
import { getParameterCode, getParameterDescription, getParameterExternalCode, getParameterExternalId, getParameterId, getParameterIsArray, getParameterLabel, getParameterOptions, getParameterParameterId, getParameterType, getParameterValues, setParameterCode, setParameterDescription, setParameterExternalCode, setParameterExternalId, setParameterIsArray, setParameterLabel, setParameterOptions, setParameterParameterId, setParameterType, setParameterValues } from '@fasstech/oip-core/entities/Parameter';
import { ParameterTypeEnum } from '@fasstech/oip-core/entities/Parameter/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';

(async () => {
  let project = await Entities('Project').create();
  let company = await Entities('Company').create();
  let offerNode = await Entities('OfferNode').create();
  const parameter = await Entities('Parameter').create();
  
  setParameterDescription('description', parameter);
  setParameterIsArray(false, parameter);
  setParameterOptions(['options'], parameter);
  setParameterType(ParameterTypeEnum.DATE, parameter);
  setParameterValues(['values'], parameter);
  setParameterCode('code', parameter);
  setParameterExternalId('externalId', parameter);
  setParameterExternalCode('externalCode', parameter);
  setParameterParameterId('parameterId', parameter);
  setParameterLabel('label', parameter);
  
  offerNode = await Entities('Parameter').save(offerNode, parameter);
  company = await Entities('OfferNode').save(company, offerNode);
  project = await Entities('Company').save(project, company);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const companyToTest = await Entities('Company').get(projectToTest, { filter: ({ id }) => id === getCompanyId(company) });
  const offerNodeToTest = await Entities('OfferNode').get(companyToTest, { filter: ({ id }) => id === getOfferNodeId(offerNode) });
  const parameterToTest = await Entities('Parameter').get(offerNodeToTest, { filter: ({ id }) => id === getParameterId(parameter) });
  
  getParameterDescription(parameterToTest); // 'description'
  getParameterIsArray(parameterToTest); // false
  getParameterOptions(parameterToTest); // ['options']
  getParameterType(parameterToTest); // ParameterTypeEnum.DATE
  getParameterValues(parameterToTest); // ['values']
  getParameterCode(parameterToTest); // 'code'
  getParameterExternalId(parameterToTest); // 'externalId'
  getParameterExternalCode(parameterToTest); // 'externalCode'
  getParameterParameterId(parameterToTest); // 'parameterId'
  getParameterLabel(parameterToTest); // 'label'
})();
```
