Cancel Import¶

Endpoint: POST /api/application-imports/cancel

Description: Cancels an in-progress application import.

Request Body¶

Field	Type	Required	Description
`applicationImportId`	string (GUID)	Yes	The unique identifier of the application import to cancel. Must reference an existing import that is not already in a terminal state (`Canceled`, `Failed`, `Finished`) or `Canceling`.

Sample Request¶

{
  "applicationImportId": "f1e2d3c4-b5a6-9788-7654-321fedcba098"
}

Response Attributes¶

Field	Type	Description
`id`	string (GUID)	Unique identifier of the import.
`kind`	string	Resource type. Always `Application Import`.
`number`	integer	Sequential import number.
`type`	string	Import type. Values: `Scheduled`, `Manual`, `API`.
`status`	string	Import status. Will be `Canceling` on success.
`createdBy`	string	Username that initiated the import.
`buildStart`	string (ISO 8601)	Date and time the import started.
`buildEnd`	string (ISO 8601)	Date and time the import completed. `null` if still running.
`log`	string	Import build log output.
`files`	array[object]	Files associated with this import.
`files[].id`	string (GUID)	Unique identifier of the import file.
`files[].fileGroupId`	string (GUID)	File group identifier.
`files[].fileGroup`	string	Display name of the file group.
`files[].name`	string	Original file name.
`metrics`	object	Import metrics. `null` unless the import status is `Finished`.
`application`	object	The application this import belongs to.
`application.id`	string (GUID)	Application ID.
`application.kind`	string	Always `Application`.
`application.name`	string	Application name.
`application.priority`	string	Priority rating.
`application.isArchived`	boolean	Whether the application is archived.
`application.lastUpdated`	string (ISO 8601)	Application last updated date.

Sample Response (200)¶

{
  "id": "f1e2d3c4-b5a6-9788-7654-321fedcba098",
  "kind": "Application Import",
  "number": 47,
  "type": "Scheduled",
  "status": "Canceling",
  "createdBy": "Permission Assist",
  "buildStart": "2025-12-01T02:00:00Z",
  "buildEnd": null,
  "log": "Import started.\nReading files...\nProcessing users...",
  "files": [
    {
      "id": "e1d2c3b4-a5f6-7890-1234-567890abcdef",
      "fileGroupId": "a1b2c3d4-0000-0000-0000-000000000001",
      "fileGroup": "Employee File",
      "name": "employees_20251201.csv"
    }
  ],
  "metrics": null,
  "application": {
    "id": "b8c1d2e3-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
    "kind": "Application",
    "name": "Jack Henry Symitar",
    "priority": "Critical",
    "isArchived": false,
    "lastUpdated": "2025-12-01T08:45:00Z"
  }
}

Error Response (400)¶

{
  "error": "validation_error",
  "message": "One or more validation errors occurred",
  "correlationId": "a1b2c3d4e5f6789012345678abcdef01",
  "errors": [
    {
      "field": "applicationImportId",
      "message": "Application import ID is required"
    }
  ]
}