When "filter={{filterId}}" is defined the API will return only valid object's which meet a conditions of defined filter.
Card
label
HTTP Method
POST
Card
label
Description
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.
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
borderColor
Red
lang
xml
title
JSON
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.
When "filter={{filterId}}" is defined the API will return only valid object's which meet a conditions of defined filter.
attributes
String
null
When "attributes={{attrubuteid1}},{{,attributeId2}}" is defined the API will return only object’s, ktorym sa zmenili len zagane atribbuty
XXXXXXXXXXXXXXXXXXXXXX
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.
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", will contain array of comparison objects with following properties:
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.