API-Vitam Version Alpha - Collect version v1

https://api.vitam.gouv.fr/collect-external/{version}

version: required(v1)

Avertissements

Cette version d'API présente des fonctionnalités sous différents statuts :

Usage non recommandé en production en dehors de vitam-UI, utiliser les "profils de sécurité" afin d'en interdire l'usage si nécessaire
Supportées : rien n'est spécifié, la fonctionnalité ou la donnée est supportée

Pour le détail du modèle de chaque collection, se référer à la documentation du modèle de données.

Licence

Ce document est distribué sous les termes de la Licence Ouverte V2.0

Projects

API de collecte. Ce point d'entrée permet d'initialiser et de gérer un projet de versement.

Création d'un projet :

une requête unique, avec un 'body' contenant toutes les informations au format JSON :
ArchivalAgencyIdentifier
TransferringAgencyIdentifier
OriginatingAgencyIdentifier
SubmissionAgencyIdentifier
MessageIdentifier
ArchivalAgreement
unitUp
Comment
LegalStatus
Name

/projects post put get

post

request body : JSON object
response : JSON of saved project / HTTP CODE 200

put

request body : JSON object
response : JSON of saved project / HTTP CODE 200

get

request body : JSON object
response : JSON of saved project / HTTP CODE 200

request body : JSON object
response : JSON of saved project / HTTP CODE 200

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

Headers

x-tenant-id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
  "ArchivalAgencyIdentifier": "Identifier0",
  "TransferringAgencyIdentifier": "Identifier3",
  "OriginatingAgencyIdentifier": "FRAN_NP_009915",
  "SubmissionAgencyIdentifier": "FRAN_NP_005061",
  "MessageIdentifier": "20220302-000005",
  "Name": "Project Name",
  "LegalStatus": "Archives privées",
  "AcquisitionInformation": "Versement",
  "ArchivalAgreement":"IC-000001",
  "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
  "UnitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba"
}

HTTP status code 200

Returns the saved transaction

Body

Media type: application/json

Type: object

Example:

{
    "httpCode": 200,
    "$hits": {
        "total": 1,
        "offset": 0,
        "limit": 0,
        "size": 1
    },
    "$results": [
        {
            "#id": "aeaaaaaaaahago4caajvgamet3mprkqaaaaq",
            "Name": "This is my Name",
            "ArchivalAgreement": "IC-000001",
            "MessageIdentifier": "20220302-000005",
            "ArchivalAgencyIdentifier": "Identifier0",
            "TransferringAgencyIdentifier": "Identifier3",
            "OriginatingAgencyIdentifier": "FRAN_NP_009915",
            "SubmissionAgencyIdentifier": "FRAN_NP_005061",
            "AcquisitionInformation": "Versement",
            "LegalStatus": "Archives privées",
            "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
            "UnitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba",
            "#tenant": 0
        }
    ],
    "$facetResults": [],
    "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

request body : JSON object
response : JSON of saved project / HTTP CODE 200

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

Headers

x-tenant-id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
    "#id": "aeaaaaaaaahago4caajvgamet3mprkqaaaaq",
    "Name": "This is my Name",
    "ArchivalAgreement": "IC-000001",
    "MessageIdentifier": "20220302-000005",
    "ArchivalAgencyIdentifier": "Identifier0",
    "TransferringAgencyIdentifier": "Identifier3",
    "OriginatingAgencyIdentifier": "FRAN_NP_009915",
    "SubmissionAgencyIdentifier": "FRAN_NP_005061",
    "AcquisitionInformation": "Versement",
    "LegalStatus": "Archives privées",
    "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
    "UnitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba",
    "#tenant": 0
}

HTTP status code 200

Returns the saved transaction

Body

Media type: application/json

Type: object

Example:

{
    "httpCode": 200,
    "$hits": {
        "total": 1,
        "offset": 0,
        "limit": 0,
        "size": 1
    },
    "$results": [
        {
            "#id": "aeaaaaaaaahago4caajvgamet3mprkqaaaaq",
            "Name": "This is my Name",
            "ArchivalAgreement": "IC-000001",
            "MessageIdentifier": "20220302-000005",
            "ArchivalAgencyIdentifier": "Identifier0",
            "TransferringAgencyIdentifier": "Identifier3",
            "OriginatingAgencyIdentifier": "FRAN_NP_009915",
            "SubmissionAgencyIdentifier": "FRAN_NP_005061",
            "AcquisitionInformation": "Versement",
            "LegalStatus": "Archives privées",
            "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
            "UnitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba",
            "#tenant": 0
        }
    ],
    "$facetResults": [],
    "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

request body : JSON object
response : JSON of saved project / HTTP CODE 200

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

Headers

x-tenant-id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
    "httpCode": 200,
    "$hits": {
        "total": 1,
        "offset": 0,
        "limit": 0,
        "size": 1
    },
    "$results": [
        [
            {
                "id": "aeeaaaaaachguhgcabg2kambqwah7zaaaaaq",
                "ArchivalAgreement": "IC-000001",
                "MessageIdentifier": "20220302-000005",
                "ArchivalAgencyIdentifier": "Identifier0",
                "TransferingAgencyIdentifier": "Identifier3",
                "OriginatingAgencyIdentifier": "FRAN_NP_009915",
                "SubmissionAgencyIdentifier": "FRAN_NP_005061",
                "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
                "tenant": 0,
                "unitUp": "aeaqaaaaaahgnz5dabg42amava5kfoqaaaba"
            }
        ]
    ],
    "$facetResults": [],
    "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/projects/{id} delete

API de collecte. Ce point d'entrée permet de supprimer un projet.

delete

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

x-tenant-id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

HTTP status code 200

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/projects/{id}/transactions post

post

request body : JSON object
response : JSON of saved transaction / HTTP CODE 200

request body : JSON object
response : JSON of saved transaction / HTTP CODE 200

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

x-tenant-id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
  "ArchivalAgencyIdentifier": "Vitam",
  "TransferingAgencyIdentifier": "AN",
  "OriginatingAgencyIdentifier": "MICHEL_MERCIER",
  "SubmissionAgencyIdentifier": "MICHEL_MERCIER",
  "MessageIdentifier": "20220302-000005",
  "ArchivalAgreement":"IC-000001",
  "Comment": "Versement du service producteur : Cabinet de Michel Mercier"
}

HTTP status code 200

Returns the saved transaction

Body

Media type: application/json

Type: object

Example:

{
    "httpCode": 200,
    "$hits": {
        "total": 1,
        "offset": 0,
        "limit": 0,
        "size": 1
    },
    "$results": [
        {
            "#id": "aeeaaaaaachago4caajvgamet3sv5riaaaaq",
            "ArchivalAgreement": "IC-000001",
            "MessageIdentifier": "20220302-000005",
            "ArchivalAgencyIdentifier": "Vitam",
            "TransferringAgencyIdentifier": "AN",
            "OriginatingAgencyIdentifier": "MICHEL_MERCIER",
            "SubmissionAgencyIdentifier": "MICHEL_MERCIER",
            "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
            "#tenant": 0
        }
    ],
    "$facetResults": [],
    "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

Transactions

/transactions put

put

request body : JSON object
response : JSON of saved transaction / HTTP CODE 200

request body : JSON object
response : JSON of saved transaction / HTTP CODE 200

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

Headers

x-tenant-id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
            "#id": "aeeaaaaaachago4caajvgamet3sv5riaaaaq",
            "ArchivalAgreement": "IC-000001",
            "MessageIdentifier": "20220302-000005",
            "ArchivalAgencyIdentifier": "Vitam",
            "TransferringAgencyIdentifier": "AN",
            "OriginatingAgencyIdentifier": "MICHEL_MERCIER",
            "SubmissionAgencyIdentifier": "MICHEL_MERCIER",
            "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
            "#tenant": 0
}

HTTP status code 200

Returns the saved transaction

Body

Media type: application/json

Type: object

Example:

{
    "httpCode": 200,
    "$hits": {
        "total": 1,
        "offset": 0,
        "limit": 0,
        "size": 1
    },
    "$results": [
        {
            "#id": "aeeaaaaaachago4caajvgamet3sv5riaaaaq",
            "ArchivalAgreement": "IC-000001",
            "MessageIdentifier": "20220302-000005",
            "ArchivalAgencyIdentifier": "Vitam",
            "TransferringAgencyIdentifier": "AN",
            "OriginatingAgencyIdentifier": "MICHEL_MERCIER",
            "SubmissionAgencyIdentifier": "MICHEL_MERCIER",
            "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
            "#tenant": 0
        }
    ],
    "$facetResults": [],
    "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/transactions/{id}/units get

get

Permet de retourner la liste des unités archivistique associés à l'identifiant du projet

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
  "$roots": [],
  "$query": [
    {
      "$gt": {
        "#approximate_creation_date": "2022-01-01"
      }
    }
  ],
  "$projection": {
    "$fields": {
    }
  },
  "$facets": [],
  "$threshold": 500000
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "httpCode": 201,
  "$hits": {
    "total": 1,
    "offset": 0,
    "limit": 0,
    "size": 1
  },
  "$results": [
    {
      "#unitups": [],
      "#min": 1,
      "#max": 1,
      "#allunitups": [],
      "DescriptionLevel": "Item",
      "Title": "My title3",
      "Description": "Allemant. - Au chemin des Dames : le chateau et la ferme de la Motte totalement detruits.",
      "Descriptions": {
        "fr": "La legendes traduites en anglais."
      },
      "Status": "Pret",
      "Tag": [
        "Grande Collecte"
      ],
      "Source": "Famille Herve, CP1",
      "CreatedDate": "2014-06-12T09:31:00",
      "TransactedDate": "2014-06-12T09:31:00",
      "#management": {},
      "#originating_agencies": [],
      "#id": "aeeaaaaaach2brfeabbykal7ds6p33qaaaaq",
      "#opi": "aeeaaaaaach2brfeabbykal7ds53vdqaaaaq"
    }
  ],
  "$facetResults": [],
  "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/transactions/{id}/unitsWithInheritedRules get

get

API pour accéder aux Unités d'archives liées à une transaction avec leurs règles de gestion héritées . La requête utilise le langage de requête DSL de Vitam en entrée et retourne une liste d'Unités d'archives avec leurs règles de gestion selon le DSL Vitam en cas de succès.

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/transactions/{id}/close post

post

Permet de fermer une transaction

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/json

Type: any

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "httpCode": 200,
  "$hits": {
    "total": 0,
    "offset": 0,
    "limit": 0,
    "size": 0
  },
  "$results": [],
  "$facetResults": [],
  "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/transactions/{id}/send post

post

Permet de génerer un SIP et l'envoyer a Vitam (Ingest)

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/json

Type: any

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "httpCode": 200,
  "$hits": {
    "total": 1,
    "offset": 0,
    "limit": 0,
    "size": 1
  },
  "$results": [
    {
      "id": "aeeaaaaaachbhe3yabli6al7eymg7iqaaaaq"
    }
  ],
  "$facetResults": [],
  "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/transactions/{id} get delete

API de collecte. Ce point d'entrée permet de supprimer une transaction.

get

delete

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

x-tenant-id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
    "httpCode": 200,
    "$hits": {
        "total": 1,
        "offset": 0,
        "limit": 0,
        "size": 1
    },
    "$results": [
        {
            "#id": "aeeaaaaaachago4caajvgamet3sv5riaaaaq",
            "ArchivalAgreement": "IC-000001",
            "MessageIdentifier": "20220302-000005",
            "ArchivalAgencyIdentifier": "Vitam",
            "TransferringAgencyIdentifier": "AN",
            "OriginatingAgencyIdentifier": "MICHEL_MERCIER",
            "SubmissionAgencyIdentifier": "MICHEL_MERCIER",
            "Comment": "Versement du service producteur : Cabinet de Michel Mercier",
            "#tenant": 0
        }
    ],
    "$facetResults": [],
    "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

x-tenant-id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

HTTP status code 200

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/transactions/{id}/upload post

post

Permet de soumettre un ensemble de binaire au format Zip

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/zip

Type: any

HTTP status code 200

Body

Media type: application/json

Type: any

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

Units

API de collecte. Ce point d'entrée permet de gérer une unité archivistique et les groupe d'objets.

/units/{id} get

get

Permet de retourner une unité archivistique par son id

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "httpCode": 201,
  "$hits": {
    "total": 1,
    "offset": 0,
    "limit": 0,
    "size": 1
  },
  "$results": [
    {
      "#unitups": [],
      "#min": 1,
      "#max": 1,
      "#allunitups": [],
      "DescriptionLevel": "Item",
      "Title": "My title3",
      "Description": "Allemant. - Au chemin des Dames : le chateau et la ferme de la Motte totalement detruits.",
      "Descriptions": {
        "fr": "La legendes traduites en anglais."
      },
      "Status": "Pret",
      "Tag": [
        "Grande Collecte"
      ],
      "Source": "Famille Herve, CP1",
      "CreatedDate": "2014-06-12T09:31:00",
      "TransactedDate": "2014-06-12T09:31:00",
      "#management": {},
      "#originating_agencies": [],
      "#id": "aeeaaaaaach2brfeabbykal7ds6p33qaaaaq",
      "#opi": "aeeaaaaaach2brfeabbykal7ds53vdqaaaaq"
    }
  ],
  "$facetResults": [],
  "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/units/{id}/objects/{usage}/{version} post

post

Permet de rajouter un groupe d'objects

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)
usage: required(string)
version: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/json

Type: object

Example:

{
  "fileInfo": {
    "filename": "plan.txt"
  }
}

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "httpCode": 200,
  "$hits": {
    "total": 1,
    "offset": 0,
    "limit": 0,
    "size": 1
  },
  "$results": [
    {
      "id": "aeeaaaaaach2brfeabbykal7egm5ysyaaaaq",
      "fileInfo": {
        "lastModified": "2022-02-22T13:23:25.846",
        "filename": "plan.txt"
      }
    }
  ],
  "$facetResults": [],
  "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

/units/{id}/objects/{usage}/{version}/binary get post

get

Permet de télécharger un binaire

post

Permet de rajouter un binaire

Permet de télécharger un binaire

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)
usage: required(string)
version: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

HTTP status code 200

Body

Media type: application/octet-stream

Type: any

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

Permet de rajouter un binaire

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)
usage: required(string)
version: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

Body

Media type: application/octet-stream

Type: any

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "httpCode": 200,
  "$hits": {
    "total": 0,
    "offset": 0,
    "limit": 0,
    "size": 0
  },
  "$results": [],
  "$facetResults": [],
  "$context": {}
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

Objects

API de collecte. Ce point d'entrée permet de gérer les groupe d'objets.

/objects/{id} get

get

Permet de retourner une groupe d'object par son id

Secured by VitamPlatform

Based on certificate passing a valid identifier of application

URI Parameters

id: required(string)

Headers

X-tenant-Id: required(string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Example:
```
SESSION-ID-00001
```
X-Personal-Certificate: (string)
Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.
Example:
```
MIIGfzCCBGegAwIBAgICAPcwDQYJK...
```
X-Tenant-Id: required(number)
Unique Tenant Identifier.
Example:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "_id": "aebaaaaaaacpbveraqxzuamdvda5l3yaaaaq",
  "_tenant": 0,
  "FileInfo": {
    "Filename": "Child C"
  },
  "_nbc": 1,
  "_opi": "TRANSACTION_ID",
  "_qualifiers": [
    {
      "qualifier": "BinaryMaster",
      "_nbc": 1,
      "versions": [
        {
          "_id": "aebqaaaaaccpbveraqxzuamdvda5l3qaaaba",
          "DataObjectVersion": "BinaryMaster_1",
          "FileInfo": {
            "Filename": "Child C"
          },
          "Size": 0
        }
      ]
    }
  ]
}

HTTP status code 401

Unauthorized (restricted operation), authentication in error

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

HTTP status code 412

Precondition Failed, some predicates are incorrect, therefore the operation is not possible

Headers

X-Request-Id: required(string)
Unique Request Identifier
Example:
```
aeeaaaaaachmj6ciaa5nwalv3rsu4laaaaaq
```

Secured by VitamPlatform

Headers

X-Identity: required(string)
Contains the application identifier from the Certificate resolution

API-Vitam Version Alpha - Collect version v1

Projects

post /projects

Headers

Body

HTTP status code 200

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 409

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

put /projects

Headers

Body

HTTP status code 200

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 409

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

get /projects

Headers

HTTP status code 200

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 409

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

delete /projects/{id}

URI Parameters

Headers

HTTP status code 200

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 409

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

post /projects/{id}/transactions

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 401

Headers

HTTP status code 404

Headers

HTTP status code 409

Headers

HTTP status code 412

Headers

Secured by VitamPlatform

Headers

Transactions

put /transactions

Headers

Body