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 Project API

The Project API from Newforma — 4 operation(s) for project.

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

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

This API exposes 5 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.0.4, at version 3.

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

5 operations 4 paths 19 schemas 3 GET1 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 Project 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 5

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

Project 5
GET
/v3/hubs/{hubId}/projects/{projectId}/issuefiltertemplate
Get issue filter templates
2 params → 200
GET
/v3/hubs/{hubId}/projects/{projectId}/issuefiltertemplate/{userTemplateId}
Get details issue filter template
3 params → 200
GET
/v3/hubs/{hubId}/projects/{projectId}/sheets
Get sheets
4 params → 200
POST
/v3/hubs/{hubId}/projects/{projectId}/sheets
Create sheets
2 params → 200
PUT
/v3/hubs/{hubId}/projects/{projectId}/models/{modelId}/revisions/{revisionId}/disciplines
Update 3D model revision disciplines
4 params body → 204

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueFilterTemplateDetail (33 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectSummary (11 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v2.UserTemplateDetail (10 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v2.AttachmentWithThumbnail (8 properties). Each schema is shown below with its type and property counts.

BIMOne.BIMTrack.Common.SharedTypes.Projects.ProjectRole
string
BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectUser
object
6 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectAttributeSummary
object
3 properties 3 required
BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectAttributeValue
object
3 properties 3 required
BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueFilterTemplateProjectAttributePredefinedValue
object
1 property
BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueFilterTemplateDetail
object
33 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectTeam
object
2 properties 2 required
BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueFilterTemplateProjectAttributeValue
object
3 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v3.Project2DSheetSummary
object
8 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v3.Project3DModelRevisionDisciplines
object
1 property
BIMOne.BIMTrack.WebAPI.Models.Model.v2.AttachmentWithThumbnail
object
8 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v2.UserTemplateDetail
object
10 properties
BIMOne.BIMTrack.Common.SharedTypes.SortByDirection
string
BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueSortingDetail
object
3 properties
BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueFilterTemplateProjectAttributeFreeFormValue
object
1 property
BIMOne.BIMTrack.Common.SharedTypes.Projects.ProjectAttributeType
string
BIMOne.BIMTrack.Common.SharedTypes.Issues.SortByField
string
BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectSummary
object
11 properties 1 required
BIMOne.BIMTrack.WebAPI.Models.Model.v2.UserSummary
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newforma-project-api-openapi.yml Raw ↑

Other APIs Newforma publishes across the network.

Newforma Konekt BCF REST API
Newforma Hub API
Newforma Issue API