Page History

...

Deck of Cards

id	bimModelRevisionsComparision

Card

default	true
label	URL / 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

Card

label	HTTP Method

GET

Card

label	Description

This api returns already calculated comparison of revisions of the model. In returned json is very important property "IsUpToDate" which provide information if revision comparison is actual or not.
In response are most important four sets of objects - inserted, deleted, changedGeometry, changed.
The unaffected & hidden objects are not returned in the response.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "divisionId": "958ee96f-12c6-4684-928c-7119ad7090ab",
  "firstRevision": 3,
  "secondRevision": 2,
  "status": "DONE",
  "isUpToDate": true,
  "calculatedAt": "2016-10-19T09:05:39.8138934",
  "calculatedBy": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "user@allplan.com"
  },
  "inserted": [ ... ],
  "deleted": [ ... ],
  "changedGeometry": [ ... ],
  "changed": [ ... ]
}
 
NOTE :  Properties "inserted", "deleted", "changedGeometry" and "changed", all returns array of objects, e.g. :
 
{                                                             
 "comparisonObjectId": "870c9ced-63fb-4fdf-beaf-ebd19507c072",
 "first": { 																									
 "id": "3a2d82dc-325c-4369-a083-02e3535d850d", 								
 "type": "Beam", 																							
 "name": "Beam_1-01" 																					
 },                                                           
 "second": { 																									
 "id": "3a2d82dc-325c-4369-a083-02e3535d850d",                
 "type": "Beam",                                              
 "name": "Beam_1-01"                                          
 }

JSON Structure:

Name	Type	Description
divisionId	string(guid)	The id of the model
firstRevision	int	higher revision number between whose the calculation was done
secondRevision	int	lower revision number between whose the calculation was done
status	string	Can be "DONE" => ok, or "PENDING" => calculation was not yet completed
isUpToDate	bool	Should be be true. False means that the model was changed after the revision comparison was calculated, so the revision comparison is not actual, and it will be better to recalculate again with POST (see api call above)
calculatedAt	string (date)	The date and time of the calculation
calculatedBy	string (user)	The user which performed the calculation
inserted	objects	Objects that exists only in in first (higher) revision but not in the second
deleted	objects	Objets that exist only in the second (lower) revision, but are already deleted in the first (higher) revision
changedGeometry	objects	Objects that exists in both revisions, but with different geometry
changed	objects	Objects that exist in both revisions, have identical geometry, but some other properties are changed, (objects identical in both revisions are not present in this response)
NOTE : Properties "inserted", "deleted", "changedGeometry" and "changed", all returns array of objects, e.g. : { "comparisonObjectId": "870c9ced-63fb-4fdf-beaf-ebd19507c072", "first": { "id": "3a2d82dc-325c-4369-a083-02e3535d850d", "type": "Beam", "name": "Beam_1-01" }, "second": { "id": "3a2d82dc-325c-4369-a083-02e3535d850d", "type": "Beam", "name": "Beam_1-01" } }
comparisonObjectId	string(guid)	id of the comparison object
first	object	Object from revision with higher revision number. This object is not present in the "deleted" list. Object has following properties: id of the compared element ("id") element type name ("type") element name ("name")
second	object	Object from revision with lower revision number. This object is not present in the "inserted" list. Object has following properties: element type name ("type") element name ("name")

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 17

New Version 18

Key