Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Data Exports

This object allows you to export specific data sets from Kantata OX. You can create or cancel exports. You can also view the full schema of available data sets, view details for all exports, and download exports.

To use these endpoints, you need to be an account administrator.

Get a list of Data Exports

Returns information on all exports that have been requested, including their status and the data sets and columns that were selected for the exports.

This endpoint returns structured Data Export objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the exports top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - The user who generated the export.
only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
Responses
200

A list of Data Exports have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/exports
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "exports": {
    },
  • "users": {
    }
}
Generate a Data Export
Generates an export. Use the data set key and each column key that you want to be included in your export. The values need to be properly formatted JSON, which means you may need to escape special characters. If no column keys are provided, the export will fail and return a 422 response.


Example
The following example creates a new export containing all the non-custom field columns for the User dataset created during October 2023.


curl -i -X POST 'https://api.mavenlink.com/api/v1/exports' -H 'Content-Type: application/json' -d '{
  "export": {
    "export_definition": {
      "8ebff9db413b3115": {
        "columns": [
          "4eb02f5e2601433d",
          "b02d7f145ad95122",
          "2bfa2c20999efe62",
          "96cb337e5007738b",
          "27e2565ae34ed9eb",
          "d5111608cc214c2a",
          "e59d1cb61256a8cf",
          "77bfd7e48d5ff668",
          "23ca4c0d7b289c5f",
          "7172de0607dcb1ef"
        ],
        "filters": {
          "start_date": "2023-10-01",
          "end_date": "2023-10-31"
        }
      }
    }
  }
}'



This endpoint returns structured Data Export objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the exports top-level JSON key.
Please see our Response Format section for more information.


Request 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • user (User) - The user who generated the export.
    • 



 
Request Body schema: application/json
required
object
 
required
object
 
additional property
object
The key value for the data set you want to export.


 
columns
required
Array of strings
The key values for each column you want to include in the export.


 
object
The filters that you want to apply to the export.


 
Responses 
200
Data Export has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/exports
Request samples 
application/json
{
  • "export": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "exports": {
    },
  • "users": {
    }
}
Get a single Data Export
Returns information on a single export that has been requested, including the status and the data sets and columns that were selected for the export.


This endpoint returns structured Data Export objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the exports top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • user (User) - The user who generated the export.
    • 



 
Responses 
200
The Data Export has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/exports/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "exports": {
    },
  • "users": {
    }
}
Cancel a Data Export
Cancel an export that is in a Queued status.


This endpoint returns structured Data Export objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the exports top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • user (User) - The user who generated the export.
    • 



 
Request Body schema: application/json
required
object
 
canceled
boolean
If set to true, cancels an export with a Queued status.


 
Responses 
200
Data Export has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/exports/{id}
Request samples 
application/json
{
  • "export": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "exports": {
    },
  • "users": {
    }
}
Download a Data Export
Returns a download URL for a successfully generated data export that expires in 60 seconds. With this URL, you can use curl or wget to download the export in a CSV format.


This endpoint returns structured Data Export objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the exports top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • user (User) - The user who generated the export.
    • 



 
Responses 
200
A list of Data Exports have been retrieved.


Response Schema: application/json
download_url
string
The URL to download a generated data export that expires in 60 seconds.


 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/exports/{id}/download_url
Request samples 
Response samples 
application/json
{
  • "download_url": "string"
}
➔ Next to Estimate Scenario Resource Allocations