printJob: abort

名前空間: microsoft.graph

印刷ジョブを中止します。 印刷ジョブを中止できるのは、アプリケーションのアクセス許可を使用するアプリケーションのみです。

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

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アプリのテナントは、次のアクセス許可に加えて、アクティブなユニバーサル印刷サブスクリプションを持ち、Printer.Read.All または Printer.ReadWrite.All アプリケーションのアクセス許可を持っている必要があります。

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

HTTP 要求

POST /print/printers/{printerId}/jobs/{printJobId}/abort

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。

要求本文

要求本文では、必要に応じて、ジョブが中止される理由を指定できます。

プロパティ	型	説明
理由	文字列	ジョブが中止される理由。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。応答本文には何も返されません。

例

要求

HTTP

POST https://graph.microsoft.com/v1.0/print/printers/{printerId}/jobs/{printJobId}/abort
Content-Type: application/json

{
  "reason": "String"
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var reason = "String";

await graphClient.Print.Printers["{printer-id}"].Jobs["{printJob-id}"]
    .Abort(reason)
    .Request()
    .PostAsync();

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

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const abort = {
  reason: 'String'
};

await client.api('/print/printers/{printerId}/jobs/{printJobId}/abort')
    .post(abort);

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

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/print/printers/{printerId}/jobs/{printJobId}/abort"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

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

NSString *reason = @"String";
payloadDictionary[@"reason"] = reason;

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];

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

Java

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

String reason = "String";

graphClient.print().printers("{printerId}").jobs("{printJobId}")
    .abort(PrintJobAbortParameterSet
        .newBuilder()
        .withReason(reason)
        .build())
    .buildRequest()
    .post();

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

応答

HTTP/1.1 204 No Content