Difference between revisions of "EVENT"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
 
(6 intermediate revisions by the same user not shown)
Line 4: Line 4:


{{objectdisclaimer}}
{{objectdisclaimer}}
<noinclude>{{objectattributeAPInote}}</noinclude>
:{| border="1" cellpadding="5" cellspacing="0"
 
 
::{| border="1" cellpadding="5" cellspacing="0"
!Field Name
!Field Name
!Display Type
!Display Type
!Description
!Description
|-
|record_id&nbsp;([[Java API|Java&nbsp;API]])&nbsp;*<br>id ([[REST API]])||Number||Unique record identifier
|-
|{{Colorhighlight}}|owner_id  *
|{{Colorhighlight}}|String
|{{Colorhighlight}}|Unique record owner identifier
|-
|date_modified  *||String||Date the record was last modified
|-
|date_created  *||String||Date the record was created
|-
|created_id  *||String||Unique identifier of the the user who created the record
|-
|modified_id  *||String||Unique identifier of the user who last modified the record
|-
|-
|{{Colorhighlight}}|assigned_id
|{{Colorhighlight}}|assigned_id
Line 68: Line 51:
|{{Colorhighlight}}|start_date
|{{Colorhighlight}}|start_date
|{{Colorhighlight}}|Date
|{{Colorhighlight}}|Date
|{{Colorhighlight}}|Event Start Date
|{{Colorhighlight}}|Event Start Date, in [[Date_Format#Date/Time_Formats|Date/Time Format]]. (The time value in this field is ignored when creating an event. The fields below are used, instead.)
|-
|-
|{{Colorhighlight}}|start_hour
|{{Colorhighlight}}|start_hour
Line 82: Line 65:
|{{Colorhighlight}}|Event subject
|{{Colorhighlight}}|Event subject
|}
|}
<br>
<noinclude>
;Standard Fields:
{{:System Fields}}


<noinclude>[[Category:Built-in Objects]]</noinclude>
[[Category:Built-in Objects]]
</noinclude>

Latest revision as of 23:02, 14 December 2011

Object ID
EVENT
Available Fields
  • Required Fields are highlighted, in italics
This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.
  • Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:
  • CALL_ACTION
  • VIEW_ACTION
Field Name Display Type Description
assigned_id String ID of the User to whom this Event is assigned
calendar_category String Calendar ID on which this event should set; The included calendar has ID = "0"; Optionally, specify the customer calendar ID that you created
calendar_frequency Number Calendar Frequency for the Event; For more information see Constants for Task and Event Objects
calendar_type Number Calendar Type for the Event; For more information see Constants for Task and Event Objects
cc String A String of email addresses (separated by commas) containing additional users/contacts that you want to notify about this event
contact_id Number ID of the Contact this event is related to; In order to relate the event to a specific contact record, you need to set only this attribute; reference_id and reference_type are not required
description String Event Description
duration Number Event duration in minutes
end_date Date Date when the task ends
end_flag Boolean Flag to specify whether this event ends or not; True value means it ends on certain date, false means it never ends
flag_all_day Boolean Flag to specify if the event is all day or not
invitee_list String A comma separated String of IDs of Additional owners of this event
notify_contact Boolean Flag to determine whether the contact identified by contact_id should be notified or not
notify_participants Boolean Flag to determine whether to notify participants in invitee_list or not
reference_id Number ID of the record this event is related to; To relate an event to a record, set reference_id, reference_id_name and reference_type ; Use this attribute to relate the event to any object other than Contact
reference_type String Type of object this event is related to; To relate an event to a record, set reference_id, reference_id_name and reference_type; Use this attribute to relate the event to any object other than Contact
reminder_duration String Event reminder duration; For more information see Constants for Task and Event Objects
repeat_flag Boolean Flag to specify whether this event repeats or not; True value means the task repeats, false indicates no recurrence
start_date Date Event Start Date, in Date/Time Format. (The time value in this field is ignored when creating an event. The fields below are used, instead.)
start_hour Date Event Start Hour
start_minute Date Event Start Minute
subject String Event subject
Standard Fields

The standard system fields are:

  • Common to, and predefined in, all Objects.
  • Created automatically when an object is created.
  • Populated automatically when a record is added or updated in the GUI.
  • Required when a record is added or updated using an API.
Field Name REST Search Name GUI Label Display Type Description
object_id object_id Object ID Number Unique identifier for the object. (This field is always present, but is only displayed when examining Object metadata (the data that defines the object).
record_id id Record ID Number Unique record identifier
owner_id OWNERID Owner String Unique identifier of the record's owner
owner_team_id OWNER_TEAM_ID n/a String Unique identifier of record owner's primary team. (This is a virtual field that does not actually exist in the record. The actual field is in the User object. It is returned in APIs, to keep from having to access the database a second time to check permissions.)
created_id CREATEDID Created By String Unique identifier of the user who created the record
date_created DATECREATED Date Created String Date the record was created:
date_modified DATEMODIFIED Date Modified String Date the record was last modified:
modified_id MODIFIEDID Modified By String Unique identifier of the user who last modified the record