Get extension - Saved Views

REST API Overview

Overview

Samples

Reference

Changelog

Saved Views

Download API definition:

Get extension

GET https://api.bentley.com/savedviews/{savedViewId}/extensions/{extensionName}

Get an extension from a saved view.

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

savedViewId

Yes

Id of the saved view.

extensionName

Yes

Name of the extension.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

Specified extension.

json

{
    "extension": {
        "extensionName": "My Extension",
        "markdownUrl": "https://github.com/iTwin/saved-views-extensions/my-extension/my-extension.md",
        "schemaUrl": "https://github.com/iTwin/saved-views-extensions/my-extension/my-extension-schema.json",
        "data": "{ \"myExtensionData\": 123 }",
        "_links": {
            "iTwin": {
                "href": "https://api.bentley.com/iTwins/c6b0bf8d-033d-4291-9931-9b20f2135111"
            },
            "project": {
                "href": "https://api.bentley.com/projects/c6b0bf8d-033d-4291-9931-9b20f2135111"
            },
            "imodel": {
                "href": "https://api.bentley.com/imodels/b2db2e65-24a5-4958-abf5-91a60b94e8a5"
            },
            "savedView": {
                "href": "https://api.bentley.com/savedviews/AB2ckLPpC-REkuTK99srqHONv7DGPQORQpkxmyDyE1ERZS7bsqUkWEmr9ZGmC5TopQ"
            }
        }
    }
}

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 extension is not available.

json

{
    "error": {
        "code": "ExtensionNotFound",
        "message": "Requested extension 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

retry-after

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

Definitions

Link

href

String

Http reference

GetExtensionResponse

extension

ExtensionPayload

extensionName

String

markdownUrl

String

schemaUrl

String

data

String

_links.iTwin

_links.project

_links.imodel

_links.savedView

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.

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.