jobs endpoint is accessible at The following actions are supported on jobs endpoint:

REST API Test Framework

Please visit our REST API Test Framework to test the queries in this page and see the results. Resuls are not shwown here for simiplicity.


GET HTTP method is used to retrieve a list of jobs.

  • List all jobs:
curl -X GET -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"

Number of Returned Results

The number of returned results is limited to 20 by default (Results Pagination).

  • Get job by ID:
curl -X GET -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"
  • Get job by property:
curl -X GET -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"

Query Parameter

The query parameter before encoding is query={"status": "finished"}.


POST HTTP method is used to create a new job. Job parameters are passed in JSON format inside body.

curl -X POST -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ" -d '
  "_material": {
    "_id": "gyfPHZk56QAxRpAqv"
  "compute": {
    "nodes": 1,
    "notify": "n",
    "ppn": 1,
    "queue": "D",
    "timeLimit": "01:00:00"
  "model": {
    "method": {
      "data": {
        "pseudo": [
            "_id": "58947f5efe450067c9c92e24"
      "precision": {
        "kpoints": {
          "shift": {
            "x": 0,
            "y": 0,
            "z": 0
          "value": {
            "x": 2,
            "y": 2,
            "z": 2
      "workflow": {
        "_id": "7GSofzPcxZryR8YiL"
  "title": "New Job Feb 15th 2017, 18:32 PM"


DELETE HTTP method is used to delete a job with a given ID.

curl -X DELETE
  "status": "success",
  "data": {
    "message": "Job HmeWjp69jHYkZYMkh successfully deleted"


PATCH HTTP method is used to update an existing job.

curl -X PATCH -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ" -d '{"title": "New Job Feb 15th 2017, 18:32 PM"}'

Job Submission

POST HTTP method with submit URL paramater are used to submit a job with a given ID.

curl -X POST -H "X-Auth-Token: f2KpRW7KeN9aPmjSZ" -H "X-User-Id: fbdpsNf4oHiX79vMJ"