Retrieves the task with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
task.id |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
task_view| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| task_type_id |
Task Type ID |
globally unique identifier | |
| company_id |
Company ID |
globally unique identifier | |
| contact_id |
Contact ID |
globally unique identifier | |
| to_db_table_id |
to db table id |
globally unique identifier | |
| to_id_in_table |
to do id in table |
globally unique identifier | |
| subject |
Subject |
string |
Required Max length: 150 |
| remark |
Remark of the Task (long text area field) |
string | |
| assigned_to_user_id |
Assigned to user id |
globally unique identifier | |
| assigned_to_user_group_id |
Assigned to user group id |
globally unique identifier | |
| date_create |
Date create |
date | |
| dateutc_create |
dateutc_create |
date | |
| date_update |
Date update |
date | |
| date_start |
date_start |
date | |
| due_date |
due date |
date | |
| date_closed |
date closed |
date | |
| archived |
Archived, means the task reachs a status "Complete" |
boolean | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
| date_assigned |
Date+Time when the task has been assigned to a specific user |
date | |
| date_suggested_by_company |
Date+Time suggested by the company to start working on this task |
date | |
| company_name |
Company name on which this task is related (Filled even if the task is linked to a Work Order or an installation) |
string |
Required Max length: 64 |
| company_code |
Company code on which this task is related (Filled even if the task is linked to a Work Order or an installation) |
string |
Max length: 50 |
| db_address_phone |
Phone number of the company |
string |
Max length: 50 |
| db_address_email |
Email address of the company |
string |
Max length: 250 |
| contact_fullname |
Contact fullname of the task |
string |
Max length: 250 |
| contact_db_address_phone |
Contact Phone number of the task |
string |
Max length: 50 |
| contact_db_address_email |
Contact Email address number of the task |
string |
Max length: 250 |
| task_type_name |
Contact Phone number of the task |
string |
Max length: 50 |
| task_status_id |
Task Status ID |
globally unique identifier | |
| task_status_name |
Status name (translated) of the task (task.task_status_id=>task_status.name) |
string |
Max length: 50 |
| task_status_description |
Status description of the task (task.task_status_id=>task_status.description) |
string |
Max length: 250 |
| task_priority_id |
Task Priority Id |
globally unique identifier | |
| task_priority_name |
Priority name (translated) of the task (task.task_priority_id=>task_priority.name) |
string |
Max length: 50 |
| assigned_to_user_fullname |
If assigned to a user, User Fullname on which the task has been assigned (task.assigned_to_user_id=>User.fullname) |
string |
Max length: 250 |
| assigned_to_user_group_name |
If assigned to a user group, UserGroup name on which the task has been assigned (task.assigned_to_user_group_id=>UserGroup.name) |
string |
Max length: 250 |
| sales_organization_name |
Organization name on which belongs the company that owns this task |
string |
Max length: 250 |
| linked_object |
Automatically value binded depending the linked object (like a job) |
string | |
| jobs_id2 |
If linked to a jobs, his ID2 |
integer | |
| jobs_reference_back_office |
If linked to a jobs, his reference_back_office |
string |
Max length: 250 |
| jobs_name |
If linked to a jobs, his name |
string |
Max length: 250 |
| project_id2 |
If linked to a project, his ID2 |
integer | |
| project_reference_back_office |
If linked to a probject, his reference_back_office |
string |
Max length: 250 |
| project_name |
If linked to a project, his name |
string |
Max length: 250 |
| project_db_address_street |
If linked to a project, the street of the project |
string | |
| project_db_address_street_number |
If linked to a project, the street number of the project |
string | |
| project_db_address_city |
If linked to a project, the city of the project |
string | |
| project_db_address_zip |
If linked to a project, the zip of the project |
string | |
| project_db_address_phone |
If linked to a project, the phone of the project |
string | |
| created_by_servicedesk_api |
ReadOnly,Specify that the task has been created by ServiceDesk |
boolean | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "773a8f2f-01ae-4fd8-bf23-c6291158aa4e",
"task_type_id": "031bad0e-db53-4016-bc91-7d4db250ca01",
"company_id": "c6d024aa-3b9e-49d4-a0ac-9ecd9adaeda7",
"contact_id": "2b98b6ee-d2a1-4445-a183-c66b626fe4fe",
"to_db_table_id": "b2543386-8cb7-428f-a119-a1154fda46ef",
"to_id_in_table": "5b9a937f-2cff-4b12-b7a5-3a4727595810",
"subject": "sample string 7",
"remark": "sample string 8",
"assigned_to_user_id": "c512254d-2641-47fe-b150-17118e722f87",
"assigned_to_user_group_id": "4d997abd-433b-491f-81f8-27f1543c2d6f",
"date_create": "2026-06-24T03:58:26.980385+00:00",
"dateutc_create": "2026-06-24T03:58:26.980385+00:00",
"date_update": "2026-06-24T03:58:26.980385+00:00",
"date_start": "2026-06-24T03:58:26.980385+00:00",
"due_date": "2026-06-24T03:58:26.980385+00:00",
"date_closed": "2026-06-24T03:58:26.980385+00:00",
"archived": true,
"id2": 18,
"date_assigned": "2026-06-24T03:58:26.980385+00:00",
"date_suggested_by_company": "2026-06-24T03:58:26.980385+00:00",
"company_name": "sample string 21",
"company_code": "sample string 22",
"db_address_phone": "sample string 23",
"db_address_email": "sample string 24",
"contact_fullname": "sample string 25",
"contact_db_address_phone": "sample string 26",
"contact_db_address_email": "sample string 27",
"task_type_name": "sample string 28",
"task_status_id": "6e45e4ef-eef5-462f-8f6a-4df22395a4b4",
"task_status_name": "sample string 30",
"task_status_description": "sample string 31",
"task_priority_id": "86645c89-bf21-4abf-8098-2be13bcea348",
"task_priority_name": "sample string 33",
"assigned_to_user_fullname": "sample string 34",
"assigned_to_user_group_name": "sample string 35",
"sales_organization_name": "sample string 36",
"linked_object": "sample string 37",
"jobs_id2": 38,
"jobs_reference_back_office": "sample string 39",
"jobs_name": "sample string 40",
"project_id2": 41,
"project_reference_back_office": "sample string 42",
"project_name": "sample string 43",
"project_db_address_street": "sample string 44",
"project_db_address_street_number": "sample string 45",
"project_db_address_city": "sample string 46",
"project_db_address_zip": "sample string 47",
"project_db_address_phone": "sample string 48",
"created_by_servicedesk_api": true,
"modified_dateutc": "2026-06-24T03:58:26.980385+00:00"
}
application/xml, text/xml
<task_view xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archived>true</archived> <assigned_to_user_fullname>sample string 34</assigned_to_user_fullname> <assigned_to_user_group_id>4d997abd-433b-491f-81f8-27f1543c2d6f</assigned_to_user_group_id> <assigned_to_user_group_name>sample string 35</assigned_to_user_group_name> <assigned_to_user_id>c512254d-2641-47fe-b150-17118e722f87</assigned_to_user_id> <company_code>sample string 22</company_code> <company_id>c6d024aa-3b9e-49d4-a0ac-9ecd9adaeda7</company_id> <company_name>sample string 21</company_name> <contact_db_address_email>sample string 27</contact_db_address_email> <contact_db_address_phone>sample string 26</contact_db_address_phone> <contact_fullname>sample string 25</contact_fullname> <contact_id>2b98b6ee-d2a1-4445-a183-c66b626fe4fe</contact_id> <created_by_servicedesk_api>true</created_by_servicedesk_api> <date_assigned>2026-06-24T03:58:26.980Z</date_assigned> <date_closed>2026-06-24T03:58:26.980Z</date_closed> <date_create>2026-06-24T03:58:26.980Z</date_create> <date_start>2026-06-24T03:58:26.980Z</date_start> <date_suggested_by_company>2026-06-24T03:58:26.980Z</date_suggested_by_company> <date_update>2026-06-24T03:58:26.980Z</date_update> <dateutc_create>2026-06-24T03:58:26.980Z</dateutc_create> <db_address_email>sample string 24</db_address_email> <db_address_phone>sample string 23</db_address_phone> <due_date>2026-06-24T03:58:26.980Z</due_date> <id>773a8f2f-01ae-4fd8-bf23-c6291158aa4e</id> <id2>18</id2> <jobs_id2>38</jobs_id2> <jobs_name>sample string 40</jobs_name> <jobs_reference_back_office>sample string 39</jobs_reference_back_office> <linked_object>sample string 37</linked_object> <modified_dateutc>2026-06-24T03:58:26.980Z</modified_dateutc> <project_db_address_city>sample string 46</project_db_address_city> <project_db_address_phone>sample string 48</project_db_address_phone> <project_db_address_street>sample string 44</project_db_address_street> <project_db_address_street_number>sample string 45</project_db_address_street_number> <project_db_address_zip>sample string 47</project_db_address_zip> <project_id2>41</project_id2> <project_name>sample string 43</project_name> <project_reference_back_office>sample string 42</project_reference_back_office> <remark>sample string 8</remark> <sales_organization_name>sample string 36</sales_organization_name> <subject>sample string 7</subject> <task_priority_id>86645c89-bf21-4abf-8098-2be13bcea348</task_priority_id> <task_priority_name>sample string 33</task_priority_name> <task_status_description>sample string 31</task_status_description> <task_status_id>6e45e4ef-eef5-462f-8f6a-4df22395a4b4</task_status_id> <task_status_name>sample string 30</task_status_name> <task_type_id>031bad0e-db53-4016-bc91-7d4db250ca01</task_type_id> <task_type_name>sample string 28</task_type_name> <to_db_table_id>b2543386-8cb7-428f-a119-a1154fda46ef</to_db_table_id> <to_id_in_table>5b9a937f-2cff-4b12-b7a5-3a4727595810</to_id_in_table> </task_view>