Submit Bulk Download

This operation processes and returns bulk data requests asynchronously. The output is returned as a CSV file that can be retrieved using the Retrieve Bulk Download Results (GET /v1/commons/exports/{id}/file) API operation.

Note: Although the payload property accepts a model similar to the Retrieve Data request, certain elements of the Retrieve Data request payload are ignored by this operation. Refer to the Submit Bulk Downloads topic for complete request and response schemas.

The associated Access Control Point is DOWNLOADS.

Example request

The following example request payload demonstrates how the Retrieve Data request model is used by this API operation inside the payLoad property.

{
  "name": "OOAP Schedule Metrics - Leadership v1",
  "type": "DATA",
  "payload": {
    "from": {
      "view": 1,
      "locationSet": {
        "hyperfind": {
          "id": "-5001"
        },
        "dateRange": {
          "startDate": "2021-01-01",
          "endDate": "2021-01-15"
        },
        "rollupBy": [
          {
            "key": "6",
            "value": "Department"
          }
        ]
      },
      "viewPresentation": "Business Structure"
    },
    "count": null,
    "index": null,
    "select": [
      {
        "key": "LOCATION_NAME",
        "alias": "alias_241606923555628",
        "properties": [
          {
            "key": "-3",
            "value": "/"
          }
        ]
      },
      {
        "key": "LOCATION_NAME",
        "alias": "alias_261606923555667",
        "properties": [
          {
            "key": "4",
            "value": "Company"
          }
        ]
      },
      {
        "key": "LOCATION_NAME",
        "alias": "alias_281606923555697",
        "properties": [
          {
            "key": "54",
            "value": "Country"
          }
        ]
      },
      {
        "key": "LOCATION_NAME",
        "alias": "alias_301606923555727",
        "properties": [
          {
            "key": "7",
            "value": "Business"
          }
        ]
      },
      {
        "key": "LOCATION_NAME",
        "alias": "alias_300606923555727",
        "properties": [
          {
            "key": "8",
            "value": "Field"
          }
        ]
      },
      {
        "key": "LOCATION_NAME",
        "alias": "alias_421606923555903",
        "properties": [
          {
            "key": "6",
            "value": "Department"
          }
        ]
      },
      {
        "key": "LOCATION_PATH",
        "alias": "alias_681606923690648",
        "properties": [
          {
            "key": "7",
            "value": "Department"
          }
        ]
      },
      {
        "key": "KPI_METRIC_ACTUAL_HRS",
        "alias": "alias_261595447145974"
      },
      {
        "key": "KPI_FRESHNESS_LASTUPDATEDTS",
        "alias": "KPI_FRESHNESS_LASTUPDATEDTS_1"
      },
      {
        "key": "KPI_FRESHNESS_DATAFRESHNESS_INDICATOR",
        "alias": "KPI_FRESHNESS_DATAFRESHNESS_INDICATOR_1"
      }
    ],
    "options": {
      "currencyType": "PREFERRED_CURRENCY",
      "includeColumnTotals": true
    }
  }
}