Qodex.ai

TasksRequest

GET {{base_url}}/TasksRequest

Retrieves a list of available tasks.

API
Task API

Requires Authentication
Yes

Returns
List [Task]

Batch?
No

Request Params

KeyDatatypeRequiredDescription
ResourceIdstringOptional.
(int32)
The identifier of the associated WorkBook resource.
For information about the Resource object, see Resource.
StartstringOptional.
(date-time)
The date and time stamp for when the task will start.
EndstringOptional.
(date-time)
The date and time stamp for when the task will end.
PrioritiesstringOptional.
(int32)
The list of identifiers of the associated priorities.
ActivestringOptional.
The flag that indicates whether or not the task is active.
NOTE: By default, this is automatically set to false if not specified.
PlanIdstringOptional.
(int32)
The identifier of the associated plan.
PhaseNumberstringOptional.
(int32)
The number of the associated phase.
JobIdstringIMPORTANT: This is obsolete. Use the JobIds query parameter instead.
Optional.
(int32)
The identifier of the associated job.
For information about the Job object, see Job.
JobIdsstringOptional.
(int32)
The list of identifiers of the associated jobs.
StatusIdsstringOptional.
(int32)
The list of identifiers of the associated job status.
AllowTimeRegistrationstringOptional.
The flag that indicates whether or not the task allows time registration.
NOTE: By default, this is automatically set to false if not specified.
ApplyCostingCodeFilteringOnPersonalExpensestringOptional.
The flag that indicates whether or not the associated job of the task has access to costing codes for personal expense.
If you want to retrieve the tasks whose associated job has access to costing codes for personal expense, set this query parameter to true and specify a single job identifier for the JobIds query parameter. Otherwise, your request will return a 400 WorkBookException error code.
NOTE: By default, this is automatically set to false if not specified.
IncludeExpiredTasksstringOptional.
The flag that indicates whether or not to include the tasks that have not yet ended (expired tasks).
NOTE: By default, this is automatically set to true if not specified.
IncludeFutureTasksstringOptional.
The flag that indicates whether or not to include the tasks that have not yet started (future tasks).
NOTE: By default, this is automatically set to true if not specified.
OnlyTasksWithApprovedBookingsstringOptional.
The flag that indicates whether or not the task has its resource booking approved.
If you want to only retrieve the tasks whose resource bookings have been approved, use this query parameter together with the ResourceId query parameter.
NOTE: By default, this is automatically set to false if not specified.
TaskFilterstringIMPORTANT: This is obsolete. Use the POST ScheduleResourceFilterTasksRequest API endpoint instead.
Optional.
The filter for tasks.
ProjectFilterstringIMPORTANT: This is obsolete. Use the POST ScheduleResourceFilterTasksRequest API endpoint instead.
Optional.
The filter for projects.
JobDimensionstringIMPORTANT: This is obsolete. Use the POST ScheduleResourceFilterTasksRequest API endpoint instead.
Optional.
The filter for job dimensions.
SearchstringOptional.
The filter for search results, either by Id or TaskName.

HEADERS

KeyDatatypeRequiredDescription
AcceptstringRequired.
The type of content accepted by the API endpoint.
Content-TypestringRequired.
The type of content supported by the API endpoint.

RESPONSES

status: OK

[{"Id":175517,"PlanId":40386,"PhaseNumber":1,"TaskNumber":2,"TaskName":"Procespect 29066 @29066 - input pipeline name","ActivityId":535,"StartDate":"2017-02-06T00:00:00.000Z","WorkDays":69,"EndDate":"2017-05-22T00:00:00.000Z","TaskStatus":1,"BookingMethod":2,"BookingStatus":1,"Milestone":false,"PriorityId":2,"SupplementaryTextRequested":true,"TaskColourId":1,"ShowPublic":true,"CreateDate":"2017-02-09T11:59:32.700Z","CreateEmployeeId":15371,"UpdateEmployeeId":35879,"UpdateDate":"2022-01-04T10:31:47.417Z","TaskResponsibleResouceId":38571,"AllowTimeRegistration":true,"AllowUseOffDay":false,"FromExternal":false,"Billable":false,"Depended":false,"CostingCodeId":1105},{"Id":175518,"PlanId":40386,"PhaseNumber":1,"TaskNumber":3,"TaskName":"Isio Inc. @ARTP - input pipeline name","ActivityId":535,"StartDate":"2017-02-06T00:00:00.000Z","WorkDays":69,"EndDate":"2017-05-22T00:00:00.000Z","TaskStatus":1,"BookingMethod":2,"BookingStatus":1,"Milestone":false,"PriorityId":2,"SupplementaryTextRequested":true,"TaskColourId":1,"ShowPublic":true,"CreateDate":"2017-02-09T11:59:32.850Z","CreateEmployeeId":15371,"UpdateEmployeeId":35879,"UpdateDate":"2022-01-04T10:43:38.987Z","TaskResponsibleResouceId":38571,"AllowTimeRegistration":true,"AllowUseOffDay":false,"FromExternal":false,"Billable":false,"Depended":false,"CostingCodeId":1105}]