API-Vitam Version Alpha - Moteur d'exécution interne API documentation version v1

http://processing.internal.vitam.gouv.fr/{version}

version: required (v1)

Avertissements

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

Supportées : rien n'est spécifié, la fonctionnalité ou la donnée est supportée
Non supportées : le mot clef UNSUPPORTED est indiqué et précise que cette fonctionnalité ou donnée n'est pas supportée par l'implémentaton courante
Cette version d'API présente des fonctionnalités sous différentes versions :
Alpha : l'API est dans une première version, susceptible d'évoluer fortement
Beta : l'API est proche de sa version stable
Production : l'API est considérée comme "production ready"
Deprecated : l'API est considérée comme obsolète et devrait disparaître dans une version majeure prochaine
Pour le moment, la partie /containers/{cid} des paths n'est pas encore pris en compte mais doit être ajoutée à terme.

Licence

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

Workflows

Le principe proposé serait le suivant:

Permet de soumettre un workflow à l'exécution:
- POST /operations/id
Obtenir le statut détaillé d'un workflow:
- GET /operations/id
Obtenir le statut d'un workflow:
- HEAD /operations/id
Permet d'intervenir sur le comportement de l'exécution et de la distribution (next,resume,pause)
- PUT /operations/id
Permet à un worker d'informer de la fin d'exécution d'une étape
- DELETE /operations/id

Permet de soumettre des operations à l'exécution:
- POST /operations
Mettre à jour le statut des operations en cours d'un workflow:
- PUT /operations

Worker_family

Le principe proposé serait le suivant:

Permet de définir les Workers dans des familles
- POST /worker_family
Permet l'abonnement et la suppression d'un worker
- POST /worker_family/id_family/workers

Questions ou remarques:

Le /status pourrait être étendu pour remonter un état statistique du moteur

Operations

Administration des Workflows Asynchrones (opérations).

/operations post put

post

Permet de soumettre une opération (workflow + contexte + lot)

put

Permet d'interagir avec la liste des opérations (pause, reprise, repriorisation par exemple)

Permet de soumettre une opération (workflow + contexte + lot)

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Action: required (string)
X-Context-Id: (string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
 "id": "DefaultIngestWorkflow",
 "comment":"Default Ingest Workflow V3",
 "steps":
 [
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check manifest existence",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "checkSeda", "actionType": "NOBLOCK"}}]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Version",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckVersion", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Objects Number",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckObjectsNumber", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Extract Unit and ObjectGroup",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
			"actions":[{"action":{"actionKey": "ExtractSeda", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Storage Availability",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckStorageAvailability", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Index Unit",
		 "stepType":"BLOCK",
			 "distribution" : {
				 "kind":"LIST",
				 "element" : "Units"
				 },
		 "actions":[{"action":{"actionKey": "IndexUnit", "actionType": "NOBLOCK"} }]

 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Store ObjectGroup",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"LIST",
				 "element" : "ObjectGroup"
				 },
		 "actions":[{"action":{"actionKey": "StoreObjectGroup", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Index ObjectGroup",
		 "stepType":"BLOCK",
			 "distribution" : {
				 "kind":"LIST",
				 "element" : "ObjectGroup"
				 },
			"actions":[{"action":{"actionKey": "IndexObjectGroup", "actionType": "NOBLOCK"} }]

 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Digest Message",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
			"actions":[{"action":{"actionKey": "CheckConformity", "actionType": "NOBLOCK"} }]
 }
 ]
}

HTTP status code 201

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Permet d'interagir avec la liste des opérations (pause, reprise, repriorisation par exemple)

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Action: required (string)
X-Context-Id: (string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "X-RequestId": "id",
  "code": 201,
  "vitamCode": 123456,
  "timestamp": "2015-07-14T17:07:14Z",
  "message": "message informatif retour"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

/operations/{id} get post put delete head

get

Permet de récupérer le statut du workflow en cours

post

Permet de soumettre un workflow à l'exécution

put

Permet d'interagir avec une opération (pause, reprise, repriorisation par exemple)

delete

pour annuler le workflow.

head

Obtenir le statut d'un workflow

Permet de récupérer le statut du workflow en cours

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
 "id": "DefaultIngestWorkflow",
 "comment":"Default Ingest Workflow V3",
 "steps":
 [
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check manifest existence",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "checkSeda", "actionType": "NOBLOCK"}}]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Version",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckVersion", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Objects Number",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckObjectsNumber", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Extract Unit and ObjectGroup",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
			"actions":[{"action":{"actionKey": "ExtractSeda", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Storage Availability",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckStorageAvailability", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Index Unit",
		 "stepType":"BLOCK",
			 "distribution" : {
				 "kind":"LIST",
				 "element" : "Units"
				 },
		 "actions":[{"action":{"actionKey": "IndexUnit", "actionType": "NOBLOCK"} }]

 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Store ObjectGroup",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"LIST",
				 "element" : "ObjectGroup"
				 },
		 "actions":[{"action":{"actionKey": "StoreObjectGroup", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Index ObjectGroup",
		 "stepType":"BLOCK",
			 "distribution" : {
				 "kind":"LIST",
				 "element" : "ObjectGroup"
				 },
			"actions":[{"action":{"actionKey": "IndexObjectGroup", "actionType": "NOBLOCK"} }]

 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Digest Message",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
			"actions":[{"action":{"actionKey": "CheckConformity", "actionType": "NOBLOCK"} }]
 }
 ]
}

HTTP status code 202

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Permet de soumettre un workflow à l'exécution

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id: required (string)

Headers

X-Action: required (string)
X-Context-Id: (string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "X-RequestId": "id",
  "code": 201,
  "vitamCode": 123456,
  "timestamp": "2015-07-14T17:07:14Z",
  "message": "message informatif retour"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
 "id": "DefaultIngestWorkflow",
 "comment":"Default Ingest Workflow V3",
 "steps":
 [
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check manifest existence",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "checkSeda", "actionType": "NOBLOCK"}}]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Version",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckVersion", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Objects Number",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckObjectsNumber", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Extract Unit and ObjectGroup",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
			"actions":[{"action":{"actionKey": "ExtractSeda", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Storage Availability",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
		 "actions":[{"action":{"actionKey": "CheckStorageAvailability", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Index Unit",
		 "stepType":"BLOCK",
			 "distribution" : {
				 "kind":"LIST",
				 "element" : "Units"
				 },
		 "actions":[{"action":{"actionKey": "IndexUnit", "actionType": "NOBLOCK"} }]

 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Store ObjectGroup",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"LIST",
				 "element" : "ObjectGroup"
				 },
		 "actions":[{"action":{"actionKey": "StoreObjectGroup", "actionType": "NOBLOCK"} }]
 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Index ObjectGroup",
		 "stepType":"BLOCK",
			 "distribution" : {
				 "kind":"LIST",
				 "element" : "ObjectGroup"
				 },
			"actions":[{"action":{"actionKey": "IndexObjectGroup", "actionType": "NOBLOCK"} }]

 },
 {
 "workerGroupId" :"DefaultWorker",
		 "stepName":"Check Digest Message",
		 "stepType":"BLOCK",
		 "distribution" : {
				 "kind":"REF",
				 "element" : "SIP/manifest.xml"
				 },
			"actions":[{"action":{"actionKey": "CheckConformity", "actionType": "NOBLOCK"} }]
 }
 ]
}

HTTP status code 202

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Permet d'interagir avec une opération (pause, reprise, repriorisation par exemple)

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id: required (string)

Headers

X-Action: required (string)
X-Context-Id: (string)
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "X-RequestId": "id",
  "code": 201,
  "vitamCode": 123456,
  "timestamp": "2015-07-14T17:07:14Z",
  "message": "message informatif retour"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

pour annuler le workflow.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 204

Succesfully deleted resource

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Obtenir le statut d'un workflow

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 200

operation trouve et status retourne avec succes

HTTP status code 204

operation non trouve

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Worker's family

Administration des familles de Workers.

/worker_family get put

get

Permet de lister les familles

put

Permet d'interagir avec les workers de la famille

Permet de lister les familles

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "query": "name='abcdef*'&since>'2015-07-14'"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
  "hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false,
    "next": "async_id_next"
  },
  "context": {
    "query": "family list"
  },
  "results": [
    {"familly ": "familyId",
    "workers": [
      {"worker" : "workerId",
      "capacity" : "capacity"},
      {"worker" : "workerId",
      "capacity" : "capacity"},
      {}
    ]},
    {"familly ": "familyId",
    "workers": [
      {"worker" : "workerId",
      "capacity" : "capacity"},
      {"worker" : "workerId",
      "capacity" : "capacity"}
    ]}
    ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Permet d'interagir avec les workers de la famille

Secured by VitamPlatform

Based on Platform Secret

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "X-RequestId": "id",
  "code": 201,
  "vitamCode": 123456,
  "timestamp": "2015-07-14T17:07:14Z",
  "message": "message informatif retour"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

/worker_family/{id_family} get post put delete

get

Permet de récupérer le statut de la famille

post

Permet de créer une famille de Worker

put

Permet d'interagir avec la famille

delete

Efface une famille si vide

Permet de récupérer le statut de la famille

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
  "familly ": "familyId",
    "workers": [
      {"worker" : "workerId",
      "capacity" : "capacity"},
      {"worker" : "workerId",
      "capacity" : "capacity"}
    ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Permet de créer une famille de Worker

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "pool" : "poolname",
  "description" : "description of pool",
  "actions" : ["digest", "transform", "formatid"],
  "status" : "Active"
}

HTTP status code 201

Body

Media type: application/json

Type: object

Examples:

{
    "id": "id",
    "type": "class, worker",
    "start_date": "2014-01-10T03:06:17.396Z",
    "last_status": {
      "code": 404,
      "vitamCode": 123456,
      "context": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Permet d'interagir avec la famille

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "X-RequestId": "id",
  "code": 201,
  "vitamCode": 123456,
  "timestamp": "2015-07-14T17:07:14Z",
  "message": "message informatif retour"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Efface une famille si vide

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

/worker_family/{id_family}/workers get delete

API de gestion des Workers d'une famille.

get

Permet de sélectionner un sous-ensemble de Workers.

delete

Efface un sous-ensemble de Workers. Le Delete de tout ou partie des workers d'une famille entraîne l'appel à "unregister" depuis le moteur vers le(s) worker(s) concerné(s), comme pour l'appel direct à un Worker

Permet de sélectionner un sous-ensemble de Workers.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "query": "name='abcdef*'&since>'2015-07-14'"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
  "hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false,
    "next": "async_id_next"
  },
  "context": {
    "query": "workers list"
  },
  "results": [
    {"worker" : "workerId",
    "capacity" : "capacity"},
    {"worker" : "workerId",
    "capacity" : "capacity"},
    {}
    ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
  "query": "name='abcdef*'&since>'2015-07-14'"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
  "hits": {
    "total": 10,
    "size": 3,
    "offset": 0,
    "limit": 100,
    "time_out": false,
    "next": "async_id_next"
  },
  "context": {
    "query": "workers list"
  },
  "results": [
    {"worker" : "workerId",
    "capacity" : "capacity"},
    {"worker" : "workerId",
    "capacity" : "capacity"},
    {}
    ]
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

/worker_family/{id_family}/workers/{id_worker} get post put delete

API permettant la gestion d'un Worker.

get

Accès à un statut d'un Worker.

post

Ajoute un nouveau Worker (abonnement) dans une famille.

put

Mise à jour d'un paramètre pour ce Worker

delete

Permet le retrait d'un Worker à cete famille (désabonnement).

Accès à un statut d'un Worker.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)
id_worker: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
  "name" : "workername",
  "family" : "familyname",
  "capacity" : 10,
  "storage" : 100,
  "status" : "Active"
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Ajoute un nouveau Worker (abonnement) dans une famille.

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)
id_worker: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
  "name" : "workername",
  "family" : "familyname",
  "capacity" : 10,
  "storage" : 100,
  "status" : "Active"
}

HTTP status code 201

Body

Media type: application/json

Type: object

Examples:

{
    "id": "id",
    "type": "class, worker",
    "start_date": "2014-01-10T03:06:17.396Z",
    "last_status": {
      "code": 404,
      "vitamCode": 123456,
      "context": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Mise à jour d'un paramètre pour ce Worker

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)
id_worker: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Examples:

{
"todo" : "à compléter...!",
  "name" : "workername",
  "family" : "familyname",
  "capacity" : 10,
  "storage" : 100,
  "status" : "Active"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
    "id": "$id_async$",
    "type": "ingest",
    "state": "done",
    "task_status": "commit",
    "start_date": "2014-01-10T03:06:17.396Z",
    "end_date": "2014-01-20T03:06:17.396Z",
    "expiration_date": "2014-02-20T03:06:17.396Z",
    "result_link": "https://xxx/v1/ingests/456",
    "error": {
      "http_code": 404,
      "code": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

Permet le retrait d'un Worker à cete famille (désabonnement).

Secured by VitamPlatform

Based on Platform Secret

URI Parameters

id_family: required (string)
id_worker: required (string)

Headers

X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 200

Body

Media type: application/json

Type: object

Examples:

{
    "id": "id",
    "type": "class, worker",
    "start_date": "2014-01-10T03:06:17.396Z",
    "last_status": {
      "code": 404,
      "vitamCode": 123456,
      "context": "ingest",
      "state": "File_Not_Found",
      "message": "File is not found",
      "description": "Operation on file xxx cannot be done since file is not found",
      "errors": [
        { "http_code": 415, "code": "ingest", "state": "Unsupported_Media_Type", "message": "Unsupported media type detected", "description": "File xxx has an unsupported media type yyy" },
        { "http_code": 412, "code": "ingest", "state": "Precondition_Failed", "message": "Precondition in error", "description": "Operation on file xxx cannot continue since precondition is in error" }
      ]
    }
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 409

Conflict, operation requested is in conflict with existing data

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

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
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Secured by VitamPlatform

Headers

X-Vitam-Key: required (string)
Vitam Platform Key

/status

/status get

get

Secured by VitamPlatform

Based on Platform Secret

Response
Security

HTTP status code 200

OK, operation in success

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

Body

Media type: application/json

Type: object

Properties

id: required (string)
Id of the instance
service: required (string)
Service Name for this instance
startDate: required (datetime)
Date time for the start of this instance
status: required (one of Active, Inactive, ShutdownInProgress, Unreachable)
Status of this instance

Examples:

{
  "id": "abcdef",
  "service": "serviceName",
  "startDate": "2015-07-14T17:07:14Z",
  "status": "Active"
}

{
  "id": "abcdef",
  "service": "serviceName",
  "startDate": "2015-07-14T17:07:14Z",
  "status": "Active"
}

HTTP status code 401

Unauthorized, authentication in error

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

HTTP status code 404

Not Found, requested resource does not exist

Headers

X-Request-Id: required (string)
Unique Request Identifier
Examples:
```
AbDUh67jj
```
FullApiVersion: required (string)
Complete Version of the API.
Examples:
```
V1.25
```
X-Application-Id: (string)
Session Identifier from client Front-Office Application
Examples:
```
SESSION-ID-00001
```
X-Tenant-Id: (number)
Unique Tenant Identifier
Examples:
```
0
```

API-Vitam Version Alpha - Moteur d'exécution interne API documentation version v1

Avertissements

Licence

Workflows

Worker_family

Operations

/operations post put

post /operations

Headers

Body

HTTP status code 201

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 /operations

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

/operations/{id} get post put delete head

get /operations/{id}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 202

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

post /operations/{id}

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 202

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 /operations/{id}

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 401