Example RECORD_VERSION with ALL value and Active

RECORD_VERSION with ALL value and active retrieves all versions of a record based on the specified criteria.

In the prior releases, if you had specified RECORD_VERSION=ALL, all versions were retrieved in the response except for the DRAFT records. Additionally, the deleted versions were also retrieved. 

<ExternalKeys>
<Key name="RECORD_VERSION"operator="eq">ALL</Key>
<Key name="RECORD_STATE">ALL</Key>
<Key name="ACTIVE" type="string">ANY</Key>
</ExternalKeys>
Note: Only the eq operator is supported for the RECORD_VERSION key.

From 8.3 release onwards, if you specify RECORD_VERSION=ALL, all CONFIRMED and ACTIVE versions are retrieved in the response. However, if the default value of the RECORD_STATE and ACTIVE keys is used for filtering, the retrieved versions may not be all. Therefore, to retrieve all versions of a record, specify the following multiple combination of keys:

  • ACTIVE: Queries whether or not the deleted records included in the response. The valid values for this key are:
    • Y: Only active records are retrieved. Query does not return any deleted record. This is the default.
    • N: Only data for deleted records is retrieved. Query does not return any active record.
    • ANY: Indicates that both active and deleted records are retrieved, that is both ACTIVE = Y and ACTIVE = N values are considered.
      Note: If you specify the value other than the valid values, Y is assumed.