GET api/tasks/{id}
Get a task by the id
Request Information
Authentication
This method requires user authentication
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
(Required)This is the TaskDetailId(not TaskId) |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Task| Name | Description | Type | Additional information |
|---|---|---|---|
| TaskId |
TaskId is the one that is shown to the user as a reference, but the real Id is the TaskDetailId |
integer |
None. |
| TaskDetailId |
TaskDetailId is the main id of the task, the one that identifies it, is important to provide it inside the object when performing an update. Please remember to use TaskDetailId and not TaskId in the following routes: * GET api/tasks/{Id} * DELETE api/tasks/{Id} * PUT api/tasks/{Id} |
integer |
None. |
| PropertyId |
Property Id. See the GET api/properties/{propertyId} route to get the property data. |
integer |
None. |
| SourceId |
Source Id. See the GET api/tasksources/{id} routes for the task sources. |
integer |
None. |
| CategoryId |
Category Id. See the GET api/taskcategories/{id} routes for the task categories. |
integer |
None. |
| ResponsiblePartyId |
Responsible Party Id. See the GET api/taskresponsibilityparties/{id} routes for the task responsible parties. |
integer |
None. |
| TaskTypeId |
Task Type Id. See the GET api/tasktypes/{id} routes for the task types. |
integer |
None. |
| AssignUserId |
Assign User Id. See the GET api/users/{id} route for the user data. |
integer |
None. |
| ModuleStatusId |
Status Id. See the GET api/modulestatuses/archmods route to get a list of arch mod statuses. |
integer |
None. |
| ModuleProgressCodeId |
Module Progress Code Id. See the GET api/moduleprogresscodes/{id} route to get the module progress code data. |
integer |
None. |
| AssignUtypeId |
Assign User Type Id. See the GET api/usertypes/{id} route for the user type data. |
integer |
None. |
| StartDate |
Start Date. |
date |
None. |
| DueDate |
Due Date. |
date |
None. |
| CompletionDate |
Completion Date. |
date |
None. |
| TaskName |
Task Name. |
string |
None. |
| AccountingCode |
Accounting Code. |
string |
None. |
| RequestedByContactInfo |
Requested by Contact Info. |
string |
None. |
| SourceInfo |
Source Info. |
string |
None. |
Response Formats
application/json, text/json
{
"TaskId": 1,
"TaskDetailId": 2,
"PropertyId": 1,
"SourceId": 1,
"CategoryId": 1,
"ResponsiblePartyId": 1,
"TaskTypeId": 1,
"AssignUserId": 1,
"ModuleStatusId": 1,
"ModuleProgressCodeId": 1,
"AssignUtypeId": 1,
"StartDate": "2025-12-24T05:22:35.8101737-05:00",
"DueDate": "2025-12-24T05:22:35.8101737-05:00",
"CompletionDate": "2025-12-24T05:22:35.8101737-05:00",
"TaskName": "sample string 3",
"AccountingCode": "sample string 4",
"RequestedByContactInfo": "sample string 5",
"SourceInfo": "sample string 6"
}
Internal Error Codes
-
106: ResourceNotFound
(The requested resource was not found., NotFound) -
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest) -
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest) -
199: UnknownError
(Internal server error., InternalServerError) -
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)