| Field | Required | Description |
|---|---|---|
timeZone | true | IANA timezone identifier (e.g., Europe/Berlin, America/New_York, UTC). The zone the local date-time values in timed events are meant in, for whoever expands the recurrence rule. |
events | true | Non-empty array of time slots, each with a start time, end time or duration, and an optional recurrence rule |
active | false | Boolean. Turns the schedule's checks on or off without deleting it. The API stores it as given and doesn't fill it in. Treat a missing value as true. |
description | false | Free-text description. The schedule's display name is the entity title, not this field. |
| Field | Required | Description |
|---|---|---|
start | Yes | Start date-time for timed events (2025-01-06T06:00:00) or date for all-day events (2025-01-06). Seconds required. No fractional seconds. No offset or Z. |
end | Conditional | End date-time (or date for all-day). Can't be combined with duration. A timed event needs exactly one of end or duration. An all-day event may omit both. |
duration | Conditional | Duration in ISO 8601 format (e.g., PT9H, PT30M, P1D). Can't be combined with end. Must be positive. For all-day events, must be whole days with no time component (e.g., P1D, P14D). Week, month and year forms (P2W, P1M, P1Y) are rejected. Preferred over end for recurring events because it stays stable across DST changes. |
showWithoutTime | No | When true, the event is all-day: start and end are dates, and the event ignores timeZone. All-day recurrence rules must not use byHour, byMinute, or bySecond. |
recurrenceRule | No | Recurrence rule defining the repeat pattern. Absent means a single occurrence at start. |
excludedDates | No | Array of local date-times to exclude from recurrence (iCalendar EXDATE). The API checks only the format of each entry and stores it as given. |
additionalDates | No | Array of local date-times to add as one-off occurrences (iCalendar RDATE). |
uid | No | Stable string identifier for the slot. Useful when tracking individual events across updates. |
title | No | Display label for this event slot (maps to VEVENT SUMMARY). |
| Field | Type | Description |
|---|---|---|
frequency | String | Required. One of: secondly, minutely, hourly, daily, weekly, monthly, yearly. Lowercase. |
interval | Integer | Repeat every N periods. Must be ≥ 1. Defaults to 1. |
count | Integer | Stop after N occurrences. Can't be combined with until. |
until | String | Stop after this local date-time. Must be ≥ start. Can't be combined with count. |
byDay | Object[] | Days of the week. Each entry is { "day": "<mo|tu|we|th|fr|sa|su>", "nthOfPeriod": <integer> }. The optional nthOfPeriod sets an ordinal (e.g., { "day": "mo", "nthOfPeriod": 1 } = first Monday of the period) and is only valid for monthly or yearly frequency. |
byMonth | Integer[] | Months: 1–12. |
byMonthDay | Integer[] | Days of the month: 1–31, or -31 to -1 from the end (-1 = last day). |
byYearDay | Integer[] | Days of the year: 1–366, or -366 to -1 from the end. |
byWeekNo | Integer[] | Weeks of the year: 1–53, or -53 to -1. Valid only with yearly frequency. |
byHour | Integer[] | Hours: 0–23. Must not be used on all-day events. |
byMinute | Integer[] | Minutes: 0–59. Must not be used on all-day events. |
bySecond | Integer[] | Seconds: 0–60 (60 is valid for leap seconds). Must not be used on all-day events. |
firstDayOfWeek | String | First day of the week for week calculations. One of mo–su. Defaults to mo. (iCalendar WKST.) |
`. Detach the schedule from them first, as shown above. If the field is required, give it another schedule instead. Then run this mutation:
```graphql
mutation DeleteMaintenanceSchedule {
bdr {
scheduleDelete(input: {
id: "019a6b2f-793e-807b-8001-534348440001"
version: 4
}) {
deletedId
}
}
}
```
Response:
```json
{
"data": {
"bdr": {
"scheduleDelete": {
"deletedId": "019a6b2f-793e-807b-8001-534348440001"
}
}
}
}
```
Including `version` ensures you don't accidentally delete a schedule that someone else has modified. If the version doesn't match, you'll receive a [conflict error](/docs/navixy-graphql-api/error-handling.md#version-conflict-409). See [Optimistic locking](/docs/navixy-graphql-api/optimistic-locking.md) for details on when to omit it.
## See also
* [Schedules](/docs/navixy-graphql-api/products/business-data-repository/api-reference/schedules.md): Complete reference for all schedule operations and types
* [Defining and using custom fields](/docs/navixy-graphql-api/products/business-data-repository/guides/defining-and-using-custom-fields.md): Define custom fields and store your own data on entities
* [Creating assets and assigning devices](/docs/navixy-graphql-api/products/business-data-repository/guides/creating-assets-and-assigning-devices.md): Create and manage assets such as vehicles and equipment
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/guides/defining-recurring-schedules.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.