Articles in this section

How to submit a Job?

  Info

The following does not require CalderaRIP to be open. The jobs won't be imported to CalderaRIP's ImageBar.

 

There are several requests required to submit a Job:

  1. Get the Service ID
  2. Get the Device ID
  3. Get the Preset ID
  4. Import an Image (see below)
  5. Submit the Job with the Image ID + the Preset ID to a Device ID running on a Service ID (see below)

Import an Image

  Warning

The image must be reachable from the target service.
For remote services, use a path or storage setup that the remote service can access.

 

POST /v1/services/{serviceId}/images
{
  "uri": "file:///path/to/file.pdf"
}
curl --request POST \
  --url http://localhost:12340/v1/services/{serviceId}/images \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "uri": "file:///path/to/file.pdf"
  }'

The previous is a synchronous event, so the request will return an image ID when the image is imported:

Common image import errors

  • 400: invalid request or unsupported file URI
  • 405: the target service does not support image import
  • 413: file too large
  • 415: unsupported file type
  • 500: server-side failure

Submit the Job

  • image is required.
  • preset is required.
  • persistJobInRIP is optional
POST /v1/devices/{deviceId}/jobs
{
    "image": "{imageId}",
    "preset": "{presetId}",
    "persistJobInRIP": true
}
curl --request POST \
  --url http://localhost:12340/v1/devices/{deviceId}/jobs \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "image": "{imageId}",
    "preset": "{presetId}",
    "persistJobInRIP": true
  }'


The request will return the Job ID to track:

Was this article helpful?
0 out of 0 found this helpful