Request headers

Response 201 Created

Created

{
    "workspace": {
        "id": "e47cf092-729a-4ce2-b20e-9b01ad820cdb",
        "createdDateTime": "2021-05-18T09:39:23.436Z",
        "name": "My workspace",
        "iTwinId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "contextCaptureVersion": "20.1"
    }
}

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 422 Unprocessable Entity

Unprocessable Entity

{
    "error": {
        "code": "InvalidContextCaptureRequest",
        "message": "Cannot create workspace.",
        "details": [{
            "code": "InvalidParameter",
            "message": "No processing cluster in project location."
        }]
    }
}

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

Workspace creation

Model for creating a new workspace

Workspace

Workspace information and details

Workspace response

DetailedError

Contains error information and an array of more specific errors.

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.

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.