IJobInfo

Interface

Describes the status of a job. See the GP Job documentation for more information.

Properties

PropertyTypeNotes
string

The ID of the job. Can be used to rehydrate an instance of Job with Job.fromExistingJob or Job.deserialize.

{ [key: string]: { paramUrl: string } }

An input property that are returned from a successful job.

{ description: string; type: string }[]

A message property that are returned from a successful job.

{ message: string; percentage: number; type: string }

A progress property that is returned while the job status is JOB_STATUSES.Executing

{ [key: string]: { paramUrl: string } }

A results property that are returned from a successful job.

Represents the status of the current job.

id

Interface Property
id: string

The ID of the job. Can be used to rehydrate an instance of Job with Job.fromExistingJob or Job.deserialize.

inputs

optional
Interface Property
inputs: { [key: string]: { paramUrl: string } }

An input property that are returned from a successful job.

Type declaration
  • [key: string]: { paramUrl: string }

messages

optional
Interface Property
messages: { description: string; type: string }[]

A message property that are returned from a successful job.

progress

optional
Interface Property
progress: { message: string; percentage: number; type: string }

A progress property that is returned while the job status is JOB_STATUSES.Executing

Type declaration

    results

    optional
    Interface Property
    results: { [key: string]: { paramUrl: string } }

    A results property that are returned from a successful job.

    Type declaration
    • [key: string]: { paramUrl: string }

    status

    Interface Property
    status: JOB_STATUSES

    Represents the status of the current job.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

    You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

    Your ArcGIS portal

    Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

    Your ArcGIS Location Platform dashboard

    Manage billing, monitor service usage, and access additional resources.

    Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

    Close