What are cut labels and how are they used?

Do I need to specify a timestamp for every Effective Date in LUSID?

In order to simplify the usage of LUSID in a global scenario (with times across multiple timezones) LUSID allows you to pre-configure "cut labels" which can then be used in place of timestamps.

Cut Labels allow clients to specify a timestamp to the LUSID APIs using a previously defined user-readable name. A Cut Label can be used wherever an effectiveAt is supplied to LUSID, i.e. in both queries and upsert requests.

 

Definition

A Cut Label is defined as

  • A named timezone, and
  • A specific local time in that timezone (expressed in hours and minutes).

Usage

Cut Labels can be used in place of dates in calls to LUSID. 

The standard date formats that LUSID expects are documented - please see here. To use a cut label instead, simply replace the T separator with N, and replace the time component with the cut label.

For example:

  • 2018-08-31T07:36:53.523415Z = Standard UTC timestamp
  • 2018-08-31T07:36:53.523415+01:00 = UTC offset time
  • 2018-08-31NSingaporeClose = Using the cut label identified with the code "SingaporeClose" and the local date of 31st August 2018