Untether LabsDevelopers

Get Demand Config

gethttps://app.untetherlabs.com/api/v1/forecasting/demand-config/{teamId}

Get a team's demand configuration: for each role, the extra columns POST /v1/forecasting/demand accepts and the values each allows.

  • An axis with mode: "column" is an upload column. column is its CSV header or JSON key, and values are the values a cell accepts, matched exactly. An empty cell means any value.
  • An axis with mode: "ratio" is a fixed split of the role's demand across the values of a licensed-region skill, used when demand is filtered by region. It is not an upload column.

roleAxis is how the team's demand maps to its roles.

Path parameters#

teamIduuid
Required

The id of a team.

Response 200#

teamIduuid
Required

The team.

roleAxisone of
Required

The team's role axis.

Option 1 — RoleAxisColumn
modeenum
Required
column
Option 2 — RoleAxisNotUsed
modeenum
Required
not_used
Option 3 — RoleAxisRatio
modeenum
Required
ratio
ratiosobject
Required

The fraction of the team total each role receives, keyed by role id. Every key must be a role of this team and the fractions must sum to 1.

Show values
<key>number· min 0 · max 1
rolesDemandConfigRole[]
Required

Every role of the team, by name.

Show DemandConfigRole properties
roleIduuid
Required

The role, as the role column of an upload names it.

roleNamestring
Required

The name of the role.

axesSkillAxis[]
Required

The role's skill axes. Empty when its demand is not broken down by any skill.

Option 1 — SkillAxisColumn
skillIduuid
Required

The skill the axis breaks demand down by.

skillNamestring
Required

The name of that skill.

modeenum
Required
column
columnstring
Required

The CSV column (or JSON key) that carries this skill in an upload for the role.

valuesstring[]
Required

The values a cell in the column may hold, matched exactly.

Option 2 — SkillAxisRatio
skillIduuid
Required

The skill the axis breaks demand down by.

skillNamestring
Required

The name of that skill.

modeenum
Required
ratio
ratiosobject
Required

The fraction of the role's demand in each of the skill's values, keyed by value. Every key must be one of the skill's values and the fractions must sum to 1.

Show values
<key>number· min 0 · max 1

Errors#

validation400

Input validation failed.

Show extension members
pathstring
messagestring
Required
team-not-found404

A specified team does not exist in the system.