seal-rest

Version: 14.37.2

Schemes:

Summary

Path Operation Description
/ GET

GET /
/openapi GET

GET /openapi
/openapi.yaml GET

GET /openapi.yaml
/swagger GET

GET /swagger
/swagger.yaml GET

GET /swagger.yaml
/v3/ GET

GET /v3/
/v3/auth/userroles GET

GET /v3/auth/userroles
/v3/configs/ DELETE

DELETE /v3/configs/
GET

GET /v3/configs/
PUT

PUT /v3/configs/
/v3/flows/ GET

GET /v3/flows/
POST

POST /v3/flows/
/v3/flows/{name} DELETE

DELETE /v3/flows/:name
GET

GET /v3/flows/:name
/v3/jobs/ GET

GET /v3/jobs/
/v3/jobs/metadata GET

GET /v3/jobs/metadata
/v3/jobs/{id} DELETE

DELETE /v3/jobs/:id
GET

GET /v3/jobs/:id
/v3/jobs/{id}/cancel PUT

PUT /v3/jobs/:id/cancel
/v3/jobs/{id}/collect GET

GET /v3/jobs/:id/collect
/v3/jobs/{id}/logfile GET

GET /v3/jobs/:id/logfile
/v3/jobs/{id}/logs GET

GET /v3/jobs/:id/logs
/v3/jobs/{id}/move PUT

PUT /v3/jobs/:id/move
/v3/jobs/{id}/pageinfo GET

GET /v3/jobs/:id/pageinfo
/v3/jobs/{id}/pause PUT

PUT /v3/jobs/:id/pause
/v3/jobs/{id}/preview GET

GET /v3/jobs/:id/preview
/v3/jobs/{id}/repeat PUT

PUT /v3/jobs/:id/repeat
/v3/jobs/{id}/resume PUT

PUT /v3/jobs/:id/resume
/v3/jobs/{id}/tempfiles PUT

PUT /v3/jobs/:id/tempfiles
/v3/printers/ GET

GET /v3/printers/
POST

POST /v3/printers/
/v3/printers/checkconnection POST

POST /v3/printers/checkconnection
/v3/printers/config GET

GET /v3/printers/config
POST

POST /v3/printers/config
/v3/printers/config/{configName} DELETE

DELETE /v3/printers/config/:configName
GET

GET /v3/printers/config/:configName
PUT

PUT /v3/printers/config/:configName
/v3/printers/metadata GET

GET /v3/printers/metadata
/v3/printers/{printerName} DELETE

DELETE /v3/printers/:printerName
GET

GET /v3/printers/:printerName
PUT

PUT /v3/printers/:printerName
/v3/printers/{printerName}/checkPhysical PUT

PUT /v3/printers/:printerName/checkPhysical
/v3/printers/{printerName}/createTestJob PUT

PUT /v3/printers/:printerName/createTestJob
/v3/printers/{printerName}/logs GET

GET /v3/printers/:printerName/logs
/v3/printers/{printerName}/message DELETE

DELETE /v3/printers/:printerName/message
PUT

PUT /v3/printers/:printerName/message
/v3/printers/{printerName}/pause PUT

PUT /v3/printers/:printerName/pause
/v3/printers/{printerName}/redirect PUT

PUT /v3/printers/:printerName/redirect
/v3/printers/{printerName}/resume PUT

PUT /v3/printers/:printerName/resume
/v3/printers/{printerName}/runtime PUT

PUT /v3/printers/:printerName/runtime
/v3/statistics/job-count GET

GET /v3/statistics/job-count
/v3/statistics/job-series GET

GET /v3/statistics/job-series
/v3/statistics/metadata GET

GET /v3/statistics/metadata
/v3/statistics/printer-count GET

GET /v3/statistics/printer-count

Paths

GET /

GET /

API Root

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /openapi

GET /openapi

Get OpenAPI specification in JSON format

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /openapi.yaml

GET /openapi.yaml

Download OpenAPI specification in YAML format

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /swagger

GET /swagger

Get OpenAPI specification in JSON format

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /swagger.yaml

GET /swagger.yaml

Download OpenAPI specification in YAML format

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/

GET /v3/

API v3 Root

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/auth/userroles

GET /v3/auth/userroles

Get user roles for the authenticated user

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

DELETE /v3/configs/

DELETE /v3/configs/

Delete all user configuration information

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/configs/

GET /v3/configs/

Get all user configuration information

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/configs/

PUT /v3/configs/

Change user configuration information

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/flows/

GET /v3/flows/

Get list of all flows

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

POST /v3/flows/

POST /v3/flows/

Create a new customer specific flow

200 OK

200 OK

400 Bad Request

400 Bad Request

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

DELETE /v3/flows/:name

DELETE /v3/flows/{name}

Delete customer specific flow
name path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/flows/:name

GET /v3/flows/{name}

Get full flow definition
name path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/jobs/

GET /v3/jobs/

Get full job information for queried jobs
$filter query object
$top query object
$skip query object
$select query object
$inlinecount query object
$orderby query object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/jobs/metadata

GET /v3/jobs/metadata

Get metadata for jobs

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

DELETE /v3/jobs/:id

DELETE /v3/jobs/{id}

Delete job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/jobs/:id

GET /v3/jobs/{id}

Get full job information
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/jobs/:id/cancel

PUT /v3/jobs/{id}/cancel

Cancel job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

412 Precondition Failed

412 Precondition Failed

500 Internal Server Error

500 Internal Server Error

GET /v3/jobs/:id/collect

GET /v3/jobs/{id}/collect

Download collected job files as a gzip archive
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/jobs/:id/logfile

GET /v3/jobs/{id}/logfile

Download extended job log
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/jobs/:id/logs

GET /v3/jobs/{id}/logs

Get logs for a single job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/jobs/:id/move

PUT /v3/jobs/{id}/move

Move job to another printer
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

412 Precondition Failed

412 Precondition Failed

500 Internal Server Error

500 Internal Server Error

GET /v3/jobs/:id/pageinfo

GET /v3/jobs/{id}/pageinfo

Get page information for a job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/jobs/:id/pause

PUT /v3/jobs/{id}/pause

Pause job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

412 Precondition Failed

412 Precondition Failed

500 Internal Server Error

500 Internal Server Error

GET /v3/jobs/:id/preview

GET /v3/jobs/{id}/preview

Get preview information for a job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/jobs/:id/repeat

PUT /v3/jobs/{id}/repeat

Repeat job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

412 Precondition Failed

412 Precondition Failed

500 Internal Server Error

500 Internal Server Error

PUT /v3/jobs/:id/resume

PUT /v3/jobs/{id}/resume

Resume job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

412 Precondition Failed

412 Precondition Failed

500 Internal Server Error

500 Internal Server Error

PUT /v3/jobs/:id/tempfiles

PUT /v3/jobs/{id}/tempfiles

Set whether to save temporary files for the job
id path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/printers/

GET /v3/printers/

Get all printer information
$filter query object
$top query object
$skip query object
$select query object
$inlinecount query object
$orderby query object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

POST /v3/printers/

POST /v3/printers/

Add a new printer

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

POST /v3/printers/checkconnection

POST /v3/printers/checkconnection

Checks the connection status of a specific printer.
printer

The name of the printer to check the connection for.

 query object
200 OK

Connection check successfully performed.

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

Connection check failed because the specified printer was not found.

500 Internal Server Error

500 Internal Server Error

GET /v3/printers/config

GET /v3/printers/config

Get all printer PPD configuration

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

POST /v3/printers/config

POST /v3/printers/config

printer PPD configuration

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

DELETE /v3/printers/config/:configName

DELETE /v3/printers/config/{configName}

Delete single printer PPD configuration
configName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/printers/config/:configName

GET /v3/printers/config/{configName}

Get single printer PPD configuration
configName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/config/:configName

PUT /v3/printers/config/{configName}

Change single printer PPD configuration
configName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/printers/metadata

GET /v3/printers/metadata

Get metadata for printers

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

DELETE /v3/printers/:printerName

DELETE /v3/printers/{printerName}

Delete single printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/printers/:printerName

GET /v3/printers/{printerName}

Get information for a single printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/:printerName

PUT /v3/printers/{printerName}

Change printer information
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/:printerName/checkPhysical

PUT /v3/printers/{printerName}/checkPhysical

Check physical connection to printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/:printerName/createTestJob

PUT /v3/printers/{printerName}/createTestJob

Create a test job on the printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/printers/:printerName/logs

GET /v3/printers/{printerName}/logs

Get logs for a single printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

DELETE /v3/printers/:printerName/message

DELETE /v3/printers/{printerName}/message

Delete administrator message of a printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/:printerName/message

PUT /v3/printers/{printerName}/message

Set administrator message for a printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/:printerName/pause

PUT /v3/printers/{printerName}/pause

Pause printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

412 Precondition Failed

412 Precondition Failed

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/:printerName/redirect

PUT /v3/printers/{printerName}/redirect

Redirect printer to another printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

412 Precondition Failed

412 Precondition Failed

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/:printerName/resume

PUT /v3/printers/{printerName}/resume

Resume printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

412 Precondition Failed

412 Precondition Failed

500 Internal Server Error

500 Internal Server Error

PUT /v3/printers/:printerName/runtime

PUT /v3/printers/{printerName}/runtime

Change runtime status of a printer
printerName path object
200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/statistics/job-count

GET /v3/statistics/job-count

Get job count statistics

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/statistics/job-series

GET /v3/statistics/job-series

Get job series statistics

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/statistics/metadata

GET /v3/statistics/metadata

Get statistics metadata information

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error

GET /v3/statistics/printer-count

GET /v3/statistics/printer-count

Get printer count statistics

200 OK

200 OK

401 Unauthorized

401 Unauthorized

403 Forbidden

403 Forbidden

404 Not Found

404 Not Found

500 Internal Server Error

500 Internal Server Error