Getting resources "as of" a certain date

In some situations, a system API call may need to retrieve an effective-dated resource as of a specific date. For example, a GET may need to retrieve policy pc:10 not as it exists today but as it existed on January 1, 2019. To achieve this, several job and policy endpoints support an asOfDate parameter. You can use this parameter to retrieve data about a resource as it existed at a given point in time. The syntax is:


For example, the following query returns policy pc:10 as it existed on January 1, 2019:

GET /policies/pc:10?asOfDate=2019-01-01

If you query for a policy at a point in time before its effective date or after its expiration date, you will get a BadInputException with the user message similar to the following: "Bad value for the 'asOfDate' query parameter - No branch found for date 01/01/2019 12:00 AM".