Deployment [EXPERIMENTAL]

Endpoints used for managing Deployments. A Deployment represents the actual assignment of an Employee to one or more TransportResources for a specific time period and location. External deployments can be created to represent work assignments that are managed outside of the Resource Management system. Releasing or unreleasing routes in PTV OptiFlow also manages Deployments. These Deployments are managed internally by Resource Management and cannot be modified by this API.

Operations

[EXPERIMENTAL] Get cursor-based deployments

Request

Retrieve deployments in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal). Deployments without a planning_id are externally managed Deployments. Deployments with a planning_id are managed by releasing or unreleasing routes in PTV OptiFlow.

Security

clientCredentials

Query

cursorstring

The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.

limitinteger, [ 1 .. 1000 ]

Number of results to return per page.

Default:100

Payload

// No request payload

Responses

The results for the current paged request and optional pointers to related result pages.

Bodyapplication/json

dataArray of objects(Deployment)

The set of results for the current page.

cursorsobject(Cursors)

The cursors represent pointers to pages of results in relation to the page that was retrieved by the current request. These pointers are nullable. For more information on these pointers, view the Developer Portal.

Response

{
  "data": [
    { … }
  ],
  "cursors": {
    "previous": "string",
    "self": "string",
    "next": "string"
  }
}