Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newforma Hub API

The Hub API from Newforma — 7 operation(s) for hub.

Newforma Hub API is one of 4 APIs that Newforma publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Hub. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 10 operations across 7 paths, and defines 14 schemas. It is described by OpenAPI 3.0.4, at version 3.

Requests are made against a single base URL, https://api.bimtrackapp.co.

10 operations 7 paths 14 schemas 2 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
3
Base URL
https://api.bimtrackapp.co
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Newforma Hub API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Enter your API key

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 2 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Hub 10
GET
/v3/hubs/{hubId}
Get hub
1 param → 200409
GET
/v3/hubs/name/{hubName}
Get a hub by name
1 param → 200
GET
/v3/hubs
Get hubs
→ 200
GET
/v3/hubs/{hubId}/projecttemplates
Get project templates
1 param → 200
POST
/v3/hubs/{hubId}/projecttemplates
Create project template
1 param body → 201
DELETE
/v3/hubs/{hubId}/projecttemplates/{projectTemplateId}
Delete project template
2 params → 200
GET
/v3/hubs/{hubId}/users
Get hub users
1 param → 200
POST
/v3/hubs/{hubId}/users
Create hub user
1 param body → 201
PUT
/v3/hubs/{hubId}/users/{userId}
Updates a user in the specified hub
2 params body → 200
DELETE
/v3/hubs/{hubId}/users/{userId}
Delete hub user
2 params → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are BIMOne.BIMTrack.WebAPI.Models.Model.v3.HubDetailWithUserPermissions (9 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v3.HubDetail (8 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v2.AttachmentWithThumbnail (8 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v2.UserSummary (6 properties). Each schema is shown below with its type and property counts.

BIMOne.BIMTrack.WebAPI.Models.Model.v3.HubDetail
object
8 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v3.HubDetailWithUserPermissions
object
9 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v2.ErrorStatus
string
BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectTemplateInput
object
2 properties 2 required
BIMOne.BIMTrack.WebAPI.Models.Model.v2.HubUser
object
6 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v3.ProjectTemplateSummary
object
5 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v2.UserProfileNotCreatedErrorModel
object
3 properties
BIMOne.BIMTrack.Common.SharedTypes.Hubs.HubRole
string
BIMOne.BIMTrack.WebAPI.Models.Model.v3.HubUserPermissions
object
1 property
BIMOne.BIMTrack.WebAPI.Models.Model.v2.HubUserPut
object
2 properties 1 required
BIMOne.BIMTrack.WebAPI.Models.Model.v3.RegionSummary
object
2 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v2.HubUserPost
object
2 properties 2 required
BIMOne.BIMTrack.WebAPI.Models.Model.v2.UserSummary
object
6 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v2.AttachmentWithThumbnail
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newforma-hub-api-openapi.yml Raw ↑

Other APIs Newforma publishes across the network.

Newforma Konekt BCF REST API
Newforma Issue API
Newforma Project API