Task
A task record exposes a task to REST web services.
This record:
-
is not a subrecord
-
has the following subrecords
-
EventFile
-
TaskCompanyMap
-
TaskContactMap
-
The REST API Browser includes information about the field names and field types of the task record, and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s task reference page.
For more information about using the REST API Browser, see The REST API Browser.
Record ID
The record ID for the task REST record is task.
Exposed Elements
The following task record elements are exposed to REST web services:
-
accesslevel
-
assigned
-
bom (Requires Advanced Bill of Materials feature)
-
bomrevision ( Requires Advanced Bill of Materials feature)
-
company
-
contact
-
createdate (Read only)
-
customform
-
duedate
-
endtime
-
externalid
-
id
-
nessage
-
order
-
owner
-
percentcomplete
-
priority
-
relateditem
-
reminderminutes
-
sendemail
-
startdate
-
starttime
-
status
-
supportcase
-
timedevent
-
title
-
transaction
-
usernotes
Code Sample
In the following example, <accountID> represents your account ID.
HTTP request: https://<accountID>/services/rest/record/v1/task
Request Body
{ "title": "Prepare sales slides", "message": "Charts are required", "priority": "HIGH", "duedate": "2022-11-03", "timedevent": true
}
To Obtain Previously-Created Task Record (where ID is 100526)
HTTP Method: GET
URL: https://<accountID>/services/rest/record/v1/task
Response Body
{ "links": [ { "rel": "self", "href": "http://<accountID>/services/rest/record/v1/task/100526 } ], "accessLevel": false, "assigned": { "links": [ { "rel": "self", "href": "http://<account>/service/rest/record/v1/customer/-5" } ], "id": "-5", "refName": "A Wolfe-admin" }, "createdDate": "2020-11-25T17:13:00Z", "links": [], "id": "-120", "refName": "Standard Task Form" }, "dueDate": "2022-11-03", "endTime": "10:00", "id": "100526", "lastModifiedDate": "2020-11-25T17:13:00Z", "message": "Charts are required", "owner": { "links": [ { "rel": "self", "href": "http://<accountID>/services/rest/record/v1/customer/-5" } ], "id": "-5", "refName": "-5" }, "percentTimeComplete": 0.0, "priority": { "links": [], "id": "HIGH", "refName": "High" }, "sendEmail": false, "startDate": "2020-11-25", "startTime": "09:00", "status": { "links": [], "id": "NOTSTART", "refName": "Not Started" }, "timedEvent": true, "timeRemaining": "0:00", "timeRemaining": "0:00", "timezone": "America/Los_Angeles",
"title": "Prepare sales slides"
}