canceljobrequest.md

title	description	keywords	topic_type	ms.topic	api_name	api_type	ms.date
CancelJobRequest Element	The required CancelJobRequest operation enables a client to cancel a scan job.	CancelJobRequest element Imaging Devices	apiref	reference	wscn CancelJobRequest	Schema	03/28/2023

CancelJobRequest element

The required CancelJobRequest operation enables a client to cancel a scan job.

Usage

<wscn:CancelJobRequest>
  child elements
</wscn:CancelJobRequest>

Attributes

There are no attributes.

Text value

None

Child elements

Element
JobId

Parent elements

There are no parent elements.

Remarks

JobId

A client can cancel a scan job from the time the job is created up to the time it is completed, canceled, or aborted. The JobId element identifies the job that the client is trying to cancel.

The WSD Scan Service should move the specified job to the Terminating state if the job was at a Pending or Active state. It is an error to attempt to cancel a completed or canceled job or to try canceling any job that the client does not have rights to.

common WSD Scan Service operation error codesWSD Scan Service Operation Error Reporting

This operation can return all of the common WSD Scan Service operation error codes. For more information about how to report errors, see WSD Scan Service Operation Error Reporting.

CancelJobRequest can also return the following error code:

• ClientErrorJobIdNotFound

See also

CancelJobResponse

JobId