Create Report - Reporting | iTwin Platform

Reporting

Download API definition:

Create Report

POST https://qa-api.bentley.com/insights/reporting/reports

Creates a Report within the context of a Project.

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_modify 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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Report (create)

displayName

String

Name of the Report.

description

String

Description of the Report.

projectId

String

The Project Id this Report will be drawing data from.

Example

json

{
    "displayName": "iModel Report",
    "description": "Report containing iModel Mappings",
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

Response 200 OK

Created a new Report successfully.

json

{
    "report": {
        "id": "617c13fd-2547-4d85-87a3-28f21f29daf2",
        "displayName": "iModel Report",
        "description": "Report containing iModel Mappings",
        "createdOn": "2022-09-01T03:20:10Z",
        "modifiedOn": "2022-09-02T12:03:00Z",
        "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 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": "InvalidInsightsRequest",
        "message": "Error message."
    }
}

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

Report (create)

Properties of the Report to be created.

displayName

String

Name of the Report.

description

String

Description of the Report.

projectId

String

The Project Id this Report will be drawing data from.

json

{
    "title": "Report (create)",
    "type": "object",
    "properties": {
        "displayName": {
            "type": "string",
            "description": "Name of the Report."
        },
        "description": {
            "type": "string",
            "description": "Description of the Report."
        },
        "projectId": {
            "type": "string",
            "description": "The Project Id this Report will be drawing data from."
        }
    },
    "additionalProperties": false,
    "description": "Properties of the Report to be created."
}

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

_links.odata

Link

json

{
    "title": "Report",
    "type": "object",
    "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",
            "properties": {
                "project": {
                    "$ref": "#/components/schemas/Link"
                },
                "odata": {
                    "$ref": "#/components/schemas/Link"
                }
            },
            "description": "Contains contextual hyperlinks to related data."
        }
    },
    "additionalProperties": false,
    "description": "Defines a unit of data that can be exposed as an OData feed. The contents of a Report are defined in Report Mappings."
}

Report Response

Container for a Report object.

report

Report

json

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

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

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

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

{
    "required": [
        "code",
        "message"
    ],
    "type": "object",
    "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
        }
    },
    "description": "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.

error

Error

json

{
    "title": "Error Response",
    "required": [
        "error"
    ],
    "type": "object",
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error"
        }
    },
    "additionalProperties": false,
    "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."
}

Was this page helpful?