get https://dev-api.bentley.com/reality-modeling/jobs/{id}
Retrieve job details.
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 page.
Request parameters
Job id
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.
Response 200 OK
OK
json
{ "job": { "id": "d75704b5-e854-4ff3-a086-3ac6a20af5fa", "state": "Active", "userId": "911edf8b-59ad-404c-a743-aec05ca038e9", "executionInfo": { "createdDateTime": "2025-03-06T09:42:33.0000000+00:00" }, "specifications": { "inputs": { "sceneToProcess": "4b72d64d-fa15-4059-b3a6-ef65486e3786" }, "outputs": { "scene": "09cc000e-726b-4719-88ee-a6085d5432db" }, "options": { "recursiveImageCollections": false, "altitudeReference": "SeaLevel" } }, "name": "My first Reality Modeling job", "type": "FillImageProperties", "iTwinId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }
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
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
Not Found
json
{ "error": { "code": "JobNotFound", "message": "Requested job is not available." } }
Response 429 Too many requests
This response indicates that the client sent more requests than allowed by this API for the current tier of the client.
json
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Job
Job information
Job unique id
Job name
Identifier of the user that created the job.
iTwin Id
List of inputs, outputs and options for the job, must be in sync with type
json
{ "type": "object", "title": "Job", "required": [ "iTwinId", "specifications", "type", "executionInfo", "id", "state", "userId" ], "properties": { "id": { "type": "string", "description": "Job unique id" }, "name": { "type": "string", "pattern": "^([^\"<>|:*?\\\\/\\u0000-\\u001f])+$", "nullable": true, "maxLength": 256, "minLength": 3, "description": "Job name" }, "type": { "$ref": "#/components/schemas/JobTypes" }, "state": { "$ref": "#/components/schemas/JobState" }, "userId": { "type": "string", "description": "Identifier of the user that created the job." }, "iTwinId": { "type": "string", "description": "iTwin Id" }, "executionInfo": { "$ref": "#/components/schemas/ExecutionInformation" }, "specifications": { "anyOf": [ { "$ref": "#/components/schemas/FillImagePropertiesSpecifications" }, { "$ref": "#/components/schemas/ImportPointCloudSpecifications" }, { "$ref": "#/components/schemas/CalibrationSpecifications" }, { "$ref": "#/components/schemas/TilingSpecifications" }, { "$ref": "#/components/schemas/ProductionSpecifications" }, { "$ref": "#/components/schemas/ReconstructionSpecifications" }, { "$ref": "#/components/schemas/ConstraintsSpecifications" }, { "$ref": "#/components/schemas/TouchUpExportSpecifications" }, { "$ref": "#/components/schemas/TouchUpImportSpecifications" }, { "$ref": "#/components/schemas/WaterConstraintsSpecifications" }, { "$ref": "#/components/schemas/GaussianSplatsSpecifications" } ], "description": "List of inputs, outputs and options for the job, must be in sync with type" } }, "description": "Job information", "additionalProperties": false }
Tag
json
{ "enum": [ "QR", "April", "Chili", "Checkerboards" ], "type": "string", "title": "Tag" }
Error
Contains error information.
One of a server-defined set of error codes.
The target of the error.
A human-readable representation of the error.
json
{ "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "target": { "type": "string", "nullable": true, "description": "The target of the error." }, "message": { "type": "string", "description": "A human-readable representation of the error." } }, "description": "Contains error information.", "additionalProperties": true }
Export
Name used for the reality data.
Options associated to format
Reality data id of the export
json
{ "type": "object", "title": "Export", "required": [ "format", "location" ], "properties": { "name": { "type": "string", "title": "name", "default": null, "nullable": true, "minLength": 3, "description": "Name used for the reality data." }, "format": { "$ref": "#/components/schemas/Format" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/Options3DTiles" }, { "$ref": "#/components/schemas/Options3MX" }, { "$ref": "#/components/schemas/OptionsOBJ" }, { "$ref": "#/components/schemas/OptionsLAS" }, { "$ref": "#/components/schemas/OptionsPLY" }, { "$ref": "#/components/schemas/OptionsOPC" }, { "$ref": "#/components/schemas/OptionsOrthoDSM" }, { "$ref": "#/components/schemas/OptionsI3S" }, { "$ref": "#/components/schemas/OptionsOSGB" } ], "title": "options", "default": null, "nullable": true, "description": "Options associated to format" }, "location": { "type": "string", "title": "location", "description": "Reality data id of the export" } }, "additionalProperties": false }
Format
json
{ "enum": [ "3DTiles", "3MX", "OBJ", "LAS", "PLY", "OPC", "OrthophotoDSM", "I3S", "OSGB" ], "type": "string", "title": "Format" }
LOD Type
json
{ "enum": [ "None", "Unary", "Quadtree", "Octree", "Adaptive", "BingMaps" ], "type": "string", "title": "LOD Type" }
Point3d
X coordinate
Y coordinate
Z coordinate
json
{ "type": "object", "title": "Point3d", "required": [ "x", "y", "z" ], "properties": { "x": { "type": "number", "description": "X coordinate" }, "y": { "type": "number", "description": "Y coordinate" }, "z": { "type": "number", "description": "Z coordinate" } }, "additionalProperties": false }
GS Format
json
{ "enum": [ "SPZ", "3DTiles", "PLY", "3DTilesLOD" ], "type": "string", "title": "GS Format" }
Job state
Job current state
json
{ "enum": [ "Queued", "Active", "TerminatingOnCancel", "TerminatingOnFailure", "Cancelled", "Failed", "Success" ], "type": "string", "title": "Job state", "description": "Job current state" }
Job type
Supported job types
json
{ "enum": [ "FillImageProperties", "ImportPointCloud", "Calibration", "Tiling", "Production", "Reconstruction", "Constraints", "TouchUpExport", "TouchUpImport", "WaterConstraints", "GaussianSplats" ], "type": "string", "title": "Job type", "description": "Supported job types" }
LOD Scope
json
{ "enum": [ "TileWise", "AcrossTiles" ], "type": "string", "title": "LOD Scope" }
DSM Format
json
{ "enum": [ "GeoTIFF", "ASC", "None" ], "type": "string", "title": "DSM Format" }
GSQuality
json
{ "enum": [ "Medium", "Standard", "High" ], "type": "string", "title": "GSQuality" }
Options 3MX
Coordinate Reference System
Flag to generate a web application
Maximum resolution for the texture color source
Minimum resolution for the texture color source
Maximum thermal value for the texture color source
Minimum thermal value for the texture color source
json
{ "type": "object", "title": "Options 3MX", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "lodScope": { "$ref": "#/components/schemas/LODScope" }, "crsOrigin": { "$ref": "#/components/schemas/Point3d" }, "generateWebApp": { "type": "boolean", "default": null, "nullable": true, "description": "Flag to generate a web application" }, "textureColorSource": { "$ref": "#/components/schemas/ColorSource" }, "textureColorSourceResMax": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Maximum resolution for the texture color source" }, "textureColorSourceResMin": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Minimum resolution for the texture color source" }, "textureColorSourceThermalMax": { "type": "number", "default": null, "nullable": true, "description": "Maximum thermal value for the texture color source" }, "textureColorSourceThermalMin": { "type": "number", "default": null, "nullable": true, "description": "Minimum thermal value for the texture color source" }, "textureColorSourceThermalUnit": { "$ref": "#/components/schemas/ThermalUnit" } }, "additionalProperties": false }
Options OBJ
Coordinate Reference System
Maximum resolution for the texture color source
Minimum resolution for the texture color source
Maximum thermal value for the texture color source
Minimum thermal value for the texture color source
json
{ "type": "object", "title": "Options OBJ", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "textureColorSource": { "$ref": "#/components/schemas/ColorSource" }, "textureColorSourceResMax": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Maximum resolution for the texture color source" }, "textureColorSourceResMin": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Minimum resolution for the texture color source" }, "textureColorSourceThermalMax": { "type": "number", "default": null, "nullable": true, "description": "Maximum thermal value for the texture color source" }, "textureColorSourceThermalMin": { "type": "number", "default": null, "nullable": true, "description": "Minimum thermal value for the texture color source" }, "textureColorSourceThermalUnit": { "$ref": "#/components/schemas/ThermalUnit" } }, "additionalProperties": false }
Options LAS
Coordinate Reference System
Flag to merge point clouds
Sampling distance
json
{ "type": "object", "title": "Options LAS", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "compress": { "$ref": "#/components/schemas/LasCompression" }, "mergePointClouds": { "type": "boolean", "default": null, "nullable": true, "description": "Flag to merge point clouds" }, "samplingDistance": { "type": "number", "default": null, "nullable": true, "description": "Sampling distance" }, "samplingStrategy": { "$ref": "#/components/schemas/SamplingStrategy" }, "textureColorSource": { "$ref": "#/components/schemas/ColorSource" } }, "additionalProperties": false }
Options OBJ
Coordinate Reference System
Flag for double precision
Enable or disable texture sharpening.
Maximum texture size
JPG compression of texture file
Maximum resolution for the texture color source
Minimum resolution for the texture color source
Maximum thermal value for the texture color source
Minimum thermal value for the texture color source
json
{ "type": "object", "title": "Options OBJ", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "lodType": { "$ref": "#/components/schemas/LODType" }, "lodScope": { "$ref": "#/components/schemas/LODScope" }, "crsOrigin": { "$ref": "#/components/schemas/Point3d" }, "doublePrecision": { "type": "boolean", "default": null, "nullable": true, "description": "Flag for double precision" }, "textureSharpening": { "type": "boolean", "default": null, "nullable": true, "description": "Enable or disable texture sharpening." }, "maximumTextureSize": { "type": "integer", "default": null, "nullable": true, "description": "Maximum texture size" }, "textureColorSource": { "$ref": "#/components/schemas/ColorSource" }, "textureCompression": { "type": "integer", "default": null, "maximum": 100, "minimum": 0, "nullable": true, "description": "JPG compression of texture file" }, "textureColorSourceResMax": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Maximum resolution for the texture color source" }, "textureColorSourceResMin": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Minimum resolution for the texture color source" }, "textureColorSourceThermalMax": { "type": "number", "default": null, "nullable": true, "description": "Maximum thermal value for the texture color source" }, "textureColorSourceThermalMin": { "type": "number", "default": null, "nullable": true, "description": "Minimum thermal value for the texture color source" }, "textureColorSourceThermalUnit": { "$ref": "#/components/schemas/ThermalUnit" } }, "additionalProperties": false }
Options OPC
Coordinate Reference System
Sampling distance
json
{ "type": "object", "title": "Options OPC", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "samplingDistance": { "type": "number", "default": null, "nullable": true, "description": "Sampling distance" }, "samplingStrategy": { "$ref": "#/components/schemas/SamplingStrategy" }, "textureColorSource": { "$ref": "#/components/schemas/ColorSource" } }, "additionalProperties": false }
Options PLY
Coordinate Reference System
Flag to include normals
Flag to merge point clouds
Sampling distance
json
{ "type": "object", "title": "Options PLY", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "includeNormals": { "type": "boolean", "default": null, "nullable": true, "description": "Flag to include normals" }, "mergePointClouds": { "type": "boolean", "default": null, "nullable": true, "description": "Flag to merge point clouds" }, "samplingDistance": { "type": "number", "default": null, "nullable": true, "description": "Sampling distance" }, "samplingStrategy": { "$ref": "#/components/schemas/SamplingStrategy" }, "textureColorSource": { "$ref": "#/components/schemas/ColorSource" } }, "additionalProperties": false }
Rig Synchro
json
{ "enum": [ "None", "Strict", "Loose" ], "type": "string", "title": "Rig Synchro" }
Skew Policy
json
{ "enum": [ "Adjust", "Keep" ], "type": "string", "title": "Skew Policy" }
TilingMode
json
{ "enum": [ "NoTiling", "RegularPlanarGrid", "RegularVolumetricGrid", "Adaptive" ], "type": "string", "title": "TilingMode" }
Touch Level
json
{ "enum": [ "Geometry", "GeometryAndTexture" ], "type": "string", "title": "Touch Level" }
Color Source
json
{ "enum": [ "None", "Visible", "Thermal", "Resolution" ], "type": "string", "title": "Color Source" }
Focal Policy
json
{ "enum": [ "Adjust", "Keep" ], "type": "string", "title": "Focal Policy" }
Hole Filling
json
{ "enum": [ "SmallHoles", "AllHoles" ], "type": "string", "title": "Hole Filling" }
Job response
json
{ "type": "object", "title": "Job response", "properties": { "job": { "$ref": "#/components/schemas/Job" } }, "additionalProperties": false }
Options OBJ
Coordinate Reference System
Enable or disable texture sharpening.
Maximum texture size
JPG compression of texture file
Maximum resolution for the texture color source
Minimum resolution for the texture color source
Maximum thermal value for the texture color source
Minimum thermal value for the texture color source
json
{ "type": "object", "title": "Options OBJ", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "lodType": { "$ref": "#/components/schemas/LODType" }, "lodScope": { "$ref": "#/components/schemas/LODScope" }, "crsOrigin": { "$ref": "#/components/schemas/Point3d" }, "textureSharpening": { "type": "boolean", "default": null, "nullable": true, "description": "Enable or disable texture sharpening." }, "maximumTextureSize": { "type": "integer", "default": null, "nullable": true, "description": "Maximum texture size" }, "textureColorSource": { "$ref": "#/components/schemas/ColorSource" }, "textureCompression": { "type": "integer", "default": null, "maximum": 100, "minimum": 0, "nullable": true, "description": "JPG compression of texture file" }, "textureColorSourceResMax": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Maximum resolution for the texture color source" }, "textureColorSourceResMin": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Minimum resolution for the texture color source" }, "textureColorSourceThermalMax": { "type": "number", "default": null, "nullable": true, "description": "Maximum thermal value for the texture color source" }, "textureColorSourceThermalMin": { "type": "number", "default": null, "nullable": true, "description": "Minimum thermal value for the texture color source" }, "textureColorSourceThermalUnit": { "$ref": "#/components/schemas/ThermalUnit" } }, "additionalProperties": false }
Ortho Format
json
{ "enum": [ "GeoTIFF", "JPEG", "None" ], "type": "string", "title": "Ortho Format" }
Thermal Unit
json
{ "enum": [ "Absolute", "Celsius", "Fahrenheit" ], "type": "string", "title": "Thermal Unit" }
Center Policy
json
{ "enum": [ "Compute", "Adjust", "AdjustWithinTolerance", "Keep", "Extend" ], "type": "string", "title": "Center Policy" }
Overview Type
json
{ "enum": [ "None", "Embedded", "OvrFile" ], "type": "string", "title": "Overview Type" }
Radial Policy
json
{ "enum": [ "Adjust", "Keep" ], "type": "string", "title": "Radial Policy" }
Tiling Inputs
Reality data id of ContextScene to process
Path in the bucket for CRS Data
List of paths to preset
Path in the bucket to region of interest file
json
{ "type": "object", "title": "Tiling Inputs", "required": [ "scene" ], "properties": { "scene": { "type": "string", "description": "Reality data id of ContextScene to process" }, "crsData": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket for CRS Data" }, "presets": { "type": "string", "default": null, "nullable": true, "description": "List of paths to preset" }, "regionOfInterest": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket to region of interest file" } }, "additionalProperties": false }
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.
json
{ "type": "object", "title": "Error Response", "required": [ "error" ], "properties": { "error": { "$ref": "#/components/schemas/Error", "description": "Error information." } }, "description": "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.", "additionalProperties": false }
Pair Selection
json
{ "enum": [ "Default", "Sequence", "Loop", "Exhaustive", "SimilarOnly" ], "type": "string", "title": "Pair Selection" }
Texture Source
json
{ "enum": [ "PhotosFirst", "PointCloudsFirst", "Smart" ], "type": "string", "title": "Texture Source" }
Tiling Options
Coordinate Reference System
Tiling Value
Ortho resolution
Untextured color
Discard emtpy tiles
Texture resolution limit
Geometry resolution limit
Planar simplification tolerance
json
{ "type": "object", "title": "Tiling Options", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "tilingMode": { "$ref": "#/components/schemas/TilingMode" }, "holeFilling": { "$ref": "#/components/schemas/HoleFilling" }, "tilingValue": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Tiling Value" }, "tilingOrigin": { "$ref": "#/components/schemas/Point3d" }, "pairSelection": { "$ref": "#/components/schemas/TilingPairSelection" }, "textureSource": { "$ref": "#/components/schemas/TextureSource" }, "simplification": { "$ref": "#/components/schemas/Simplification" }, "colorCorrection": { "$ref": "#/components/schemas/ColorCorrection" }, "orthoResolution": { "type": "number", "nullable": true, "description": "Ortho resolution" }, "untexturedColor": { "type": "string", "default": null, "pattern": "^#[a-fA-F0-9]{6}$", "nullable": true, "description": "Untextured color" }, "discardEmptyTiles": { "type": "boolean", "default": null, "nullable": true, "description": "Discard emtpy tiles" }, "geometricPrecision": { "$ref": "#/components/schemas/GeometricPrecision" }, "photoUsedForGeometry": { "$ref": "#/components/schemas/PhotoUsedForGeometry" }, "modelingReferenceType": { "$ref": "#/components/schemas/ModelingReferenceType" }, "pointCloudColorSource": { "$ref": "#/components/schemas/PointCloudColorSource" }, "textureResolutionLimit": { "type": "number", "default": null, "nullable": true, "description": "Texture resolution limit" }, "geometryResolutionLimit": { "type": "number", "nullable": true, "description": "Geometry resolution limit" }, "untexturedRepresentation": { "$ref": "#/components/schemas/UntexturedRepresentation" }, "planarSimplificationTolerance": { "type": "number", "default": null, "nullable": true, "description": "Planar simplification tolerance" } }, "additionalProperties": false }
Tiling Outputs
json
{ "type": "object", "title": "Tiling Outputs", "required": [ "modelingReference" ], "properties": { "modelingReference": { "$ref": "#/components/schemas/ModelingReference" } }, "additionalProperties": false }
Constraint Type
json
{ "enum": [ "Mesh", "Polygon" ], "type": "string", "title": "Constraint Type" }
Las Compression
json
{ "enum": [ "None", "LAZ" ], "type": "string", "title": "Las Compression" }
Options 3DTiles
Coordinate Reference System
Maximum resolution for the texture color source
Minimum resolution for the texture color source
Maximum thermal value for the texture color source
Minimum thermal value for the texture color source
json
{ "type": "object", "title": "Options 3DTiles", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "compress": { "$ref": "#/components/schemas/CesiumCompression" }, "lodScope": { "$ref": "#/components/schemas/LODScope" }, "textureColorSource": { "$ref": "#/components/schemas/ColorSource" }, "textureColorSourceResMax": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Maximum resolution for the texture color source" }, "textureColorSourceResMin": { "type": "number", "default": null, "minimum": 0, "nullable": true, "description": "Minimum resolution for the texture color source" }, "textureColorSourceThermalMax": { "type": "number", "default": null, "nullable": true, "description": "Maximum thermal value for the texture color source" }, "textureColorSourceThermalMin": { "type": "number", "default": null, "nullable": true, "description": "Minimum thermal value for the texture color source" }, "textureColorSourceThermalUnit": { "$ref": "#/components/schemas/ThermalUnit" } }, "additionalProperties": false }
Projection Mode
json
{ "enum": [ "HighestPoint", "LowestPoint" ], "type": "string", "title": "Projection Mode" }
Rotation Policy
json
{ "enum": [ "Compute", "Adjust", "Keep", "Extend" ], "type": "string", "title": "Rotation Policy" }
Simplification
json
{ "enum": [ "Standard", "PlanarRelative", "PlanarAbsolute" ], "type": "string", "title": "Simplification" }
Color Correction
json
{ "enum": [ "None", "Standard", "StandardWithThermal", "BlockWise", "BlockWiseWithThermal" ], "type": "string", "title": "Color Correction" }
Constraint To Add
Coordinate Reference System
Name of the constraint
Fill color for the constraint
Resolution of the constraint
Description of the constraint
Path in the bucket to the texture file
Size of the texture
Path in the bucket to the constraint file
json
{ "type": "object", "title": "Constraint To Add", "required": [ "constraint Path", "crs" ], "properties": { "crs": { "type": "string", "description": "Coordinate Reference System" }, "name": { "type": "string", "default": null, "nullable": true, "description": "Name of the constraint" }, "type": { "$ref": "#/components/schemas/ConstraintType" }, "fillColor": { "type": "string", "default": null, "nullable": true, "description": "Fill color for the constraint" }, "resolution": { "type": "number", "default": null, "nullable": true, "description": "Resolution of the constraint" }, "description": { "type": "string", "default": null, "nullable": true, "description": "Description of the constraint" }, "texturePath": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket to the texture file" }, "textureSize": { "type": "integer", "default": null, "nullable": true, "description": "Size of the texture" }, "constraintPath": { "type": "string", "pattern": "^bkt:.+", "description": "Path in the bucket to the constraint file" } }, "additionalProperties": false }
Options OrthoDSM
Coordinate Reference System
Flag to merge parts
No data color
No data value
Sampling distance
No data transparency
json
{ "type": "object", "title": "Options OrthoDSM", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Coordinate Reference System" }, "dsmFormat": { "$ref": "#/components/schemas/DSMFormat" }, "overviews": { "$ref": "#/components/schemas/OverviewType" }, "mergeParts": { "type": "boolean", "default": null, "nullable": true, "description": "Flag to merge parts" }, "colorSource": { "$ref": "#/components/schemas/OrthoColorSource" }, "noDataColor": { "type": "string", "default": null, "nullable": true, "description": "No data color" }, "noDataValue": { "type": "number", "default": null, "nullable": true, "description": "No data value" }, "orthoFormat": { "$ref": "#/components/schemas/OrthoFormat" }, "projectionMode": { "$ref": "#/components/schemas/ProjectionMode" }, "samplingDistance": { "type": "number", "default": null, "nullable": true, "description": "Sampling distance" }, "noDataTransparency": { "type": "boolean", "default": null, "nullable": true, "description": "No data transparency" } }, "additionalProperties": false }
Principal Policy
json
{ "enum": [ "Adjust", "Keep" ], "type": "string", "title": "Principal Policy" }
Tiepoints Policy
json
{ "enum": [ "Compute", "Keep" ], "type": "string", "title": "Tiepoints Policy" }
Keypoints Density
json
{ "enum": [ "Normal", "High" ], "type": "string", "title": "Keypoints Density" }
Ortho Color Source
json
{ "enum": [ "Reference3dModelVisible", "OptimizedComputationVisible", "Reference3dModelThermal", "OptimizedComputationThermal" ], "type": "string", "title": "Ortho Color Source" }
Production Inputs
Reality data id of ContextScene to process
Path in the bucket to region of interest file, used for export extent
Path in the bucket for CRS Data
List of paths to preset
Reality data id of modeling reference to process
json
{ "type": "object", "title": "Production Inputs", "required": [ "scene", "modelingReference" ], "properties": { "scene": { "type": "string", "description": "Reality data id of ContextScene to process" }, "extent": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket to region of interest file, used for export extent" }, "crsData": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket for CRS Data" }, "presets": { "type": "string", "default": null, "nullable": true, "description": "List of paths to preset" }, "modelingReference": { "type": "string", "description": "Reality data id of modeling reference to process" } }, "additionalProperties": false }
Sampling Strategy
json
{ "enum": [ "Resolution", "Absolute" ], "type": "string", "title": "Sampling Strategy" }
Tangential Policy
json
{ "enum": [ "Adjust", "Keep" ], "type": "string", "title": "Tangential Policy" }
Altitude Reference
Values for Altitude Reference when filling image properties.
json
{ "enum": [ "SeaLevel", "WGS84Ellipsoid" ], "type": "string", "title": "Altitude Reference", "description": "Values for Altitude Reference when filling image properties.", "additionalProperties": false }
Aspect Ratio Policy
json
{ "enum": [ "Adjust", "Keep" ], "type": "string", "title": "Aspect Ratio Policy" }
Calibration Inputs
Reality data ID of ContextScene to process
Path in the bucket for CRS Data
List of paths to preset
json
{ "type": "object", "title": "Calibration Inputs", "required": [ "scene" ], "properties": { "scene": { "type": "string", "description": "Reality data ID of ContextScene to process" }, "crsData": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket for CRS Data" }, "presets": { "type": "string", "default": null, "nullable": true, "description": "List of paths to preset" } }, "additionalProperties": false }
Cesium Compression
json
{ "enum": [ "None", "Draco" ], "type": "string", "title": "Cesium Compression" }
Color Equalization
json
{ "enum": [ "None", "BlockWise", "MachineLearning" ], "type": "string", "title": "Color Equalization" }
Constraints Inputs
Path in the bucket for CRS Data
Reality data id of ContextScene to process
IDs of constraints to delete
json
{ "type": "object", "title": "Constraints Inputs", "required": [ "modelingReference" ], "properties": { "crsData": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket for CRS Data" }, "constraintsToAdd": { "type": "array", "items": { "$ref": "#/components/schemas/ConstraintToAdd" }, "default": null, "nullable": true, "description": "Constraints to add" }, "modelingReference": { "type": "string", "description": "Reality data id of ContextScene to process" }, "constraintsToDelete": { "type": "array", "items": { "type": "string", "format": "uuid4" }, "default": null, "nullable": true, "description": "IDs of constraints to delete" } }, "additionalProperties": false }
Modeling Reference
Reality data id of Modeling Reference
json
{ "type": "object", "title": "Modeling Reference", "required": [ "location" ], "properties": { "location": { "type": "string", "description": "Reality data id of Modeling Reference" } }, "additionalProperties": false }
Production Outputs
json
{ "type": "object", "title": "Production Outputs", "required": [ "exports" ], "properties": { "exports": { "type": "array", "items": { "$ref": "#/components/schemas/Export" }, "description": "List of exports" } }, "additionalProperties": false }
Calibration Options
Enable precalibration
CRS to use when producing the output ContextScene
Center tolerance, use only when center policy is AdjustWithinTolerance
Pair selection distance, use only when pair selection mode is Sequence or Loop
json
{ "type": "object", "title": "Calibration Options", "properties": { "rigSynchro": { "$ref": "#/components/schemas/RigSynchro" }, "skewPolicy": { "$ref": "#/components/schemas/SkewPolicy" }, "focalPolicy": { "$ref": "#/components/schemas/FocalPolicy" }, "centerPolicy": { "$ref": "#/components/schemas/CenterPolicy" }, "radialPolicy": { "$ref": "#/components/schemas/RadialPolicy" }, "pairSelection": { "$ref": "#/components/schemas/PairSelection" }, "precalibration": { "type": "boolean", "default": null, "nullable": true, "description": "Enable precalibration" }, "rotationPolicy": { "$ref": "#/components/schemas/RotationPolicy" }, "sceneOutputCrs": { "type": "string", "default": null, "nullable": true, "description": "CRS to use when producing the output ContextScene" }, "tagsExtraction": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" }, "default": null, "nullable": true, "description": "Tags to extract" }, "centerTolerance": { "type": "number", "default": null, "nullable": true, "description": "Center tolerance, use only when center policy is AdjustWithinTolerance" }, "principalPolicy": { "$ref": "#/components/schemas/PrincipalPolicy" }, "tiepointsPolicy": { "$ref": "#/components/schemas/TiepointsPolicy" }, "keypointsDensity": { "$ref": "#/components/schemas/KeypointsDensity" }, "tangentialPolicy": { "$ref": "#/components/schemas/TangentialPolicy" }, "aspectRatioPolicy": { "$ref": "#/components/schemas/AspectRatioPolicy" }, "colorEqualization": { "$ref": "#/components/schemas/ColorEqualization" }, "fisheyeFocalPolicy": { "$ref": "#/components/schemas/FisheyeFocalPolicy" }, "adjustmentConstraints": { "type": "array", "items": { "$ref": "#/components/schemas/AdjustmentConstraints" }, "default": null, "nullable": true, "description": "Adjustment constraints" }, "pairSelectionDistance": { "type": "integer", "default": null, "nullable": true, "description": "Pair selection distance, use only when pair selection mode is Sequence or Loop" }, "rigidRegistrationScale": { "$ref": "#/components/schemas/RigidRegistrationScale" }, "fisheyeDistortionPolicy": { "$ref": "#/components/schemas/FisheyeDistortionPolicy" }, "rigidRegistrationPosition": { "$ref": "#/components/schemas/RigidRegistrationPosition" }, "rigidRegistrationRotation": { "$ref": "#/components/schemas/RigidRegistrationRotation" } }, "additionalProperties": false }
Calibration Outputs
Reality data ID of calibrated ContextScene
Path in the bucket of Calibration report
Reality data ID of textured tie points
json
{ "type": "object", "title": "Calibration Outputs", "required": [ "scene" ], "properties": { "scene": { "type": "string", "description": "Reality data ID of calibrated ContextScene" }, "report": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket of Calibration report" }, "texturedTiePoints": { "type": "string", "default": null, "nullable": true, "description": "Reality data ID of textured tie points" } }, "additionalProperties": false }
Constraints Outputs
Path in the bucket for added ConstraintsInfo
json
{ "type": "object", "title": "Constraints Outputs", "required": [ "addedConstraintsInfo" ], "properties": { "addedConstraintsInfo": { "type": "string", "pattern": "^bkt:.+", "description": "Path in the bucket for added ConstraintsInfo" } }, "additionalProperties": false }
Fisheye Focal Policy
json
{ "enum": [ "AdjustSymmetric", "AdjustAsymmetric", "Keep" ], "type": "string", "title": "Fisheye Focal Policy" }
Geometric Precision
json
{ "enum": [ "Medium", "High", "Extra", "Ultra" ], "type": "string", "title": "Geometric Precision" }
Tiling Pair Selection
json
{ "enum": [ "Generic", "StructuredAerial", "RegionOfInterest" ], "type": "string", "title": "Tiling Pair Selection" }
TouchUp Export Inputs
List of tiles to export for touch up
Reality data id of Modeling Reference
json
{ "type": "object", "title": "TouchUp Export Inputs", "required": [ "modelingReference" ], "properties": { "tilesToTouchUp": { "type": "array", "items": { "type": "string" }, "default": null, "nullable": true, "description": "List of tiles to export for touch up" }, "modelingReference": { "type": "string", "description": "Reality data id of Modeling Reference" } }, "additionalProperties": false }
TouchUp Import Inputs
Reality Data id for touch up data
Reality data id of Modeling Reference
json
{ "type": "object", "title": "TouchUp Import Inputs", "required": [ "modelingReference", "touchUpData" ], "properties": { "touchUpData": { "type": "string", "description": "Reality Data id for touch up data" }, "modelingReference": { "type": "string", "description": "Reality data id of Modeling Reference" } }, "additionalProperties": false }
Execution Information
Execution information relative to a job.
End time of the job.
Creation time of the job.
The number of processing units consumed by the job.
Start time of the job.
json
{ "type": "object", "title": "Execution Information", "required": [ "createdDateTime" ], "properties": { "endedDateTime": { "type": "string", "format": "date-time", "nullable": true, "description": "End time of the job." }, "createdDateTime": { "type": "string", "format": "date-time", "description": "Creation time of the job." }, "processingUnits": { "type": "number", "nullable": true, "description": "The number of processing units consumed by the job." }, "startedDateTime": { "type": "string", "format": "date-time", "nullable": true, "description": "Start time of the job." } }, "description": "Execution information relative to a job.", "additionalProperties": false }
Gaussian Splats Inputs
Reality data id of ContextScene to process
Path to preset
Path in the bucket for CRS Data
Reality data ID of the Gaussian Splats Reference.
Path in the bucket to region of interest file
json
{ "type": "object", "title": "Gaussian Splats Inputs", "required": [ "scene" ], "properties": { "scene": { "type": "string", "description": "Reality data id of ContextScene to process" }, "preset": { "type": "string", "default": null, "nullable": true, "description": "Path to preset" }, "crsData": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket for CRS Data" }, "splatsReference": { "type": "string", "default": null, "nullable": true, "description": "Reality data ID of the Gaussian Splats Reference." }, "regionOfInterest": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket to region of interest file" } }, "additionalProperties": false }
Photo Used For Geometry
json
{ "enum": [ "ExcludeThermal", "IncludeThermal", "None" ], "type": "string", "title": "Photo Used For Geometry" }
Reconstruction Inputs
Reality data id of ContextScene to process
Path in the bucket to region of interest file, used for export extent
Path in the bucket for CRS Data
List of paths to preset
Path in the bucket to region of interest file, used for tiling region of interest
Reality data id of modeling reference to process
json
{ "type": "object", "title": "Reconstruction Inputs", "required": [ "scene" ], "properties": { "scene": { "type": "string", "description": "Reality data id of ContextScene to process" }, "extent": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket to region of interest file, used for export extent" }, "crsData": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket for CRS Data" }, "presets": { "type": "string", "default": null, "nullable": true, "description": "List of paths to preset" }, "regionOfInterest": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket to region of interest file, used for tiling region of interest" }, "modelingReference": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of modeling reference to process" } }, "additionalProperties": false }
Tiling Specifications
json
{ "type": "object", "title": "Tiling Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/TilingInputs" }, "options": { "$ref": "#/components/schemas/TilingOptions" }, "outputs": { "$ref": "#/components/schemas/TilingOutputs" } }, "additionalProperties": false }
TouchUp Export Options
json
{ "type": "object", "title": "TouchUp Export Options", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "Export CRS" }, "level": { "$ref": "#/components/schemas/TouchLevel" } }, "additionalProperties": false }
TouchUp Export Outputs
Reality Data id for touch up data
json
{ "type": "object", "title": "TouchUp Export Outputs", "required": [ "touchUpData" ], "properties": { "touchUpData": { "type": "string", "description": "Reality Data id for touch up data" } }, "additionalProperties": false }
TouchUp Import Outputs
Folder in bucket containing the information about what was imported
json
{ "type": "object", "title": "TouchUp Import Outputs", "properties": { "importInfo": { "type": "string", "default": null, "nullable": true, "description": "Folder in bucket containing the information about what was imported" } }, "additionalProperties": false }
Adjustment Constraints
json
{ "enum": [ "None", "ControlPoints", "PositionMetadata", "PointClouds", "Automatic" ], "type": "string", "title": "Adjustment Constraints" }
Gaussian Splats Options
json
{ "type": "object", "title": "Gaussian Splats Options", "properties": { "exportCrs": { "type": "string", "default": null, "nullable": true, "description": "CRS for the exported Gaussian Splats" }, "exportFormat": { "$ref": "#/components/schemas/GSFormat" }, "referenceQuality": { "$ref": "#/components/schemas/GSQuality" }, "referenceTileSize": { "type": "number", "default": null, "nullable": true, "description": "Tile size for the Splats Reference" } }, "additionalProperties": false }
Gaussian Splats Outputs
Reality data ID of Gaussian Splats.
Reality data ID of Gaussian Splats Reference.
json
{ "type": "object", "title": "Gaussian Splats Outputs", "properties": { "splats": { "type": "string", "default": null, "nullable": true, "description": "Reality data ID of Gaussian Splats." }, "splatsReference": { "type": "string", "default": null, "nullable": true, "description": "Reality data ID of Gaussian Splats Reference." } }, "additionalProperties": false }
Modeling Reference Type
json
{ "enum": [ "Orthophoto", "Complete" ], "type": "string", "title": "Modeling Reference Type" }
PointCloud Color Source
json
{ "enum": [ "None", "Color", "Intensity", "ScaledIntensity" ], "type": "string", "title": "PointCloud Color Source" }
Reconstruction Outputs
json
{ "type": "object", "title": "Reconstruction Outputs", "properties": { "exports": { "type": "array", "items": { "$ref": "#/components/schemas/Export" }, "default": null, "nullable": true, "description": "List of exports" }, "modelingReference": { "$ref": "#/components/schemas/ModelingReference" } }, "additionalProperties": false }
ImportPointCloud Inputs
Reality data id of ContextScene to process
Path in the bucket for CRS Data
json
{ "type": "object", "title": "ImportPointCloud Inputs", "required": [ "scene" ], "properties": { "scene": { "type": "string", "description": "Reality data id of ContextScene to process" }, "crsData": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket for CRS Data" } }, "additionalProperties": false }
Rigid Registration Scale
json
{ "enum": [ "None", "UserConstraints", "ControlPoints", "PositionMetadata", "PointClouds", "Automatic" ], "type": "string", "title": "Rigid Registration Scale" }
WaterConstraints Inputs
Reality data id of ContextScene
Path in the bucket for CRS Data
Reality data id of Modeling Reference
json
{ "type": "object", "title": "WaterConstraints Inputs", "required": [ "scene", "modelingReference" ], "properties": { "scene": { "type": "string", "description": "Reality data id of ContextScene" }, "crsData": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket for CRS Data" }, "modelingReference": { "type": "string", "description": "Reality data id of Modeling Reference" } }, "additionalProperties": false }
Fisheye Distortion Policy
json
{ "enum": [ "Adjust_01xx0", "Adjust_x1xx0", "Adjust_x1xxx", "Keep" ], "type": "string", "title": "Fisheye Distortion Policy" }
ImportPointCloud Outputs
Output reality data id for context scene referencing scan collection
Output reality data id for scan collection
json
{ "type": "object", "title": "ImportPointCloud Outputs", "required": [ "scanCollection" ], "properties": { "scene": { "type": "string", "default": null, "nullable": true, "description": "Output reality data id for context scene referencing scan collection" }, "scanCollection": { "type": "string", "description": "Output reality data id for scan collection" } }, "additionalProperties": false }
WaterConstraints Options
Force constraints to be horizontal
json
{ "type": "object", "title": "WaterConstraints Options", "properties": { "forceHorizontal": { "type": "boolean", "default": null, "nullable": true, "description": "Force constraints to be horizontal" } }, "additionalProperties": false }
WaterConstraints Outputs
Path in the bucket of output constraints
json
{ "type": "object", "title": "WaterConstraints Outputs", "required": [ "constraints" ], "properties": { "constraints": { "type": "string", "pattern": "^bkt:.+", "description": "Path in the bucket of output constraints" } }, "additionalProperties": false }
Production Specifications
json
{ "type": "object", "title": "Production Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/ProductionInputs" }, "outputs": { "$ref": "#/components/schemas/ProductionOutputs" } }, "additionalProperties": false }
Untextured Representation
json
{ "enum": [ "InpaintingCompletion", "UniformColor" ], "type": "string", "title": "Untextured Representation" }
Calibration Specifications
json
{ "type": "object", "title": "Calibration Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/CalibrationInputs" }, "options": { "$ref": "#/components/schemas/CalibrationOptions" }, "outputs": { "$ref": "#/components/schemas/CalibrationOutputs" } }, "additionalProperties": false }
Constraints Specifications
json
{ "type": "object", "title": "Constraints Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/ConstraintsInputs" }, "outputs": { "$ref": "#/components/schemas/ConstraintsOutputs" } }, "additionalProperties": false }
FillImageProperties Inputs
List of possible inputs for a Fill Image Properties job.
List of paths to preset.
Reality data id of ContextScene to process.
Reality data id of ContextScene to complete.
List of image collection reality data ids.
json
{ "type": "object", "title": "FillImageProperties Inputs", "properties": { "presets": { "type": "string", "default": null, "nullable": true, "description": "List of paths to preset." }, "sceneToProcess": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene to process." }, "sceneToComplete": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene to complete." }, "imageCollections": { "type": "array", "items": { "type": "string" }, "default": null, "nullable": true, "description": "List of image collection reality data ids." } }, "description": "List of possible inputs for a Fill Image Properties job.", "additionalProperties": false }
Rigid Registration Position
json
{ "enum": [ "None", "UserConstraints", "ControlPoints", "PositionMetadata", "PointClouds", "Automatic" ], "type": "string", "title": "Rigid Registration Position" }
Rigid Registration Rotation
json
{ "enum": [ "None", "UserConstraints", "ControlPoints", "PositionMetadata", "PointClouds", "Automatic", "RotationMetadata" ], "type": "string", "title": "Rigid Registration Rotation" }
FillImageProperties Options
List of possible options for Fill Image Properties job.
Recursively read folders in image collection.
json
{ "type": "object", "title": "FillImageProperties Options", "properties": { "altitudeReference": { "$ref": "#/components/schemas/AltitudeReference" }, "recursiveImageCollections": { "type": "boolean", "default": null, "nullable": true, "description": "Recursively read folders in image collection." } }, "description": "List of possible options for Fill Image Properties job.", "additionalProperties": false }
FillImageProperties Outputs
List of possible outputs for a Fill Image Properties job.
Output reality data id of ContextScene with image properties filled.
json
{ "type": "object", "title": "FillImageProperties Outputs", "required": [ "scene" ], "properties": { "scene": { "type": "string", "description": "Output reality data id of ContextScene with image properties filled." } }, "description": "List of possible outputs for a Fill Image Properties job.", "additionalProperties": false }
TouchUp Export Specifications
json
{ "type": "object", "title": "TouchUp Export Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/TouchUpExportInputs" }, "options": { "$ref": "#/components/schemas/TouchUpExportOptions" }, "outputs": { "$ref": "#/components/schemas/TouchUpExportOutputs" } }, "additionalProperties": false }
TouchUp Import Specifications
json
{ "type": "object", "title": "TouchUp Import Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/TouchUpImportInputs" }, "outputs": { "$ref": "#/components/schemas/TouchUpImportOutputs" } }, "additionalProperties": false }
Gaussian Splats Specifications
json
{ "type": "object", "title": "Gaussian Splats Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/GaussianSplatsInputs" }, "options": { "$ref": "#/components/schemas/GaussianSplatsOptions" }, "outputs": { "$ref": "#/components/schemas/GaussianSplatsOutputs" } }, "additionalProperties": false }
Reconstruction Specifications
json
{ "type": "object", "title": "Reconstruction Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/ReconstructionInputs" }, "options": { "$ref": "#/components/schemas/TilingOptions" }, "outputs": { "$ref": "#/components/schemas/ReconstructionOutputs" } }, "additionalProperties": false }
ImportPointCloud Specifications
json
{ "type": "object", "title": "ImportPointCloud Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/ImportPointCloudInputs" }, "outputs": { "$ref": "#/components/schemas/ImportPointCloudOutputs" } }, "additionalProperties": false }
WaterConstraints Specifications
json
{ "type": "object", "title": "WaterConstraints Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/WaterConstraintsInputs" }, "options": { "$ref": "#/components/schemas/WaterConstraintsOptions" }, "outputs": { "$ref": "#/components/schemas/WaterConstraintsOutputs" } }, "additionalProperties": false }
FillImageProperties Specifications
Specifications for Fill Image Properties job.
json
{ "type": "object", "title": "FillImageProperties Specifications", "properties": { "inputs": { "$ref": "#/components/schemas/FillImagePropertiesInputs" }, "options": { "$ref": "#/components/schemas/FillImagePropertiesOptions" }, "outputs": { "$ref": "#/components/schemas/FillImagePropertiesOutputs" } }, "description": "Specifications for Fill Image Properties job.", "additionalProperties": false }
Was this page helpful?