iTwin Platform
Get Started
Documentation
Learning
Samples
Blog
Support
Pricing
Sign In
Free Trial
Table of contents
v1
REST API Overview
Overview
Tutorials
Samples
Reference
View All
Changelog
Documentation
Library
Library
Download API definition:
OpenAPI v3 (JSON)
API references
Call
Request URL
Title
Tags
POST
/library/applications
Create Application
Applications
POST
/library/catalogs
Create Catalog
Catalogs
POST
/library/catalogs/{catalogId}/documents
Create Catalog Document
Catalogs
POST
/library/catalogs/{catalogId}/weblinks
Create Catalog WebLink
Catalogs
POST
/library/categories
Create Category
Categories
POST
/library/components
Create Component
Components
POST
/library/components/{componentId}/documents
Create Component Document
Components
POST
/library/components/{componentId}/variations
Create Component Variation
Components
POST
/library/components/{componentId}/weblinks
Create Component WebLink
Components
POST
/library/manufacturers
Create Manufacturer
Manufacturers
DELETE
/library/applications/{id}
Delete Application
Applications
DELETE
/library/catalogs/{id}
Delete Catalog
Catalogs
DELETE
/library/catalogs/{catalogId}/documents/{documentId}
Delete Catalog Document
Catalogs
DELETE
/library/catalogs/{catalogId}/weblinks/{webLinkId}
Delete Catalog WebLink
Catalogs
DELETE
/library/categories/{id}
Delete Category
Categories
DELETE
/library/components/{id}
Delete Component
Components
DELETE
/library/components/{componentId}/documents/{documentId}
Delete Component Document
Components
DELETE
/library/components/{componentId}/variations/{variationId}
Delete Component Variation
Components
DELETE
/library/components/{componentId}/weblinks/{webLinkId}
Delete Component WebLink
Components
DELETE
/library/manufacturers/{id}
Delete Manufacturer
Manufacturers
GET
/library/components/analytics/download?startDate={startDate}&endDate={endDate}
Download Analytics
Analytics
GET
/library/applications/{id}
Get Application
Applications
GET
/library/applications[?continuationToken]
Get Applications
Applications
GET
/library/brands/{brandId}
Get Brand
Brands
GET
/library/brands/{brandId}/components/{componentId}/documents
Get Brand Component Documents
Brands
GET
/library/brands/{brandId}/components/{componentId}/variations
Get Brand Component Variations
Brands
GET
/library/brands/{brandId}/components/{componentId}/weblinks
Get Brand Component WebLinks
Brands
GET
/library/brands/{brandId}/components[?$top][&$skip][&$search]
Get Brand Components
Brands
GET
/library/brands
Get Brands
Brands
GET
/library/catalogs/{id}
Get Catalog
Catalogs
GET
/library/catalogs/{catalogId}/documents/{documentId}
Get Catalog Document
Catalogs
GET
/library/catalogs/{catalogId}/documents
Get Catalog Documents
Catalogs
GET
/library/catalogs/{catalogId}/weblinks/{webLinkId}
Get Catalog WebLink
Catalogs
GET
/library/catalogs/{catalogId}/weblinks
Get Catalog WebLinks
Catalogs
GET
/library/catalogs[?$top][&$skip][&$search]
Get Catalogs
Catalogs
GET
/library/categories[?continuationToken]
Get Categories
Categories
GET
/library/categories/{id}
Get Category
Categories
GET
/library/components/{id}[?projectId]
Get Component
Components
GET
/library/components/{componentId}/documents/{documentId}[?projectId]
Get Component Document
Components
GET
/library/components/{componentId}/documents[?projectId]
Get Component Documents
Components
GET
/library/components/{componentId}/variations/{variationId}[?projectId]
Get Component Variation
Components
GET
/library/components/{componentId}/variations[?projectId]
Get Component Variations
Components
GET
/library/components/{componentId}/weblinks/{webLinkId}[?projectId]
Get Component WebLink
Components
GET
/library/components/{componentId}/weblinks[?projectId]
Get Component WebLinks
Components
GET
/library/components[?$top][&$skip][&projectId][&$search][&catalogs]
Get Components
Components
GET
/library/jobs/{id}
Get Job
Jobs
GET
/library/manufacturers/{id}
Get Manufacturer
Manufacturers
GET
/library/manufacturers[?continuationToken]
Get Manufacturers
Manufacturers
PUT
/library/applications/{id}
Update Application
Applications
PUT
/library/catalogs/{id}
Update Catalog
Catalogs
PUT
/library/catalogs/{catalogId}/documents/{documentId}
Update Catalog Document
Catalogs
PUT
/library/catalogs/{catalogId}/weblinks/{webLinkId}
Update Catalog WebLink
Catalogs
PUT
/library/categories/{id}
Update Category
Categories
PUT
/library/components/{id}
Update Component
Components
PUT
/library/components/{componentId}/documents/{documentId}
Update Component Document
Components
PUT
/library/components/{componentId}/variations/{variationId}
Update Component Variation
Components
PUT
/library/components/{componentId}/weblinks/{webLinkId}
Update Component WebLink
Components
PUT
/library/manufacturers/{id}
Update Manufacturer
Manufacturers
POST
/library/upload
Upload Component
Components
Was this page helpful?
Yes
No