Reality Data Analysis

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Jobs

Download API definition:

PATCH https://sampleHostName/realitydataanalysis/jobs/{jobId}

Patch an existing job

Patch can be used for changing the job state (to active or cancelled), updating job type and settings or changing cost estimation parameters.

Authentication

Requires Authorization header with valid Bearer token for scope realitydataanalysis:modify.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.


Request parameters

Name
In
Required?
Description
jobId
template
Yes

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope realitydataanalysis:modify

Accept
No

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

Request body

jobPatch

Name
Type
Required?
Description
No data.

jobPatch

Name
Type
Required?
Description
No data.

jobPatch

Name
Type
Required?
Description
No data.

Response 200 OK

Created

json

Response 401 Unauthorized

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.

json

Response 404 Not Found

Not Found

json

Response 422 Unprocessable Entity

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

json

Response 429 Too many requests

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

json

Response headers

Name
Description
retry-after

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