Maintenance / Imports

Purge Maintenance Imports

Purge pending maintenance import.

DELETE

/fm/maintenance-imports/purge

curl --request DELETE \
  --url https://api.catch-e.com/fm/maintenance-imports/purge \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'interface_batch_no=%3Cstring%3E'

{
  "detail": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Posted batches cannot be purged.

This method requires the MaintenanceImports:Purge permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Body

interface_batch_nostringrequired

Interface Batch No

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

Still need help? Ask the team