Get Catalogs - Library | iTwin Platform

Library

Download API definition:

GET https://api.bentley.com/library/catalogs[?$top][&$skip][&$search]

Retrieves digital catalogs from user's organization context.

Response

By default, each entity in the returned list will have only the id and display name.

A full representation of each entity can be returned by specifying the prefer header that includes a value of 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.

Authorization

User must be an Organization Administrator for the Organization or have Read permission assigned at the organization level.

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 parameters

$top

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$search

Find all catalogs that have the search string anywhere in the  hashTags or displayName.

Request headers

Prefer

Indicates a level of details in the response. This operation supports 'return=representation' and 'return=minimal' preferences.

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "catalogs": [{
            "id": "4ca8dcff-5ebb-b236-ea2f-0bfbdf3c623e",
            "displayName": "Door's Catalog"
        },
        {
            "id": "3ea8dcff-5ebb-b236-ea2f-0bfbdf3c624b",
            "displayName": "Fittings"
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/Library/catalogs?$skip=0&$top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/Library/catalogs?$skip=0&$top=100"
        },
        "next": {
            "href": "https://api.bentley.com/Library/catalogs?$skip=100&$top=100"
        }
    }
}

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

This response indicates that the specified components not found.

json

{
    "error": {
        "code": "CatalogsNotFound",
        "message": "Requested Catalogs is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get catalogs.

json

{
    "error": {
        "code": "InvalidCatalogsRequest",
        "message": "Cannot perform operation.",
        "details": [{
            "code": "InvalidValue",
            "message": "Page size is over '1000' items limit.",
            "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

Catalogs (prefer return=representation)

catalogs

Catalog[]

_links

links-paging

Contains the hyperlinks to the previous and next pages of results.

json

{
    "type": "object",
    "title": "Catalogs (prefer return=representation)",
    "properties": {
        "catalogs": {
            "type": "array",
            "items": {
                "description": "List of catalogs.",
                "$ref": "#/components/schemas/Catalog"
            }
        },
        "_links": {
            "description": "Contains the hyperlinks to the previous and next pages of results.",
            "$ref": "#/components/schemas/links-paging"
        }
    },
    "additionalProperties": false
}

Catalogs (prefer return=minimal)

catalogs

catalog-summary[]

_links

links-paging

Contains the hyperlinks to the previous and next pages of results.

json

{
    "type": "object",
    "title": "Catalogs (prefer return=minimal)",
    "properties": {
        "catalogs": {
            "type": "array",
            "items": {
                "description": "List of catalogs.",
                "$ref": "#/components/schemas/catalog-summary"
            }
        },
        "_links": {
            "description": "Contains the hyperlinks to the previous and next pages of results.",
            "$ref": "#/components/schemas/links-paging"
        }
    },
    "additionalProperties": false
}

Catalog (summary)

String

Id of the catalog.

displayName

String

Display name of the catalog.

json

{
    "type": "object",
    "title": "Catalog (summary)",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the catalog."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the catalog."
        }
    },
    "additionalProperties": false
}

Catalog

String

Id of the catalog.

displayName

String

Display name of the catalog.

description

String

Description of the catalog.

region

String

Region of the catalog.

createdDateTime

String

Created datetime of the catalog.

lastModifiedDateTime

String

Last modified datetime of the catalog.

hashtags

String[]

Hashtags of the catalog.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the catalog."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the catalog."
        },
        "description": {
            "type": "string",
            "description": "Description of the catalog."
        },
        "region": {
            "type": "string",
            "description": "Region of the catalog."
        },
        "createdDateTime": {
            "type": "string",
            "description": "Created datetime of the catalog."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "description": "Last modified datetime of the catalog."
        },
        "hashtags": {
            "type": "array",
            "description": "Hashtags of the catalog.",
            "items": {
                "description": "List of hashtags.",
                "type": "string"
            }
        }
    },
    "additionalProperties": false
}

Link

href

String

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string"
        }
    },
    "additionalProperties": false
}

Links (paging)

self

Link

json

{
    "type": "object",
    "title": "Links (paging)",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link"
        },
        "next": {
            "$ref": "#/components/schemas/Link"
        },
        "prev": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

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

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

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.

json

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

Was this page helpful?