Jobs

Get job details

get

Returns a streamable file that contains a job’s log. You can read the log file for completed or aborted jobs to review results. You can also stream the log file for a running job to view logs in real time.

Autorizaciones

AuthorizationstringRequerido

Bearer <access_token>

Parámetros de ruta

idnumberRequerido

connectionIdnumberRequerido

Respuestas

200

Returns the streamable file containing job logs

application/json

object · StreamableFileOpcional

400

Incorrect request data is provided. For example, id or connectionId isn't a valid number

application/json

404

Connection or job not found

application/json

get/api/v1/connections/{connectionId}/jobs/{id}/logs/details

GET /api/v1/connections/{connectionId}/jobs/{id}/logs/details HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Get job progress

get

Returns information about job progress steps. Can be used for completed or aborted jobs to review results, or for running jobs to view runtime progress

Autorizaciones

AuthorizationstringRequerido

Bearer <access_token>

Parámetros de ruta

idnumberRequerido

connectionIdnumberRequerido

Respuestas

200

Returns a list of work completed for every processed object. The response structure may differ based on the specific work performed in the job

application/json

objectNamestringRequerido

Object name

statusstringRequerido

Status of progress step

backupSuccessCountnumberOpcional

Number of successfully backed up records.

removeSuccessCountnumberOpcional

Number of successfully removed records.

successCountnumberOpcional

Success count for restore-request/import

failedCountnumberOpcional

Failed count for import

restoreSuccessCountnumberOpcional

Number of successfully restored records.

restoreFailedCountnumberOpcional

Number of records that failed to restore.

updateSuccessCountnumberOpcional

Updated number of successfully restored records.

updateFailedCountnumberOpcional

Updated number of records that failed to restore.

searchSuccessCountnumberOpcional

Number of records found in search.

400

Incorrect request data is provided. For example, id or connectionId isn't a valid number

application/json

404

Connection or job not found

application/json

get/api/v1/connections/{connectionId}/jobs/{id}/logs/progress

GET /api/v1/connections/{connectionId}/jobs/{id}/logs/progress HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "objectName": "text",
    "status": "text",
    "backupSuccessCount": 1,
    "removeSuccessCount": 1,
    "successCount": 1,
    "failedCount": 1,
    "restoreSuccessCount": 1,
    "restoreFailedCount": 1,
    "updateSuccessCount": 1,
    "updateFailedCount": 1,
    "searchSuccessCount": 1
  }
]

Abort backup/archive job

patch

Aborts the backup or archive job

Autorizaciones

AuthorizationstringRequerido

Bearer <access_token>

Parámetros de ruta

idnumberRequerido

connectionIdnumberRequerido

Respuestas

200

Aborts the backup or archive job

application/json

messagestringRequeridoExample: Job was aborted successfully.

400

Incorrect request data is provided. For example, connectionId isn't a valid positive number

application/json

404

Connection not found

application/json

patch/api/v1/connections/{connectionId}/jobs/{id}/abort/backup

PATCH /api/v1/connections/{connectionId}/jobs/{id}/abort/backup HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Job was aborted successfully."
}