Patch can be used for changing the job state (to active or cancelled), updating job type, inputs , outputs, options or changing cost estimation parameters.
Authentication
Requires Authorization header with valid Bearer token for scope realityconversion:modify.
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 scope realityconversion:modify
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
New job state. Possible values SHOULD be either 'active' or 'cancelled'.
New job type.
Example
{ "costEstimationParameters": { "gigaPixels": 2.5, "megaPoints": 1.7 } }
New job state. Possible values SHOULD be either 'active' or 'cancelled'.
New job type.
Example
{ "state": "active" }
New job state. Possible values SHOULD be either 'active' or 'cancelled'.
New job type.
Example
{ "type": "Conversion" }
New job state. Possible values SHOULD be either 'active' or 'cancelled'.
New job type.
Example
{ "inputs": [{ "id": "18e0c0ca-f730-4e5b-808d-1c8cacacb4d4" }] }
New job state. Possible values SHOULD be either 'active' or 'cancelled'.
New job type.
Example
{ "outputs": [ "PNTS" ] }
New job state. Possible values SHOULD be either 'active' or 'cancelled'.
New job type.
Example
{ "options": { "processingEngines": 2, "merge": true } }
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 user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
The number of requests exceeds the rate-limit for the client subscription.
Cost Estimation Parameters
Parameters to be used to estimate the cost of the job
Gigapixels to be processed
Megapoints to be processed
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
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
Job
Job information
Job unique id
Job name
Job type
Job current state
iTwin Id
Creation time of the job
Last modification date of the job
Datacenter location of the job
Job Patch
Patch information to be applied
New job state. Possible values SHOULD be either 'active' or 'cancelled'.
New job type.
Job Input
Input description for a job.
Input type for a job. Possible values SHOULD be among LAS, LAZ, PLY or E57.
Id of the input.
Job Output
Output description for a job.
Output format for a job. Possible value is OPC or PNTS.
Options
List of optional parameters to create job
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. Else output file will be created per input file.
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.