Versions Compared

Key

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

...

Note

Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page.

...

Introduction

Class diagram represent API architecture, objects (classes) structure, services (methods) and their relations.

...

  • resulting JSON objects structure, which will be sent to client upon AJAX request with defined services
  • class methods (services), which can be used by the client with HTTP requests (see Bimplus Services for detailed description).

...

Object name means that you can use it lowercased lower cased as a path (route) to resource / collection. Fields define which properties will be transferred to client as resulting JSON string. If you provide an element id in collection, particular object in the collection will be addressed and you will get its detailed information. 

...

 is read only, has method get(), implemented as web service. This means that by a client it can be used as follows:

Code Block
https://api-stage.bimplus.net/v2/bimplus/disciplines/

...

Anchor
classDiagramFull
classDiagramFull

Class diagrams (v2, draft)

Anchor
class_diagram_full
class_diagram_full

General

Gliffy Diagram
nameobject_model
pagePin31

Anchor
class_diagram_objects
class_diagram_objects

Objects and its Attributes (v2, draft)

Gliffy Diagram
sizeL
nameObjects and its Attributes
pagePin4