API Reference
  1. Bench API V2
  2. Unavailabilities

Adds a period of unavailability to a person, optionally creating backfill allocation segments for specified roles.

post
https://bench.gobridgit.com/rp/api/v2/accounts//persons//unavailabilities

If createBackfillRoleIds is provided and non-empty, the person must be actively allocated to each
specified role during the unavailability period. Backfill is only allowed when type is TimeOff.
All operations (unavailability + backfill segments) are performed atomically.
Permissions
Private: Write
Person: Read
HourlyProfile: Read
Unavailabilities: Write
HourlyUnavailabilities: Write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The Account ID

int64
required

The Person ID

Body Params

The unavailability to create, with an optional list of role IDs to backfill

date-time
required
date-time
required
string | null
boolean
required
createBackfillRoleIds
array of int64s | null
createBackfillRoleIds
boolean
required

When true, backfill every role the person is allocated to during the unavailability,
ignoring ResourcePlanning.Contracts.UnavailabilityV2Request.CreateBackfillRoleIds.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

400

Bad Request

401

Unauthorized

403

Forbidden

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 1 month ago

Did this page help you?