printDocument: createUploadSession

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

アプリが印刷ドキュメントにリンクされたバイナリ ファイルの範囲を繰り返しアップロードできるアップロード セッションを作成します。

応答の一部として、このアクションは、後続の順次クエリで使用できるアップロード URL を PUT 返します。 各操作の要求 PUT ヘッダーを使用して、アップロードするバイトの正確な範囲を指定できます。 これにより、アップロード中にネットワーク接続が削除された場合に、転送を再開できます。

注: アプリケーションのアクセス許可を使用してアップロード セッションを作成することは、要求するアプリが作成したトリガーによって開始された、関連付けられた印刷ジョブの状態に printTask がある場合にのみ processing 成功します。 タスク トリガーを登録する方法の詳細については、「プル印刷をサポートするための ユニバーサル 印刷の拡張」を参照してください。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。 次のアクセス許可に加えて、ユーザーまたはアプリのテナントはアクティブなユニバーサル印刷サブスクリプションを持ち、プリンターまたは printerShare が使用されているかどうかに応じて、Get printer または Get printerShare アクセスを許可するアクセス許可を持っている必要があります。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	PrintJob.Create、PrintJob.ReadWrite、PrintJob.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	PrintJob.ReadWrite.All

HTTP 要求

プリンターを使用してアップロード セッションを作成 するには、

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

printerShare を使用してアップロード セッションを 作成するには (委任されたアクセス許可でのみサポートされます)。

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

要求ヘッダー

名前	説明
Authorization	ベアラー {トークン}。必須。
Content-type	application/json. Required.

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター	種類	説明
プロパティ	printDocumentUploadProperties	アップロードするバイナリ ファイルのプロパティを表します。

要求本文の contentType プロパティの値は、printer/printerShare でサポートされている必要があります。 printer/printerShare の printerCapabilities を取得すると、サポートされているコンテンツ タイプを取得できます。

OXPS から PDF への変換では、サポートする application/oxps printer/printerShare の contentType として渡す必要があります application/pdf 。 ユニバーサル 印刷は、次のすべての条件が 満たされた場合に OXPS を PDF に変換します。

1. printerCapabilities でプリンター/プリンター application/pdf 共有 がサポートされています。
2. printer/printer 共有は application/oxps printerCapabilities ではサポートされていません。
3. 要求本文の contentType プロパティの値は、 です application/oxps 。

応答

成功した場合、このメソッドは応答コードと、応答本文の新しい 200 OK uploadSession オブジェクトを返します。

注: uploadSession 応答オブジェクトの一部として返される uploadUrl プロパティは、ファイルのバイト範囲をアップロードする後続のクエリの不透明な URL PUT です。 このトークンには、expirationDateTime によって期限切れになる後続のクエリに適 PUT した認証 トークンが含まれます。 この URL は変更しない。

例

次の例は、指定した printDocument への後続のファイルアップロード操作で使用できるアップロード セッションを作成する方法を示しています。

要求

HTTP

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
  }
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var properties = new PrintDocumentUploadProperties
{
    DocumentName = "TestFile.pdf",
    ContentType = "application/pdf",
    Size = 4533322
};

await graphClient.Print.Shares["{printerShare-id}"].Jobs["{printJob-id}"].Documents["{printDocument-id}"]
    .CreateUploadSession(properties)
    .Request()
    .PostAsync();

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const uploadSession = {
  properties: {
    documentName: 'TestFile.pdf',
    contentType: 'application/pdf', 
    size: 4533322
  }
};

await client.api('/print/shares/1c879027-5120-4aaf-954a-ebfd509a3bcc/jobs/46207/documents/9001bcd9-e36a-4f51-bfc6-140c3ad7f9f7/createUploadSession')
    .version('beta')
    .post(uploadSession);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/print/shares/1c879027-5120-4aaf-954a-ebfd509a3bcc/jobs/46207/documents/9001bcd9-e36a-4f51-bfc6-140c3ad7f9f7/createUploadSession"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

MSGraphPrintDocumentUploadProperties *properties = [[MSGraphPrintDocumentUploadProperties alloc] init];
[properties setDocumentName:@"TestFile.pdf"];
[properties setContentType:@"application/pdf"];
[properties setSize: 4533322];
payloadDictionary[@"properties"] = properties;

NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

PrintDocumentUploadProperties properties = new PrintDocumentUploadProperties();
properties.documentName = "TestFile.pdf";
properties.contentType = "application/pdf";
properties.size = 4533322L;

graphClient.print().shares("1c879027-5120-4aaf-954a-ebfd509a3bcc").jobs("46207").documents("9001bcd9-e36a-4f51-bfc6-140c3ad7f9f7")
    .createUploadSession(PrintDocumentCreateUploadSessionParameterSet
        .newBuilder()
        .withProperties(properties)
        .build())
    .buildRequest()
    .post();

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ 版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

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"
    ]
}