SmartJobCenter

Introduction

REST API to manage jobs and to read job status information.

GET methods

/jobs

Response

TYPE

JSON

STATUS CODE

200 OK

Example

{
  "jobs" : [
    {
      "robot" : 10,
      "job" : 10,
      "priority" : 1,
      "fromstation" : 2,
      "frombelt" : 1,
      "tostation" : 3,
      "tobelt" : 4,
      "state" : "DRIVING",
      "life-cycle-state" : "RUNNING"
    },
    {
      "robot" : 10,
      "job" : 11,
      "position" : 2,
      "state" : "DRIVING",
      "life-cycle-state" : "RUNNING"
    }
  ]
}

/jobs/:jobid

Response

TYPE

JSON

STATUS CODE

If jobid exists 200 OK, else 404 Not Found

Example

{
  "robot" : 10,
  "job" : 10,
  "priority" : 1,
  "fromstation" : 2,
  "frombelt" : 1,
  "tostation" : 3,
  "tobelt" : 4,
  "state" : "DRIVING",
  "life-cycle-state" : "RUNNING"
}

POST methods

/gotoposition

Create a new GotoPosition job.

Posted data

TYPE

JSON

Example

{
  "robot" : 1,
  "position" : 2
}

Response

TYPE

JSON

STATUS CODE

201 (Created) if a new job was created, 304 (Not Modified) if no job was created

Example (job created)

{
  "robot" : 1,
  "job" : 1867,
  "position" : 2,
  "state" : "NIL",
  "life-cycle-state" : "NOTSTARTED"
}