Skip to main content
GET
/
job
/
v1
/
libraries
/
{libraryId}
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/job/v1/libraries/{libraryId} \
  --header 'Authorization: Bearer <token>'
{
  "jobList": [
    {
      "completed": true,
      "failedTasks": 123,
      "jobId": "<string>",
      "kind": "<string>",
      "lastActivityAt": 123,
      "libraryId": "<string>",
      "remainingTasks": 123,
      "requestor": "<string>",
      "startedAt": 123,
      "succeededTasks": 123,
      "taskRetries": 123
    }
  ],
  "kind": "<string>",
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
libraryId
string
required

The ID of the library

Query Parameters

​
securityCode
string

The security code

​
domain
string

The G Suite domain

​
pageToken
string

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

​
pageSize
integer<int32>
default:50

The maximum number of items to return

​
status
enum<string>

The job status to filter on

Available options:
IN_PROGRESS,
COMPLETED,
FAILED,
CANCELLED
​
type
enum<string>

The type of job to filter on

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,
FIX_INHERITED_PERMISSIONS_DISABLED,
VALIDATE_DOCUMENT_WORKFLOW_TRANSITION,
MAKE_LIBRARY_PUBLIC,
MIGRATE_SF_PUBLIC_TO_PRIVATE
​
user
string

The email of the user who request the job to filter on

​
orderBy
string

The order of the jobs with the following syntax 'sortCriterion sortDirection' (possible values: [started|lastActivity] [asc|desc])

Response

200 - application/json

A ApiJobList response

​
jobList
object[]
​
kind
string
​
nextPageToken
string