Sign in

v2

latestSwagger 2.02026-07-1372442.7 KB

Create a de-identification job.

Long-running resource create or replace operation template.

put/jobs/{name}

Path parameters

namestring required

The name of a job.

Query parameters

api-versionstring required

The API version to use for this operation.

Headers

x-ms-client-request-idstring uuid

An opaque, globally-unique, client-generated string identifier for the request.

Request body

namestring required

The name of a job.

operation'Redact' | 'Surrogate' | 'Tag' | 'SurrogateOnly'

Operation to perform on the input documents.

status'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Canceled' required

Enum describing allowed operation states.

lastUpdatedAtstring date-time required

Date and time when the job was completed.

If the job is canceled, this is the time when the job was canceled.

If the job failed, this is the time when the job failed.

createdAtstring date-time required

Date and time when the job was created.

startedAtstring date-time

Date and time when the job was started.

Response

The request has succeeded.

namestring required

The name of a job.

operation'Redact' | 'Surrogate' | 'Tag' | 'SurrogateOnly'

Operation to perform on the input documents.

status'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Canceled' required

Enum describing allowed operation states.

lastUpdatedAtstring date-time required

Date and time when the job was completed.

If the job is canceled, this is the time when the job was canceled.

If the job failed, this is the time when the job failed.

createdAtstring date-time required

Date and time when the job was created.

startedAtstring date-time

Date and time when the job was started.