Provoly logo
API docs by Redocly

Execution engine API (0.25.0)

Download OpenAPI specification:

URL: ../provoly-back/main/index.html License: Apache 2.0

Version

Returns the deployed application and helm package version

Responses

Response samples

Content type
application/json
{
  • "applicationVersion": "dev",
  • "chartVersion": "dev"
}

Job Execution

retourne la liste des exécutions de travail

Service permettant de retourner la liste des JobExecution. Si il n'y a pas d'exécution de travail dans la liste, renvoie un tableau vide.

Authorizations:
SecurityScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

retourne une exécution de travail

Service permettant de retourner le JobExecution en fonction de l'id. Si l'exécution de travail n'existe pas, retourne 404.

Authorizations:
SecurityScheme
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "instance": {
    },
  • "status": "STARTED",
  • "executionDate": "2022-03-10T16:15:50Z"
}

Job Instance

Renvoie l'ensemble des JobInstance existant

Service permettant de récupérer une collection de JobInstanceDTO, si aucune instance existant le contenu retourné est vide.

Authorizations:
SecurityScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Créé ou met à jour une nouvelle instance d'un travail.

Service permettant d'enregistrer une nouvelle instance d'un travail (JobInstance) ou de la mettre à jour.

Authorizations:
SecurityScheme
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
model
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Array of objects (DataSourceProvidingDto) unique
Array of objects (DatasetOutcomeDto) unique
Array of objects (ParameterValueDto) unique

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "model": "a047ecae-0f27-4ff4-95bb-0f06d1225aa8",
  • "inDataSources": [
    ],
  • "outDatasets": [
    ],
  • "parametersValue": [
    ]
}

Activating a job instance by id

Activating a job instance by set activate attribute TRUE, if already activated return 409

Authorizations:
SecurityScheme
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Deactivating a job instance by his ID.

Deactivating a job instance by set activate attribute FALSE, if already deactivated return 409.

Authorizations:
SecurityScheme
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Renvoie le jobInstance correspondant à l'id fournie.

Le jobInstance possédant l'ID fournie est renvoyé à l'utilisateur, si aucun jobInstance ne correspond à l'ID une erreur 404 est levé

Authorizations:
SecurityScheme
path Parameters
jobInstanceUuid
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "model": {
    },
  • "inDataSources": [
    ],
  • "outDatasets": [
    ],
  • "parametersValue": [
    ],
  • "active": true
}

Supprime l'instance correspondant à l'ID envoyée

Suppression du jobInstance correspondant à l'ID dans l'URL, si n'existe pas une 404 est levé

Authorizations:
SecurityScheme
path Parameters
jobInstanceUuid
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Returns the last job ecution id details

Authorizations:
SecurityScheme
path Parameters
jobInstanceUuid
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "instance": {
    },
  • "status": "STARTED",
  • "executionDate": "2022-03-10T16:15:50Z"
}

Exécute une instance de travail (jobInstance) existante.

Exécute le jobInstance pointé par l'ID et renvoie une instance d'exécution à l'utilisateur.

Authorizations:
SecurityScheme
path Parameters
jobInstanceUuid
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "instance": {
    },
  • "status": "STARTED",
  • "executionDate": "2022-03-10T16:15:50Z"
}

Job Model

récupérer la liste des modèles de travaux existant

Service permettant de récuperer une collection de JobModelDTO

Authorizations:
SecurityScheme

Responses

Response samples

Content type
application/json
[
  • {
    }
]

créé ou met à jour un nouveau model de travail

Service permettant d'enregistrer un JobModelDto ou de le mettre à jour

Authorizations:
SecurityScheme
Request Body schema: application/json
id
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
image
string
Array of objects (ParameterDto) unique

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "image": "string",
  • "parameters": [
    ]
}

retoune un modèle de travaux

Service permettant de retourner le jobModelDto en fonction de l'id. Si le modèle de travail n'existe pas, retourne 404.

Authorizations:
SecurityScheme
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "image": "string",
  • "parameters": [
    ]
}

Supprime un modèle de travail

Service permettant de supprimer un JobModelDto en fonction de son id. Si le modèle de travail n'existe pas, retourne 404.

Authorizations:
SecurityScheme
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...

Responses