v3

latestSwagger 2.02026-08-067506752.0 MB

guideline

Get a specific guideline

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

idstring required

ID of the desired guideline

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent organization id

compReviewIdstring required

comp review id

labelstring required

guideline name

budgetPoolIdstring

the budget pool the guideline is allocated from

participantsExprstring

CQL filter to determine which employees the guideline applies to

appliedFieldstring required

the field the guideline applies to

sourceFieldstring required

the field the guideline is calculated from

calculationType'RANGE' | 'TARGET' required

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

flagMode'DEVIATION_THRESHOLD' | 'NONE' required

how does the guideline indicate deviations from the target amount

flagDeviationThresholdnumber

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

enablePopulateValueboolean required

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

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

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

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "compReviewId": "588f7ee98f138b19220041a7",
  "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)",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z"
}