Event
An event record exposes an event to REST web services.
This record:
-
is not a subrecord
-
has the following subrecords:
-
Attendee
-
CalendarEventRresourceMap
-
EventFile
-
The REST API Browser includes information about the field names and field types of the event record, and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s event reference page.
For information about using the REST API Browser, see The REST API Browser.
Record ID
The record ID for the event REST record is calendarevent.
Exposed Elements
The following event record elements are exposed to REST web services:
-
accesslevel
-
alldayevent
-
company
-
contact
-
createddate (Read only – set to current date)
-
customform
-
endtime (For alldayevent, set to 6pm)
-
id
-
location
-
message
-
organizer
-
owner (read only)
-
relateditem
-
resource
-
response
-
startdate
-
starttime (For alldayevent, set to 8am)
-
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/calendarevent
Request Body
{ "title": "Meeting with Tom", "status": "CONFIRMED", "message": "Bring Monthly Results", "location": "Caffe West", "startdate": "2022-11-02", "starttime": "14:30", "timedevent": true
}
To Obtain Previously-Created Event Record (where ID is 100425)
HTTP Method: GET
URL: https://<accountID>/services/rest/record/v1/calendarevent/100425
Response Body
{ "links": [ { "rel": "self", "href": http://<accountID>/services/rest/record/v1/calendarevent/100425 } ], "accessLevel": { "links": [], "id": "PUBLIC", "refName": "Public" }, "allDayEvent": false, "attendee": { "links": [ { "rel": "self", "href": http://<accountID>/services/rest/record/v1/calendarevent/100425/attendee } ] }, "createdDate": "2020-11-25T16:40:00Z", "customForm": { "links": [], "id": "-110", "refName": "Standard Event Form" }, "endTime": "15:30", "id": "100425", "lastModifiedDate": "2020-11-25T16:40:00Z", "location": "Caffe West", "message": "Bring Monthly Results", "organizer": { "links": [ { "rel": "self", "href": http://<accountID>/services/rest/record/v1/customer/-5 } ], "id": "-5", "refName": "A Wolfe-admin" }, "owner": { "links": [ { "rel": "self", "href": http://<accountID>/services/rest/record/v1/customer/-5 } ], "id": "-5", "refName": "-5" } "resource": { "links": [ { "rel": "self", "href": "http://<accountID>.eng.netsuite.com/services/rest/record/v1/calendarevent/100425/resource" } ] }, "startDate": "2022-11-02", "startTime": "14:30", "status": { "links": [], "id": "CONFIRMED", "refName": "Confirmed" }, "timedEvent": true, "timezone": "America/Los_Angeles", "title": "Meeting with Tom"
}