CUcubesoftware
Connections

Cancel a Data Import

Changed on

Cancel an active data import by providing the import ID and connection ID. This action immediately stops the import process and sends a cancellation email to the user who initiated the import. Accessible only to Finance and Admin users.

put/connections/{connection_id}/imports/{import_id}

Request

  • Base URL
    https://api.cubesoftware.com
  • Auth
    • OAuth 2
      Authorization code: https://portal.cubesoftware.com/o/authorize/
      Token URL: https://api.cubesoftware.com/o/token/
    • or none

Path parameters

connection_idstring uuid required
import_idinteger required

Headers

HTTP_ACCEPTstring required

Set the version of API the request is for

X-Company-IDstring required

Associates request with company

Request body

status'CANCELLED' required
  • CANCELLED - Cancelled
status_messagestring

Response

Attempt to cancel an active import.

idinteger required
created_atstring date-time required
completed_atstring date-time nullable
status'CANCELLED' required
  • CANCELLED - Cancelled
status_messagestring nullable
source_import_type'USER' | 'SCHEDULED' required
  • USER - User
  • SCHEDULED - Scheduled

Changes

  • 14bc2527c11cRevision changes
    • warning

      added the new PLANNING_TABLE enum value to the ///// response property for the response status

    • warning

      added the new PLANNING_TABLE enum value to the ///// response property for the response status

    • warning

      added the new PLANNING_TABLE enum value to the ///// response property for the response status

  • 29a7569c2f46Revision changes
    • warning

      added the new HEADCOUNT enum value to the ///// response property for the response status

    • warning

      added the new HEADCOUNT enum value to the ///// response property for the response status

    • warning

      added the new HEADCOUNT enum value to the ///// response property for the response status