Perform bulk operations on the status reports (bulkStatusReports)

NONE

POST /{custNr}/fax/reports

Description

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.

If you have sent the fax job requests via a high availability URL, the job request is forwarded to one of the data centers within a processing domain. The fax job is processed in that data center and the corresponding status report can be queried or deleted in that data center. To query or delete the status reports, you must send a status query request or a delete request to both data centers in the processing domain. Please do not send a status query or delete request directly to an HA URL, but use the URLs for the specific data centers. Otherwise it is likely that the fax job request has not been processed in the referenced data center and hence no status is available there or cannot be deleted.

Parameters

Type	Name	Description	Schema
Path	custNr required	Customer Number	string
Body	bulkStatusRe quest required		BulkJobReportsRequestBody

Responses

HTTP code	Description	Schema
200	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.	BulkJobReportResponseBody
401	AUTHENTICATION_FAILURE: Bad or missing authentication	No Content
503	SERVICE_UNAVAILABLE: The server cannot handle the request due to a temporary overloading or maintenance of the server.	No Content
520	UNKNOWN_ERROR: Server signals that there was an unknown problem, most likely with the backend adaptor	No Content

Consumes

application/json

Example HTTP request/response

Request body

JSON

{
   "action":"DELETE",
   "jobIds":[
      "FJJ5Y09UM505ZZBIELCRYC",
      "FJJ5WA23UO05ZZBIEL0JY5",
      "FJJ5WA0FWM05ZZBIELZPE4",
      "FJJ5Y07H3805ZZBIELBAPL",
      "FJJ5WA25VB0BRN8TPSGGVY",
      "FJJ5WA253505ZZBIELEKRC",
      "FJJ5WA24GI0BRN8TPSWAVM"
   ]
}

Response 200

JSON

{
   "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
      }
   ]
}