Get Report - Reporting | iTwin Platform

Reporting

Download API definition:

Get Report

GET https://api.bentley.com/insights/reporting/reports/{reportId}

Gets a single Report.

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.

Authorization

User must have insights_view permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

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

reportId

Yes

The Report Id.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Response

Response 200 OK

Fetched Report successfully.

json

{
    "report": {
        "id": "617c13fd-2547-4d85-87a3-28f21f29daf2",
        "displayName": "iModel Report",
        "description": "Report containing iModel Mappings",
        "createdOn": "2022-09-01T15:20:10+00:00",
        "modifiedOn": "2022-09-02T12:03:00+00:00",
        "deleted": false,
        "_links": {
            "project": {
                "href": "https://api.bentley.com/projects/3fa85f64-5717-4562-b3fc-2c963f66afa6"
            },
            "odata": {
                "href": "https://api.bentley.com/insights/reporting/odata/3fa85f64-5717-4562-b3fc-2c963f66afa6?api-version=v1"
            }
        }
    }
}

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 Report was not found.

json

{
    "error": {
        "code": "ReportNotFound",
        "message": "Requested Report is not available.",
        "target": "id"
    }
}

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

retry-after

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

Definitions

Report

Defines a unit of data that can be exposed as an OData feed. The contents of a Report are defined in Report Mappings.

String

The Report Id.

displayName

String

Name of the Report.

description

String

Description of the Report.

createdOn

String

Creation time of the Report.

modifiedOn

String

Latest modification time of the Report.

deleted

Boolean

Flag indicating whether or not a Report has been marked for deletion.

_links.project

Link

URL pointing to the related Project.

_links.odata

Link

Link to the OData feed.

json

{
    "title": "Report",
    "type": "object",
    "description": "Defines a unit of data that can be exposed as an OData feed. The contents of a Report are defined in Report Mappings.",
    "properties": {
        "id": {
            "type": "string",
            "description": "The Report Id."
        },
        "displayName": {
            "type": "string",
            "description": "Name of the Report."
        },
        "description": {
            "type": "string",
            "description": "Description of the Report."
        },
        "createdOn": {
            "type": "string",
            "description": "Creation time of the Report."
        },
        "modifiedOn": {
            "type": "string",
            "description": "Latest modification time of the Report."
        },
        "deleted": {
            "type": "boolean",
            "description": "Flag indicating whether or not a Report has been marked for deletion."
        },
        "_links": {
            "type": "object",
            "description": "Contains contextual hyperlinks to related data.",
            "properties": {
                "project": {
                    "$ref": "#/components/schemas/Link",
                    "description": "URL pointing to the related Project."
                },
                "odata": {
                    "$ref": "#/components/schemas/Link",
                    "description": "Link to the OData feed."
                }
            }
        }
    },
    "additionalProperties": false
}

Report Response

Container for a Report object.

report

Report

Report properties.

json

{
    "title": "Report Response",
    "type": "object",
    "description": "Container for a Report object.",
    "properties": {
        "report": {
            "$ref": "#/components/schemas/Report",
            "description": "Report properties."
        }
    },
    "additionalProperties": false
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "title": "Link",
    "type": "object",
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "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?