Table of contents
Saved Views
Download API definition:
GET https://api.bentley.com/savedviews/groups[?iTwinId][&iModelId]

Retrieves all groups associated to a iTwin or iTwin/iModel combination.

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

Name
Required?
Description
iTwinId
No
iModelId
No

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.

Response 200 OK

List of all available groups for the iTwin and iModel.

json
{
    "groups": [{
        "id": "ACZbDmWhULVChRcDRkoPdLaNv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ",
        "displayName": "Test Name",
        "shared": false,
        "_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"
            },
            "savedViews": {
                "href": "https://api.bentley.com/path1/path2/id"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/path1/path2/id"
        }
    }
}

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

Requested group is not available.

json
{
    "error": {
        "code": "GroupNotFound",
        "message": "Requested group is not available."
    }
}

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.

Link

Name
Type
Description
href
String

Http reference

GroupLinks

Name
Type
Description
iTwin
project
imodel
creator
savedViews

Group

Name
Type
Description
id
String

Unique identifier

readOnly
Boolean

Whether the group is read-only and only editable by admin users

displayName
String

User visible name

shared
Boolean

Flag for whether or not element is shared

GroupListLinks

Name
Type
Description
self

GroupListResponse

Name
Type
Description
groups

Requested groups

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 information.