v3

latestSwagger 2.02026-08-067506752.0 MB

budget-pool

Get a specific budget pool

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

idstring required

ID of the desired budget pool

Response

successful operation

idstring required

globally unique id

orgIdstring required

parent organization id (empty if built-in)

compReviewIdstring required

the ID of the comp review this budget is for

labelstring required

unique label

participantsExprstring

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

appliedFieldstring required

the field this budget pool applies to

sourceFieldstring required

the field this budget pool is calculated from

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

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

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",
  "appliedField": "base",
  "sourceField": "base",
  "visibilityPersonIds": [
    "588f7ee98f138b19220041a7"
  ],
  "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"
}