Skip to content

API Jobs

Brunovski edited this page Jul 26, 2020 · 15 revisions

GET /projects/{project}/jobs

Description: ?

Request:

  • URI Params:
    • project (String) Project identifier
  • Query String:
    • page (Integer, Optional) Page to retrieve. Default value is 0
  • Example:
?

Success Response:

  • Status Code: 200 OK
  • Content: A list of objects with the information of the jobs
  • Content Type:
    • application/json
  • Schema:
?
  • Example:
?

Error Responses:

  • 400 Bad Request
  • 401 Unauthorized

Role: User

POST /projects/{project}/jobs

Description: Creates the specified job

Request:

  • URI Params:
    • project (String) Project identifier
  • Content: ?
  • Content Type:
    • application/json
  • Schema:
?
  • Example:
?

Success Response:

  • Status Code: 202 Accepted
  • Content: An object with the identifiers to track the job and the analysis to be created, either inference or visualization
  • Content Type:
    • application/json
  • Schema:
?
  • Example:
?

Error Responses:

  • 404 Not Found
  • 401 Unauthorized

Role: User

DELETE /projects/{project}/jobs/{job}

Description: Removes the specified job

Request:

  • URI Params:
    • project (String) Project identifier
    • job (String) Job identifier
  • Example:
?

Success Response:

  • Status Code: 204 No Content

Error Responses:

  • 401 Unauthorized

Role: User