Skip to main content
POST
/
job
/
v1
/
{jobId}
/
cancel
cURL
curl --request POST \
  --url https://aodocs.altirnao.com/api/job/v1/{jobId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "completed": true,
  "failedTasks": 123,
  "jobId": "<string>",
  "kind": "<string>",
  "lastActivityAt": 123,
  "libraryId": "<string>",
  "remainingTasks": 123,
  "requestor": "<string>",
  "startedAt": 123,
  "status": "IN_PROGRESS",
  "succeededTasks": 123,
  "taskRetries": 123,
  "type": "UNKNOWN"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
jobId
string
required

The ID of the job

Query Parameters

​
securityCode
string

The security code

​
domain
string

The G Suite domain

Response

200 - application/json

A ApiJob response

​
completed
boolean
​
failedTasks
integer<int32>
​
jobId
string
​
kind
string
​
lastActivityAt
integer<int64>
​
libraryId
string
​
remainingTasks
integer<int32>
​
requestor
string
​
startedAt
integer<int64>
​
status
enum<string>
Available options:
IN_PROGRESS,
COMPLETED,
FAILED,
CANCELLED
​
succeededTasks
integer<int32>
​
taskRetries
integer<int32>
​
type
enum<string>
Available options:
UNKNOWN,
IMPORT_FOLDER,
DELETE_FOLDER,
RESTORE_FOLDER,
PERMANENTLY_DELETE_FOLDER,
MOVE_FOLDER,
FOLDER_CACHE_UPDATE,
DELETE_DOCUMENTS_AND_FOLDERS,
PERMANENTLY_DELETE_DOCUMENTS_AND_FOLDERS,
TRASH_DOCUMENTS,
COPY_FILE,
COPY_FILE_RESUMABLE,
CREATE_FOLDER_MAINTENANCE,
REVERT_VERSION,
RESTORE_VERSION,
MOVE_DOCUMENTS_AND_FOLDERS,
DELETE_VERSIONEDDOCUMENT,
CREATE_DOCUMENTS,
CHECK_OUT_DOCUMENT,
CHECK_IN_DOCUMENT,
IMPORT_PREPROCESS,
IMPORT,
REVERT,
DUPLICATE_FOLDER_STRUCTURE,
EXPORT_FOLDER,
EXPORT_FILE,
PUSH_TO_DRIVE,
APPLY_PERMISSIONS_TO_ALL_CHILDREN,
DRIVE_SCAN,
FIX_PERMISSION_PROPAGATION,
LIBRARY_COPY_CONTENT,
EXPORT_TO_LIBRARY,
LIBRARY_DELETE,
REPLACE_FOLDER,
BACKUP,
MARK_STORED_EMAIL_DELIVERED,
CONCURRENCY_TEST,
CLEAN_CATEGORY,
VALIDATE_DOCUMENTS,
CREATE_DOCUMENT_ASYNC,
CREATE_DOCUMENT_FROM_INBOUND_EMAIL,
UPDATE_GROUP_MEMBERSHIP_CACHE,
SET_PERMISSION_ID_FOR_USERS,
PATCH_DOCUMENT_ASYNC,
UPDATE_ATTACHMENT,
UPDATE_STORAGE_ACCOUNT_QUOTA_USAGE,
COPY_DOCUMENT_WITH_VERSIONS,
REFRESH_INDEX_STAT,
VERIFY_SUBDOMAIN_EXISTENCE,
CREATE_DOCUMENT_WITH_VERSIONS_ASYNC_V1,
REMOVE_EXPLICIT_PERMISSIONS_FROM_TF,
CHANGE_LIBRARY_TYPE,
LIBRARY_OWNERSHIP_CHANGE,
LIBRARY_PERMISSION_EXTRACTION,
SEND_NOTIFICATION_REMINDERS,
CHECK_ANYONE_INCONSISTENCIES,
PURGE_DOMAIN,
BLACKLIST_USERS,
PROPAGATE_OUTDATED_CATEGORY_VALUE_PROPERTY,
CACHE_DRIVE_SEARCH,
VALIDATE_DOCUMENT_WORKFLOW_TRANSITION