Scheduling

Retrieve Task

Work with a Task.Retrieve a Task with the given ID.

For File-type additional fields, the response includes the object additional_attributes.<field_name> with api_url, web_url, filename and download_link. download_link is an absolute URL signed by hash+time query parameters and can be opened directly to fetch the file without a session/access token (useful for previews on mobile clients).

File uploads into File-type additional fields are done via a separate POST /admin/scheduling/tasks/{id}--upload request with multipart/form-data, because PUT does not support file uploads in PHP.

get/admin/scheduling/tasks/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/scheduling/tasks/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Task.

Response

titlestring required

Task title, min length: 3, max length: 64

descriptionstring

Task description

reporter_idnumber
addressstring required

Address

gpsstring

Valid coordinates

related_customer_idnumber

Customer ID

related_lead_idnumber

Lead ID

resolved_atstring
partner_idnumber required

Partner ID

project_idnumber required

Project ID

location_idnumber
related_to_idnumber
related_service_idnumber
related_service_type'internet' | 'recurring' | 'voice'

The type of service related to the task

created_atstring

Date of task creating

updated_atstring
prioritystring required

Task priority: 'priority_low', 'priority_medium', 'priority_high'

assigned_to'assigned_to_anyone' | 'assigned_to_administrator' | 'assigned_to_team'

The team or individual to whom the task is assigned

assigneenumber
assigned_atstring
is_scheduledboolean

Is Task Scheduled true or false

scheduled_fromstring

Shcheduled from date time

formatted_durationstring

Scheduled task duration format '0h 0m'

checklist_template_idnumber

Checklist template ID

workflow_status_idnumber required

Workflow status ID

is_archivednumber

Is task archived. Valid values: 0, 1. Default: 0

createdFromTicketboolean

If Task created from ticket true or false

task_labelsnumber[]

Array of task labels (ids).

travel_time_tonumber
travel_time_fromnumber
closednumber
notification_send_intervalnumber
notification_enabledstring
remainingnumber
last_status_changedstring
watchersnumber[]

Array of task watchers IDs

idnumber required

Task ID

Example response

{
  "title": "Scheduling task 1",
  "description": "My new project",
  "reporter_id": 1,
  "address": "3rd Street 2345",
  "gps": "50.10676296991858,14.445095658302305",
  "related_customer_id": 1,
  "related_lead_id": 0,
  "resolved_at": "2019-05-16 20:00:55",
  "partner_id": 1,
  "project_id": 1,
  "location_id": 1,
  "related_to_id": 1,
  "related_service_id": 1,
  "related_service_type": "internet",
  "created_at": "2019-05-16 17:00:55",
  "updated_at": "2019-05-16 20:00:55",
  "priority": "priority_medium",
  "assigned_to": "assigned_to_anyone",
  "assignee": 1,
  "assigned_at": "2024-11-04 16:33:18",
  "is_scheduled": true,
  "scheduled_from": "2019-05-16 18:00:55",
  "formatted_duration": "1h 25m",
  "checklist_template_id": 1,
  "workflow_status_id": 1,
  "is_archived": 0,
  "createdFromTicket": true,
  "task_labels": [
    1,
    2
  ],
  "related_ticket_info": {
    "ticket_id": 1,
    "ticket_subject": "Ticket subject"
  },
  "travel_time_to": 0,
  "travel_time_from": 0,
  "closed": 0,
  "notification_send_interval": 0,
  "notification_enabled": "1",
  "remaining": 0,
  "last_status_changed": "2024-04-15 11:06:45",
  "watchers": [
    10,
    11
  ],
  "id": 1
}

Changes

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