Uxopian Software documentation is now centralized on a single site. Find the up-to-date documentation for our products on doc.uxopian.com.

Background job management

Monitor and manage background processing jobs

The job management service allows monitoring and managing background processing jobs (waiting, processing, errors).

List waiting jobs


# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
curl -X GET "<CORE_HOST>/rest/jobs/waiting" \
  -H "token: <TOKEN>"

Count waiting jobs


# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
curl -X GET "<CORE_HOST>/rest/jobs/waiting/count" \
  -H "token: <TOKEN>"

List processing jobs


# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
curl -X GET "<CORE_HOST>/rest/jobs/processing" \
  -H "token: <TOKEN>"

Count processing jobs


# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
curl -X GET "<CORE_HOST>/rest/jobs/processing/count" \
  -H "token: <TOKEN>"

List error jobs


# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
curl -X GET "<CORE_HOST>/rest/jobs/errors" \
  -H "token: <TOKEN>"

Count error jobs


# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
curl -X GET "<CORE_HOST>/rest/jobs/errors/count" \
  -H "token: <TOKEN>"

Retry a job


# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
# <ID>         job identifier
curl -X POST "<CORE_HOST>/rest/jobs/retry/<ID>" \
  -H "token: <TOKEN>"

Clear error queue


This operation permanently removes all jobs in the error queue. This action cannot be undone. 


# <CORE_HOST>  FlowerDocs Core base URL
# <TOKEN>      authentication token
curl -X DELETE "<CORE_HOST>/rest/jobs/errors" \
  -H "token: <TOKEN>"