printDocument: createUploadSession

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create an upload session that allows an app to iteratively upload ranges of a binary file linked to the print document.

As part of the response, this action returns an upload URL that can be used in subsequent sequential PUT queries. Request headers for each PUT operation can be used to specify the exact range of bytes to be uploaded. This allows transfer to be resumed, in case the network connection is dropped during upload.

Note: Creating an upload session using application permissions will only succeed if there is a printTask in a processing state on the associated print job, started by a trigger that the requesting app created. For details about how to register a task trigger, see Extending Universal Print to support pull printing.

This API is available in the following national cloud deployments.

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

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) PrintJob.Create PrintJob.ReadWrite, PrintJob.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application PrintJob.ReadWrite.All Not available.

HTTP request

To create an upload session using printer:

POST /print/printers/{id}/jobs/{id}/documents/{id}/createUploadSession

To create an upload session using printerShare (supported with delegated permissions only):

POST /print/shares/{id}/jobs/{id}/documents/{id}/createUploadSession

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-type application/json. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
properties printDocumentUploadProperties Represents properties of the binary file to be uploaded.

The value of the contentType property in the request body should be supported by the printer/printerShare. You can get the supported content types by getting printerCapabilities of the printer/printerShare.

For OXPS to PDF conversion, you need to pass application/oxps as contentType for printer/printerShare that supports application/pdf. Universal Print converts OXPS to PDF, when all the following conditions are met:

  1. The printer/printer share supports application/pdf in printerCapabilities.
  2. The printer/printer share does NOT support application/oxps in printerCapabilities.
  3. The value for the contentType property in the request body is application/oxps.

Response

If successful, this method returns a 200 OK response code and a new uploadSession object in the response body.

Note: The uploadUrl property returned as part of the uploadSession response object is an opaque URL for subsequent PUT queries to upload byte ranges of the file. It contains the appropriate auth token for subsequent PUT queries that expire by expirationDateTime. Do not change this URL.

Examples

The following example shows how to create an upload session that you can use in subsequent file upload operations to the specified printDocument.

Request

POST https://graph.microsoft.com/beta/print/shares/1c879027-5120-4aaf-954a-ebfd509a3bcc/jobs/46207/documents/9001bcd9-e36a-4f51-bfc6-140c3ad7f9f7/createUploadSession
Content-type: application/json

{
  "properties": {
    "documentName": "TestFile.pdf",
    "contentType": "application/pdf", 
    "size": 4533322
  }
}

Response

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.uploadSession",
    "uploadUrl": "https://print.print.microsoft.com/uploadSessions/5400be13-5a4e-4c20-be70-90c85bfe5d6e?tempauthtoken={token}",
    "expirationDateTime": "2020-10-25T02:19:38.1694207Z",
    "nextExpectedRanges": [
        "0-4533321"
    ]
}