---
title: DigitalService
slug: oip-next/0lk32a4e7yba3h2aebkfx
icon: {"lucideIcon":"📘"}
createdAt: 2024-04-08T10:17:29.000Z
---

# DigitalService

## Description

Structure informative de l'état d'un service digital.

## Relations

### Ascendantes

| Entité | Propriété       |
| ------ | --------------- |
| Svc    | digitalServices |

### Descendantes

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

## Propriétés

| Nom              | Type                       | Description                                                                              | Validateur | Lecture seule ? | Dépréciée ? | Dernière version modifiée |
| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------- | ---------- | --------------- | ----------- | ------------------------- |
| offerId          | `String`                   | Identifiant unique interne de l'offre liée à ce process                                  |            |                 |             | 3.1.1                     |
| processId        | `String`                   | Identifiant unique interne du process instancié                                          |            |                 |             | 3.1.1                     |
| state            | `DigitalServiceStatusEnum` | Etat de l'instance du digital service                                                    |            |                 |             | 3.1.1                     |
| status           | `String`                   | Etat métier spécifique du digital service                                                |            |                 |             | 3.1.1                     |
| type             | `DigitalServiceTypeEnum`   | Type catalogué de digital service                                                        |            |                 |             | 3.1.1                     |
| id               | `String`                   | Identifiant de l'entité `DigitalService`                                                 |            | X               |             |                           |
| code             | `String`                   | Codification fonctionnelle de l'entité `DigitalService`                                  |            |                 |             |                           |
| externalId       | `String`                   | Identifiant de l'entité `DigitalService` dans le système client                          |            |                 |             |                           |
| externalCode     | `String`                   | Codification fonctionnelle de l'entité `DigitalService` dans le système client           |            |                 |             |                           |
| digitalServiceId | `String`                   | Identifiant public de l'entité `DigitalService` dans l'OIP                               |            |                 |             |                           |
| label            | `String`                   | Information relative au nom de l'entité `DigitalService` dans son contexte d'utilisation |            |                 |             |                           |
| createdAt        | `Date`                     | Date de création de l'entité `DigitalService`                                            |            | X               |             |                           |
| updatedAt        | `Date`                     | Date de modification de l'entité `DigitalService`                                        |            | X               |             |                           |

## Enumérations

### DigitalServiceStatusEnum

- `COMPLETED`
- `COMPLETING`
- `PENDING`
- `RUNNING`
- `STARTING`
- `TERMINATED`
- `TERMINATING`

### DigitalServiceTypeEnum

- `FINANCIAL_FORM`
- `MEDICAL_FORM`

## Enumérations génériques

Aucune enumération générique.

## Exemple

```javascript
import { Entities } from '@fasstech/oip-core';
import { getDigitalServiceCode, getDigitalServiceDigitalServiceId, getDigitalServiceExternalCode, getDigitalServiceExternalId, getDigitalServiceId, getDigitalServiceLabel, getDigitalServiceOfferId, getDigitalServiceProcessId, getDigitalServiceState, getDigitalServiceStatus, getDigitalServiceType, setDigitalServiceCode, setDigitalServiceDigitalServiceId, setDigitalServiceExternalCode, setDigitalServiceExternalId, setDigitalServiceLabel, setDigitalServiceOfferId, setDigitalServiceProcessId, setDigitalServiceState, setDigitalServiceStatus, setDigitalServiceType } from '@fasstech/oip-core/entities/DigitalService';
import { DigitalServiceStatusEnum, DigitalServiceTypeEnum } from '@fasstech/oip-core/entities/DigitalService/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';
import { getSvcId } from '@fasstech/oip-core/entities/Svc';

(async () => {
  let project = await Entities('Project').create();
  let svc = await Entities('Svc').create();
  const digitalService = await Entities('DigitalService').create();
  
  setDigitalServiceOfferId('offerId', digitalService);
  setDigitalServiceProcessId('processId', digitalService);
  setDigitalServiceState(DigitalServiceStatusEnum.RUNNING, digitalService);
  setDigitalServiceStatus('status', digitalService);
  setDigitalServiceType(DigitalServiceTypeEnum.FINANCIAL_FORM, digitalService);
  setDigitalServiceCode('code', digitalService);
  setDigitalServiceExternalId('externalId', digitalService);
  setDigitalServiceExternalCode('externalCode', digitalService);
  setDigitalServiceDigitalServiceId('digitalServiceId', digitalService);
  setDigitalServiceLabel('label', digitalService);
  
  svc = await Entities('DigitalService').save(svc, digitalService);
  project = await Entities('Svc').save(project, svc);
  await Entities('Project').save(project);
  
  const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
  const svcToTest = await Entities('Svc').get(projectToTest, { filter: ({ id }) => id === getSvcId(svc) });
  const digitalServiceToTest = await Entities('DigitalService').get(svcToTest, { filter: ({ id }) => id === getDigitalServiceId(digitalService) });
  
  getDigitalServiceOfferId(digitalServiceToTest); // 'offerId'
  getDigitalServiceProcessId(digitalServiceToTest); // 'processId'
  getDigitalServiceState(digitalServiceToTest); // DigitalServiceStatusEnum.RUNNING
  getDigitalServiceStatus(digitalServiceToTest); // 'status'
  getDigitalServiceType(digitalServiceToTest); // DigitalServiceTypeEnum.FINANCIAL_FORM
  getDigitalServiceCode(digitalServiceToTest); // 'code'
  getDigitalServiceExternalId(digitalServiceToTest); // 'externalId'
  getDigitalServiceExternalCode(digitalServiceToTest); // 'externalCode'
  getDigitalServiceDigitalServiceId(digitalServiceToTest); // 'digitalServiceId'
  getDigitalServiceLabel(digitalServiceToTest); // 'label'
})();
```
