Sign in

v6

latestSwagger 2.02026-07-134187316.2 KB

Get analysis status and results

Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.

get/analyze-text/jobs/{jobId}

Path parameters

jobIdstring uuid required

job ID

Query parameters

api-versionstring required

The API version to use for this operation.

showStatsboolean

(Optional) if set to true, response will contain request and document level statistics.

topinteger

The maximum number of resources to return from the collection.

skipinteger

An offset into the collection of the first resource to be returned.

Response

The request has succeeded.

displayNamestring

display name

createdDateTimestring date-time required

Date and time job created

expirationDateTimestring date-time

Date and time job expires

jobIdstring uuid required

Universally Unique Identifier

lastUpdatedDateTimestring date-time required

last updated date and time

status'notStarted' | 'running' | 'succeeded' | 'partiallyCompleted' | 'failed' | 'cancelled' | 'cancelling' required

The status of the task at the mentioned last update time.

nextLinkstring

next link