External Domain API Resource

Web Service for external domains

GET /api/domain/json

Get list of data sources with handled classes.

Response Body
media type data type description
application/json object (JSON) JSON Response with the specified object properties. Properties are in format {propertyName:propertyValue}.

Example of response:

{"list":[{"domainId":"284110","domainName":"IFC","classes":[{"classId":"12","className":"h1_struct","hasContent":false,"isExternalContent":false}]},{"domainId":"342572","domainName":"BimEye","classes":[{"classId":"14","className":"h1_space","hasContent":false,"isExternalContent":false}]}]}

Example

Request
GET /api/domain/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/domain/eid2hdid/json/{domain}

Web service to obtain a list of HDC objectIds and ClassIds for externalIds(Guids) and Classname/classid from external domain

Example of request:

{"objects":[{"externalClassName":"Rooms","externalId":"e2dceb38-8074-4350-800d-dee689ad734e"}, {"externalClassId":"195","externalId":"e2dceb38-8074-4350-800d-dee689ad734e"}]}

Request Parameters
name type description
domain path - id or name of external domain, we assume domain name doesn't consist of digits only
Request Body
media type data type
application/json HdcIdMappingsListWithDomainTO (JSON)
Response Body
media type data type description
application/json HdcIdMappingsListWithDomainTO (JSON) JSON Response with HDC objectIds and ClassIds and info whether conversion was success {"objects":[{"objectId":"53200","classId":"108","externalId":"000480000900037", "externalClassName":"HDV_H1_SPACE","externalClassId":"530","success":true}, {"externalId":"000480000900037","externalClassId":"195","success":false}] }

Example

Request
POST /api/domain/eid2hdid/json/{domain}
Content-Type: application/json
Accept: application/json

                
{
  "objects" : [ {
    "externalId" : "...",
    "classId" : 12345,
    "success" : true,
    "externalClassName" : "...",
    "externalClassId" : 12345,
    "objectId" : 12345,
    "systemGuid" : "...",
    "conditionValue" : "...",
    "tobisFieldName" : "...",
    "conditionField" : "..."
  }, {
    "externalId" : "...",
    "classId" : 12345,
    "success" : true,
    "externalClassName" : "...",
    "externalClassId" : 12345,
    "objectId" : 12345,
    "systemGuid" : "...",
    "conditionValue" : "...",
    "tobisFieldName" : "...",
    "conditionField" : "..."
  } ],
  "domainId" : 12345,
  "domainName" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "objects" : [ {
    "externalId" : "...",
    "classId" : 12345,
    "success" : true,
    "externalClassName" : "...",
    "externalClassId" : 12345,
    "objectId" : 12345,
    "systemGuid" : "...",
    "conditionValue" : "...",
    "tobisFieldName" : "...",
    "conditionField" : "..."
  }, {
    "externalId" : "...",
    "classId" : 12345,
    "success" : true,
    "externalClassName" : "...",
    "externalClassId" : 12345,
    "objectId" : 12345,
    "systemGuid" : "...",
    "conditionValue" : "...",
    "tobisFieldName" : "...",
    "conditionField" : "..."
  } ],
  "domainId" : 12345,
  "domainName" : "..."
}

POST /api/domain/hdid2eid/json/{domainId}

Web service to obtain ids, TOBIS fields and classnames from external domain for HDC objectIds and ClassIds

Example of request:

{"objects":[{"objectId":"22424","classId":"104"}]}

Request Parameters
name type description constraints
domainId path - id of external domain long
Request Body
media type data type
application/json HdcObjectListWithDomainTO (JSON)
Response Body
media type data type description
application/json HdcIdMappingsListWithDomainTO (JSON) JSON Response with information external ids {"objects":[{"objectId":"22424","classId":"104","externalId":"010114105", "tobisFieldname":"fi2prop_id","externalClassname":"HDV_H1_PROP"}]}

Example

Request
POST /api/domain/hdid2eid/json/{domainId}
Content-Type: application/json
Accept: application/json

                
{
  "domainName" : "...",
  "config" : {
    "exportAttachments" : true,
    "exportDocuments" : true,
    "description" : "...",
    "secondaryPerspectiveId" : 12345,
    "primaryPerspectiveId" : 12345,
    "exportFormat" : "FI2V131",
    "exportSubtree" : true,
    "exportGeometries" : true
  },
  "objects" : [ { }, { } ],
  "packageName" : "...",
  "domainId" : 12345
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "objects" : [ {
    "externalId" : "...",
    "classId" : 12345,
    "success" : true,
    "externalClassName" : "...",
    "externalClassId" : 12345,
    "objectId" : 12345,
    "systemGuid" : "...",
    "conditionValue" : "...",
    "tobisFieldName" : "...",
    "conditionField" : "..."
  }, {
    "externalId" : "...",
    "classId" : 12345,
    "success" : true,
    "externalClassName" : "...",
    "externalClassId" : 12345,
    "objectId" : 12345,
    "systemGuid" : "...",
    "conditionValue" : "...",
    "tobisFieldName" : "...",
    "conditionField" : "..."
  } ],
  "domainId" : 12345,
  "domainName" : "..."
}