Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Bulk Export

Get List of Bulk Exports

Use this API to retrieve a list of bulk exports. The response will include the created date, ID, and status of each export.

🗒 Things to Know

  • The status of a bulk export will automatically change to Expired 10 days after its creation.
get/api/ot-insights/v1/bulk-export-jobs

Query parameters

pageinteger

Results page to be retrieved (0..N). Example- '?page=1'

The page number of the results.

sizeinteger

Number of records per page (1..2000). Example- '?size=30'

The number of results per page.

sort'name,asc' | 'name,desc' | 'status,asc' | 'status,desc' | 'createdDate,asc' | 'createdDate,desc' | 'completedDate,asc' | 'completedDate,desc' | 'expiryDate,asc' | 'expiryDate,desc'

The sort criteria that dictates the order of the results.

The sort criteria that dictates the order of the results.

Response

OK

lastboolean

This flag indicates whether the current page is the last page of the list.

totalElementsinteger

The total number of results in the list.

totalPagesinteger

The total number of pages in the list.

sizeinteger

The number of results per page.

numberinteger

The page number of the results.

firstboolean

This flag indicates whether the current page is the first page of the list.

numberOfElementsinteger

The number of results on the current page.

emptyboolean

This flag indicates whether no results exist on the page.

Example response

{
  "content": [
    {
      "runId": "90f2241a-16d7-45e8-b913-1cb9951bb843",
      "name": "Bulk Export",
      "status": "EXPORT_IN_PROGRESS",
      "createdDate": "2024-11-24 22:20:30",
      "createdBy": {
        "textAttributeName": [
          {
            "value": "Text"
          }
        ],
        "optionBasedAttributeName": [
          {
            "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          }
        ]
      },
      "exportType": "Data Subjects",
      "fileFormat": "csv",
      "completionDate": "2024-11-24 22:20:30",
      "expiryDate": "2024-11-24 22:20:30"
    }
  ]
}