Get iModel Baseline File Details - iModels

iModels

Download API definition:

GET https://dev-api.bentley.com/imodels/{id}/baselinefile

Retrieves the metadata of a Baseline File. Baseline File is the base iModel file that does not have any changesets applied.

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.

User must have imodels_webview permission assigned at the iModel level. If iModel Role permissions at the iModel level are configured, then user must additionally have at least imodels_webview permission assigned at the iTwin level. If permissions at the iModel level are not configured, then user must have imodels_webview permission assigned at the iTwin level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin the iModel belongs to.

For more information please refer to Account Administrator documentation section on Access Control API documentation page.

Note: download property requires user to have at least imodels_read permission. If user has only imodels_webview permission download will always be null.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request

Request parameters

Yes

iModel 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

Response 200 OK

json

{
    "baselineFile": {
        "id": "5e19bee0-3aea-4355-a9f0-c6df9989ee7d",
        "displayName": "5e19bee0-3aea-4355-a9f0-c6df9989ee7d.bim",
        "fileSize": 12563,
        "state": "initialized",
        "_links": {
            "creator": {
                "href": "https://api.bentley.com/imodels/5e19bee0-3aea-4355-a9f0-c6df9989ee7d/users/42101fba-847a-4f4e-85a8-a4bed89065e4"
            },
            "download": {
                "storageType": "azure",
                "href": "https://example.com/imodelhub-5e19bee0-3aea-4355-a9f0-c6df9989ee7d/5e19bee0-3aea-4355-a9f0-c6df9989ee7d.bim?sv=2019-07-07&sr=b&sig=**removed**&st=2021-07-30T10%3A53%3A09.5224547Z&se=2021-07-30T11%3A13%3A09.5224552Z&sp=r"
            }
        }
    }
}

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 404 Not Found

Specified iModel was not found or it does not have an associated Baseline File entity.

json

{
    "error": {
        "code": "iModelNotFound",
        "message": "Requested iModel is not available."
    }
}

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

Baseline File Response

Container for Baseline File object.

baselineFile

BaselineFile

Baseline File properties.

json

{
    "type": "object",
    "title": "Baseline File Response",
    "description": "Container for Baseline File object.",
    "properties": {
        "baselineFile": {
            "$ref": "#/components/schemas/BaselineFile",
            "description": "Baseline File properties."
        }
    },
    "additionalProperties": false
}

Baseline File state

Indicates the state of the Baseline File. 'initialized' - Baseline File is initialized. 'initializationScheduled' - Baseline File creation is complete and initialization is scheduled or currently in progress. 'waitingForFile' - file upload to file storage hasn't been completed yet. 'initializationFailed' - initializing Baseline File failed. 'fileIsBriefcase' - file is not a standalone iModel and cannot be used as a Baseline File.

initialized

String

initializationScheduled

String

initializationFailed

String

waitingForFile

String

fileIsBriefcase

String

json

{
    "type": "string",
    "description": "Indicates the state of the Baseline File. 'initialized' - Baseline File is initialized. 'initializationScheduled' - Baseline File creation is complete and initialization is scheduled or currently in progress. 'waitingForFile' - file upload to file storage hasn't been completed yet. 'initializationFailed' - initializing Baseline File failed. 'fileIsBriefcase' - file is not a standalone iModel and cannot be used as a Baseline File.",
    "enum": [
        "initialized",
        "initializationScheduled",
        "initializationFailed",
        "waitingForFile",
        "fileIsBriefcase"
    ],
    "title": "Baseline File state"
}

Baseline File

Metadata of Baseline File of the iModel.

String

Id of the Baseline File.

displayName

String

Name of the Baseline File.

fileSize

Int64

Size of the Baseline File in bytes.

Baseline File state

BaselineFile-state

_links

BaselineFileLinks

Contains the hyperlinks to the related data of the Baseline File.

json

{
    "type": "object",
    "title": "Baseline File",
    "description": "Metadata of Baseline File of the iModel.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the Baseline File."
        },
        "displayName": {
            "type": "string",
            "description": "Name of the Baseline File."
        },
        "fileSize": {
            "type": "integer",
            "format": "int64",
            "description": "Size of the Baseline File in bytes."
        },
        "state": {
            "type": "string",
            "description": "Indicates the state of the Baseline File. 'initialized' - Baseline File is initialized. 'initializationScheduled' - Baseline File creation is complete and initialization is scheduled or currently in progress. 'waitingForFile' - file upload to file storage hasn't been completed yet. 'initializationFailed' - initializing Baseline File failed. 'fileIsBriefcase' - file is not a standalone iModel and cannot be used as a Baseline File.",
            "enum": [
                "initialized",
                "initializationScheduled",
                "initializationFailed",
                "waitingForFile",
                "fileIsBriefcase"
            ],
            "title": "Baseline File state",
            "$ref": "#/components/schemas/BaselineFile-state"
        },
        "_links": {
            "$ref": "#/components/schemas/BaselineFileLinks",
            "description": "Contains the hyperlinks to the related data of the Baseline File."
        }
    },
    "additionalProperties": false
}

Baseline File Links

Hyperlinks to Briefcase related data.

creator

Link

Information about the creator of the Baseline File.

download

CloudStorageLink, null

Link to download Baseline File from storage. Set only if the user has at least imodels_read permission, otherwise it is always set to null.

json

{
    "type": "object",
    "title": "Baseline File Links",
    "description": "Hyperlinks to Briefcase related data.",
    "properties": {
        "creator": {
            "$ref": "#/components/schemas/Link",
            "description": "Information about the creator of the Baseline File."
        },
        "download": {
            "$ref": "#/components/schemas/CloudStorageLink",
            "description": "Link to download Baseline File from storage. Set only if the user has at least `imodels_read` permission, otherwise it is always set to null.",
            "nullable": true
        }
    },
    "additionalProperties": false
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "nullable": true,
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false
}

CloudStorageLink storageType

Storage type. Possible values: azure - Azure Blob storage, google - Google Cloud storage.

azure

String

google

String

json

{
    "type": "string",
    "description": "Storage type. Possible values: `azure` - Azure Blob storage, `google` - Google Cloud storage.",
    "enum": [
        "azure",
        "google"
    ],
    "title": "CloudStorageLink storageType"
}

CloudStorageLink

Hyperlink container.

href

String

Hyperlink to cloud storage.

CloudStorageLink storageType

CloudStorageLink-storageType

Storage type. Possible values: azure - Azure Blob storage, google - Google Cloud storage.

json

{
    "type": "object",
    "nullable": true,
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to cloud storage."
        },
        "storageType": {
            "type": "string",
            "description": "Storage type. Possible values: `azure` - Azure Blob storage, `google` - Google Cloud storage.",
            "enum": [
                "azure",
                "google"
            ],
            "title": "CloudStorageLink storageType",
            "$ref": "#/components/schemas/CloudStorageLink-storageType"
        }
    },
    "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

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

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?