Get all saved views - Saved Views

REST API Overview

Overview

Samples

Reference

Changelog

Saved Views

Download API definition:

Get all saved views

GET https://api.bentley.com/savedviews/[?iTwinId][&iModelId][&groupId][&$top][&$skip]

Retrieves all saved view associated to a iTwin, iTwin/iModel combination or group, at least one parameter must be provided.

This operation supports pagination and will sort saved views by displayName.

As the view data can be quite large, this collection call will not contain the view data themselves. To retrieve the data, make a call to Get saved view

Extension data is returned as a list of links to query further. If you want to obtain the full saved view data, including extension data, use the Prefer header with return=representation.

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 parameters

iTwinId

query

iModelId

query

groupId

query

$top

query

$skip

query

Request headers

Prefer

Controls the returned data. Setting to return=representation will return the saved views with all the extension data in a single payload. Setting to return=minimal will return the saved views with the list of extensions that exist and links to query those separately.

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

List of all saved views associated to the query.

json

{
    "savedViews": [{
        "id": "ACZbDmWhULVChRcDRkoPdLaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ",
        "displayName": "Test Name",
        "shared": false,
        "tags": [{
            "displayName": "Tag Test Name",
            "id": "ABRBqKCBtXZCl_ax5ZFB9uaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ"
        }],
        "_links": {
            "iTwin": {
                "href": "https://api.bentley.com/path1/path2/id"
            },
            "imodel": {
                "href": "https://api.bentley.com/path1/path2/id"
            },
            "creator": {
                "href": "https://api.bentley.com/path1/path2/id"
            },
            "group": {
                "href": "https://api.bentley.com/path1/path2/id"
            },
            "image": {
                "href": "https://api.bentley.com/path1/path2/id"
            },
            "thumbnail": {
                "href": "https://api.bentley.com/path1/path2/id"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/path1/path2/id"
        },
        "prev": {
            "href": "https://api.bentley.com/path1/path2/id"
        },
        "next": {
            "href": "https://api.bentley.com/path1/path2/id"
        }
    }
}

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

Requested savedview is not available.

json

{
    "error": {
        "code": "SavedViewNotFound",
        "message": "Requested savedview is not available."
    }
}

Response 422 Unprocessable Entity

Cannot retrieve saved view.

json

{
    "error": {
        "code": "InvalidSavedviewsRequest",
        "message": "Cannot retrieve saved view.",
        "details": [{
            "code": "InvalidParameter",
            "message": "$top must be a number.",
            "target": "$top"
        }]
    }
}

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

Link

TableSchema

href

String

Http reference

SavedViewTag

TableSchema

String

Linked Tag identifier

displayName

String

SavedViewLinks

TableSchema

iTwin

imodel

creator

group

image

thumbnail

SavedView

TableSchema

String

Unique identifier

displayName

String

User visible name

shared

Boolean

Flag for whether or not element is shared

SavedViewListLinks

TableSchema

self

Link

SavedViewListResponse

TableSchema

savedViews

SavedView[]

Requested saved views

_links

SavedViewListLinks

extensions

Extension[]

Extension

TableSchema

extension.extensionName

String

extension.markdownUrl

String

extension.schemaUrl

String

extension.data

String

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

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.

TableSchema

error

Error

Error information.