• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Free Trial
    Table of contents
    Overview
    CC Image Collection
    CC Orientations
    Production Settings
    Available Events
    Tutorials
    Samples
    Changelog
    Reality Modeling
    Download API definition:
    Create a workspace
    POST https://qa-api.bentley.com/contextcapture/workspaces

    Create a new workspace

    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

    Request headers

    Name
    Required?
    Description
    Authorization
    Yes

    OAuth access token with itwin-platform scope

    Accept
    Yes

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

    Request body

    Workspace creation

    Name
    Type
    Required?
    Description
    name
    String
    Yes

    Name of the workspace

    iTwinId
    String
    No

    iTwin Id

    Example

    json
    {
    "name": "Workspace test",
    "iTwinId": "60805594-3e04-43b5-8fd8-5ccae0de23cc"
}

    Response

    Response 201 Created

    Created

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

    json
    {
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

    Response 422 Unprocessable Entity

    Unprocessable Entity

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

    json
    {
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

    Response headers

    Name
    Description
    retry-after

    The number of requests exceeds the rate-limit for the client subscription.

    Definitions

    Workspace creation

    Model for creating a new workspace

    Name
    Type
    Description
    name
    String

    Name of the workspace

    iTwinId
    String

    iTwin Id

    Workspace

    Workspace information and details

    Name
    Type
    Description
    id
    String

    Unique id of the workspace

    createdDateTime
    Date-time

    Creation time of the workspace

    name
    String

    Name of the workspace

    iTwinId
    String

    iTwin Id

    contextCaptureVersion
    String

    Version of the worker to be used for this workspace

    Workspace response

    Name
    Type
    Description
    workspace
    workspace

    Workspace details

    DetailedError

    Contains error information and an array of more specific errors.

    Name
    Type
    Description
    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.

    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.

    Name
    Type
    Description
    error
    DetailedError

    Error Detailed information.

    Error

    Contains error information.

    Name
    Type
    Description
    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.

    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.

    Name
    Type
    Description
    error
    Error

    Error information.

    Was this page helpful?