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

JAGGAER Jobs API

Optimization job management operations

JAGGAER Jobs API is one of 16 APIs that JAGGAER publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against a single base URL, https://ches.aso-api.jaggaer.com.

4 operations 4 paths 6 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v26.0.0.4
Base URL
https://ches.aso-api.jaggaer.com/
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

JAGGAER Jobs API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as X-Api-Key (apiKeyHeader). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 bearer token for authentication.
  • apiKeyHeader — API key passed as a request header.

Paths & Operations 4

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

Jobs 4

Optimization job management operations

POST
/submitJob
Submit Job
submitJob 2 params body → 200422429
POST
/cancelJob/{job-id}
Cancel Job
cancelJob 3 params → 201404422
GET
/jobStatus/{job-id}
Job Status
getJobStatus 2 params → 200404
GET
/job/{job-id}
Job
getJob 2 params → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are JobResponse (16 properties), SubmitJobRequest (7 properties), JobStatusResponse (1 property), SubmitJobResponse (1 property). Each schema is shown below with its type and property counts.

QuayRateLimitResponse
object
Rate limit error response returned when a customer exceeds their configured optimization job limits.
1 property
JobResponse
object
Full details for an optimization job.
16 properties 16 required
QuayErrorResponse
object
Error response from the Quay service.
1 property
SubmitJobResponse
object
Response for a successful job submission.
1 property
JobStatusResponse
object
Current status of an optimization job.
1 property 1 required
SubmitJobRequest
object
Request body for submitting an optimization job to Quay.
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jaggaer-jobs-api-openapi.yml Raw ↑

Other APIs JAGGAER publishes across the network.

JAGGAER Async API
JAGGAER Attributes API
JAGGAER Awards API
JAGGAER Bids API
JAGGAER Contacts API
JAGGAER Customer Hosts API
JAGGAER Events API
JAGGAER Items API
JAGGAER Locations API
JAGGAER Rates API
JAGGAER Scenarios API
JAGGAER Suppliers API