Difference between revisions of "Standard Fields"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
Line 4: Line 4:
:*Required when a record is added or updated using an API.  
:*Required when a record is added or updated using an API.  


===Object Fields===
:{| border="1" cellpadding="5" cellspacing="0"
:{| border="1" cellpadding="5" cellspacing="0"
!Label
!Label
Line 31: Line 30:
|}
|}


===Additional Java Parameters===
See also: [[Standard Parameters]]
When a Java method is invoked by a [[Rule]] or [[Macro]], the record's fields are passed to the method in a [[Parameters Class|Parameters]] instance. That instance contains the object's fields, along with the standard fields shown above. The following convenience parameters are passed, as well:
:{| border="1" cellpadding="5" cellspacing="1" width="50%"
! Field name !! Notes
|-
| name || The record's "name", as specified in the object's Record Locator definition. For cases, it's the unique case number. For users, it's the unique username. And so on.
 
|-
| is_deleted || True (=1) if the record is in the recycle bin. Otherwise false (=0).
 
|-
| colspan="2" bgcolor="lightblue" style="height:6px" | <!-- SPACER ROW -->
|}

Latest revision as of 00:34, 12 November 2014

These fields are predefined in all Objects. They:

  • 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.
Label Field Name REST Search Name 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 id Number Unique record identifier
Owner owner_id OWNERID String Unique identifier of the record's owner
Created By created_id CREATEDID String Unique identifier of the user who created the record
Date Created date_created DATECREATED String Date the record was created:
Modified By modified_id MODIFIEDID String Unique identifier of the user who last modified the record
Date Modified date_modified DATEMODIFIED String Date the record was last modified:

See also: Standard Parameters