Skip to main content
POST
Create workload scheme

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Body

application/json

Workload scheme values and stable integration identifier.

name
string
required
Required string length: 2 - 100
Pattern: \S
Example:

"Standard full-time"

mondayHours
integer<int32>
required
Required range: 0 <= x <= 24
tuesdayHours
integer<int32>
required
Required range: 0 <= x <= 24
wednesdayHours
integer<int32>
required
Required range: 0 <= x <= 24
thursdayHours
integer<int32>
required
Required range: 0 <= x <= 24
fridayHours
integer<int32>
required
Required range: 0 <= x <= 24
saturdayHours
integer<int32>
required
Required range: 0 <= x <= 24
sundayHours
integer<int32>
required
Required range: 0 <= x <= 24
externalId
string
Maximum string length: 255
Example:

"WORKLOAD_STANDARD_FULL_TIME"

description
string
Maximum string length: 300

Response

Workload scheme created

data
object
meta
object