Frequency patterns

A frequency pattern is a Cúram specific datatype that is used to represent the frequency of an occurrence, for example, how often a meeting should be scheduled for. A frequency pattern is a nine digit, non-human readable, number.

For a Curam REST API resource representation, a frequency pattern is represented as a JSON object containing the following two properties:

value: The nine digit representation of a frequency pattern
description: The localized display text for a frequency pattern

The following is an example of a JSON object frequency pattern:

"frequency": {       
           "value": "100101600",       
           "description": "Recur every 1 week(s) on Friday"
}

For PUT and POST methods, only the value property is required to be provided. The description property is ignored if specified.

A shorthand way of specifying the frequency pattern value is also available, where the content of the value property can be passed up directly. The following inputs are accepted for a frequency pattern value in a PUT and POST method:

"frequency": {
     "value": "100101600","description": "Recur
      every 1 week(s) on Friday"
}

"frequency": {
     "value": "100101600"
}

"frequency": "100101600"