Newforma Issue API

The Issue API from Newforma — 17 operation(s) for issue.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 24 operations across 17 paths, and defines 56 schemas. It is described by OpenAPI 3.0.4, at version 3.

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

24 operations 17 paths 56 schemas 3 DELETE12 GET4 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.4

API Version

Base URL

https://api.bimtrackapp.co

Authentication

API Key

Resource Areas

Authentication & Security 1

Newforma Issue 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 24

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

Issue 24

GET

/v3/hubs/{hubId}/projects/{projectId}/archivedissues

Get archived issues

GetArchivedIssues_V3 35 params → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/archivedissues/{issueId}

Get archived issue

3 params → 200

PATCH

/v3/hubs/{hubId}/projects/{projectId}/archivedissues/{archivedIssueId}

Restore issue

3 params body → 200

DELETE

/v3/hubs/{hubId}/projects/{projectId}/archivedissues/{archivedIssueId}

Delete archived issue

3 params → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}/attachments

Get issue attachments list

3 params → 200

POST

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}/attachments

Create issue attachment

3 params body → 201

DELETE

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}/attachments/{attachmentId}

Delete issue attachment

4 params → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}/comments

Get issue comments

3 params → 200

POST

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}/comments

Create issue comment

3 params body → 201

DELETE

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}/comments/{issueCommentId}

Delete issue comment

4 params → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues

Get issues

GetIssues_V3 36 params → 200

POST

/v3/hubs/{hubId}/projects/{projectId}/issues

Create issue

2 params body → 201

PATCH

/v3/hubs/{hubId}/projects/{projectId}/issues

Multi edit issues

2 params body → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/search

Search issues with filters

SearchIssues_V3 36 params → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/details

Get issues details

GetIssuesDetails_V3 33 params → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}

Get Issue

GetIssue_V3 3 params → 200

PUT

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}

Update issue

3 params body → 200

PATCH

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}

Archive an issue

3 params body → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/multiple

Get multiple issues

GetMultiple 5 params → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/number/{issueNumber}

Get issue by issue number

3 params → 200

PATCH

/v3/hubs/{hubId}/projects/{projectId}/issues/archiveissues

Archive multiple issues

2 params body → 200

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}/history

Get issue history

3 params → 200

POST

/v3/hubs/{hubId}/projects/{projectId}/issues/viewpoints/batch

Get viewpoints for multiple issues

2 params body → 200400401403404

GET

/v3/hubs/{hubId}/projects/{projectId}/issues/{issueId}/viewpoints/{viewpointId}/viewstate

Get viewpoint view state

6 params → 200400401403404

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueDetail (32 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueSummary (30 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueModificationSummary (24 properties), BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueSummaryUpdateInput (17 properties). Each schema is shown below with its type and property counts.

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueHistory

object

1 property

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueModificationSummary

object

24 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueConfidentiality

object

1 property

BIMOne.BIMTrack.WebAPI.Models.Model.v2.Enums.IssueCreationOperationResult

string

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ModelElement

object

2 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssuePatchRestore

object

2 properties 2 required

Json.Patch.PatchOperation

object

4 properties

BIMOne.BIMTrack.Common.SharedTypes.SourceType

string

BIMOne.BIMTrack.WebAPI.Models.Model.v2.OrthogonalCamera

object

6 properties 4 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueChangeSet

object

4 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueProjectAttribute

object

5 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ViewpointViewStateSummary

object

5 properties 1 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectIssuePriority

object

4 properties 4 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueSummaryInput

object

15 properties 1 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueNotifyListInput

object

2 properties

System.Text.Json.Nodes.JsonNodeOptions

object

1 property

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueSummary

object

30 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.Attachment

object

6 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueDetail

object

32 properties

System.Text.Json.Nodes.JsonNode

object

3 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.Enums.ViewType

string

BIMOne.BIMTrack.WebAPI.Models.Model.v2.Enums.ChangeType

string

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ViewpointPinpoint

object

4 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectZone

object

3 properties 3 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ViewpointSheetInformation

object

2 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueNotifyList

object

2 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectPhase

object

3 properties 3 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.Enums.ViewpointClipMode

string

BIMOne.BIMTrack.WebAPI.Models.Model.v2.PerspectiveCamera

object

4 properties 4 required

Microsoft.AspNetCore.Mvc.ProblemDetails

object

5 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectTeam

object

2 properties 2 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ViewpointSummary

object

16 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.Element

object

5 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectIssueDiscipline

object

2 properties 2 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.SectionBox

object

3 properties 3 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueSummaryUpdateInput

object

17 properties 4 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.CommentSummary

object

5 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssuePatchArchive

object

1 property 1 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.AttachmentWithThumbnail

object

8 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectIssueType

object

3 properties 3 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueConfidentialityInput

object

1 property

Json.Patch.OperationType

string

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueCommentInput

object

3 properties 1 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ViewpointViewStateDetail

object

8 properties 1 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.Point3D

object

3 properties 3 required

BIMOne.BIMTrack.WebAPI.Models.Model.v3.Issue.ProjectIssuesDetails

object

3 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueChange

object

3 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueProjectTeam

object

1 property

BIMOne.BIMTrack.WebAPI.Models.Model.v3.Issue.IssueViewpointsBatchInput

object

1 property 1 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueProjectAttributeInput

object

3 properties 1 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ClippingPlane

object

2 properties 2 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.IssueProjectAttributeValue

object

3 properties 3 required

BIMOne.BIMTrack.WebAPI.Models.Model.v2.AspNetCore.IssuesPatchInput

object

2 properties 2 required

BIMOne.BIMTrack.WebAPI.Models.Model.v3.Issue.IssuePatchArchiveIssues

object

1 property

BIMOne.BIMTrack.WebAPI.Models.Model.v2.UserSummary

object

6 properties

BIMOne.BIMTrack.WebAPI.Models.Model.v2.ProjectIssueStatus

object

4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Newforma publishes across the network.

Newforma Konekt BCF REST API

AE Profile APIs.io

Newforma Hub API

AE Profile APIs.io

Newforma Project API

AE Profile APIs.io

#Issue

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Newforma Issue API

Metadata

Authentication & Security 1

Paths & Operations 24

Schemas 56

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Newforma Issue API

Metadata

Authentication & Security 1

Paths & Operations 24

Schemas 56

Specification

Source

More from Newforma 3

API Details

Provider

Explore more