REretarus
Fax reports

Perform bulk operations on the status reports

Changed on

It is possible to perform bulk operations on the status reports through a POST on the /{custNr}/fax/reports endpoint. The required parameters are:

  • the type of action to be performed
  • A list of Job IDs on which the operation should be performed

Status reports are available for up to 30 days or until deleted.

The maximum number of jobs per POST request is set to 1000.

Please note: This endpoint should only be used with a data center specific URL. This endpoint could return an error about unknown job IDs depending on the data center the request is processed by.

post/{custNr}/fax/reports

Request

  • Base URL
    https://faxws.de1.retarus.com/rest/v1
  • Auth
    HTTP basic

Path parameters

custNrstring required

Customer Number

Request body

actionstring required

Defines the action to be performed on all jobs whose Job ID is provided in the jobIds list

Possible options are:

  • DELETE: Bulk delete the requested jobs
  • GET: Bulk get the requested jobs

Both options are case insensitive.

jobIdsstring[] required

List of Job IDs to be processed in bulk

Response

Depending on the request type, this returns a reports item containing either:

  • an array of Fax Report items for the bulk GET (same as getAllStatusReports).
  • an array of Job Delete Report items for the bulk DELETE.

Example response

{
  "reports": [
    {
      "jobId": "FJJ5Y09UM505ZZBIELCRYC",
      "deleted": true
    },
    {
      "jobId": "FJJ5WA23UO05ZZBIEL0JY5",
      "deleted": true
    },
    {
      "jobId": "FJJ5WA0FWM05ZZBIELZPE4",
      "deleted": false,
      "reason": "NOT_FOUND"
    },
    {
      "jobId": "FJJ5Y07H3805ZZBIELBAPL",
      "deleted": true
    },
    {
      "jobId": "FJJ5WA25VB0BRN8TPSGGVY",
      "deleted": false,
      "reason": "INTERNAL_ERROR"
    },
    {
      "jobId": "FJJ5WA253505ZZBIELEKRC",
      "deleted": true
    },
    {
      "jobId": "FJJ5WA24GI0BRN8TPSWAVM",
      "deleted": true
    }
  ]
}

Changes

  • 64e666009b31Revision changes
    • breaking

      the // response's property type changed from boolean to string for status