Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
guideline

Update a guideline

patch/v1/org/{orgId}/guideline/{id}

Path parameters

orgIdstring required
idstring required

Request body

labelstring

guideline name

budgetPoolIdstring

the budget pool the guideline is allocated from

participantsExprstring

CQL filter to determine which employees the guideline applies to

appliedFieldstring

the field the guideline applies to

sourceFieldstring

the field the guideline is calculated from

calculationType'RANGE' | 'TARGET'

how does the guideline calculate the target value? e.g. is there a range (min/max) or only a target

flagMode'DEVIATION_THRESHOLD' | 'NONE'

how does the guideline indicate deviations from the target amount

flagDeviationThresholdnumber

the threshold (percent) against which deviations from the guideline are flagged

enablePopulateValueboolean

whether or not the target values from the guidelines are pre-populated in the given columns

basisType'CUSTOM' | 'FIXED' | 'CUSTOM_FIXED' | 'PERCENTAGE' | 'CUSTOM_PERCENTAGE'

how an individual guideline value itself is calculated, e.g. percentage of the appliedField, fixed amount, or custom CQL

basisExprstring

if basisType.CUSTOM, the custom CQL expression used to generate the guideline value

Example request

{
  "label": "Merit Guideline",
  "budgetPoolId": "588f7ee98f138b19220041a7",
  "participantsExpr": "is:person and tenure>=12",
  "appliedField": "'base' or 'grantShares'",
  "sourceField": "'base' or 'grantShares'",
  "calculationType": "TARGET",
  "flagMode": "NONE",
  "basisType": "CUSTOM",
  "basisExpr": "tenure>12 ? (base * 0.04) : (base * 0.02)"
}

Response

No Content