Reality Analysis
Jobs
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
Request headers
OAuth access token with scope realitydataanalysis:modify
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
New settings for this job, must be in sync with type
Example
New settings for this job, must be in sync with type
Example
New settings for this job, must be in sync with type
Example
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.
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).
Response 429 Too many requests
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.
Job type
Available job types among 'objects2D', 'segmentation2D'.
Job state
Possible state of a job among 'unsubmitted', 'active', 'success', 'failed' and 'cancelled'.
Input format
Input format available for inputs. Refer to tutorials for per job type list.
Job Input
Input description for an Objects2D job
Reality Data id of the input
Output format
Output format available for outputs. Refer to tutorials for per job type list.
Job Output
Output description for an Objects2D job
Reality Data id of the output
Input format
Input format available for inputs. Refer to tutorials for per job type list.
Job Input
Input description for a Segmentation2D job
Reality Data id of the input
Output format
Output format available for outputs. Refer to tutorials for per job type list.
Job Output
Output description for a Segmentation2D job
Reality Data id of the output
Input format
Input format available for inputs. Refer to tutorials for per job type list.
Job Input
Input description for an Objects3D job
Reality Data id of the input
Output format
Output format available for outputs. Refer to tutorials for per job type list.
Job Output
Output description for an Objects3D job
Reality Data id of the output
Input Objects3D Settings
Settings for an Objects3D job
Use tie points from input scene
Min number of 2D detections per 3D object (0 for default)
Maximum distance between photos and 3D objects (0 for default)
SRS used by all exports
Complete Objects3D Settings
Settings for an Objects3D job
Use tie points from input scene
Min number of 2D detections per 3D object (0 for default)
Maximum distance between photos and 3D objects (0 for default)
SRS used by all exports
Input format
Input format available for inputs. Refer to tutorials for per job type list.
Job Input
Input description for a Segmentation3D job
Reality Data id of the input
Output format
Output format available for outputs. Refer to tutorials for per job type list.
Job Output
Output description for a Segmentation3D job
Reality Data id of the output
Input Segmentation2D Settings
Input settings for a Segmentation3D job
If true, save a confidence estimate for each point
SRS used by all exports
Complete Segmentation3D Settings
Settings for an Segmentation3D job
If true, save a confidence estimate for each point
SRS used by all exports
Input format
Input format available for inputs. Refer to tutorials for per job type list.
Job Input
Input description for a Lines3D job
Reality Data id of the input
Output format
Output format available for outputs. Refer to tutorials for per job type list.
Job Output
Output description for a Lines3D job
Reality Data id of the output
Input Lines3D Settings
Input settings for a Lines3D job
Estimate lines diameter
Minimum length of a 3D line
SRS used by all exports
Complete Lines3D Settings
Settings for an Lines3D job
Estimate lines diameter
Minimum length of a 3D line
SRS used by all exports
Input format
Input format available for inputs. Refer to tutorials for per job type list.
Job Input
Input description for a ChangeDetection job
Reality Data id of the input
Output format
Output format available for outputs. Refer to tutorials for per job type list.
Job Output
Output description for a ChangeDetection job
Reality Data id of the output
Input ChangeDetection Settings
Input settings for a ChangeDetection job
Cluster is a change if color discrepancy is above this threshold. 0 to ignore color changes
Cluster is a change only kept if color discrepancy of at least one point in the change is above this threshold. 0 to ignore color changes
Cluster is a change if distance between point clouds is above this threshold. 0 for automatic setting
Cluster is a change only kept if the distance of at least one point in the change is above this threshold. 0 for automatic setting
Resolution of point clouds converted from meshes
Minimum number of points in a cluster
SRS used by all exports
Complete ChangeDetection Settings
Settings for an ChangeDetection job
Cluster is a change if color discrepancy is above this threshold. 0 to ignore color changes
Cluster is a change only kept if color discrepancy of at least one point in the change is above this threshold. 0 to ignore color changes
Cluster is a change if distance between point clouds is above this threshold. 0 for automatic setting
Cluster is a change only kept if the distance of at least one point in the change is above this threshold. 0 for automatic setting
Resolution of point clouds converted from meshes
Minimum number of points in a cluster
SRS used by all exports
Cost Estimation Parameters
Optional parameters for estimating job cost before its processing
Number of giga pixels in inputs
Number of photos in inputs
Width of the scene
Height of the scene
Length of the scene
Scale of the detector
Cost of the detector
Job Patch
Patch information to be applied
New settings for this job, must be in sync with type
Error and Warning messages
Model for error and warning messages
Error or warning message code
Error or warning message title
Error or warning message
Error or warning message parameters
Execution information
Execution details regarding a job
Exit code of the processing
Submission date time of the job
Start date time of the job
End date time of the job
Estimated cost of the executed job
Cost Estimation information
Cost estimate based on parameters before job processing
Number of giga pixels in inputs
Number of photos in inputs
Width of the scene
Height of the scene
Length of the scene
Scale of the detector
Cost of the detector
Estimated Cost of the job using the CostEstimationParameters
Job
Job complete details
Job id
User email address
Job name
ITwin Id
Settings for this job, must be in sync with type
Created date time of the job
Date time of the latest modification of the job
Data center location of the job
DetailedError
Contains error information and an array of more specific errors.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Detailed Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.