Difference between revisions of "System Object Types"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 7: Line 7:
! Customization Capabilities
! Customization Capabilities
|-
|-
|[[Case]]||<tt>CASE</tt> || [[REST API:record Resource]] || Virtually unlimited ability to [[Objects|Customize Objects]]
|[[Case]]||<tt>cases</tt> || [[REST API:record Resource]] || Virtually unlimited ability to [[Objects|Customize Objects]]
|-
|-
|[[Role]]||<tt>ROLE</tt> || [[REST API:role Resource]] || none
|[[Role]]||<tt>ROLE</tt> || [[REST API:role Resource]] || none
Line 30: Line 30:
!System Object
!System Object
!Object Type Identifier
!Object Type Identifier
!Reference Information
! Comments
! Reference Information
|-
|-
| Attachments
| Attachments
| attachments
| attachments
| rowspan="3"| Use the [[REST API:record Resource]] to manage records. In each record, set the muli-object lookup field, <tt>related_to</tt> to reference the object and record the item relates to. For example: <tt>"CASE:345rjkz921"</tt>, where <tt>345rjkz921</tt> is the ID of a record in the Cases object.
|
| rowspan="3"| In each record, set the muli-object lookup field, <tt>related_to</tt> to reference the object and record the item relates to. For example: <tt>"cases:345rjkz921"</tt>, where <tt>345rjkz921</tt> is the ID of a record in the <tt>cases</tt> object.


|-
|-
| Notes
| History
| notes
| history
| Private notes plus a record of case activities


|-
|-
| Tasks
| Tasks
| tasks
| tasks
 
|
|}
|}

Revision as of 01:53, 24 September 2013

System Objects are listed here, showing the names that appear in the UI, along with the object-type identifiers used in the APIs.

System Object
(As shown in the Platform UI)
Object Type Identifier
Reference Information Customization Capabilities
Case cases REST API:record Resource Virtually unlimited ability to Customize Objects
Role ROLE REST API:role Resource none
User USER REST API:user Resource
Team TEAM REST API:team Resource
User Team USER_TEAM REST API:userTeam Resource none

These objects are related to records in other objects. The objects are not visible as independent entities in the UI. The records they contain can be see only by viewing the records they are related to. However, they can be accessed programmatically:

System Object Object Type Identifier Comments Reference Information
Attachments attachments In each record, set the muli-object lookup field, related_to to reference the object and record the item relates to. For example: "cases:345rjkz921", where 345rjkz921 is the ID of a record in the cases object.
History history Private notes plus a record of case activities
Tasks tasks