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

When I Work OpenShift Requests API

Shift Bidding, also called “OpenShift Requests”, is an option within an OpenShift that allows employees to express interest in the shift. Management can then view who has requested to pick up the OpenShift and select and approve an employee to work the shift.For more info about using OpenShift Requests, visit the [Help Center](https://help.wheniwork.com/articles/shift-bidding/).

When I Work OpenShift Requests API is one of 22 APIs that When I Work publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include OpenShift Requests. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and 8 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.wheniwork.com.

5 operations 3 paths 5 schemas 2 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.wheniwork.com/2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

When I Work OpenShift Requests API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JSON Web Token) (W-Token). By default, every request must be authenticated.

  • W-Token — Authentication with When I Work is based on a token model using [JSON Web Tokens](https://jwt.io/). First, you authenticate using a private developer key and t…

Paths & Operations 5

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

OpenShift Requests 5

Shift Bidding, also called “OpenShift Requests”, is an option within an OpenShift that allows employees to express interest in the shift. Management can then view who has requeste…

GET
/2/openshiftapprovalrequests
List OpenShift Approval Requests
4 params → 200
DELETE
/2/openshiftapprovalrequests/{request_id}
Delete an OpenShift Approval Request.
1 param → 200
GET
/2/openshiftapprovalrequests/{request_id}
Get specific OpenShift Approval Request
1 param → 200
PUT
/2/openshiftapprovalrequests/{request_id}
Update an OpenShift Approval Request.
1 param body → 200
DELETE
/2/openshiftapprovarequests/{request_id}/user-requests
Cancel an individual's request for an OpenShift
1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Shift (30 properties), OpenShiftApprovalRequest (12 properties), BaseScheduledBreak (9 properties), OpenShiftApprovalRequestUser (4 properties). Each schema is shown below with its type and property counts.

ShiftScheduledBreak
BaseScheduledBreak
object
9 properties 2 required
OpenShiftApprovalRequestUser
object
4 properties
Shift
object
30 properties 3 required
OpenShiftApprovalRequest
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

when-i-work-openshift-requests-api-openapi.yml Raw ↑

Other APIs When I Work publishes across the network.

When I Work Accounts API
When I Work Annotations API
When I Work Availabilities API
When I Work Import API
When I Work Payrolls API
When I Work Positions API
When I Work Punch API
When I Work Request Type API
When I Work Schedule Templates API
When I Work Schedules (Locations) API
When I Work Shift Break - Paid Rest API
When I Work Shift Breaks API