Share via


Device deployment - Get BatchJobStatus

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/batchJobStatus/{batchUploadTracking_id}

URI Parameters

Name In Required Type Description
batchUploadTracking_id
path True

string

The batch tracking id.

customer_id
path True

string

The customer id.

version
path True

string

Request Header

Name Required Type Description
Authorization True

string

Authorization Bearer token

ms-correlationid

string

Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request

ms-cv

string

Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request

ms-requestid

string

Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name Type Description
200 OK

Microsoft.Partner.Providers.Contracts.V1.BatchUploadDetails

The request was successful. The status of the batch upload are returned in the response body.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name Description
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Providers.Contracts.V1.BatchUploadDetails
Microsoft.Partner.Providers.Contracts.V1.DeviceUploadDetails

Microsoft.Partner.Core.Collections.ResourceAttributes

Name Type Description
etag

string

objectType

string

Microsoft.Partner.Providers.Contracts.V1.BatchUploadDetails

Name Type Description
batchTrackingId

string

completedTime

string (date-time)

devicesStatus

Microsoft.Partner.Providers.Contracts.V1.DeviceUploadDetails[]

startedTime

string (date-time)

status enum:
  • finished (int32)
  • finished_with_errors (int32)
  • processing (int32)
  • queued (int32)
  • unknown (int32)

Microsoft.Partner.Providers.Contracts.V1.DeviceUploadDetails

Name Type Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

deviceId

string

errorCode

string

errorDescription

string

productKey

string

serialNumber

string

status enum:
  • finished (int32)
  • finished_with_errors (int32)
  • processing (int32)
  • queued (int32)
  • unknown (int32)