Interact with your data analysis jobs.

Create, update, delete jobs.

realitydataanalysis

This information is included in every event the webhook will receive.

base-event

content

object

eventType

string

enqueuedDateTime

iTwinId

messageId

webhookId

Base Event

Event that gets triggered when a reality analysis job is complete

realityAnalysis.jobCompleted.v1-event

Globally Unique Identifier of the reality analysis job.

jobId

realityAnalysis.jobCompleted.v1

---

Create a new job based on its type and options

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydataanalysis:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


jobs-create

OAuth access token with `realitydataanalysis:modify` or `itwin-platform` scope

Authorization

Setting to `application/vnd.bentley.itwin-platform.v1+json` is recommended.

Accept

My first objects2D job

default

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

HeaderNotFound

application/json;InvalidAuthorizationScheme

InvalidAuthorizationScheme

InvalidHeaderValue

RequiredScopeMissing

Unauthorized

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Delete an unsubmitted job

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydataanalysis:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


jobs-delete

Job can't be deleted once it has been submitted.

---

Retrieve job details, such as current state, execution information, outputs, etc.

### Parameters

The job id

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydataanalysis:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


jobs-get

OAuth access token with `realitydataanalysis:read` or `itwin-platform` scope

---

Retrieve job progress.

### Parameters

The job id

### Remarks

The job progression is deemed valid when the job is active and won't be available after 30 days.

Client should query with a backoff intervals [15,30,60,120] seconds. The interval between the first and second query is 15 sec and then 30 sec... If the percentage changes the sequence is restarted.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydataanalysis:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


jobs-progress

---

Patch an existing job

Patch can be used for changing the job state (to active or cancelled), updating job type and options or changing cost estimation parameters.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `realitydataanalysis:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


jobs-patch

Reference - Reality Analysis | iTwin Platform

This tutorial is an introduction to Reality Analysis API, explaining the basic workflows.

API references