Get Current Import Operations

Prev Next
Get
/api/v1/getCurrentImportOperation

Get the current import operation. Permission required: run-import

Changelog

Version Description
3.0.0 Added
Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Responses
200

OK

Success
{
  "success": true,
  "operation": {
    "_id": "7PbvsnKJD9ZAqw38C",
    "type": "Pending Avatars",
    "importerKey": "pending-avatars",
    "ts": "1635337234169",
    "status": "importer_done",
    "valid": true,
    "user": "d26x6zSkaPSe5gCyy",
    "_updatedAt": "2021-10-27T12:20:34.184Z"
  }
}
Expand All
object
success
boolean
operation
object
_id
string
type
string
importerKey
string
ts
integer
status
string
valid
boolean
user
string
_updatedAt
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string