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 Mappings API

The Mappings API from Quinyx — 5 operation(s) for mappings.

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

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

This API exposes 6 operations across 5 paths, and defines 5 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 5 paths 5 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 Mappings 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 5 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.

Mappings 6
PUT
/v2/mapping/{mappingId}
Update mapping
update 1 param body → 200400401403404501
DELETE
/v2/mapping/{mappingId}
Delete mapping
delete 1 param → 204400401403404
POST
/v2/mapping/groups/{domainGroupId}
Create mapping
save 1 param body → 201400401403404501
POST
/v2/mapping/domains/{domainId}/mappings/{mappingType}
Search mappings by domain and type
getMappings 2 params body → 200400401403404
GET
/v2/mapping/mappingTypes
List existing mapping types that can be used in a request
getMappingTypes → 200400401403
GET
/v2/mapping/mappingTypes/{mappingType}/mappings
List mappings by type
getMappings_1 3 params → 200400401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are mapping_ValidationError (6 properties), mapping_MappingResponse (5 properties), mapping_MappingRequest (4 properties), mapping_MappingValues (2 properties). Each schema is shown below with its type and property counts.

mapping_MappingRequest
object
4 properties 2 required
mapping_MappingValues
object
2 properties
mapping_MappingResponse
object
5 properties
mapping_MappingExternalValueRequest
object
1 property 1 required
mapping_ValidationError
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quinyx-mappings-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