Create deviceManagementExportJob

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Create a new deviceManagementExportJob object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All

HTTP Request

POST /deviceManagement/reports/exportJobs

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the deviceManagementExportJob object.

The following table shows the properties that are required when you create the deviceManagementExportJob.

Property	Type	Description
id	String	Unique identifier for this entity.
reportName	String	Name of the report. The maximum length allowed for this property is 2000 characters.
filter	String	Filters applied on the report. The maximum length allowed for this property is 2000 characters.
select	String collection	Columns selected from the report. The maximum number of allowed columns names is 256. The maximum length allowed for each column name in this property is 1000 characters.
format	deviceManagementReportFileFormat	Format of the exported report. Possible values are csv and json. Possible values are: csv, pdf, json, unknownFutureValue.
snapshotId	String	A snapshot is an identifiable subset of the dataset represented by the ReportName. A sessionId or CachedReportConfiguration id can be used here. If a sessionId is specified, Filter, Select, and OrderBy are applied to the data represented by the sessionId. Filter, Select, and OrderBy cannot be specified together with a CachedReportConfiguration id. The maximum length allowed for this property is 128 characters.
localizationType	deviceManagementExportJobLocalizationType	Configures how the requested export job is localized. Possible values are replaceLocalizableValues and localizedValuesAsAdditionalColumn. Possible values are: localizedValuesAsAdditionalColumn, replaceLocalizableValues.
search	String	Configures a search term to filter the data. The maximum length allowed for this property is 100 characters.
status	deviceManagementReportStatus	Status of the export job. Possible values are unknown, notStarted, inProgress, completed and failed. Possible values are: unknown, notStarted, inProgress, completed, failed.
url	String	Temporary location of the exported report.
requestDateTime	DateTimeOffset	Time that the exported report was requested.
expirationDateTime	DateTimeOffset	Time that the exported report expires.

Response

If successful, this method returns a 201 Created response code and a deviceManagementExportJob object in the response body.

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/deviceManagement/reports/exportJobs
Content-type: application/json
Content-length: 484

{
  "@odata.type": "#microsoft.graph.deviceManagementExportJob",
  "reportName": "Report Name value",
  "filter": "Filter value",
  "select": [
    "Select value"
  ],
  "format": "pdf",
  "snapshotId": "Snapshot Id value",
  "localizationType": "replaceLocalizableValues",
  "search": "Search value",
  "status": "notStarted",
  "url": "Url value",
  "requestDateTime": "2017-01-01T00:03:07.1589002-08:00",
  "expirationDateTime": "2016-12-31T23:57:57.2481234-08:00"
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 533

{
  "@odata.type": "#microsoft.graph.deviceManagementExportJob",
  "id": "9ddfb995-b995-9ddf-95b9-df9d95b9df9d",
  "reportName": "Report Name value",
  "filter": "Filter value",
  "select": [
    "Select value"
  ],
  "format": "pdf",
  "snapshotId": "Snapshot Id value",
  "localizationType": "replaceLocalizableValues",
  "search": "Search value",
  "status": "notStarted",
  "url": "Url value",
  "requestDateTime": "2017-01-01T00:03:07.1589002-08:00",
  "expirationDateTime": "2016-12-31T23:57:57.2481234-08:00"
}