Introduction Procédures d'exploitation - utilisateur Procédures d'exploitation - administrateur Configuration Documentation API Chemins Fonctions de coffre-fort numérique Transactions d'échange de données d'archive Gestion de l'archive Accès à l'archive Liste d'identifiant d'archives Demande de destruction Geler une archive Liste d'identifiant d'archives Versement d'archive Versement asynchrone d'archive Lecture de toutes les informations d'une archive Lecture d'une ressource Recherche d'une archive Dégeler une archive Mise à jour de la règle de conservation d'une archive Définitions Annexes

Recherche d'une archive

Route

GET /recordsManagement/archives?[searchParameters]

Description

Route de service permettant la recherche d'une archive

Paramètres

Variables de chemin

Nom de la propriété	Type	Description
archiveExpired	string	Archive expirée (true, false, null)
agreementReference	string
archiveName	string	Nom de l'archive
archiveId	string	Identifiant de l'archive
depositEndDate	string	Fin de la date de dépôt Format : yyyy-mm-dd
depositStartDate	string	Début de la date de dépôt Format : yyyy-mm-dd
description	string	description de l'archive
filePlanPosition	string	Identifiant de la position dans le plan de classement
finalDisposition	string	Statut de l'action à effectuer une fois l'archive échue preservation \| destruction
hasParent	bool	Existence d'un parent (true ou false)
originatingDate	array	Tableau des dates de début et fin de recherche par date Format [date début yyyy-mm-dd, yyyy-mm-dd]
originatingEndDate	string	Fin de la date de création du fichier Format : yyyy-mm-dd
originatingStartDate	string	Début de la date de création du fichier Format : yyyy-mm-dd
originatorArchiveId	string	Identifiant de l’archive pour le producteur
originatorOrgRegNumber	string	Référence organisationnel du service auquel appartient l’archive
originatorOwnerOrgId	string	Identifiant du service auquel appartient l'archive
partialRetentionRule	bool	Possède une règle de conservation partielle true or false
profileReference	string	Code de la règle de conservation de l'archive
retentionRuleCode	string	Code de la règle de conservation
status	string	Statut de l'archive Valeur : received \| pending \| preserved \| frozen \| disposable \| disposed \| restitued
text	string	Description d'une partie du nom de l'archive

En-tête

Nom de l'en-tête	Type	Description
Accept	string	application/json
Content-Type	string	application/json

Nom du cookie	Type	Description
LAABS-AUTH	string	Jeton de connexion à l'application URL encodé Génération d'un jeton

Corps

Nom de la propriété	Type	Description
Néant

Exemple

Requête

GET http://maarchrm/recordsManagement/archives?text=ju

Headers

Accept          application/json
Content-Type    application/json
Cookie          LAABS-AUTH=phdF9WkJuTKkDuPXoqDZuOjLMAFGC6ZrzrSEEqC9YjJCJRzd9eC0tkXUb7dxJfYJkO796O20xWnkAcSH6xSclPI3ijyxkdyObVtwujfhT0m8wgq2G4c1Cg%3D%3D

Réponses

Succès

Le service web retourne les informations de l'archive et de ses agrégats.

Code HTTP 200

retour

[
    {
        "description": "null",
        "text": "0005 _ Casier Judiciaire ",
        "archiveId": "maarchRM_pgqh2p-00c5-slcfb3",
        "archiverArchiveId": null,
        "originatorArchiveId": null,
        "depositorArchiveId": null,
        "archiveName": "0005 _ Casier Judiciaire",
        "filePlanPosition": null,
        "originatingDate": null,
        "archivalProfileReference": "CASJU",
        "serviceLevelReference": "serviceLevel_002",
        "archivalAgreementReference": null,
        "retentionRuleCode": null,
        "retentionStartDate": null,
        "retentionDuration": null,
        "finalDisposition": null,
        "disposalDate": null,
        "retentionRuleStatus": null,
        "accessRuleCode": null,
        "accessRuleDuration": null,
        "accessRuleStartDate": null,
        "accessRuleComDate": null,
        "classificationRuleCode": null,
        "classificationRuleDuration": null,
        "classificationRuleStartDate": null,
        "classificationEndDate": null,
        "classificationLevel": null,
        "classificationOwner": null,
        "originatorOrgRegNumber": "DRH",
        "originatorOwnerOrgId": "ACME",
        "originatorOwnerOrgRegNumber": "DRH",
        "depositorOrgRegNumber": null,
        "archiverOrgRegNumber": null,
        "depositDate": "2018-10-17 08:04:01.000000",
        "lastCheckDate": null,
        "lastDeliveryDate": null,
        "lastModificationDate": null,
        "lifeCycleEvent": null,
        "status": "preserved",
        "fullTextIndexation": "none",
        "descriptionClass": null,
        "descriptionObject": null,
        "fileplanLevel": "item",
        "storagePath": "//maarchRM/ACME/DRH/DOSIP/2018/10/17/maarchRM_pgqh2o-24ab-hjjn7m/maarchRM_pgqh2p-00c5-slcfb3",
        "parentArchiveId": "maarchRM_pgqh2o-24ab-hjjn7m",
        "contents": null,
        "digitalResources": null,
        "archiveRelationship": null
    }
]

Documentation Maarch RM