Work_queues
This resource allows you to fetch work queues from Octopi.

In Octopi, there are different types of work queues: * terminal: where items are created as containers enter and leave the terminal via the gates * voyage: where items are created as containers get unloaded and loaded from vessels. * general_cargo: where items are created as non-containerized cargo enter and leave the terminal via the gates. * warehouse: where items are created as cargo is stripped from a container.

Supported Formats

json
>>>

GET /api/v1/work_queues.json

This API endpoint allows you to fetch a list of work queues in Octopi.

Supported Formats

json

Errors

Code Description
404 Not found.
400 Invalid request.
500 Server crashed.

Examples

curl "https://app.octopi.co/api/v1/work_queues.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE" -d '{"exclude_voyage_queues":"true"}'

{
   "work_queues" : [
      {
         "active" : true,
         "voyage" : {
            "name" : null,
            "id" : null
         },
         "queue_type" : "General Cargo",
         "terminal" : {
            "name" : "Blue Yard",
            "id" : 31
         },
         "name" : "General Cargo: Blue Yard",
         "yard_area" : {
            "id" : null,
            "name" : null
         },
         "id" : 304
      },
      {
         "yard_area" : {
            "id" : null,
            "name" : null
         },
         "id" : 48,
         "active" : true,
         "name" : "Terminal: Blue Yard",
         "queue_type" : "Terminal",
         "voyage" : {
            "id" : null,
            "name" : null
         },
         "terminal" : {
            "id" : 31,
            "name" : "Blue Yard"
         }
      }
   ],
   "actions" : {
      "index" : {
         "url" : "http://app.octopi.co/api/v1/work_queues.json",
         "method" : "GET"
      }
   }
}

Params

Param name Description
exclude_voyage_queues
optional

Pass this parameter if you want to exclude voyage queues from the list.

Validations:

  • Must be a String