Patch can be used for changing the job state (to active or cancelled), options or changing cost estimation parameters.
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.v1+json
is recommended.
Request body
JobStateModify (UpdateState)
Set to 'active' to start processing the job, or 'cancelled' to cancel the running job.
Example
{ "state": "active" }
JobModify (UpdateOptions)
Parameters to be used to estimate the cost of the job.
Example
{ "options": { "processingEngines": 2, "merge": false }, "costEstimationParameters": { "gigaPixels": 2.5, "megaPoints": 1.7 } }
Response 200 OK
Job was successfully updated.
{ "job": { "id": "cc3d35cc-416a-4262-9714-b359da70b419", "name": "My first RCS job", "type": "Conversion", "state": "active", "createdDateTime": "2020-09-14T14:29:55Z", "lastModifiedDateTime": "2020-09-14T14:29:55Z", "iTwinId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "example@email.com", "dataCenter": "East US", "inputs": [{ "id": "58e0c0ca-f730-4e5b-808d-1c8cacacb4d4", "type": "LAS" }], "outputs": [{ "id": "3ddee08c-01e8-44a5-8e56-3879109f6728", "type": "OPC" }], "options": { "processingEngines": 5, "merge": false }, "costEstimation": { "estimatedCost": 3.5, "gigaPixels": 2.1, "megaPoints": 1.5 } } }
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": "JobNotFound", "message": "Requested job is not available." } }
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).
{ "error": { "code": "InvalidRealityConversionRequest", "message": "Cannot modify job.", "details": [{ "code": "InvalidChange", "message": "Cannot resubmit an already submitted job." }] } }
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 Response
{ "title": "Job Response", "type": "object", "properties": { "job": { "$ref": "#/components/schemas/job", "description": "Complete job details." } }, "required": [ "job" ], "additionalProperties": false }
Job
Full representation of a job.
Job unique id.
Job name.
iTwin Id.
owner Id.
Creation time of the job.
Last modification date of the job.
Datacenter location of the job.
User email address.
{ "title": "Job", "description": "Full representation of a job.", "type": "object", "properties": { "id": { "type": "string", "description": "Job unique id." }, "name": { "type": "string", "description": "Job name." }, "type": { "$ref": "#/components/schemas/jobType", "description": "Job type." }, "state": { "$ref": "#/components/schemas/jobState", "description": "Job current state." }, "iTwinId": { "type": "string", "description": "iTwin Id." }, "ownerId": { "type": "string", "description": "owner Id." }, "createdDateTime": { "type": "string", "format": "date-time", "description": "Creation time of the job." }, "lastModifiedDateTime": { "type": "string", "format": "date-time", "description": "Last modification date of the job." }, "dataCenter": { "type": "string", "description": "Datacenter location of the job." }, "email": { "type": "string", "description": "User email address." }, "executionInformation": { "$ref": "#/components/schemas/executionInformation", "description": "Execution information of the job." }, "costEstimation": { "$ref": "#/components/schemas/costEstimation", "description": "Parameters to be used to estimate the cost of the job." }, "inputs": { "description": "List of inputs of the job.", "items": { "$ref": "#/components/schemas/jobInput" }, "type": "array" }, "outputs": { "description": "List of outputs of a job.", "items": { "$ref": "#/components/schemas/jobOutput" }, "type": "array" }, "options": { "$ref": "#/components/schemas/jobOptions", "description": "List of optional parameters." } }, "required": [ "id", "name", "type", "state", "createdDateTime", "lastModifiedDateTime", "dataCenter", "inputs", "outputs", "iTwinId" ], "additionalProperties": false }
Job Type
Possible values:
- Conversion: Converts input data from one format to another.
- ImportFeatures: Takes vector inputs and imports features into a feature class of Geospatial Features API. Use
FDB
as the output format for this type.
{ "title": "Job Type", "type": "string", "enum": [ "Conversion", "ImportFeatures" ], "description": "Possible values:\n- Conversion: Converts input data from one format to another.\n- ImportFeatures: Takes vector inputs and imports features into a feature class of Geospatial Features API. Use `FDB` as the output format for this type." }
Job State
Job state.
{ "title": "Job State", "type": "string", "enum": [ "unsubmitted", "active", "success", "failed", "cancelled" ], "description": "Job state." }
Point Cloud Input Formats
List of available input formats for point cloud conversion.
{ "title": "Point Cloud Input Formats", "description": "List of available input formats for point cloud conversion.", "enum": [ "LAS", "LAZ", "PLY", "E57", "OPC", "PointCloud", "PNTS", "Cesium3DTiles" ] }
Vector Input Formats
List of available input formats for vector conversion.
{ "title": "Vector Input Formats", "description": "List of available input formats for vector conversion.", "enum": [ "ContextScene", "GeoJSON", "OVF", "OVT", "SHP" ] }
Tile Map Input Formats
Input types representing raster or tiled datasets for generating tile maps.
{ "title": "Tile Map Input Formats", "description": "Input types representing raster or tiled datasets for generating tile maps.", "enum": [ "Orthophoto", "OrthophotoDSM", "OMI", "OVF", "OVT" ] }
Job Input
Input description for a job.
Reality data Id of the input.
{ "type": "object", "title": "Job Input", "description": "Input description for a job.", "properties": { "type": { "description": "Input format for a job.", "oneOf": [ { "$ref": "#/components/schemas/PointCloudInputs" }, { "$ref": "#/components/schemas/VectorInputs" }, { "$ref": "#/components/schemas/TileMapInputs" } ] }, "id": { "type": "string", "description": "Reality data Id of the input." } }, "additionalProperties": false }
Point Cloud Output Formats
List of available point cloud output formats.
- OPC: Orbit Point Cloud
- PNTS: OGC 3DTiles Point Cloud 1.0
- GLB: OGC 3DTiles Point Cloud 1.1
- GLBC: OGC 3DTiles Point Cloud 1.1 Compressed.
{ "title": "Point Cloud Output Formats", "description": "List of available point cloud output formats.\n- OPC: Orbit Point Cloud\n- PNTS: OGC 3DTiles Point Cloud 1.0\n- GLB: OGC 3DTiles Point Cloud 1.1\n- GLBC: OGC 3DTiles Point Cloud 1.1 Compressed.", "enum": [ "OPC", "PNTS", "GLB", "GLBC" ] }
Vector Output Formats
List of available vector output formats.
- Use FDB as the output format when the job type is ImportFeatures.
{ "title": "Vector Output Formats", "description": "List of available vector output formats.\n\n - Use FDB as the output format when the job type is ImportFeatures.", "enum": [ "GeoJSON", "FDB" ] }
Tile Map Output Formats
List of available tile map output formats.
{ "title": "Tile Map Output Formats", "description": "List of available tile map output formats.", "enum": [ "XYZTileMap" ] }
Job Output
Output description for a job.
Reality data Id of the output.
{ "type": "object", "title": "Job Output", "description": "Output description for a job.", "properties": { "type": { "description": "Output format for a job.", "oneOf": [ { "$ref": "#/components/schemas/PointCloudOutputs" }, { "$ref": "#/components/schemas/VectorOutputs" }, { "$ref": "#/components/schemas/TileMapOutputs" } ] }, "id": { "type": "string", "description": "Reality data Id of the output.", "nullable": true } }, "additionalProperties": false }
Options
List of optional parameters.
Number of engines to be used at most, between 0 and your engine limit. If set at 0, RCS will use your engine limit.
If true, then all the input files from multiple containers will be merged into one output file. Otherwise, creates one output per input file. Valid only for Conversion jobs.
EPSG code for the spatial reference system of input files (horizontal or horizontal+vertical).
EPSG code for the spatial reference system of output files (horizontal or horizontal+vertical).
Sampling step size in meters for traversing triangles in mesh geometry. Default is 0.125. Only valid for Cesium3DTiles input.
Name of the feature class to create in the Geospatial Features API. If omitted, uses the input reality data display name. Only valid for ImportFeatures jobs.
Top level of the tile map to generate. Default is -1 (single tile for all input data). Only valid for TileMap output.
Bottom level of the tile map to generate. Default is -1 (closest to native resolution). Only valid for TileMap output.
Tile format for the tile map. Supported values are 'JPG' (default) and 'PNG'. Only valid for TileMap output.
Quality of JPG tiles to generate (10–99). Default is 85. Only valid for TileMap output.
Background color to use for tiles, in 'r.g.b' where r,g,b (red,green,blue) are values 0..255, default value is '255.255.255' (white). Only valid for TileMap output.
{ "type": "object", "title": "Options", "description": "List of optional parameters.", "properties": { "processingEngines": { "type": "integer", "description": "Number of engines to be used at most, between 0 and your engine limit. If set at 0, RCS will use your engine limit." }, "merge": { "type": "boolean", "description": "If true, then all the input files from multiple containers will be merged into one output file. Otherwise, creates one output per input file. Valid only for Conversion jobs." }, "inputSRS": { "type": "string", "description": "EPSG code for the spatial reference system of input files (horizontal or horizontal+vertical)." }, "outputSRS": { "type": "string", "description": "EPSG code for the spatial reference system of output files (horizontal or horizontal+vertical)." }, "sampleWorldStep": { "type": "number", "format": "double", "description": "Sampling step size in meters for traversing triangles in mesh geometry. Default is 0.125. Only valid for Cesium3DTiles input." }, "featureClassDisplayName": { "type": "string", "description": "Name of the feature class to create in the Geospatial Features API. If omitted, uses the input reality data display name. Only valid for ImportFeatures jobs." }, "topLevel": { "type": "integer", "description": "Top level of the tile map to generate. Default is -1 (single tile for all input data). Only valid for TileMap output." }, "bottomLevel": { "type": "integer", "description": "Bottom level of the tile map to generate. Default is -1 (closest to native resolution). Only valid for TileMap output." }, "tileFormat": { "type": "string", "description": "Tile format for the tile map. Supported values are 'JPG' (default) and 'PNG'. Only valid for TileMap output." }, "jpgQuality": { "type": "number", "format": "double", "description": "Quality of JPG tiles to generate (10–99). Default is 85. Only valid for TileMap output.", "minimum": 10, "maximum": 99 }, "backgroundColor": { "type": "string", "description": "Background color to use for tiles, in 'r.g.b' where r,g,b (red,green,blue) are values 0..255, default value is '255.255.255' (white). Only valid for TileMap output." } }, "additionalProperties": false }
Execution Info
Execution information of the job.
Submission time of the job.
Start time of the job.
End time of the job.
Estimated processing units cost.
{ "title": "Execution Info", "description": "Execution information of the job.", "type": "object", "properties": { "submissionDateTime": { "type": "string", "format": "date-time", "description": "Submission time of the job." }, "startedDateTime": { "type": "string", "format": "date-time", "description": "Start time of the job.", "nullable": true }, "endedDateTime": { "type": "string", "format": "date-time", "description": "End time of the job.", "nullable": true }, "estimatedUnits": { "type": "number", "description": "Estimated processing units cost.", "nullable": true } }, "required": [ "submissionDateTime" ], "additionalProperties": false }
Cost Estimation Parameters
Parameters to be used to estimate the cost of the job.
Gigapixels to be processed.
Megapoints to be processed.
{ "title": "Cost Estimation Parameters", "description": "Parameters to be used to estimate the cost of the job.", "type": "object", "properties": { "gigaPixels": { "type": "number", "description": "Gigapixels to be processed." }, "megaPoints": { "type": "number", "description": "Megapoints to be processed." } }, "additionalProperties": false }
Cost Estimation Information
Cost estimate based on parameters before job processing.
Number of giga pixels in inputs.
Number of mega points in inputs.
Estimated cost of the job using the CostEstimationParameters.
{ "type": "object", "title": "Cost Estimation Information", "description": "Cost estimate based on parameters before job processing.", "properties": { "gigaPixels": { "description": "Number of giga pixels in inputs.", "type": "number", "format": "double", "nullable": true }, "megaPoints": { "description": "Number of mega points in inputs.", "type": "number", "format": "double", "nullable": true }, "estimatedCost": { "type": "number", "description": "Estimated cost of the job using the CostEstimationParameters.", "format": "double" } }, "additionalProperties": false }
Job State
Set to 'active' to start processing the job, or 'cancelled' to cancel the running job.
{ "title": "Job State", "type": "string", "enum": [ "active", "cancelled" ], "description": "Set to 'active' to start processing the job, or 'cancelled' to cancel the running job." }
Modify Job State
Request model for updating the state of a job. Use to start processing or cancel a running job.
Set to 'active' to start processing the job, or 'cancelled' to cancel the running job.
{ "title": "Modify Job State", "type": "object", "description": "Request model for updating the state of a job. Use to start processing or cancel a running job.", "properties": { "state": { "title": "Job State", "type": "string", "enum": [ "active", "cancelled" ], "description": "Set to 'active' to start processing the job, or 'cancelled' to cancel the running job.", "$ref": "#/components/schemas/JobStateModify-state" } }, "additionalProperties": false }
Modify Job
PATCH model for updating job properties. All properties are optional; only provided fields will be updated.
Parameters to be used to estimate the cost of the job.
{ "title": "Modify Job", "type": "object", "description": "PATCH model for updating job properties. All properties are optional; only provided fields will be updated.", "properties": { "options": { "$ref": "#/components/schemas/jobOptions", "description": "List of optional parameters." }, "costEstimationParameters": { "$ref": "#/components/schemas/costEstimationParameters", "description": "Parameters to be used to estimate the cost of the job." } }, "additionalProperties": false }
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.
{ "type": "object", "description": "Contains error information and an array of more specific errors.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true }, "details": { "type": "array", "description": "Optional array of more specific errors.", "items": { "$ref": "#/components/schemas/Error" } } }, "required": [ "code", "message", "details" ], "additionalProperties": true }
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", "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.", "properties": { "error": { "description": "Error Detailed information.", "$ref": "#/components/schemas/DetailedError" } }, "required": [ "error" ], "additionalProperties": false }
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.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "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", "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.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?