Optimization Server Master RESTful API

Optimization Server Master RESTful API Copyright (c) 2018 DecisionBrain.
More information: https://openapi-generator.tech
Contact Info: optim-server@decisionbrain.com
Version: 3.3.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication
  2. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Bucket

Configuration

File

Flow

Job

JobExecution

ProjectInformation

Task

TaskExecution

Bucket

Up 
post /buckets
Creates a new Bucket, and returns its ID for later use. (createBucket)
This API creates a new Bucket. The returned ID will be used in further jobs requests, to specify job parameters.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

BucketCreation BucketCreation (required)
Body Parameter —

Return type

BucketDefinition

Example data

Content-Type: application/json
{
  "createdAt" : 0,
  "size" : 6,
  "zipped" : false,
  "description" : "description",
  "bucketId" : "bucketId"
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  123456789
  123
  true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Bucket Successfully created. return the bucket definition BucketDefinition
Up 
delete /buckets/{bucketId}
Deletes this bucket. (deleteBucket)
This API is to be called to delete a bucket. It cannot be undone.

Path parameters

bucketId (required)
Path Parameter — default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

bucket has been deleted. String
Up 
get /buckets/{bucketId}
Return a bucket object. (getBucket)
This API is to be called to get a bucket, including bucket definition and bucket data.

Path parameters

bucketId (required)
Path Parameter — default: null

Return type

Bucket

Example data

Content-Type: application/json
{
  "data" : "data",
  "definition" : {
    "createdAt" : 0,
    "size" : 6,
    "zipped" : false,
    "description" : "description",
    "bucketId" : "bucketId"
  }
}

Example data

Content-Type: application/xml

  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A single bucket. Bucket

404

The bucket does not exist.
Up 
get /buckets/{bucketId}/content
Returns the content of the requested bucket. (getBucketContent)
Returns the content of the requested bucket.

Path parameters

bucketId (required)
Path Parameter — default: null

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A blob with the content of the requested bucket, as it was sent during job creation. File

404

The bucket does not exist.
Up 
get /buckets/{bucketId}/definition
Return a bucket definition object. (getBucketDefinition)
This API is to be called to get a bucket definition (without bucket data).

Path parameters

bucketId (required)
Path Parameter — default: null

Return type

BucketDefinition

Example data

Content-Type: application/json
{
  "createdAt" : 0,
  "size" : 6,
  "zipped" : false,
  "description" : "description",
  "bucketId" : "bucketId"
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  123456789
  123
  true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A single bucket definition. BucketDefinition

404

The bucket does not exist.
Up 
get /buckets
Returns requested bucket definitions. (getBuckets)
This API allows you to retrieve bucket definitions (without the content) from the system.

Return type

array[BucketDefinition]

Example data

Content-Type: application/json
{
  "createdAt" : 0,
  "size" : 6,
  "zipped" : false,
  "description" : "description",
  "bucketId" : "bucketId"
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  123456789
  123
  true

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

returns all the bucket definitions
Up 
get /buckets/content
Returns an archive containing the compressed content of requested buckets. (getBucketsContent)
Returns an archive containing the compressed content of requested buckets.

Query parameters

bucketIds (required)
Query Parameter — default: null

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An archive, with compressed data for given buckets. File

Configuration

Up 
put /configuration/on-demand/tasks/refresh
Refresh on demand tasks (refreshOnDemandTasks)
Refresh the tasks of all on demand workers already registered

Responses

200

the tasks are refreshing

File

Up 
post /files
Creates a temporary file on server side for later use. (saveTemporaryFile)
Save a file on the server and returns it's id, you can use it later but the file is deleted after a short period if not used.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body File (required)
Body Parameter —

Query parameters

name (optional)
Query Parameter — Optional parameter to give a name of the file (essentially to give a hint about the content of the file). default: null

Return type

FileDefinition

Example data

Content-Type: application/json
{
  "fileId" : "fileId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The file has been successfully created FileDefinition

Flow

Up 
post /jobFlows
Creates a new Flow, and returns its ID for later use. (createFlow)
This API creates a new Flow, optionally for an existing Job, and returns the new Flow. If a root Job is provided, and is already associated with a Flow, no flow is created, but the existing Flow is returned instead.

Query parameters

rootJobId (optional)
Query Parameter — Identifier of the existing Job that should be the root of the new Flow. If the root Job is already associated with a Flow, no flow is created, but the existing flow is returned instead. If the root Job does not have an associated flow yet, a new Flow is created and the given root Job is associated to this new Flow. default: null

Return type

JobFlow

Example data

Content-Type: application/json
{
  "jobIds" : [ "jobIds", "jobIds" ],
  "createdAt" : 0,
  "creator" : "creator",
  "jobRelations" : [ {
    "firstJobId" : "firstJobId",
    "secondJobId" : "secondJobId"
  }, {
    "firstJobId" : "firstJobId",
    "secondJobId" : "secondJobId"
  } ],
  "id" : "id"
}

Example data

Content-Type: application/xml

  aeiou
  123456789
  aeiou
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The given root Job has already an associated Flow, that is returned. JobFlow

201

Flow successfully created; the new Flow is returned. JobFlow
Up 
get /jobFlows/{flowId}/jobs
Returns job definitions for the given flow ID. (getJobDefinitionsByFlow)
This API allows you to retrieve job definitions by flow ID.

Path parameters

flowId (required)
Path Parameter — default: null

Return type

array[JobDefinition]

Example data

Content-Type: application/json
{
  "outputs" : {
    "key" : "outputs"
  },
  "onDemandExecutionContext" : "onDemandExecutionContext",
  "createdAt" : 0,
  "onDemand" : true,
  "creator" : "creator",
  "inputs" : {
    "key" : "inputs"
  },
  "description" : "description",
  "id" : "id",
  "statusEvents" : [ null, null ],
  "flowId" : "flowId",
  "taskId" : "taskId"
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  123456789
  aeiou
  aeiou
  UNDEFINED_EXAMPLE_VALUE
  UNDEFINED_EXAMPLE_VALUE
  aeiou
  true
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

returns job definitions for the given flow ID
Up 
get /jobFlows/{flowId}
Returns a Flow with the given ID, if any. (getJobFlow)
This API allows you to retrieve a flow.

Path parameters

flowId (required)
Path Parameter — default: null

Return type

JobFlow

Example data

Content-Type: application/json
{
  "jobIds" : [ "jobIds", "jobIds" ],
  "createdAt" : 0,
  "creator" : "creator",
  "jobRelations" : [ {
    "firstJobId" : "firstJobId",
    "secondJobId" : "secondJobId"
  }, {
    "firstJobId" : "firstJobId",
    "secondJobId" : "secondJobId"
  } ],
  "id" : "id"
}

Example data

Content-Type: application/xml

  aeiou
  123456789
  aeiou
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

returns the flow. JobFlow

404

The specified Job does not exist.
Up 
get /jobFlows
Returns all known flows. (getJobFlows)
This API allows you to retrieve all flows from the system.

Return type

array[JobFlow]

Example data

Content-Type: application/json
{
  "jobIds" : [ "jobIds", "jobIds" ],
  "createdAt" : 0,
  "creator" : "creator",
  "jobRelations" : [ {
    "firstJobId" : "firstJobId",
    "secondJobId" : "secondJobId"
  }, {
    "firstJobId" : "firstJobId",
    "secondJobId" : "secondJobId"
  } ],
  "id" : "id"
}

Example data

Content-Type: application/xml

  aeiou
  123456789
  aeiou
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

returns all known flows

Job

Up 
post /jobs
Creates a new asyncron Job (without starting it), and returns its ID for later use. (createJob)
This API creates a new asyncron Job. The returned ID must be used for further requests like register events/submit/stop/delete the job.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

JobCreation JobCreation (required)
Body Parameter —

Return type

JobDefinition

Example data

Content-Type: application/json
{
  "outputs" : {
    "key" : "outputs"
  },
  "onDemandExecutionContext" : "onDemandExecutionContext",
  "createdAt" : 0,
  "onDemand" : true,
  "creator" : "creator",
  "inputs" : {
    "key" : "inputs"
  },
  "description" : "description",
  "id" : "id",
  "statusEvents" : [ null, null ],
  "flowId" : "flowId",
  "taskId" : "taskId"
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  123456789
  aeiou
  aeiou
  UNDEFINED_EXAMPLE_VALUE
  UNDEFINED_EXAMPLE_VALUE
  aeiou
  true
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Job Successfully created. returns the job definition. JobDefinition
Up 
delete /jobs/{jobId}
Deletes this job and cleans all related data. (deleteJob)
This API is to be called when your application is finished with this job. This will delete all related data like process, input data, response, etc.

Path parameters

jobId (required)
Path Parameter — default: null

Return type

String

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Job Successfully deleted. String

404

The specified Job does not exist.

409

The job is running. It cannot be deleted.
Up 
get /jobs/{jobId}
Returns a job definition. (getJobDefinition)
This API allows you to retrieve a job definition.

Path parameters

jobId (required)
Path Parameter — default: null

Return type

JobDefinition

Example data

Content-Type: application/json
{
  "outputs" : {
    "key" : "outputs"
  },
  "onDemandExecutionContext" : "onDemandExecutionContext",
  "createdAt" : 0,
  "onDemand" : true,
  "creator" : "creator",
  "inputs" : {
    "key" : "inputs"
  },
  "description" : "description",
  "id" : "id",
  "statusEvents" : [ null, null ],
  "flowId" : "flowId",
  "taskId" : "taskId"
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  123456789
  aeiou
  aeiou
  UNDEFINED_EXAMPLE_VALUE
  UNDEFINED_EXAMPLE_VALUE
  aeiou
  true
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

returns the job definition. JobDefinition

404

The specified Job does not exist.
Up 
get /jobs
Returns all current job definitions. (getJobs)
This API allows you to retrieve all current jobs from the system.

Return type

array[JobDefinition]

Example data

Content-Type: application/json
{
  "outputs" : {
    "key" : "outputs"
  },
  "onDemandExecutionContext" : "onDemandExecutionContext",
  "createdAt" : 0,
  "onDemand" : true,
  "creator" : "creator",
  "inputs" : {
    "key" : "inputs"
  },
  "description" : "description",
  "id" : "id",
  "statusEvents" : [ null, null ],
  "flowId" : "flowId",
  "taskId" : "taskId"
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  123456789
  aeiou
  aeiou
  UNDEFINED_EXAMPLE_VALUE
  UNDEFINED_EXAMPLE_VALUE
  aeiou
  true
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

returns all known job definitions

JobExecution

Up 
get /jobs/{jobId}/execution
Gets the job execution status. (getJobExecutionStatus)
This API retrieves the current Job execution status.

Path parameters

jobId (required)
Path Parameter — default: null

Return type

JobExecutionStatus

Example data

Content-Type: application/json
{
  "jobId" : "jobId",
  "events" : [ {
    "date" : 0,
    "jobId" : "jobId",
    "objectType" : "objectType"
  }, {
    "date" : 0,
    "jobId" : "jobId",
    "objectType" : "objectType"
  } ]
}

Example data

Content-Type: application/xml

  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

The specified Job does not exist.

200

The current Job execution status JobExecutionStatus
Up 
post /jobs/{jobId}/execution
Schedule an already created job for an asyncronous execution. (startAsyncJobExecution)
This API will ask the optim Server to schedule an asyncron job for being executed on a worker. The execution status of the job is expected to become "SCHEDULED".

Path parameters

jobId (required)
Path Parameter — default: null

Query parameters

timeout (optional)
Query Parameter — Execution timeout after which the job will be abandoned, if it has not been started yet (in ms). default: null format: int64

Return type

JobDefinition

Example data

Content-Type: application/json
{
  "outputs" : {
    "key" : "outputs"
  },
  "onDemandExecutionContext" : "onDemandExecutionContext",
  "createdAt" : 0,
  "onDemand" : true,
  "creator" : "creator",
  "inputs" : {
    "key" : "inputs"
  },
  "description" : "description",
  "id" : "id",
  "statusEvents" : [ null, null ],
  "flowId" : "flowId",
  "taskId" : "taskId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

The specified Job does not exist. String

201

The job with the given ID has already been executed. Thus another job (similar to the given one, with the same componentId) has been created and started. The new job ID is sent back. JobDefinition

202

The job asyncronous execution has been requested, the job definition is sent back. JobDefinition
Up 
post /jobs/execution
Schedule a syncron job execution. (startSyncJobExecution)
This API will ask the Optimization Server to schedule a syncronous job for being executed on a worker. The solution will be returned in the response. Set the timeout query parameter to provide a time limit on job execution. Please note that the synchronous job feature should not be used in High Availability mode with multiple masters.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

JobCreation JobCreation (optional)
Body Parameter —

Query parameters

timeout (optional)
Query Parameter — Execution timeout after which the job will be abandoned, even if it was started (in ms). default: null format: int64

Return type

JobSolution

Example data

Content-Type: application/json
{
  "outputs" : [ {
    "data" : "data",
    "zipped" : false,
    "name" : "name",
    "bucketId" : "bucketId",
    "required" : false
  }, {
    "data" : "data",
    "zipped" : false,
    "name" : "name",
    "bucketId" : "bucketId",
    "required" : false
  } ],
  "jobId" : "jobId",
  "taskId" : "taskId"
}

Example data

Content-Type: application/xml

  aeiou
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

408

The current Job didn't return a result before time limit

200

returns the Job solution JobSolution
Up 
delete /jobs/{jobId}/execution
Request this job to stop its execution. (stopJobExecution)
This API allows you to stop the execution of a running job. Notice that stopping a job is an asynchronous operation so the job might not stop immediately after the server responds to this request.

Path parameters

jobId (required)
Path Parameter — default: null

Query parameters

abortPolicy (optional)
Query Parameter — default: null

Return type

JobExecutionStatus

Example data

Content-Type: application/json
{
  "jobId" : "jobId",
  "events" : [ {
    "date" : 0,
    "jobId" : "jobId",
    "objectType" : "objectType"
  }, {
    "date" : 0,
    "jobId" : "jobId",
    "objectType" : "objectType"
  } ]
}

Example data

Content-Type: application/xml

  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

The specified Job does not exist.

202

The request of stopping this job has been accepted and will be processed later. returns the current job status. JobExecutionStatus

ProjectInformation

Up 
get /project
Gets the project information. (getProject)
Gets the project information.

Return type

ProjectInformation

Example data

Content-Type: application/json
{
  "build" : {
    "date" : "2000-01-23T04:56:07.000+00:00"
  },
  "version" : "version"
}

Example data

Content-Type: application/xml

  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

The project does not exist.

200

The current project version. ProjectInformation

Task

Up 
get /tasks/{taskId}
Get a specific task details. (getTask)
This API retrieves the details for a specific task. If the task is known, but disabled (the worker is down), details can still be retrieved. This is, on purpose, not the same behaviour as the API to retrieve the list of tasks. This allows to get information about completed jobs derived from disabled tasks.

Path parameters

taskId (required)
Path Parameter — default: null

Return type

Task

Example data

Content-Type: application/json
{
  "outputs" : [ {
    "name" : "name",
    "description" : "description",
    "required" : true
  }, {
    "name" : "name",
    "description" : "description",
    "required" : true
  } ],
  "createdAt" : 6,
  "onDemand" : true,
  "onDemandExecutionContexts" : [ "onDemandExecutionContexts", "onDemandExecutionContexts" ],
  "inputs" : [ {
    "name" : "name",
    "description" : "description",
    "required" : true
  }, {
    "name" : "name",
    "description" : "description",
    "required" : true
  } ],
  "defaultOnDemandExecutionContext" : "defaultOnDemandExecutionContext",
  "description" : "description",
  "nbWorkers" : 0,
  "id" : "id",
  "latestHeartbeat" : 1,
  "properties" : {
    "key" : "{}"
  }
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  UNDEFINED_EXAMPLE_VALUE
  123
  123456789
  123456789
  true
  aeiou
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A single task. Task

404

The task does not exist.
Up 
get /tasks
Get all known tasks. (getTasks)
This API allows you to retrieve all currently known tasks in the system. The list of tasks is an aggregate of all the taskIds supported by the connected workers.

Return type

array[Task]

Example data

Content-Type: application/json
{
  "outputs" : [ {
    "name" : "name",
    "description" : "description",
    "required" : true
  }, {
    "name" : "name",
    "description" : "description",
    "required" : true
  } ],
  "createdAt" : 6,
  "onDemand" : true,
  "onDemandExecutionContexts" : [ "onDemandExecutionContexts", "onDemandExecutionContexts" ],
  "inputs" : [ {
    "name" : "name",
    "description" : "description",
    "required" : true
  }, {
    "name" : "name",
    "description" : "description",
    "required" : true
  } ],
  "defaultOnDemandExecutionContext" : "defaultOnDemandExecutionContext",
  "description" : "description",
  "nbWorkers" : 0,
  "id" : "id",
  "latestHeartbeat" : 1,
  "properties" : {
    "key" : "{}"
  }
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  UNDEFINED_EXAMPLE_VALUE
  123
  123456789
  123456789
  true
  aeiou
  aeiou

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

All known tasks.

TaskExecution

Up 
get /tasks/{taskId}/execution
Gets all the jobs execution status for this task. (getTaskExecution)
This API retrieves the current Jobs execution status for this task.

Path parameters

taskId (required)
Path Parameter — default: null

Return type

TaskExecutionStatus

Example data

Content-Type: application/json
{
  "description" : "description",
  "statuses" : [ {
    "number" : 6
  }, {
    "number" : 6
  } ],
  "id" : "id",
  "workers" : 0
}

Example data

Content-Type: application/xml

  aeiou
  aeiou
  123

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

404

The specified Task does not exist.

200

The current Jobs execution status for this task TaskExecutionStatus

Models

[ Jump to Methods ]

Table of Contents

  1. AbortPolicy -
  2. Bucket -
  3. BucketCreation -
  4. BucketDefinition -
  5. FileDefinition -
  6. FlowArc -
  7. JobCreation -
  8. JobDefinition -
  9. JobEvent -
  10. JobExecutionStatus -
  11. JobExecutionStatusEnum -
  12. JobFlow -
  13. JobParameter -
  14. JobRelation -
  15. JobRelationType -
  16. JobSolution -
  17. JobStatusEvent -
  18. JobStatusEvent_allOf -
  19. KpiEvent -
  20. KpiEvent_allOf -
  21. LanguageEnum -
  22. LogEvent -
  23. LogEvent_allOf -
  24. MessageEvent -
  25. MessageEvent_allOf -
  26. ParameterType -
  27. ProgressEvent -
  28. ProgressEvent_allOf -
  29. ProjectInformation -
  30. ProjectInformation_build -
  31. Task -
  32. TaskExecutionStatus -
  33. TaskExecutionStatusCount -
  34. TaskParameter -

AbortPolicy - Up

An indicator on how the job should terminate

Bucket - Up

A data bucket.
definition
BucketDefinition
data
byte[] data, passed as a sequence of bytes. format: byte

BucketCreation - Up

bucket metadata.
type (optional)
ParameterType
description
String Description of the bucket. Can be used as a hint to deserialize the data
data (optional)
byte[] Input data, passed as a sequence of bytes. format: byte
fileId (optional)
String Input data, using an already uploaded file.

BucketDefinition - Up

bucket metadata.
bucketId
String The ID of the bucket. Read-only
type (optional)
ParameterType
description
String Description of the bucket. Can be used as a hint to deserialize the data
createdAt
Long The creation date time of this job. Read-only format: int64
size
Integer Data size. Read-only format: int32
zipped (optional)
Boolean Is the data zipped ?

FileDefinition - Up

Description of a file.
fileId (optional)
String The ID of the file

FlowArc - Up

An arc in a JobFlow is an ordered pair of job IDs, with a type of relation between them.
firstJobId
String The ID of the first job.
secondJobId
String The ID of the second job.
arcType
JobRelationType

JobCreation - Up

A description of a job creation order.
taskId
String The ID of the task to create a job for.
flowId (optional)
String A flow is a graph of jobs, connected or not. This field gives the identifier of the flow this job should take part into. It is optional.
description (optional)
String a free text description of the created job.
flowParents
array[JobRelation]
inputs
array[JobParameter] Input parameters of the job.
onDemand (optional)
Boolean Whether or not the job should be executed with on demand worker (optional)
onDemandExecutionContextName (optional)
String If the task is "on demand", this is the name of the on demand execution context to use for the task.

JobDefinition - Up

Description of a job, including its status.
id
String The ID of the Job; read only.
taskId
String The ID of the underlying task.
createdAt
Long The creation date time of this job. format: int64
flowId (optional)
String A flow is a graph of jobs, connected or not. This field gives the identifier of the flow this job takes part into. It is optional.
description (optional)
String a free text description of the created job.
inputs
map[String, String] Input data, passed as references to a bucketId.
outputs (optional)
map[String, String] Output data, passed as references to a bucketId.
statusEvents (optional)
array[JobStatusEvent]
status (optional)
JobExecutionStatusEnum
creator (optional)
String The job creator.
onDemand (optional)
Boolean Whether or not the job is/was executed using an on demand worker.
onDemandExecutionContext (optional)
String The on demand execution context of the worker of this job.

JobEvent - Up

A job event.
date
Long date of this event format: int64
jobId (optional)
String identifier of the job this event is refering to
objectType
String type of the concrete class of the job event

JobExecutionStatus - Up

Status of a job execution.
jobId
String The ID of the job
value
JobExecutionStatusEnum
events (optional)
array[JobEvent] History of this job events

JobExecutionStatusEnum - Up

JobFlow - Up

A flow is a directed graph with no cycles.
id
String The ID of the Flow; read only.
createdAt
Long The creation date time of this flow. format: int64
creator
String The flow creator.
jobIds
array[String]
jobRelations
array[FlowArc]

JobParameter - Up

A description of a job parameter.
name
String The parameter name for the job.
type (optional)
ParameterType
required (optional)
Boolean Is this parameter required ?
bucketId (optional)
String The bucket ID. if bucketId is used then data MUST not be set.
data (optional)
byte[] Input data, passed as a sequence of bytes. if data is used then bucketId MUST not be set. format: byte
zipped (optional)
Boolean Is the input data zipped ?

JobRelation - Up

A relation in the flow regarding the given job ID and a relation type.
relatedJobId
String The ID of the related job in the flow.
relationType (optional)
JobRelationType

JobRelationType - Up

The possible types of arcs. The type defines the relation between the jobs of the arc.

JobSolution - Up

A job solution.
jobId (optional)
String The ID of the Job. Read only
taskId
String The ID of the task to create a job for.
status (optional)
JobExecutionStatusEnum
outputs (optional)
array[JobParameter] Solution, passed as a sequence of bytes.

JobStatusEvent - Up

date
Long date of this event format: int64
jobId (optional)
String identifier of the job this event is refering to
objectType
String type of the concrete class of the job event
message (optional)
String
status
JobExecutionStatusEnum

JobStatusEvent_allOf - Up

message (optional)
String
status
JobExecutionStatusEnum

KpiEvent - Up

date
Long date of this event format: int64
jobId (optional)
String identifier of the job this event is refering to
objectType
String type of the concrete class of the job event
key
String
value
oas_any_type_not_mapped
coefficient (optional)
BigDecimal

KpiEvent_allOf - Up

key
String
value
oas_any_type_not_mapped
coefficient (optional)
BigDecimal

LanguageEnum - Up

The language in which the task has been written

LogEvent - Up

date
Long date of this event format: int64
jobId (optional)
String identifier of the job this event is refering to
objectType
String type of the concrete class of the job event
message
String
level
String

LogEvent_allOf - Up

message
String
level
String

MessageEvent - Up

date
Long date of this event format: int64
jobId (optional)
String identifier of the job this event is refering to
objectType
String type of the concrete class of the job event
message
String

MessageEvent_allOf - Up

message
String

ParameterType - Up

The task input or output type

ProgressEvent - Up

date
Long date of this event format: int64
jobId (optional)
String identifier of the job this event is refering to
objectType
String type of the concrete class of the job event
message (optional)
String
progressType
String
progressValue
BigDecimal

ProgressEvent_allOf - Up

message (optional)
String
progressType
String
progressValue
BigDecimal

ProjectInformation - Up

Project global information (version, build date...)
version (optional)
String The current project version
build (optional)
ProjectInformation_build

ProjectInformation_build - Up

The build information
date (optional)
Date the build date format: date-time

Task - Up

A description of a task.
id
String The Task ID.
description (optional)
String A human readable description of the task.
inputs (optional)
array[TaskParameter]
outputs (optional)
array[TaskParameter]
properties (optional)
map[String, Object] Additional properties of the task.
nbWorkers (optional)
Integer
createdAt (optional)
Long format: int64
latestHeartbeat (optional)
Long format: int64
onDemand (optional)
Boolean Whether or not the task is available on demand.
defaultOnDemandExecutionContext (optional)
String If the task is "on demand", this is the default on demand execution context that will ne used.
onDemandExecutionContexts (optional)
array[String] If the task is "on demand", this is the list of on demand execution contexts available for the task.

TaskExecutionStatus - Up

A description of a task and a summary of its jobs execution status.
id
String The Task ID.
description (optional)
String A human readable description of the task.
language (optional)
LanguageEnum
workers
Integer The numbers of workers that can handle this task format: int32
statuses
array[TaskExecutionStatusCount] A summary of jobs execution status for this task

TaskExecutionStatusCount - Up

The number of jobs per status
status
JobExecutionStatusEnum
number
Integer format: int32

TaskParameter - Up

A description of a task parameter.
name
String The parameter name.
type (optional)
ParameterType
description (optional)
String The parameter description.
required (optional)
Boolean Is this parameter required ?