Interact with your jobs and projects for ContextCapture

Create, update, delete jobs and projects.

contextcapture

Reality Modeling

Technology Preview

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


jobs-cancel

OAuth access token with scope `contextcapture:modify`

Authorization

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

Accept

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.

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

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


jobs-create

My first CCCS job

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

application/json;InvalidContextCaptureRequest

---

Delete an unsubmitted job

### Authentication

Requires `Authorization` header with valid Bearer token for scope `contextcapture:modify`.

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.

### Parameters

The job id

### Authentication

Requires `Authorization` header with valid Bearer token for scope `contextcapture:read`.

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 scope `contextcapture:read`

---

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 `contextcapture:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


jobs-progress

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


jobs-submit

---

Create a new workspace

### Authentication

Requires `Authorization` header with valid Bearer token for scope `contextcapture:modify`.

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 `contextcapture:modify`.

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 `contextcapture:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


workspaces-get

---

Estimate reconstruction cost

### Parameters

A JSON object containing processing information should be passed in the request body.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `contextcapture:read`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


estimate-cost

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


limits-engines

projectId

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


ContextCapture

Jobs

Authentication