Document
Document
Description
L'entité Document permet la gestion des documents. Ceux-ci sont classés par type.
Relations
Ascendantes
Entité | Propriété |
|---|---|
Project | documents |
Descendantes
Entité | Propriété |
|---|---|
History | history |
Propriétés
Nom | Type | Description | Validateur | Lecture seule ? | Dépréciée ? | DerniÚre version modifiée |
|---|---|---|---|---|---|---|
fileName | String | Nom du fichier | ï»ż | ï»ż | ï»ż | 2.1.1 |
fileType | String | Type du fichier | ï»ż | ï»ż | ï»ż | 2.1.1 |
hasBeenChecked | Boolean | Permet de savoir si le document a Ă©tĂ© lu. | ï»ż | ï»ż | ï»ż | 2.6.0 |
isSignedDocument | Boolean | Document signĂ© | ï»ż | ï»ż | ï»ż | 2.1.1 |
key | String | ClĂ© du document | ï»ż | ï»ż | ï»ż | 2.1.1 |
metadata | String | MĂ©tadonnĂ©es du document | ï»ż | ï»ż | ï»ż | 2.1.1 |
mimeType | String | Type mime du fichier | ï»ż | ï»ż | ï»ż | 2.3.0 |
ownershipURI | String[] | Pointeur vers une entitĂ© dĂ©finissant la propriĂ©tĂ© du document. Le tableau peut rĂ©fĂ©rencer plusieurs propriĂ©taires. | ï»ż | ï»ż | ï»ż | 3.5.2 |
type | DocumentTypeEnum | Type du document DocumentTypeEnum | ï»ż | ï»ż | ï»ż | 2.6.0 |
id | String | Identifiant de l'entitĂ© Document | ï»ż | X | ï»ż | ï»ż |
code | String | Codification fonctionnelle de l'entitĂ© Document | ï»ż | ï»ż | ï»ż | ï»ż |
externalId | String | Identifiant de l'entitĂ© Document dans le systĂšme client | ï»ż | ï»ż | ï»ż | ï»ż |
externalCode | String | Codification fonctionnelle de l'entitĂ© Document dans le systĂšme client | ï»ż | ï»ż | ï»ż | ï»ż |
documentId | String | Identifiant public de l'entitĂ© Document dans l'OIP | ï»ż | ï»ż | ï»ż | ï»ż |
label | String | Information relative au nom de l'entitĂ© Document dans son contexte d'utilisation | ï»ż | ï»ż | ï»ż | ï»ż |
createdAt | Date | Date de crĂ©ation de l'entitĂ© Document | ï»ż | X | ï»ż | ï»ż |
updatedAt | Date | Date de modification de l'entitĂ© Document | ï»ż | X | ï»ż | ï»ż |
Enumérations
DocumentTypeEnum
- AFFILIATION_CERTIFICATE
- ASSOCIATION_RECEIPT
- BANKACCOUNTDETAILS
- CANCELLATION_LETTER
- CHEQUE_SCAN
- CONTRACT
- CONTRIBUTIONS_PAYMENT
- CUSTOMIZED_COVERAGE_TABLE
- CUSTOMIZED_COVERAGE_TABLE_MANDATORY_CONTRACT
- CUSTOMIZED_COVERAGE_TABLE_OPTIONAL_CONTRACT
- DRIVINGLICENSE
- EMPLOYEE_REGISTRATION
- ENROLLMENT_CERTIFICATE
- FAMILY_RECORD_BOOKLET
- FILE_TRANSFER_CONFIRMATION
- FREE_CLAUSE
- GENERAL_CONDITIONS
- GENERAL_CONDITIONS_MANDATORY_CONTRACT
- GENERAL_CONDITIONS_OPTIONAL_CONTRACT
- GRANTEE_PRE_REGISTRATION
- HANDICAP_CERTIFICATE
- HEALTH_INSURANCE_TERMINATION_CERTIFICATE
- IDCARD
- IPID
- KBIS
- MADELIN_CERTIFICATE
- MANDATE
- MANDATORY_REGIME_CERTIFICATE
- MANUAL_SIGNED_CONTRACT_PROPOSAL
- MEMBERSHIP_CERTIFICATE
- OTHER
- PASSPORT
- PERMANENT_RESIDENCE_CARD
- POLICY_INFORMATION_DOCUMENT
- POLITICALLY_EXPOSED_PERSON_PROOF
- QUOTE
- RESIDENCE_CARD
- RESIDENCE_CERTIFICATE
- RIA
- RNA
- RNM
- SCHOOL_CERTIFICATE
- SEPA
- SIGNED_ADVICE_AND_INFORM_SHEET
- SIGNING_AUTHORITY
- SIRENE_NOTICE
- SPECIFIC_CONDITIONS
- SPECIFIC_CONDITIONS_MANDATORY_CONTRACT
- SPECIFIC_CONDITIONS_OPTIONAL_CONTRACT
- TNS_CERTIFICATE
- VISA
- WAIVER
Enumérations génériques
Aucune enumération générique.
Exemple
import { Entities } from '@fasstech/oip-core';
import { getDocumentCode, getDocumentDocumentId, getDocumentExternalCode, getDocumentExternalId, getDocumentFileName, getDocumentFileType, getDocumentHasBeenChecked, getDocumentId, getDocumentIsSignedDocument, getDocumentKey, getDocumentLabel, getDocumentMetadata, getDocumentMimeType, getDocumentOwnershipURI, getDocumentType, setDocumentCode, setDocumentDocumentId, setDocumentExternalCode, setDocumentExternalId, setDocumentFileName, setDocumentFileType, setDocumentHasBeenChecked, setDocumentIsSignedDocument, setDocumentKey, setDocumentLabel, setDocumentMetadata, setDocumentMimeType, setDocumentOwnershipURI, setDocumentType } from '@fasstech/oip-core/entities/Document';
import { DocumentTypeEnum } from '@fasstech/oip-core/entities/Document/enums';
import { getProjectId } from '@fasstech/oip-core/entities/Project';
(async () => {
let project = await Entities('Project').create();
const document = await Entities('Document').create();
setDocumentFileName('fileName', document);
setDocumentFileType('fileType', document);
setDocumentHasBeenChecked(true, document);
setDocumentIsSignedDocument(false, document);
setDocumentKey('key', document);
setDocumentMetadata('metadata', document);
setDocumentMimeType('mimeType', document);
setDocumentOwnershipURI(['ownershipURI'], document);
setDocumentType(DocumentTypeEnum.ENROLLMENT_CERTIFICATE, document);
setDocumentCode('code', document);
setDocumentExternalId('externalId', document);
setDocumentExternalCode('externalCode', document);
setDocumentDocumentId('documentId', document);
setDocumentLabel('label', document);
project = await Entities('Document').save(project, document);
await Entities('Project').save(project);
const projectToTest = await Entities('Project').get({ id: getProjectId(project) });
const documentToTest = await Entities('Document').get(projectToTest, { filter: ({ id }) => id === getDocumentId(document) });
getDocumentFileName(documentToTest); // 'fileName'
getDocumentFileType(documentToTest); // 'fileType'
getDocumentHasBeenChecked(documentToTest); // true
getDocumentIsSignedDocument(documentToTest); // false
getDocumentKey(documentToTest); // 'key'
getDocumentMetadata(documentToTest); // 'metadata'
getDocumentMimeType(documentToTest); // 'mimeType'
getDocumentOwnershipURI(documentToTest); // ['ownershipURI']
getDocumentType(documentToTest); // DocumentTypeEnum.ENROLLMENT_CERTIFICATE
getDocumentCode(documentToTest); // 'code'
getDocumentExternalId(documentToTest); // 'externalId'
getDocumentExternalCode(documentToTest); // 'externalCode'
getDocumentDocumentId(documentToTest); // 'documentId'
getDocumentLabel(documentToTest); // 'label'
})();