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

Xerox Jobs API

Print job creation, management, and history operations

Xerox Jobs API is one of 9 APIs that Xerox 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 7 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 5.5.0.

Requests are made against a single base URL, https://publicprintapi.services.xerox.com/api/v1.

7 operations 4 paths 7 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
5.5.0
Base URL
https://publicprintapi.services.xerox.com/api/v1
Authentication
API Key, API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Xerox Jobs API declares 3 security schemes for authenticating requests. An API key is passed in the header as xrxauth (xrxauth). An API key is passed in the header as user-email (userEmail). An API key is passed in the header as appid (appId). By default, every request must be authenticated.

  • xrxauth — Xerox authentication credentials
  • userEmail — User email address for user-context requests
  • appId — Application identifier

Paths & Operations 7

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

Jobs 7

Print job creation, management, and history operations

PUT
/Job
Create Print Job
createJob body → 201400
GET
/Job
Get Print Job
getJob 1 param → 200400404
GET
/Job/Status
Get Job Status
getJobStatus 1 param → 200400404
POST
/Job/Status
Update Job Status
updateJobStatus body → 200400
GET
/Job/History
Get Job History
getJobHistory 2 params → 200400
DELETE
/Job/History
Clear Job History
clearJobHistory → 204400
GET
/Job/Options
Get Job Options
getJobOptions → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Job (7 properties), CreateJobRequest (4 properties), JobStatus (3 properties), JobOption (3 properties). Each schema is shown below with its type and property counts.

Job
object
A print job
7 properties
JobOptionsResponse
object
Available print job options
1 property
CreateJobRequest
object
Request body for creating a new print job
4 properties 1 required
JobOption
object
A supported print job option
3 properties
JobHistoryResponse
object
Paginated list of job history
2 properties
JobStatus
object
Status of a print job
3 properties
UpdateJobStatusRequest
object
Request to update job status
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xerox-jobs-api-openapi.yml Raw ↑

Other APIs Xerox publishes across the network.

Xerox Managed Print Services API
Xerox Extensible Interface Platform (EIP)
Xerox FreeFlow SDK
Xerox EULA API
Xerox Provider Types API
Xerox Providers API
Xerox Sites API
Xerox Status API