Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Create a new revision or update/overwrite a model
  • Get the list of revisions of a model
  • Get the info about a revision
  • Update a revision
  • List of APIs for retrieving info from a particular resource (3D objects, attachments etc)

 

Anchor
projectServicerevisionServiceprojectService
revisionService

...

Revision Service

...

A Project is basically a holder which contains building models.

Anchor
createProjectcreateRevisioncreateProject
createRevision

Create a new project
Deck of Cards
idbimCreateProjectbimCreateRevision
Card
labelURL / Resource / JSON Structure
Resource: projects revisions

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projectsdivisions

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/divisions/00b54edd-c84c-4bd2-a08c-c93d1f28907a/revisions

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the project

shortDescrdescription

optional

string

Short description of the project

createdprojectId

will be ignored

string (date)

Creation date of the project

divisionIdwill be ignored  
revisionNrwill be ignored  
createdwill be ignored  
createdBywill be ignored  
applicationIdwill be ignored  
inputTypeoptional  
Card
labelHTTP Method
 POST
Card
defaulttrue
labelDescription
 Creates a new project.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
"name" : "Your Awesome Building",
"shortDescr" : "Example for creating a project"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...