Table of contents
Saved Views

Groups

Download API definition:

POST https://api.bentley.com/savedviews/groups

Creates a group to organize saved views.

Note: any string parameter being passed in the payload will be rejected if it contains any of the following characters: <, >, &, ", ', .

Authentication

Requires Authorization header with valid Bearer token for scope savedviews:modify.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope savedviews:modify

Accept
Yes

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

Request body

GroupCreate

Name
Type
Required?
Description
iTwinId
String
Yes

ITwin ID

iModelId
String
No

IModel ID

displayName
String
Yes

Group Name

shared
Boolean
No

Is Group Shared

Example

json
{
    "iTwinId": "c6b0bf8d-033d-4291-9931-9b20f2135111",
    "iModelId": "b2db2e65-24a5-4958-abf5-91a60b94e8a5",
    "displayName": "Desktop",
    "shared": true
}

Response 201 Created

Created group.

json
{
    "group": {
        "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"
            }
        }
    }
}

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 403 Forbidden

The user has insufficient permissions for the requested operation.

json
{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 422 Unprocessable Entity

Cannot create group.

json
{
    "error": {
        "code": "InvalidSavedviewsRequest",
        "message": "Cannot create group.",
        "details": [{
            "code": "InvalidRequestBody",
            "message": "displayName must be a string.",
            "target": "displayName"
        }]
    }
}

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.

GroupCreate

TableSchema
Name
Type
Description
iTwinId
String

ITwin ID

iModelId
String

IModel ID

displayName
String

Group Name

shared
Boolean

Is Group Shared

Link

TableSchema
Name
Type
Description
href
String

Http reference

GroupLinks

TableSchema
Name
Type
Description
iTwin
imodel
creator
savedViews

Group

TableSchema
Name
Type
Description
id
String

Unique identifier

displayName
String

User visible name

shared
Boolean

Flag for whether or not element is shared

GroupResponse

TableSchema
Name
Type
Description
group

Error

Contains error information.

TableSchema
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

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
Name
Type
Description
error

Error information.