Predefined Keys

You can specify predefined keys along with the repository attributes.

  • RECORD_STATE: identifies the state of a record that is being searched. The RECORD_STATE key supports a list of multiple values separated by a comma. The following values are supported:
    • CONFIRMED: includes the confirmed records. This is the default value.
    • UNCONFIRMED: includes the unconfirmed records.
    • REJECTED: includes the rejected records.
    • DRAFT: includes the draft records.
      Note: The DRAFT record versions are owned by an event. The version is created during the event. To retrieve the DRAFT version records, you must specify the work item context.
    • LATEST: includes the confirmed or unconfirmed records.
    • ALL: includes all records with any state.
      Note: Specify the LATEST and ALL values to include multiple states of a record.
  • RECORD_VERSION: identifies the version of a record that is being searched. The following values are supported:
    • Integer: includes a number for a single record query.
    • ALL and ACTIVE: retrieves all versions of a record based on the specified criteria.