< Previous | Next >

Working with records

An Entity object represents a record in a Rational® ClearQuest® user database. You can view, modify, and create records by using methods of the Session object.
In this module, you learn about the Rational ClearQuest API objects and methods to view, modify, and create a record and the data it contains.

When users enter change requests, the data is stored in a logical record called an entity.

An Entity refers to a structure that organizes the information available for a single instance of a record type (EntityDef), such as defect. Each instance of the Entity class provides access to the values in any defined field types of the record, including a list of the duplicates of the record, the history of the record, and any file attachments.

You can use the Rational ClearQuest API to view, edit, and create record and record type data by using these methods of the Session object:
  • GetEntity method to view an existing record
  • EditEntity method to edit an existing record
  • BuildEntity method to create a new record

The Rational ClearQuest API also provides methods for validating changes and committing the updated record to the database.

Learning objectives

After completing the lessons in this module you will know understand the concepts and know how to do the following:
  • View a record
  • View the fields of a record
  • Modify a record
  • Create a new record

Time required

This module should take approximately 30 minutes to complete.
< Previous | Next >