DEdeputy
TaskSetup

Search TaskSetup

Flexible search endpoint. Body supports search, sort, start, max, and join clauses. Example: {"search": {"s1": {"field": "Id", "data": 1, "type": "eq"}}}.

post/resource/TaskSetup/QUERY

Request

  • Base URL
    https://your-subdomain.deputy.deputy.com/api/v1
  • URL
    https://your-subdomain.deputy.deputy.com/api/v1/resource/TaskSetup/QUERY
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://once.deputy.com/my/oauth/login
      Token URL: https://once.deputy.com/my/oauth/access_token

Request body

searchobject

Map of search clauses keyed by an arbitrary id (e.g. s1, s2). Each clause filters one field.

sortobject

Map of field name → asc or desc.

startinteger

Pagination offset (0-indexed).

maxinteger

Max records per page (server caps at 500).

joinstring[]

Related ORMs to expand inline (e.g. ["EmployeeObject"]).

Example request

{
  "search": {
    "s1": {
      "field": "Id",
      "data": 1,
      "type": "ge"
    }
  },
  "max": 100
}

Response

Success

Idinteger required
GroupIdinteger required
Typeinteger required
Parentinteger required
Questionstring required
Defaultstring
SortOrderinteger
Scheduleinteger
OnYesstring required
OnNostring required
RenderFuncstring required
Activeboolean
AvailableAfterstring
RepeatIfNotCompletedboolean
Timestring
Sectionstring
Prioritystring
Helptextstring
SupercedePrevboolean required
Colourstring
OnStartstring
OnSubmitstring
Durationinteger
Creatorinteger required
Createdstring date-time required
Modifiedstring required
Groupobject
ScheduleObjectobject

Changes

No recorded changes to this operation across all 1 revision of this API.