API Reference
Log In
API Reference

/tasktemplates/reference-preview

post
https://api.dev.orbit.do/v5/tasktemplates/reference-preview

Count how many objects a schedule template's set reference matches right now: the active vehicles, carriers or carrier users it names that meet the given conditions. Counting stops one past the cap of 500 objects per occurrence; overCap then says an occurrence would create no task. Read-only.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
reference
required

A set reference of a schedule template: vehicles-of-carrier, all-vehicles, all-carriers or carrier-users-of-carrier.

conditions
object

Conditions an object of a set must meet to get a task, over the fields of the reference object: { combinator: 'and' | 'or', rules: [...] }, where each rule is { field, operator, value } with a dotted field path such as 'vehicle.make', or a nested group of rules. Only allowed on the set references. Omit to include every active object.

Responses

400

not a set reference, or invalid conditions

401

unauthorized

403

The role of the API key does not allow this action. The key needs a role with the matching permission, for example full access.

Updated 22 days ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago

Did this page help you?