System Object Types

From AgileApps Support Wiki

Main System Objects

The main 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 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

Notepad.png

Note:
USER_TEAM is the Junction Object that allows a User to belong to multiple Teams, and a Team to have multiple Users.

Related System Objects

These objects are related to records in other objects. By default. these objects are not visible as independent entities in the UI, because end users and even designers have little need to see them. In general, then, the records they contain can be see only by viewing the records they are related to.

They can, however, be accessed programmatically:

System Object Object Type Identifier Reference Information
Attachments attachments In each record, the Multi Object Lookup field related_to references the object and record that the item relates to. For example: "cases:345rjkz921", where 345rjkz921 is the ID of a record in the cases object.
History history
Tasks tasks

Viewing the Related System Objects and other "Hidden" System Objects

For developers who are working with the Related System Objects need to make them visible, both to inspect their properties and to view the records they contain (generally while debugging). The same process applies to other System Objects that are hidden by default: Users, Teams, and the User_Team object.

Thumbsup.gif

Tip:
You can easily add Fields to the Users object, and add Rules to both Users and Teams, without going to these lengths. See the Customization Capabilities for the main system objects, earlier on this page.

To view a Related System Object:

--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.)