Create Data Extract Definitions

Use the Data Export REST API to create individual data extract definitions. Each extract definition specifies the data to be extracted.

You can create one or more data extract definitions, which can later be grouped into an extract group definition.

Endpoint

Attribute	Value
URL	/api/boss/data/objects/ora/commonBoss/dataExport/v1/exportDefinitions
HTTP Method	POST

Request

Example

{
  "name": "CostDistributionsExtraction_costDistributionExtract_test_11",
  "owner": "RODS_EXTRACTION_USER",
  "ownerRole": "Admin",
  "extractClient": "FA_DATA_EXTRACT_UI",
  "exportConfiguration": {
    "type": "BV",
    "outputDataFormat": "CSV",
    "csvDelimiter": ",",
    "sortBy": null,
    "csvFormat": null,
    "historyStartDate": null
  },
  "bossArtifacts": {
    "extractionQuery": "{...}"
  }
}

Response

On successful submission, a 201 Created response is returned along with the Location header pointing to the created extract definition resource.

201 Created
Location: https://example.com/api/boss/data/objects/ora/commonBoss/dataExport/v1/exportDefinitions/{exportDefinitionId}