Jobs

Some of the tasks performed by the API, such as building models and importing files, may take some time to execute.

To manage these tasks, Mix provides jobs. A job is created for complex tasks and assigned a unique job ID in a project. For example, when you start a build, the endpoint returns a job ID. You can then use the Get job details endpoint with this job ID to poll the status of the job and get a detailed report.

When you delete a job, it is deleted from the database, but the job keeps running until it completes or fails.

Get job details

GET /v4/projects/{projectId}/jobs/{jobId}

Retrieve the details of a job in a project.

Responses

Status Meaning Description Schema
200 OK Job details mix.api.JobResponse
401 Unauthorized Request could not be authorized Inline
404 Not Found Job not found Inline
500 Internal Server Error Internal server error Inline
default Default An unexpected error response. grpc.gateway.runtime.Error

Example responses

  200 response  

Delete a job

DELETE /v4/projects/{projectId}/jobs/{jobId}

Delete the specified job.

Responses

Status Meaning Description Schema
200 OK Job successfully deleted google.rpc.Status
401 Unauthorized Request could not be authorized Inline
404 Not Found Job not found Inline
500 Internal Server Error Internal server error Inline
default Default An unexpected error response. grpc.gateway.runtime.Error

Example responses

  200 response  

Get jobs

GET /v4/projects/{projectId}/jobs

Retrieve the list of jobs available in a project.

Responses

Status Meaning Description Schema
200 OK List of jobs mix.api.ListProjectJobsResponse
401 Unauthorized Request could not be authorized Inline
404 Not Found Project not found Inline
500 Internal Server Error Internal server error Inline
default Default An unexpected error response. grpc.gateway.runtime.Error

Example responses

  200 response