budget-pool

Update a budget pool

patch/v1/org/{orgId}/budget-pool/{id}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/budget-pool/{id}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug

idstring required

ID of the desired budget pool

Request body

labelstring

unique label

participantsExprstring

expression that determines if a particular job is included in this budget pool

appliedFieldstring

the field this budget pool applies to

sourceFieldstring

the field this budget pool is calculated from

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

the method for calculating the amount in the budget

fixedValuenumber

a fixed amount for the budget (used with basisType=FIXED || basisType=PERCENTAGE)

fixedBudgetMapobject

a map of reviewer job IDs to fixed budget money amounts

basisExprstring

expression that calculates how much each job contributes to the budget (used with basisType=CUSTOM)

defaultCurrencystring

Default currency used when calculating budget pool, falls back to org primary currency if not set

visibilityType'DEFAULT' | 'ROLE_SELECTION' | 'SPECIFIC_PEOPLE' | 'CUSTOM_CQL'

Controls who can view this budget

visibilityExprstring

CQL expression evaluated on the user to determine visibility (used with visibilityType=CUSTOM_CQL)

visibilityPersonIdsstring[]

Set of person IDs who can view this budget (used with visibilityType=SPECIFIC_PEOPLE)

sortinteger

sort order for sequential budget allocation priority

Example request

{
  "label": "Merit",
  "appliedField": "base",
  "sourceField": "base",
  "visibilityPersonIds": [
    "588f7ee98f138b19220041a7"
  ]
}

Changes

No recorded changes to this operation across all 22 revisions of this API.