Worker Task Leases

Get WorkerTaskLeases

GET /api/{spaceId}/workertaskleases

Also reachable at /api/spaces/{spaceIdentifier}/workertaskleases.

Gets a paginated set of WorkerTaskLeases.

Path Parameters

  • spaceId string (required)
    The id of the space for the WorkerTaskLease.

Query Parameters

  • skip integer (required)
    Number of items to skip. Minimum 0.
  • take integer (required)
    Number of items to take. Minimum 0.

Response

200 — Rseponse to getting set of WorkerTaskLeases

  • WorkerTaskLeases object
    • Id string
      Gets or sets a unique identifier for this resource.
    • ItemType string
    • Items array of object
    • ItemsPerPage integer
    • LastModifiedBy string
      Gets or sets the username of the user who last modified this resource.
    • LastModifiedOn string
      Gets or sets the date/time that this resource was last modified. Format date-time.
    • LastPageNumber integer
    • Links object
      Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    • NumberOfPages integer
    • TotalResults integer

Example Response

JSON
{
  "WorkerTaskLeases": {
    "Id": "string",
    "ItemType": "string",
    "Items": [
      {
        "Exclusive": true,
        "Id": "string",
        "Name": "string",
        "ServerTaskId": "string",
        "SpaceId": "string",
        "TakenAt": "2020-01-01T00:00:00.000Z",
        "WorkerId": "string",
        "WorkerPoolId": "string"
      }
    ],
    "ItemsPerPage": 0,
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "LastPageNumber": 0,
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "NumberOfPages": 0,
    "TotalResults": 0
  }
}