Request Data Download

Prev Next
Get
/api/v1/users.requestDataDownload

Changelog

Version Description
1.2.0 Added as users.requestDataDownload
Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
fullExport
boolean

Whether you want a full export or not. By default, the value is false.

Defaultfalse
Responses
200
Success Example
{
  "requested": false,
  "exportOperation": {
    "_id": "uDSuaW7vGd9B7j8qD",
    "createdAt": "2019-06-07T23:02:13.359Z",
    "userId": "hjwGZafNqExtFNmN7",
    "roomList": [
      {
        "roomId": "GENERAL",
        "roomName": "general",
        "userId": null,
        "exportedCount": 8,
        "status": "completed",
        "targetFile": "general.html",
        "type": "c"
      }
    ],
    "status": "uploading",
    "exportPath": "/tmp/userData/hjwGZafNqExtFNmN7/partial",
    "assetsPath": "/tmp/userData/hjwGZafNqExtFNmN7/partial/assets",
    "fileList": [],
    "generatedFile": "/tmp/zipFiles/hjwGZafNqExtFNmN7.zip",
    "fullExport": false,
    "_updatedAt": "2019-06-07T23:15:00.326Z"
  },
  "success": true
}
Expand All
object
requested
boolean
exportOperation
object
_id
string
createdAt
string
userId
string
roomList
Array of object
object
roomId
string
roomName
string
userId
string | null
exportedCount
integer
status
string
targetFile
string
type
string
status
string
exportPath
string
assetsPath
string
fileList
Array of object
object
generatedFile
string
fullExport
boolean
_updatedAt
string
success
boolean
401

Unauthorized

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