Exports the list of databases users to an XLSX file.
Starting the job
This operation is a long-running batch job. You must first submit a request to start the job.
POST https://www.activityinfo.org/resources/jobs
Request body
| object | |||
| type | string | The type of the job to start. Must be "exportUsers" |
required |
| descriptor | object | required | |
| databaseId | string | The id of the database whose users should be exported. | required |
| utcOffset | integer | The requested offset from Universal Coordinated Time (UTC) in minutes. XLSX times do not include timezones, so this is the timezone to use for the invitation and last login times. |
required |
Getting the job status
The result of this first call provides a job id that you can use to poll for status:
GET https://www.activityinfo.org/resources/jobs/{jobId}
curl -X GET https://www.activityinfo.org/resources/jobs/ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICAzd390wkM \
-u anything:APITOKEN \
-H 'Content-type: application/json' \
--data-binary @- << EOF
{
"id": "ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICAzd390wkM",
"state": "STARTED"
}
EOF
Successful result
When the job state transitions to "COMPLETED", the status object will include the result:
| object | |||
| id | string | The id of the job | required |
| state | string | "COMPLETED" |
required |
| result | object | required | |
| filename | string | The filename of the export. | required |
| downloadUrl | string | The URL that can be used to download the result. | required |