Retrieve list of jobs matching provided filter.
The iTwinId in filter is optional. If it is not provided, this will return jobs created by the same user. However, if the iTwinId is provided and the user has access to it, this will return jobs associated with that specific iTwin.
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
The $filter query option requests a specific set of jobs.
The given filter is evaluated for each job and only job where the filter evaluates to true are returned.
Properties supported for filtering: id, iTwinId, name, email, type, state, createdDateTime, inputId, outputId.
Supported operators: eq, lt, le, gt, ge, ne, in, and, or.
Samples of $filter values:
$filter=iTwinId eq dc720f05-e5f7-448b-ae06-765de46f0af1
$filter=inputId in ('482b2968-6a85-4e50-b05c-8acbf828c1bd', '14c03448-bea0-4d76-b53b-4b20bd3f4cbc')
$filter=id eq 9e2d27cf-b695-47e9-b7f0-0d47dc3b88ad
$filter=createdDateTime gt 2024-06-24T13:00:00Z
Parameter that enables continuing to the next page of the previous paged query. This must be passed exactly as it is in the response body's _links.next property.
The number of reality conversion jobs to get in each page. Max 1000, but 100 is the default if this parameter is not included.
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.
Response 200 OK
OK
{ "jobs": [{ "id": "eba823ca-f8e3-4ebb-be5f-6bc77aadbe14", "state": "Success", "userId": "e263a543-db55-4fa5-8a4e-69b9cfcf6c59", "executionInfo": { "startedDateTime": "2026-04-01T09:56:14.0000000+00:00", "endedDateTime": "2026-04-01T10:07:49.0000000+00:00", "createdDateTime": "2026-04-01T09:48:28.0000000+00:00", "processingUnits": 0 }, "specifications": { "inputs": { "pointCloud": "b8bdeba4-a4a6-42d7-b81a-a22f892707a2" }, "output": "4a770816-f9b0-45e5-9b8c-143269d687ac", "options": { "outputFormat": "OPC" } }, "name": "Unified Job- PC Conversion", "type": "PointCloudConversion", "iTwinId": "2c8e4988-eb9b-4e5f-a903-8c7c18f3030a" }, { "id": "f2257da7-1c9d-4599-811d-db8aa139c1ac", "state": "Failed", "userId": "e263a543-db55-4fa5-8a4e-69b9cfcf6c59", "executionInfo": { "startedDateTime": "2026-04-01T09:56:14.0000000+00:00", "endedDateTime": "2026-04-01T10:02:00.0000000+00:00", "createdDateTime": "2026-04-01T09:50:33.0000000+00:00", "processingUnits": 0 }, "specifications": { "inputs": { "pointClouds": ["fc2746d5-7b62-4f00-9a88-1bfaa22475d7"] }, "output": "62869765-1031-470f-9730-15ef7aac8adb", "options": { "outputFormat": "3DTilesPnts" } }, "name": "Unified Job- PCOptimization", "type": "PointCloudOptimization", "iTwinId": "2c8e4988-eb9b-4e5f-a903-8c7c18f3030a" }], "_links": { "next": { "href": "https://api.bentley.com/reality-conversion/jobs?$filter=iTwinId%20eq%203fa85f64-5717-4562-b3fc-2c963f66afa6&continuationToken=MzY3ZmY1ZDEtNDEzOS00ZGU1LTg0MjMtN2I5NmVkZDAyN2M0" } } }
Response 400 Bad Request
The 400 (Bad Request) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).
{ "error": { "code": "InvalidRealityConversionRequest", "message": "Cannot find jobs.", "details": [{ "code": "InvalidParameter", "message": "The $top query parameter value must be a positive integer that does not exceed 1000.", "target": "$top" }] } }
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
Not Found
{ "error": { "code": "iTwinNotFound", "message": "Requested iTwin 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.
{ "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.
Unique id of the job.
Name of the job.
Identifier of the user that created the job.
iTwin Id for the job.
List of inputs, outputs and options for the job, must be in sync with the type.
{ "type": "object", "title": "Job", "required": [ "iTwinId", "specifications", "type", "executionInfo", "id", "state", "userId" ], "properties": { "id": { "type": "string", "description": "Unique id of the job." }, "name": { "type": "string", "default": null, "pattern": "^([^\"<>|:*?\\\\/\\u0000-\\u001f])+$", "nullable": true, "maxLength": 256, "minLength": 3, "description": "Name of the job." }, "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 for the job." }, "executionInfo": { "$ref": "#/components/schemas/ExecutionInformation" }, "specifications": { "anyOf": [ { "$ref": "#/components/schemas/PointCloudConversionSpecifications" }, { "$ref": "#/components/schemas/PointCloudOptimizationSpecifications" }, { "$ref": "#/components/schemas/TileMapOptimizationSpecifications" }, { "$ref": "#/components/schemas/VectorOptimizationSpecifications" }, { "$ref": "#/components/schemas/MeshSamplingSpecifications" }, { "$ref": "#/components/schemas/ContextSceneTilerSpecifications" } ], "description": "List of inputs, outputs and options for the job, must be in sync with the type." } }, "description": "Job information.", "additionalProperties": false }
Link
The URL.
{ "type": "object", "required": [ "href" ], "properties": { "href": { "type": "string", "description": "The URL." } }, "additionalProperties": false }
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.
{ "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 }
CSObject
{ "enum": [ "Cameras", "TiePoints", "Annotations" ], "type": "string", "title": "CSObject" }
Job State
Job current state.
{ "enum": [ "Queued", "Active", "TerminatingOnCancel", "TerminatingOnFailure", "Cancelled", "Failed", "Success" ], "type": "string", "title": "Job State", "description": "Job current state." }
Job Types
Supported job types
{ "enum": [ "PointCloudConversion", "PointCloudOptimization", "TileMapOptimization", "VectorOptimization", "MeshSampling", "ContextSceneTiler" ], "title": "Job Types", "description": "Supported job types" }
CSTilerInputs
ContextScene reality data id to tile
{ "type": "object", "title": "CSTilerInputs", "required": [ "scene" ], "properties": { "scene": { "type": "string", "title": "Scene", "description": "ContextScene reality data id to tile" } }, "additionalProperties": false }
DetailedError
Contains error information and an array of more specific errors.
One of a server-defined set of error codes.
The target of the error.
A human-readable representation of the error.
{ "type": "object", "required": [ "code", "message", "details" ], "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." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "description": "Optional array of more specific errors." }, "message": { "type": "string", "description": "A human-readable representation of the error." } }, "description": "Contains error information and an array of more specific errors.", "additionalProperties": true }
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.
{ "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 }
Reality Conversion Jobs
Jobs
{ "type": "object", "title": " Reality Conversion Jobs", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/Job" }, "description": "Array of jobs" }, "_links": { "$ref": "#/components/schemas/next-page-link" } }, "description": "Jobs", "additionalProperties": false }
CSTilerOptions
{ "type": "object", "title": "CSTilerOptions", "properties": { "objectToTile": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/CSObject" } ], "nullable": true, "description": "Object to tile inside the ContextScene." } }, "additionalProperties": false }
Next Page Link
URL for getting the next page of data, if applicable.
{ "type": "object", "title": "Next Page Link", "properties": { "next": { "$ref": "#/components/schemas/Link" } }, "description": "URL for getting the next page of data, if applicable.", "additionalProperties": false }
MeshSamplingFormat
{ "enum": [ "OPC", "3DTilesPnts", "3DTilesGlbc", "LAS", "LAZ", "E57", "POD" ], "type": "string", "title": "MeshSamplingFormat" }
Mesh Sampling Inputs
Reality data Ids of meshes to sample
{ "type": "object", "title": "Mesh Sampling Inputs", "required": [ "meshes" ], "properties": { "meshes": { "type": "array", "items": { "type": "string" }, "title": "Meshes", "description": "Reality data Ids of meshes to sample" } }, "additionalProperties": false }
PointCloud Conversion Format
{ "enum": [ "OPC", "3DTilesPnts", "3DTilesGlbc", "LAS", "LAZ", "E57", "POD" ], "type": "string", "title": "PointCloud Conversion Format" }
PointCloud Conversion Inputs
Reality data Id of point cloud(s) to convert
{ "type": "object", "title": "PointCloud Conversion Inputs", "required": [ "pointCloud" ], "properties": { "pointCloud": { "type": "string", "title": "PointCloud", "description": "Reality data Id of point cloud(s) to convert" } }, "additionalProperties": false }
TileMap Image Format
{ "enum": [ "JPG", "PNG" ], "type": "string", "title": "TileMap Image Format" }
Mesh Sampling Options
CRS for the input data
Sampling value in meter
CRS for the output data
{ "type": "object", "title": "Mesh Sampling Options", "properties": { "inputCrs": { "type": "string", "nullable": true, "description": "CRS for the input data" }, "sampling": { "type": "number", "title": "Sampling", "nullable": true, "description": "Sampling value in meter" }, "outputCrs": { "type": "string", "nullable": true, "description": "CRS for the output data" }, "outputFormat": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/MeshSamplingFormat" } ], "nullable": true, "description": "Output format for the conversion." } }, "additionalProperties": false }
PointCloud Conversion Options
CRS for the input data
CRS for the output data
{ "type": "object", "title": "PointCloud Conversion Options", "properties": { "inputCrs": { "type": "string", "nullable": true, "description": "CRS for the input data" }, "outputCrs": { "type": "string", "nullable": true, "description": "CRS for the output data" }, "outputFormat": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/PCConversionFormat" } ], "nullable": true, "description": "Output format for the conversion." } }, "additionalProperties": false }
Execution Information
Execution information of 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.
{ "type": "object", "title": "Execution Information", "required": [ "createdDateTime" ], "properties": { "endedDateTime": { "type": "string", "format": "date-time", "default": null, "nullable": true, "description": "End time of the job." }, "createdDateTime": { "type": "string", "format": "date-time", "description": "Creation time of the job." }, "processingUnits": { "type": "number", "default": null, "nullable": true, "description": "The number of processing units consumed by the job." }, "startedDateTime": { "type": "string", "format": "date-time", "default": null, "nullable": true, "description": "Start time of the job." } }, "description": "Execution information of a job.", "additionalProperties": false }
PointCloud Optimization Format
{ "enum": [ "OPC", "3DTilesPnts", "3DTilesGlbc", "LAS", "LAZ", "E57", "POD" ], "type": "string", "title": "PointCloud Optimization Format" }
PointCloud Optimization Inputs
Reality data Ids of point cloud(s) to convert
{ "type": "object", "title": "PointCloud Optimization Inputs", "required": [ "pointClouds" ], "properties": { "pointClouds": { "type": "array", "items": { "type": "string" }, "title": "Pointclouds", "description": "Reality data Ids of point cloud(s) to convert" } }, "additionalProperties": false }
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.
{ "type": "object", "title": "Detailed Error Response", "required": [ "error" ], "properties": { "error": { "$ref": "#/components/schemas/DetailedError", "description": "Error Detailed 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 }
PointCloud Optimization Options
CRS for the input data
CRS for the output data
{ "type": "object", "title": "PointCloud Optimization Options", "properties": { "inputCrs": { "type": "string", "nullable": true, "description": "CRS for the input data" }, "outputCrs": { "type": "string", "nullable": true, "description": "CRS for the output data" }, "outputFormat": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/PCOptimizationFormat" } ], "nullable": true, "description": "Output format for the conversion." } }, "additionalProperties": false }
Vector Optimization Format
{ "enum": [ "GeoJSON", "FeatureDB" ], "type": "string", "title": "Vector Optimization Format" }
Vector Optimization Inputs
Reality data Ids of vectors to consolidate
{ "type": "object", "title": "Vector Optimization Inputs", "required": [ "vectors" ], "properties": { "vectors": { "type": "array", "items": { "type": "string" }, "title": "Vectors", "description": "Reality data Ids of vectors to consolidate" } }, "additionalProperties": false }
TileMap Optimization Format
{ "enum": [ "XYZTileMap" ], "type": "string", "title": "TileMap Optimization Format" }
TileMap Optimization Inputs
Reality data Ids of tile maps to convert
{ "type": "object", "title": "TileMap Optimization Inputs", "required": [ "tileMaps" ], "properties": { "tileMaps": { "type": "array", "items": { "type": "string" }, "title": "Tile Maps", "description": "Reality data Ids of tile maps to convert" } }, "additionalProperties": false }
Vector Optimization Options
CRS for the input data
CRS for the output data
Display class name
{ "type": "object", "title": "Vector Optimization Options", "properties": { "inputCrs": { "type": "string", "nullable": true, "description": "CRS for the input data" }, "outputCrs": { "type": "string", "nullable": true, "description": "CRS for the output data" }, "outputFormat": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/VectorOptimizationFormat" } ], "nullable": true, "description": "Output format for the conversion." }, "featureClassDisplayName": { "type": "string", "title": "Feature Class Display Name", "nullable": true, "description": "Display class name" } }, "additionalProperties": false }
Mesh Sampling Specifications
Specifications for Mesh Sampling.
Reality Data id of the sampled point cloud
{ "type": "object", "title": "Mesh Sampling Specifications", "required": [ "inputs", "output" ], "properties": { "inputs": { "$ref": "#/components/schemas/MeshSamplingInputs" }, "output": { "type": "string", "title": "output", "description": "Reality Data id of the sampled point cloud" }, "options": { "allOf": [ { "$ref": "#/components/schemas/MeshSamplingOptions" } ], "nullable": true, "description": "Options" } }, "description": "Specifications for Mesh Sampling.", "additionalProperties": false }
TileMap Optimization Options
CRS for the input data
Top level of the tile map to generate.
CRS for the output data
Quality of JPG tiles to generate
Bottom level of the tile map to generate.
Background color to use for tiles
{ "type": "object", "title": "TileMap Optimization Options", "properties": { "inputCrs": { "type": "string", "nullable": true, "description": "CRS for the input data" }, "topLevel": { "type": "integer", "title": "Top Level", "nullable": true, "description": "Top level of the tile map to generate." }, "outputCrs": { "type": "string", "nullable": true, "description": "CRS for the output data" }, "jpgQuality": { "type": "integer", "title": "JPG Quality", "maximum": 99, "minimum": 10, "nullable": true, "description": "Quality of JPG tiles to generate" }, "bottomLevel": { "type": "integer", "title": "Bottom Level", "nullable": true, "description": "Bottom level of the tile map to generate." }, "imageFormat": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/TileMapImageFormat" } ], "nullable": true, "description": "Image format" }, "outputFormat": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/TileMapOptimizationFormat" } ], "nullable": true, "description": "Output format for the conversion." }, "backgroundColor": { "type": "string", "title": "Background Color", "pattern": "^#[a-fA-F0-9]{6}$", "nullable": true, "description": "Background color to use for tiles" } }, "additionalProperties": false }
Context Scene Tiler Specifications
Specifications for Context Scene Tiler.
Reality Data id of tiled ContextScene
{ "type": "object", "title": "Context Scene Tiler Specifications", "required": [ "inputs", "output" ], "properties": { "inputs": { "$ref": "#/components/schemas/CSTilerInputs" }, "output": { "type": "string", "title": "output", "description": "Reality Data id of tiled ContextScene" }, "options": { "allOf": [ { "$ref": "#/components/schemas/CSTilerOptions" } ], "nullable": true, "description": "Options" } }, "description": "Specifications for Context Scene Tiler.", "additionalProperties": false }
Vector Optimization Specifications
Specifications for Vector Optimization.
Reality Data id of the vector data or Feature DB index (fdb:)
{ "type": "object", "title": "Vector Optimization Specifications", "required": [ "inputs", "output" ], "properties": { "inputs": { "$ref": "#/components/schemas/VectorOptimizationInputs" }, "output": { "type": "string", "title": "output", "description": "Reality Data id of the vector data or Feature DB index (fdb:)" }, "options": { "allOf": [ { "$ref": "#/components/schemas/VectorOptimizationOptions" } ], "nullable": true, "description": "Options" } }, "description": "Specifications for Vector Optimization.", "additionalProperties": false }
TileMap Optimization Specifications
Specifications for TileMap Optimization.
Reality Data id of the tile map
{ "type": "object", "title": "TileMap Optimization Specifications", "required": [ "inputs", "output" ], "properties": { "inputs": { "$ref": "#/components/schemas/TileMapOptimizationInputs" }, "output": { "type": "string", "title": "output", "description": "Reality Data id of the tile map" }, "options": { "allOf": [ { "$ref": "#/components/schemas/TileMapOptimizationOptions" } ], "nullable": true, "description": "Options" } }, "description": "Specifications for TileMap Optimization.", "additionalProperties": false }
PointCloud Conversion Specifications
Specifications for PointCloud Conversion.
Reality Data id of the converted point cloud
{ "type": "object", "title": "PointCloud Conversion Specifications", "required": [ "inputs", "output" ], "properties": { "inputs": { "$ref": "#/components/schemas/PCConversionInputs" }, "output": { "type": "string", "title": "output", "description": "Reality Data id of the converted point cloud" }, "options": { "allOf": [ { "$ref": "#/components/schemas/PCConversionOptions" } ], "nullable": true, "description": "Options" } }, "description": "Specifications for PointCloud Conversion.", "additionalProperties": false }
PointCloud Optimization Specifications
Specifications for PointCloud Optimization.
Reality Data id of the converted point cloud
{ "type": "object", "title": "PointCloud Optimization Specifications", "required": [ "inputs", "output" ], "properties": { "inputs": { "$ref": "#/components/schemas/PCOptimizationInputs" }, "output": { "type": "string", "title": "output", "description": "Reality Data id of the converted point cloud" }, "options": { "allOf": [ { "$ref": "#/components/schemas/PCOptimizationOptions" } ], "nullable": true, "description": "Options" } }, "description": "Specifications for PointCloud Optimization.", "additionalProperties": false }
Was this page helpful?