Cancel a job - Reality Conversion

Reality Conversion

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Cancel a job

DELETE https://dev-api.bentley.com/reality-conversion/jobs/{id}

Cancel a job.

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

Yes

Job Id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.

Response 200 OK

json

{
    "job": {
        "id": "5e315451-564e-4e8b-a952-45b14e6a9c90",
        "state": "TerminatingOnCancel",
        "userId": "3a8670f9-b69f-4a60-b958-f103d580755f",
        "executionInfo": {
            "createdDateTime": "2026-04-05T14:04:56Z"
        },
        "specifications": {
            "inputs": {
                "pointClouds": "40a8142e-3277-4c65-922f-e1f3759b904b"
            },
            "output": "f4cc6131-a9c8-4833-8d2a-cd0a11b8b778",
            "options": {
                "outputFormat": "3DTilesPnts"
            }
        },
        "name": "PointCloudConversion Job",
        "type": "PointCloudConversion",
        "iTwinId": "ce54f773-67db-4b4f-a98b-368329107429"
    }
}

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

This response indicates that the specified job was not found.

json

{
    "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)

json

{
    "error": {
        "code": "InvalidRealityConversionRequest",
        "message": "Invalid request to Reality Conversion.",
        "details": [{
            "code": "InvalidChange",
            "message": "The job is about to complete. It is saving the data. Cancellation is not allowed during this period.",
            "target": ""
        }]
    }
}

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

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Job Response

job

Job

json

{
    "title": "Job Response",
    "type": "object",
    "properties": {
        "job": {
            "$ref": "#/components/schemas/Job"
        }
    },
    "required": [
        "job"
    ],
    "additionalProperties": false
}

Job

Job information.

String

Unique id of the job.

state

JobState

Current state of the job.

userId

String

Identifier of the user that created the job.

executionInfo

ExecutionInformation

Known execution information for the job.

specifications

Any of: PointCloudConversionSpecifications PointCloudOptimizationSpecifications TileMapOptimizationSpecifications VectorOptimizationSpecifications MeshSamplingSpecifications ContextSceneTilerSpecifications

List of inputs, outputs and options for the job, must be in sync with the type.

name

String, null

Name of the job.

type

JobTypes

Type of the job.

iTwinId

String

iTwin Id for the job.

json

{
    "title": "Job",
    "description": "Job information.",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique id of the job."
        },
        "state": {
            "$ref": "#/components/schemas/JobState",
            "description": "Current state of the job."
        },
        "userId": {
            "type": "string",
            "description": "Identifier of the user that created the job."
        },
        "executionInfo": {
            "$ref": "#/components/schemas/ExecutionInformation",
            "description": "Known execution information for the job."
        },
        "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."
        },
        "name": {
            "maxLength": 256,
            "minLength": 3,
            "pattern": "^([^\"<>|:*?\\\\/\\u0000-\\u001f])+$",
            "type": "string",
            "description": "Name of the job.",
            "nullable": true,
            "default": null
        },
        "type": {
            "$ref": "#/components/schemas/JobTypes",
            "description": "Type of the job."
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin Id for the job."
        }
    },
    "required": [
        "iTwinId",
        "specifications",
        "type",
        "executionInfo",
        "id",
        "state",
        "userId"
    ],
    "additionalProperties": false
}

Job Types

Supported job types

PointCloudConversion

String

PointCloudOptimization

String

TileMapOptimization

String

VectorOptimization

String

MeshSampling

String

ContextSceneTiler

String

json

{
    "title": "Job Types",
    "description": "Supported job types",
    "enum": [
        "PointCloudConversion",
        "PointCloudOptimization",
        "TileMapOptimization",
        "VectorOptimization",
        "MeshSampling",
        "ContextSceneTiler"
    ]
}

Job State

Job current state.

Queued

String

Active

String

TerminatingOnCancel

String

TerminatingOnFailure

String

Cancelled

String

Failed

String

Success

String

json

{
    "title": "Job State",
    "description": "Job current state.",
    "enum": [
        "Queued",
        "Active",
        "TerminatingOnCancel",
        "TerminatingOnFailure",
        "Cancelled",
        "Failed",
        "Success"
    ],
    "type": "string"
}

Execution Information

Execution information of a job.

createdDateTime

Date-time

Creation time of the job.

startedDateTime

Date-time, null

Start time of the job.

endedDateTime

Date-time, null

End time of the job.

processingUnits

Number, null

The number of processing units consumed by the job.

json

{
    "title": "Execution Information",
    "description": "Execution information of a job.",
    "type": "object",
    "properties": {
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Creation time of the job."
        },
        "startedDateTime": {
            "type": "string",
            "nullable": true,
            "default": null,
            "format": "date-time",
            "description": "Start time of the job."
        },
        "endedDateTime": {
            "type": "string",
            "nullable": true,
            "default": null,
            "format": "date-time",
            "description": "End time of the job."
        },
        "processingUnits": {
            "type": "number",
            "nullable": true,
            "default": null,
            "description": "The number of processing units consumed by the job."
        }
    },
    "required": [
        "createdDateTime"
    ],
    "additionalProperties": false
}

PointCloud Conversion Specifications

Specifications for PointCloud Conversion.

inputs

PCConversionInputs

Inputs

output

String

Reality Data id of the converted point cloud

options

Any of: PCConversionOptions null

Options

json

{
    "title": "PointCloud Conversion Specifications",
    "description": "Specifications for PointCloud Conversion.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/$defs/PCConversionInputs",
            "description": "Inputs"
        },
        "output": {
            "description": "Reality Data id of the converted point cloud",
            "title": "output",
            "type": "string"
        },
        "options": {
            "anyOf": [
                {
                    "$ref": "#/$defs/PCConversionOptions"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Options"
        }
    },
    "required": [
        "inputs",
        "output"
    ]
}

PointCloud Conversion Inputs

PointCloud

String

Reality data Id of point cloud(s) to convert

json

{
    "required": [
        "pointCloud"
    ],
    "title": "PointCloud Conversion Inputs",
    "type": "object",
    "properties": {
        "pointCloud": {
            "description": "Reality data Id of point cloud(s) to convert",
            "title": "PointCloud",
            "type": "string"
        }
    }
}

PointCloud Conversion Options

outputFormat

Any of: PCConversionFormat null

Output format for the conversion.

inputCrs

Any of: string null

CRS for the input data

outputCrs

Any of: string null

CRS for the output data

json

{
    "title": "PointCloud Conversion Options",
    "type": "object",
    "properties": {
        "outputFormat": {
            "anyOf": [
                {
                    "$ref": "#/$defs/PCConversionFormat"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Output format for the conversion."
        },
        "inputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the input data"
        },
        "outputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the output data"
        }
    }
}

PointCloud Conversion Format

OPC

String

3DTilesPnts

String

3DTilesGlbc

String

LAS

String

LAZ

String

E57

String

POD

String

json

{
    "title": "PointCloud Conversion Format",
    "type": "string",
    "enum": [
        "OPC",
        "3DTilesPnts",
        "3DTilesGlbc",
        "LAS",
        "LAZ",
        "E57",
        "POD"
    ]
}

PointCloud Optimization Specifications

Specifications for PointCloud Optimization.

inputs

PCOptimizationInputs

Inputs

output

String

Reality Data id of the converted point cloud

options

Any of: PCOptimizationOptions null

Options

json

{
    "title": "PointCloud Optimization Specifications",
    "description": "Specifications for PointCloud Optimization.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/$defs/PCOptimizationInputs",
            "description": "Inputs"
        },
        "output": {
            "description": "Reality Data id of the converted point cloud",
            "title": "output",
            "type": "string"
        },
        "options": {
            "anyOf": [
                {
                    "$ref": "#/$defs/PCOptimizationOptions"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Options"
        }
    },
    "required": [
        "inputs",
        "output"
    ]
}

PointCloud Optimization Inputs

Pointclouds

String[]

Reality data Ids of point cloud(s) to convert

json

{
    "title": "PointCloud Optimization Inputs",
    "type": "object",
    "properties": {
        "pointClouds": {
            "description": "Reality data Ids of point cloud(s) to convert",
            "items": {
                "type": "string"
            },
            "title": "Pointclouds",
            "type": "array"
        }
    },
    "required": [
        "pointClouds"
    ]
}

PointCloud Optimization Options

outputFormat

Any of: PCOptimizationFormat null

Output format for the conversion.

inputCrs

Any of: string null

CRS for the input data

outputCrs

Any of: string null

CRS for the output data

json

{
    "title": "PointCloud Optimization Options",
    "type": "object",
    "properties": {
        "outputFormat": {
            "anyOf": [
                {
                    "$ref": "#/$defs/PCOptimizationFormat"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Output format for the conversion."
        },
        "inputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the input data"
        },
        "outputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the output data"
        }
    }
}

PointCloud Optimization Format

OPC

String

3DTilesPnts

String

3DTilesGlbc

String

LAS

String

LAZ

String

E57

String

POD

String

json

{
    "title": "PointCloud Optimization Format",
    "type": "string",
    "enum": [
        "OPC",
        "3DTilesPnts",
        "3DTilesGlbc",
        "LAS",
        "LAZ",
        "E57",
        "POD"
    ]
}

TileMap Optimization Specifications

Specifications for TileMap Optimization.

inputs

TileMapOptimizationInputs

Inputs

output

String

Reality Data id of the tile map

options

Any of: TileMapOptimizationOptions null

Options

json

{
    "title": "TileMap Optimization Specifications",
    "description": "Specifications for TileMap Optimization.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/$defs/TileMapOptimizationInputs",
            "description": "Inputs"
        },
        "output": {
            "description": "Reality Data id of the tile map",
            "title": "output",
            "type": "string"
        },
        "options": {
            "anyOf": [
                {
                    "$ref": "#/$defs/TileMapOptimizationOptions"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Options"
        }
    },
    "required": [
        "inputs",
        "output"
    ]
}

TileMap Optimization Inputs

Tile Maps

String[]

Reality data Ids of tile maps to convert

json

{
    "title": "TileMap Optimization Inputs",
    "type": "object",
    "properties": {
        "tileMaps": {
            "description": "Reality data Ids of tile maps to convert",
            "items": {
                "type": "string"
            },
            "title": "Tile Maps",
            "type": "array"
        }
    },
    "required": [
        "tileMaps"
    ]
}

TileMap Optimization Options

outputFormat

Any of: TileMapOptimizationFormat null

Output format for the conversion.

inputCrs

Any of: string null

CRS for the input data

outputCrs

Any of: string null

CRS for the output data

Top Level

Any of: integer null

Top level of the tile map to generate.

Bottom Level

Any of: integer null

Bottom level of the tile map to generate.

imageFormat

Any of: TileMapImageFormat null

Image format

JPG Quality

Any of: integer null

Quality of JPG tiles to generate

Background Color

Any of: string null

Background color to use for tiles

json

{
    "title": "TileMap Optimization Options",
    "type": "object",
    "properties": {
        "outputFormat": {
            "anyOf": [
                {
                    "$ref": "#/$defs/TileMapOptimizationFormat"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Output format for the conversion."
        },
        "inputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the input data"
        },
        "outputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the output data"
        },
        "topLevel": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Top level of the tile map to generate.",
            "title": "Top Level"
        },
        "bottomLevel": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Bottom level of the tile map to generate.",
            "title": "Bottom Level"
        },
        "imageFormat": {
            "anyOf": [
                {
                    "$ref": "#/$defs/TileMapImageFormat"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Image format"
        },
        "jpgQuality": {
            "anyOf": [
                {
                    "maximum": 99,
                    "minimum": 10,
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Quality of JPG tiles to generate",
            "title": "JPG Quality"
        },
        "backgroundColor": {
            "anyOf": [
                {
                    "pattern": "^#[a-fA-F0-9]{6}$",
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Background color to use for tiles",
            "title": "Background Color"
        }
    }
}

TileMap Image Format

JPG

String

PNG

String

json

{
    "enum": [
        "JPG",
        "PNG"
    ],
    "title": "TileMap Image Format",
    "type": "string"
}

TileMap Optimization Format

XYZTileMap

String

json

{
    "enum": [
        "XYZTileMap"
    ],
    "title": "TileMap Optimization Format",
    "type": "string"
}

Vector Optimization Specifications

Specifications for Vector Optimization.

inputs

VectorOptimizationInputs

Inputs

output

String

Reality Data id of the vector data or Feature DB index (fdb:)

options

Any of: VectorOptimizationOptions null

Options

json

{
    "title": "Vector Optimization Specifications",
    "description": "Specifications for Vector Optimization.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/$defs/VectorOptimizationInputs",
            "description": "Inputs"
        },
        "output": {
            "description": "Reality Data id of the vector data or Feature DB index (fdb:)",
            "title": "output",
            "type": "string"
        },
        "options": {
            "anyOf": [
                {
                    "$ref": "#/$defs/VectorOptimizationOptions"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Options"
        }
    },
    "required": [
        "inputs",
        "output"
    ]
}

Vector Optimization Inputs

Vectors

String[]

Reality data Ids of vectors to consolidate

json

{
    "title": "Vector Optimization Inputs",
    "type": "object",
    "properties": {
        "vectors": {
            "description": "Reality data Ids of vectors to consolidate",
            "items": {
                "type": "string"
            },
            "title": "Vectors",
            "type": "array"
        }
    },
    "required": [
        "vectors"
    ]
}

Vector Optimization Options

outputFormat

Any of: VectorOptimizationFormat null

Output format for the conversion.

inputCrs

Any of: string null

CRS for the input data

outputCrs

Any of: string null

CRS for the output data

Feature Class Display Name

Any of: string null

Display class name

json

{
    "title": "Vector Optimization Options",
    "type": "object",
    "properties": {
        "outputFormat": {
            "anyOf": [
                {
                    "$ref": "#/$defs/VectorOptimizationFormat"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Output format for the conversion."
        },
        "inputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the input data"
        },
        "outputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the output data"
        },
        "featureClassDisplayName": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Display class name",
            "title": "Feature Class Display Name"
        }
    }
}

Vector Optimization Format

GeoJSON

String

FeatureDB

String

json

{
    "enum": [
        "GeoJSON",
        "FeatureDB"
    ],
    "title": "Vector Optimization Format",
    "type": "string"
}

Mesh Sampling Specifications

Specifications for Mesh Sampling.

inputs

MeshSamplingInputs

Inputs

output

String

Reality Data id of the sampled point cloud

options

Any of: MeshSamplingOptions null

Options

json

{
    "title": "Mesh Sampling Specifications",
    "description": "Specifications for Mesh Sampling.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/$defs/MeshSamplingInputs",
            "description": "Inputs"
        },
        "output": {
            "description": "Reality Data id of the sampled point cloud",
            "title": "output",
            "type": "string"
        },
        "options": {
            "anyOf": [
                {
                    "$ref": "#/$defs/MeshSamplingOptions"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Options"
        }
    },
    "required": [
        "inputs",
        "output"
    ]
}

Mesh Sampling Inputs

Meshes

String[]

Reality data Ids of meshes to sample

json

{
    "properties": {
        "meshes": {
            "description": "Reality data Ids of meshes to sample",
            "items": {
                "type": "string"
            },
            "title": "Meshes",
            "type": "array"
        }
    },
    "required": [
        "meshes"
    ],
    "title": "Mesh Sampling Inputs",
    "type": "object"
}

Mesh Sampling Options

outputFormat

Any of: MeshSamplingFormat null

Output format for the conversion.

inputCrs

Any of: string null

CRS for the input data

outputCrs

Any of: string null

CRS for the output data

Sampling

Any of: number null

Sampling value in meter

json

{
    "title": "Mesh Sampling Options",
    "type": "object",
    "properties": {
        "outputFormat": {
            "anyOf": [
                {
                    "$ref": "#/$defs/MeshSamplingFormat"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Output format for the conversion."
        },
        "inputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the input data"
        },
        "outputCrs": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "CRS for the output data"
        },
        "sampling": {
            "anyOf": [
                {
                    "type": "number"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Sampling value in meter",
            "title": "Sampling"
        }
    }
}

MeshSamplingFormat

OPC

String

3DTilesPnts

String

3DTilesGlbc

String

LAS

String

LAZ

String

E57

String

POD

String

json

{
    "enum": [
        "OPC",
        "3DTilesPnts",
        "3DTilesGlbc",
        "LAS",
        "LAZ",
        "E57",
        "POD"
    ],
    "title": "MeshSamplingFormat",
    "type": "string"
}

Context Scene Tiler Specifications

Specifications for Context Scene Tiler.

inputs

CSTilerInputs

Inputs

output

String

Reality Data id of tiled ContextScene

options

Any of: CSTilerOptions null

Options

json

{
    "title": "Context Scene Tiler Specifications",
    "description": "Specifications for Context Scene Tiler.",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/$defs/CSTilerInputs",
            "description": "Inputs"
        },
        "output": {
            "description": "Reality Data id of tiled ContextScene",
            "title": "output",
            "type": "string"
        },
        "options": {
            "anyOf": [
                {
                    "$ref": "#/$defs/CSTilerOptions"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Options"
        }
    },
    "required": [
        "inputs",
        "output"
    ]
}

CSTilerInputs

Scene

String

ContextScene reality data id to tile

json

{
    "properties": {
        "scene": {
            "description": "ContextScene reality data id to tile",
            "title": "Scene",
            "type": "string"
        }
    },
    "required": [
        "scene"
    ],
    "title": "CSTilerInputs",
    "type": "object"
}

CSTilerOptions

objectToTile

Any of: CSObject null

Object to tile inside the ContextScene.

json

{
    "properties": {
        "objectToTile": {
            "anyOf": [
                {
                    "$ref": "#/$defs/CSObject"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Object to tile inside the ContextScene."
        }
    },
    "title": "CSTilerOptions",
    "type": "object"
}

CSObject

Cameras

String

TiePoints

String

Annotations

String

json

{
    "enum": [
        "Cameras",
        "TiePoints",
        "Annotations"
    ],
    "title": "CSObject",
    "type": "string"
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

json

{
    "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.

error

DetailedError

Error Detailed information.

json

{
    "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.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "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

error

Error

Error information.

json

{
    "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?