System Object Types

From AgileApps Support Wiki
Revision as of 02:13, 24 September 2013 by imported>Aeric (→‎Adding and Accessing Records)

Main System Objects

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

Related System Objects

__TBD: Move User_Team object here??__

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 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.
Learn more: Multi Object Lookup
History history
Tasks tasks

Viewing the Related System Objects

--the main System Objects are visible, by default

--4 steps
--after step __???__, object fields visible
--after step 4, records are visible

Adding and Accessing Related System Object Records

Considerations:

  • Add attachments and tasks to the appropriate object.
  • Inspect those objects to get a list. Filter it to get the items that relate a particular record.
  • Add private notes to the History object, specifying the category field with value="29"
  • To get a list of private notes attached to a record, inspect the History object. Filter it to:
  • Return only those items where the related_to field matches the record of interest
  • Return only those items where the category field has the value "29" (a string).

Learn more:

-Java Code Samples
--link back here to view the Related System Objects
Java record APIs to search and manage records
--Java REST record Resource to search and manage records using REST APIs
(Use the same patterns as in the Java code samples.)