POST/api/v1/platform/queue/jobs/claim

ReturnsResponseListQueueJob

AcceptsClaimJobsRequest

Response examples

200OK

*/* example derived from schema

{
  "statusCode": 0,
  "statusMessage": "string",
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "queue": "string",
      "payload": {
        "array": true,
        "empty": true,
        "null": true,
        "float": true
      },
      "priority": 0
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string",
      "field": "string"
    }
  ]
}

Try ItOpenAPI definition vv0

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "queue": "string",
  "worker": "string"
}' 'http://localhost/api/v1/platform/queue/jobs/claim'

fetch("http://localhost/api/v1/platform/queue/jobs/claim", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"queue\": \"string\",\n  \"worker\": \"string\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "http://localhost/api/v1/platform/queue/jobs/claim"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"queue\": \"string\",\n  \"worker\": \"string\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Body:

{ "queue": "string", "worker": "string" }