openapi: 3.2.0 info: title: Deputy Task API version: 1.0.0 description: 'Operations tagged Task across 2 of this provider''s published API definitions: deputy-openapi.json, deputy-task-api-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy tags: - name: Task description: V1 /my/task/* endpoints paths: /my/task: get: tags: - Task summary: List or get Task operationId: my_task__get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found security: - BearerAuth: [] post: tags: - Task summary: Create or update Task operationId: my_task__post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy /my/task/completed: get: tags: - Task summary: GET Task / completed operationId: my_task__completed_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found security: - BearerAuth: [] post: tags: - Task summary: POST Task / completed operationId: my_task__completed_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy /my/task/department: get: tags: - Task summary: GET Task / department operationId: my_task__department_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found security: - BearerAuth: [] post: tags: - Task summary: POST Task / department operationId: my_task__department_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy /my/task/department/{date}: get: tags: - Task summary: GET Task / :date operationId: my_task__department_date_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: date in: path required: true schema: type: string pattern: '[0-9]{4}\-[0-9]{1,2}\-[0-9]{1,2}' security: - BearerAuth: [] post: tags: - Task summary: POST Task / :date operationId: my_task__department_date_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: date in: path required: true schema: type: string pattern: '[0-9]{4}\-[0-9]{1,2}\-[0-9]{1,2}' requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy /my/task/{id}: post: tags: - Task summary: POST Task / :id operationId: my_task__id_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: id in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy /my/task/{id}/do: post: tags: - Task summary: POST Task / do operationId: my_task__id_do_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: id in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy /my/task/{id}/undo: post: tags: - Task summary: POST Task / undo operationId: my_task__id_undo_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: id in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy /resource/Task: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: List Task records description: Returns Task records the authenticated caller is permitted to see. For large tables prefer POST /QUERY with pagination. operationId: listTask responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] post: tags: - Task summary: Create a Task operationId: createTask requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Task' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] put: tags: - Task summary: Create a Task operationId: createOrReplaceTask requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Task' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/BULK: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: Bulk create/update Task description: Accepts an array of records. Each record is processed independently. operationId: bulkTask requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/Task' responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/INFO: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: Get field metadata for Task description: Returns the field list, types, and associations for this resource. Useful when building integrations that need to know which fields are queryable. operationId: infoTask responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/PREDICT: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: Predict-match a Task record description: Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating. operationId: predictTask requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Task' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/QUERY: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: Search Task description: 'Flexible search endpoint. Body supports `search`, `sort`, `start`, `max`, and `join` clauses. Example: `{"search": {"s1": {"field": "Id", "data": 1, "type": "eq"}}}`.' operationId: searchTask requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryRequest' responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/{id}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: Get a Task by id operationId: getTaskById parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] post: tags: - Task summary: Update a Task operationId: updateTask parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Task' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] put: tags: - Task summary: Update a Task operationId: replaceTask parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Task' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] delete: tags: - Task summary: Delete a Task operationId: deleteTask parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource responses: '200': description: Success content: application/json: schema: type: object properties: success: type: boolean '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/{id}/COMMENTS: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: List comments on a Task operationId: getCommentsTask parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: Id: type: integer Comment: type: string Creator: type: integer Created: type: string format: date-time '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] post: tags: - Task summary: Add a comment to a Task operationId: addCommentTask parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource requestBody: required: true content: application/json: schema: type: object properties: Comment: type: string required: - Comment responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/{id}/COMMENTS/{commentId}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy delete: tags: - Task summary: Delete a comment on a Task operationId: deleteCommentTask parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource - name: commentId in: path required: true schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: success: type: boolean '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/{id}/HISTORY: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: Get change history for a Task operationId: historyTask parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/Task/{id}/HISTORY/travel/{timestamp}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: Get a Task as it existed at a prior time operationId: historyTaskTravel parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource - name: timestamp in: path required: true schema: type: integer format: int64 description: Unix epoch seconds responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Task' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /supervise/task: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: List or get Task operationId: supervise_task__get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found security: - BearerAuth: [] put: tags: - Task summary: Create Task operationId: supervise_task__put responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] post: tags: - Task summary: Create or update Task operationId: supervise_task__post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/QUERY: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / QUERY operationId: supervise_task__query_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/completed: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / completed operationId: supervise_task__completed_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found security: - BearerAuth: [] post: tags: - Task summary: POST Task / completed operationId: supervise_task__completed_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / department operationId: supervise_task__department_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found security: - BearerAuth: [] post: tags: - Task summary: POST Task / department operationId: supervise_task__department_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/generate: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / generate operationId: supervise_task__department_generate_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/schedule: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / schedule operationId: supervise_task__department_schedule_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found security: - BearerAuth: [] /supervise/task/department/task/systemtemplate/copy: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / copy operationId: supervise_task__department_task_systemtemplate_copy_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/task/systemtemplate/list: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / list operationId: supervise_task__department_task_systemtemplate_list_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found security: - BearerAuth: [] /supervise/task/department/task/{taskid}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy delete: tags: - Task summary: DELETE Task / :taskid operationId: supervise_task__department_task_taskid_delete responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: taskid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/department/taskgroup/{taskgroupid}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy delete: tags: - Task summary: DELETE Task / :taskgroupid operationId: supervise_task__department_taskgroup_taskgroupid_delete responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: taskgroupid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/department/{deptid}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / :deptid operationId: supervise_task__department_deptid_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/department/{deptid}/apply: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / apply operationId: supervise_task__department_deptid_apply_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/{deptid}/create: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / create operationId: supervise_task__department_deptid_create_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/{deptid}/date/{strYMD}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / :strYMD operationId: supervise_task__department_deptid_date_strymd_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: strYMD in: path required: true schema: type: string security: - BearerAuth: [] /supervise/task/department/{deptid}/date/{strYMD}/{strendYMD}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / :strendYMD operationId: supervise_task__department_deptid_date_strymd_strendymd_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: strYMD in: path required: true schema: type: string - name: strendYMD in: path required: true schema: type: string security: - BearerAuth: [] /supervise/task/department/{deptid}/setup: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / setup operationId: supervise_task__department_deptid_setup_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/department/{deptid}/setup/apply: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / apply operationId: supervise_task__department_deptid_setup_apply_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/{deptid}/setup/create: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy put: tags: - Task summary: PUT Task / create operationId: supervise_task__department_deptid_setup_create_put responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] post: tags: - Task summary: POST Task / create operationId: supervise_task__department_deptid_setup_create_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/{deptid}/setup/{taskgroupsetupid}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / :taskgroupsetupid operationId: supervise_task__department_deptid_setup_taskgroupsetupid_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] post: tags: - Task summary: POST Task / :taskgroupsetupid operationId: supervise_task__department_deptid_setup_taskgroupsetupid_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] delete: tags: - Task summary: DELETE Task / :taskgroupsetupid operationId: supervise_task__department_deptid_setup_taskgroupsetupid_delete responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/department/{deptid}/setup/{taskgroupsetupid}/apply: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / apply operationId: supervise_task__department_deptid_setup_taskgroupsetupid_apply_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/{deptid}/setup/{taskgroupsetupid}/create: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy put: tags: - Task summary: PUT Task / create operationId: supervise_task__department_deptid_setup_taskgroupsetupid_create_put responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] post: tags: - Task summary: POST Task / create operationId: supervise_task__department_deptid_setup_taskgroupsetupid_create_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/{deptid}/setup/{taskgroupsetupid}/generate: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / generate operationId: supervise_task__department_deptid_setup_taskgroupsetupid_generate_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/{deptid}/setup/{taskgroupsetupid}/{tasksetupid}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / :tasksetupid operationId: supervise_task__department_deptid_setup_taskgroupsetupid_tasksetupid_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ - name: tasksetupid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] post: tags: - Task summary: POST Task / :tasksetupid operationId: supervise_task__department_deptid_setup_taskgroupsetupid_tasksetupid_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ - name: tasksetupid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] delete: tags: - Task summary: DELETE Task / :tasksetupid operationId: supervise_task__department_deptid_setup_taskgroupsetupid_tasksetupid_delete responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupsetupid in: path required: true schema: type: integer pattern: \d+ - name: tasksetupid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/department/{deptid}/{taskgroupid}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / :taskgroupid operationId: supervise_task__department_deptid_taskgroupid_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/department/{deptid}/{taskgroupid}/any: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - Task summary: GET Task / any operationId: supervise_task__department_deptid_taskgroupid_any_get responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupid in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/department/{deptid}/{taskgroupid}/apply: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / apply operationId: supervise_task__department_deptid_taskgroupid_apply_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/department/{deptid}/{taskgroupid}/create: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / create operationId: supervise_task__department_deptid_taskgroupid_create_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: deptid in: path required: true schema: type: integer pattern: \d+ - name: taskgroupid in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/{id}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / :id operationId: supervise_task__id_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: id in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] put: tags: - Task summary: PUT Task / :id operationId: supervise_task__id_put responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: id in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] delete: tags: - Task summary: DELETE Task / :id operationId: supervise_task__id_delete responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: id in: path required: true schema: type: integer pattern: \d+ security: - BearerAuth: [] /supervise/task/{id}/do: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / do operationId: supervise_task__id_do_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: id in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] /supervise/task/{id}/undo: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - Task summary: POST Task / undo operationId: supervise_task__id_undo_post responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Not authenticated '403': description: Insufficient permissions '404': description: Not found parameters: - name: id in: path required: true schema: type: integer pattern: \d+ requestBody: required: true content: application/json: schema: type: object security: - BearerAuth: [] components: schemas: Task: type: object properties: Id: type: integer TaskSetupId: type: integer OpUnitId: type: integer GroupId: type: integer DayTimestamp: type: integer Date: type: string format: date-time OrigDayTimestamp: type: integer OrigDate: type: string format: date-time AvailableAfterTimestamp: type: integer DueDate: type: string format: date-time DueTimestamp: type: integer RepeatIfNotCompleted: type: boolean SortOrder: type: integer Type: type: integer Question: type: string maxLength: 255 Answer: type: string Comment: type: string maxLength: 255 UserEntry: type: integer UserPerformTask: type: integer UserResponsible: type: integer Created: type: string format: date-time Modified: type: string TsCompleted: type: integer Start: type: integer End: type: integer Duration: type: integer TaskSetup: type: object OpUnit: type: object Group: type: object required: - Id - TaskSetupId - OpUnitId - GroupId - DayTimestamp - Date - SortOrder - Question - UserEntry - Created - Modified QueryRequest: type: object description: V1 Resource search payload. All fields optional; an empty body returns the first page of results. properties: search: type: object description: Map of search clauses keyed by an arbitrary id (e.g. `s1`, `s2`). Each clause filters one field. additionalProperties: type: object required: - field - data - type properties: field: type: string description: Field name to filter on (e.g. `Id`, `Employee`). data: description: Comparison value. Type depends on the field. type: type: string description: Comparison operator. enum: - eq - ne - gt - lt - ge - le - is - is not - in - not in - starts - contains sort: type: object description: Map of field name → `asc` or `desc`. additionalProperties: type: string enum: - asc - desc start: type: integer minimum: 0 default: 0 description: Pagination offset (0-indexed). max: type: integer minimum: 1 maximum: 500 default: 100 description: Max records per page (server caps at 500). join: type: array items: type: string description: Related ORMs to expand inline (e.g. `["EmployeeObject"]`). example: search: s1: field: Id data: 1 type: ge max: 100 securitySchemes: BearerAuth: type: http scheme: bearer description: OAuth 2.0 access token or Deputy Permanent Token. OAuth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://once.deputy.com/my/oauth/login tokenUrl: https://once.deputy.com/my/oauth/access_token scopes: longlife_refresh_token: Extended session x-refined-from: - deputy-openapi.json - deputy-task-api-openapi.yml