POST /api/schedule/plans/{id}/generate-events/

post

https://<subdomain>.huvrdata.app/api/schedule/plans/{id}/generate-events/

Generate Events for a SchedulePlan

Required permissions:

IsAuthenticated
WorkspaceRequired
HasRolePermissions::schedule_plan_create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

local_timezone

string

required

created_by

object

asset

object

required

crew

object

required

owner

object

is_active

boolean

Is entity active

deactivated_on

date-time | null

name

string

required

length between 1 and 100

description

string

Description of the schedule plan.

start

date-time

Plan start date.

end

date-time | null

Plan end date (Optional).

recurrence_type

string

enum

How is the schedule defined. Periodic, Manual, etc

Allowed:

recurrence_rule

string

Recurrence rule for future events.

event_duration

string

length between 1 and 50

Event length, defined as interval in ISO8601 duration format: P5D (5 days)

creation_window

string

length ≤ 50

Pauses event creation until the defined duration before upcoming event, defined as ISO8601 duration format: P5D (5 days).

event_count

integer

-32768 to 32767

Number of events in the future that exist in the database.

event_name_template

string

Template to dynamically build event name.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

application/yaml

200