import { getItemStatus } from "@esri/arcgis-rest-portal";
  id: "30e5fe3149c34df1ba922e6f5bbf808f",

Inquire about status when publishing an item, adding an item in async mode, or adding with a multipart upload. See the REST Documentation for more information.


Parameter Type Default Notes
requestOptions Required IItemStatusOptions

Options for the request

Available requestOptions

Property Type Notes
authentication Inherited UserSession

A session representing a logged in user.

id Inherited string

Unique identifier of the item.

format Optional "html"

The response format. The default and the only response format for this resource is HTML.

jobId Optional string

The job ID returned during publish, generateFeatures, export, and createService calls.

jobType Optional "publish" | "generateFeatures" | "export" | "createService"

The type of asynchronous job for which the status has to be checked. Default is none, which check the item's status.

credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

owner Optional Inherited string

Item owner username. If not present, authentication.username is utilized.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to ''.

rawResponse Optional Inherited boolean

Return the raw response


A Promise to get the item status.

Property Type Notes
itemId string
status "partial" | "processing" | "failed" | "completed"
statusMessage string

Function defined in packages/arcgis-rest-portal/src/items/get.ts:293