Versions Compared

Old Version 31

changes.mady.by.user Noema Bradnanska

Saved on

compared with

New Version 32

changes.mady.by.user Noema Bradnanska

Saved on

Key

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

...

Deck of Cards
idbimCalculateModelRevisionsComparison


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: divisions/<division_id>/revisionscomparison/<higher_revision_number>/<lower_revision_number>

URL: https://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>/revisionscomparison/<higher_revision_number>/<lower_revision_number>

Example: https://api-stage.bimplus.net/v2/bimplus/divisions/00b54edd-c84c-4bd2-a08c-c93d1f28907a/revisionscomparison/5/2


Optional query parameters


NameTypeDefault valueDescription
filterGuidnullWhen "filter={{filterId}}" is defined the API will return only valid object's which meet a conditions of defined filter.
attributes    Stringnull

When "attributes={{attrubuteid1}},;{{,attributeId2}}" are defined the API will return only objects, for which the given attributes were changed. Only really changed attributes are touched by that, the new elements, deleted elements and also the modified geometry are returned always.

selectionobjectGuidnullWhen "selectionobject={{selectionObjectId}}" is defined the API will return only object's in selections.



Card
labelHTTP Method
 POST


Card
labelDescription

This API call will calculate comparison between two revisions of the same model to provide revisions differences. The revisions numbers does not have to be consecutive, meaning you can compare revisions e.g. 5 vs 2. But revision numbers must be in correct order, revisions number higher_revision_number must be higher then lower_revision_number. The higher revision number maybe be also the latest revision.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK - when succeeded calculation of comparison of revisions of the model

Status : 400 BadRequest - if revision numbers are incorrect, or first revision is not greater than second
Status : 400 NotFound - if any of the revisions does not exist


Code Block
borderColorRed
langxml
titleJSON
The response is similar to the GET <Url>/<TeamSlug>/divisions/<division_id>/revisionscomparison/<higher_revision_number>/<lower_revision_number>. 
For details see "Get calculated comparison of revisions of the model" below.



...