AgileApps Support Wiki Pre Release

Difference between revisions of "Standard Fields"

From AgileApps Support Wiki
imported>Aeric
(Created page with "__TOC__ ==System Fields== The standard ''system fields'' are: :::*Common to all objects (predefined) :::*Created automatically when an object is created :::*Populated automatical…")
 
imported>Aeric
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
__TOC__
These fields are predefined in all [[Objects]]. They:
==System Fields==
:*Created automatically when an object is created.
The standard ''system fields'' are:
:*Populated automatically when a record is added or updated in the GUI.
:::*Common to all objects (predefined)
:*Required when a record is added or updated using an API.
:::*Created automatically when an object is created
:::*Populated automatically when a record is saved/updated


::{| border="1" cellpadding="5" cellspacing="0"
:{| border="1" cellpadding="5" cellspacing="0"
!Label
!Field Name
!Field Name
!REST Search Name
!REST Search Name
!GUI Label
!Display Type
!Display Type
!Description
!Description
|-
|-
| || || Object ID || Number||Unique identifier for the object
| 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
| Record ID ||id ||id || Number||Unique record identifier
|-
|-
|owner_id ||OWNERID || Owner || String||Unique identifier of the record's owner
| Owner ||owner_id ||OWNERID || String||Unique identifier of the record's owner
|-
|-
|owner_team_id ||OWNER_TEAM_ID || || String||Unique identifier of record owner's team
| Created By ||created_id ||CREATEDID || String||Unique identifier of the user who created the record
|-
|-
|date_modified ||DATEMODIFIED || Date Modified || String||Date the record was last modified
| Date Created ||date_created ||DATECREATED || 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_created ||DATECREATED || || String||Date the record was created
| Modified By ||modified_id ||MODIFIEDID || String||Unique identifier of the user who last modified the record
|-
|-
|created_id ||CREATEDID || || String||Unique identifier of the the user who created the record
| Date Modified ||date_modified ||DATEMODIFIED || String||Date the record was last modified:
|-
:* [[UTC Format]] in the [[REST API]].
|modified_id ||MODIFIEDID || Modified By || String||Unique identifier of the user who last modified the record
:* User's [[Date#Date/Time Formats|Date Format]] in the GUI and the Java API.
|}
|}


==Workflow Fields==
See also: [[Standard Parameters]]
The standard ''workflow'' fields are:
:::* Common to all custom objects (predefined)
:::*Created automatically when an object is created
:::*Populated automatically when actions are taken
 
::{| border="1" cellpadding="5" cellspacing="0"
!Field Name
!REST Search Name
!GUI Label
!Display Type
!Description
|-
| workflow_owner ||  || Workflow Owner(s) || String || Unique {{TBD|identifier??? Array??}} of the user(s) who can advance the record to the next stage of processing in the workflow.
|-
|  ||  || Workflow State || String || Current state the record is in, with respect to the workflow process.
|-
|  ||  || Workflow State Change Date || String || Date the workflow state changed.
|}

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