Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Quinyx Forecast Events API

The Forecast Events API from Quinyx — 4 operation(s) for forecast events.

Quinyx Forecast Events API is one of 35 APIs that Quinyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Forecast Events. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 2 base URLs: https://api.quinyx.com, https://api-rc.quinyx.com.

6 operations 4 paths 6 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.eu.quinyx.com
Authentication
OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Quinyx Forecast Events API declares 7 security schemes for authenticating requests. It supports OAuth 2.0 (employee_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (opening-hours_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (organisation_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (rest-api-uaa_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule-availability_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (statistics_OAuth2ClientCredentials) using the clientCredentials flow.

  • employee_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • opening-hours_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • organisation_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • rest-api-uaa_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule-availability_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • statistics_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Forecast Events 6
PUT
/v2/forecast-events/groups/{groupId}/events/{eventId}
Update forecast event
updateEvent 2 params body → 200
DELETE
/v2/forecast-events/groups/{groupId}/events/{eventId}
Delete forecast event
deleteEvent 2 params → 200
GET
/v2/forecast-events/groups/{groupId}/events
List forecast events for group
getIntegrationEvents 3 params → 200
POST
/v2/forecast-events/groups/{groupId}/events
List forecast events for group and its ancestors
getGroupHierarchyIntegrationEvents 1 param body → 200
POST
/v2/forecast-events/groups/{groupId}/event
Create forecast events for forecast configurations and groups
createIntegrationEvent 1 param body → 200
GET
/v2/forecast-events/groups/{groupId}/events/{eventId}/overrides
List override events for forecast event
getIntegrationEventsByEventId 2 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are forecast-events_Event (11 properties), forecast-events_IntegrationEvent (11 properties), forecast-events_CreateEventIntegrationRequest (10 properties), forecast-events_UpdateEventIntegrationRequest (7 properties). Each schema is shown below with its type and property counts.

forecast-events_IntegrationEvent
object
11 properties 4 required
forecast-events_GroupHierarchyEventsExternalRequest
object
4 properties 4 required
forecast-events_EventEffect
object
3 properties 3 required
forecast-events_CreateEventIntegrationRequest
object
10 properties 6 required
forecast-events_UpdateEventIntegrationRequest
object
7 properties 4 required
forecast-events_Event
object
11 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quinyx-forecast-events-api-openapi.yml Raw ↑

Other APIs Quinyx publishes across the network.

Quinyx Absence Schedules API
Quinyx Absence Types API
Quinyx Absences API
Quinyx Access Token API
Quinyx Agreements API
Quinyx AI Scheduled Headcount API
Quinyx Authentication API
Quinyx Collaboration Groups API
Quinyx Collaboration Groups Labels API
Quinyx Employee API
Quinyx Employees API
Quinyx Forecast Data API