Group Extract Definitions

Combine one or more data extract definitions into an extract group definition based on the required extraction scope and grouping strategy.

An extract group definition serves as a logical container that determines which data extracts are executed together during job submission.

Endpoint

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

Request

Example

{
  "extractClient": "FA_DATA_EXTRACT_UI",
  "name": "CostDistributionsExtract_test_1",
  "owner": "RODS_EXTRACTION_USER",
  "ownerRole": "Admin",
  "groupedExtracts": {
    "items": [
      {
        "name": "CostDistributionsExtraction_costDistributionExtract_test_11"
      },
      {
        "name": "CostDistributionsExtraction_costDistributionLineExtract_test_111"
      }
    ]
  }
}

Response

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

Example Respose

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