> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/api-reference/efalia-process-api/agentcalendar.md).
# AgentCalendar
## Create New Agent Calendar
> \Workflow Manager\\
> \### Note\
> Only JSON input is currently supported.
```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"AgentCalendar","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"AgentCalendar":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"cronExpression":{"type":"string"},"excludedDates":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendarDate"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"AgentCalendarDate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/AgentCalendarDateType"},"formatedDate":{"type":"string"}}},"AgentCalendarDateType":{"type":"string","enum":["ANNUAL","CRON","HOLIDAY","WEEKLY","DAILY"]},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/agentCalendar":{"post":{"summary":"Create New Agent Calendar","description":"Workflow Manager\n### Note\nOnly JSON input is currently supported.","operationId":"createCalendar","deprecated":false,"tags":["AgentCalendar"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCalendar"}}}},"responses":{"200":{"description":"Calendar #{calendarId} created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```
## Get Agent Calendar Detail
> Get the description of an agent calendar.\
> \
> \Workflow Manager\
```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"AgentCalendar","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"AgentCalendar":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"cronExpression":{"type":"string"},"excludedDates":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendarDate"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"AgentCalendarDate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/AgentCalendarDateType"},"formatedDate":{"type":"string"}}},"AgentCalendarDateType":{"type":"string","enum":["ANNUAL","CRON","HOLIDAY","WEEKLY","DAILY"]},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/agentCalendar/{calendarId}":{"get":{"summary":"Get Agent Calendar Detail","description":"Get the description of an agent calendar.\n\nWorkflow Manager","operationId":"getAgentCalendar","deprecated":false,"tags":["AgentCalendar"],"parameters":[{"name":"calendarId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` or the ``name`` (must be unique) of the calendar."}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCalendar"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"404":{"description":"No calendar \"{calendarId}\" found"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```
## Update Existing Calendar
> \Workflow Manager\\
> \### Note\
> Only JSON input is currently supported.
```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"AgentCalendar","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"AgentCalendar":{"allOf":[{"$ref":"#/components/schemas/WorkeyObject"},{"type":"object","properties":{"cronExpression":{"type":"string"},"excludedDates":{"type":"array","items":{"$ref":"#/components/schemas/AgentCalendarDate"}}}}]},"WorkeyObject":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"}}},"AgentCalendarDate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"date":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/AgentCalendarDateType"},"formatedDate":{"type":"string"}}},"AgentCalendarDateType":{"type":"string","enum":["ANNUAL","CRON","HOLIDAY","WEEKLY","DAILY"]},"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/agentCalendar/{calendarId}":{"put":{"summary":"Update Existing Calendar","description":"Workflow Manager\n### Note\nOnly JSON input is currently supported.","operationId":"updateCalendar","deprecated":false,"tags":["AgentCalendar"],"parameters":[{"name":"calendarId","in":"path","required":true,"schema":{"type":"string"},"description":"The ``Id`` of the calendar to update"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCalendar"}}}},"responses":{"200":{"description":"Calendar #{calendarId} updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```
## Remove Calendar
> \Workflow Manager\
```json
{"openapi":"3.0.0","info":{"title":"Efalia Process API","version":"6.36.1"},"tags":[{"name":"AgentCalendar","description":""}],"servers":[{"url":"http://{hostname}/{workeyContext}/api/","variables":{"hostname":{"default":"localhost:8080","description":"Hostname and port of the Workey server"},"workeyContext":{"default":"workey","description":"Name of the running context of Workey"}}}],"security":[{"Basic":[]},{"Bearer":[]},{"ApiKey":[],"ApiKeyImpersonate":[]}],"components":{"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Value: Basic {encode username:password}"},"Bearer":{"type":"http","scheme":"bearer","description":"Value: Bearer {jwt}"},"ApiKey":{"type":"apiKey","name":"X-API-KEY","in":"header","description":"API key defined in Process configuration."}},"schemas":{"RestMessage":{"type":"object","properties":{"code":{"type":"integer"},"error":{"type":"boolean"},"message":{"type":"string"},"cause":{"$ref":"#/components/schemas/ErrorCause"}}},"ErrorCause":{"type":"object","properties":{"className":{"type":"string"},"method":{"type":"string"},"line":{"type":"integer"},"stackTrace":{"type":"object"}}}},"responses":{"WorkeyUnauthorized":{"description":"Unauthorized Workey access error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"WorkeyError":{"description":"Unexpected Workey Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}}}},"paths":{"/agentCalendar/{calendarId}":{"delete":{"summary":"Remove Calendar","description":"Workflow Manager","operationId":"removeCalendar","deprecated":false,"tags":["AgentCalendar"],"parameters":[{"name":"calendarId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Calendar #{calendarId} removed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessage"}}}},"401":{"$ref":"#/components/responses/WorkeyUnauthorized"},"555":{"$ref":"#/components/responses/WorkeyError"}}}}}}
```
---
# 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 dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://documentation.efalia.com/api-reference/efalia-process-api/agentcalendar.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
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.