Interact with your jobs and workspaces for Reality Modeling

Create, update, delete jobs and workspaces.

contextcapture

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

base-event

content

object

Base Event eventType

base-event-eventType

enqueuedDateTime

string

iTwinId

messageId

webhookId

Base Event

Event that gets triggered when a reality modeling job is complete

realityModeling.jobCompleted.v1-event

Globally Unique Identifier of the reality modeling job.

jobId

realityModeling.jobCompleted.v1

ContextCapture Service is available as technology preview.

ContextCapture Service is generally available.

ContextCapture Service is rebranded to Reality Modeling Service.

contextcapture-rcsTemplateUpdate

---

Create a new job

### Authentication

Requires `Authorization` header with valid Bearer token for scope `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 `itwin-platform` scope

Authorization

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

Accept

My first Reality Modeling 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

InvalidAuthorizationScheme

InvalidHeaderValue

RequiredScopeMissing

Unauthorized

InvalidApplicationTier

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).

InvalidContextCaptureRequest

MissingRequestBody

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 `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 cannot be deleted once it has been submitted.

---

Retrieve job details.

### Parameters

The job id

### Authentication

Requires `Authorization` header with valid Bearer token for scope `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

---

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 `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 a job to modify it (type, settings, cost estimation parameters), submit or cancel it.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `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

State

Settings

CostEstimationParameters

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


workspaces-create

---

Delete a workspace.

### Parameters

A workspace id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


workspaces-delete

---

Retrieve workspace information.

### Parameters

A workspace id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


workspaces-get

---

Retrieve the engines limit.

### Parameters

An optional projectId.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


limits-engines

Changelog - Reality Modeling | iTwin Platform

Learn how to specify calibration settings in Reality Modeling, and download the result of a calibration

Better calibration in Reality Modeling

This tutorial focuses on using cache for faster processing in Reality Modeling

Using cache in Reality Modeling API

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

Changelog

Jun 15, 2023