Get Extract Group ID

You can retrieve the export group ID by filtering using the name of the extract group definition.

Note:

Create extract group definitions in the Data Extraction user interface. REST APIs don't support creating extract group definitions. Use this API only to retrieve the ID of an existing extract group definition.

Endpoint

Attribute	Value
URL	/api/boss/data/objects/ora/commonBoss/dataExport/v1/exportGroupDefinitions?$filter=name='{{extractGroupDefinitionName}}'&$fields=exportGroupId,name
HTTP Method	GET

Request

Replace {{extractGroupDefinitionName}} with the name of the extract group definition.

Ensure that the extractGroupDefinitionName is enclosed in single quotes (') in the URL.

Response

Example Response

{
  "items": [
    {
      "name": "CostDistributionsExtract_test_1",
      "exportGroupId": "300100641963646",
      "$id": "300100641963646",
      "$context": {
        "links": {
          "$self": {
            "href": "https://example.com/api/boss/data/objects/ora/commonBoss/dataExport/v1/exportGroupDefinitions/300100641963646"
          }
        }
      }
    }
  ],
  "hasMore": false
}