Difference between revisions of "Standard Fields"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 1: | Line 1: | ||
These fields are predefined in | <blockquote> | ||
These fields are predefined in all objects. The standard 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. | |||
:{| border="1" cellpadding="5" cellspacing="0" | |||
!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: | |||
:* [[UTC Format]] in the [[REST API]]. | |||
:* User's [[Date#Date/Time Formats|Date Format]] in the GUI and the Java API. | |||
|- | |||
|date_modified ||DATEMODIFIED || Date Modified || String||Date the record was last modified: | |||
:* [[UTC Format]] in the [[REST API]]. | |||
:* User's [[Date#Date/Time Formats|Date Format]] in the GUI and the Java API. | |||
|- | |||
|modified_id ||MODIFIEDID || Modified By || String||Unique identifier of the user who last modified the record | |||
|} | |||
</blockquote> |
Revision as of 20:28, 21 June 2013
These fields are predefined in all objects. The standard 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:
- UTC Format in the REST API.
- User's Date Format in the GUI and the Java API.
date_modified DATEMODIFIED Date Modified String Date the record was last modified:
- UTC Format in the REST API.
- User's Date Format in the GUI and the Java API.
modified_id MODIFIEDID Modified By String Unique identifier of the user who last modified the record