Versions Compared

Key

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

...

Section
Column
width25%

Messaging Service


Column
width25%

Log Service


Column
width50%

BTW(Bim Team Work) related Service


 

Anchor
projectService
projectService

...

Deck of Cards
idbimGetAllLog
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: objectview 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/<objectview_name>/tablecolumns

Examplehttps://api-stage.bimplus.net/v2/bimplus/onProjectElements_Building/tablecolumns

Card
labelDescription

 Get the properties(column names) of the "Object List".

Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "name": "ObjectID",
        "ordernr": 1,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Nr",
        "ordernr": 2,
        "datatype": "int",
        "isdefault": null,
        "categorynameid": "Category.General",
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Name",
        "ordernr": 3,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Name",
        "proporder": null,
        "converter": "Converter_PPName",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Description",
        "ordernr": 4,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Description",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "DivisionID",
        "ordernr": 5,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Division",
        "ordernr": 6,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Model",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ModelType",
        "ordernr": 7,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Discipline",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ElementTyp",
        "ordernr": 8,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Type",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Weight",
        "ordernr": 9,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Mass",
        "proporder": null,
        "converter": "Converter_Mass",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Volume",
        "ordernr": 10,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Volume",
        "proporder": null,
        "converter": "Converter_Volume",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Area",
        "ordernr": 11,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Area",
        "proporder": null,
        "converter": "Converter_Area",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Length",
        "ordernr": 12,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Length",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Width",
        "ordernr": 13,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Width",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    }
]

Anchor
messageReadgetDetailsFromObjectListmessageRead

...

getDetailsFromObjectList

Get the object's details from input object list of an "Object Navigator" item
Deck of Cards
idbimMessageReadbimGetDetailsFromObjectList
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: messages/<message_id>/markasread objectview/tablecontent 

URLhttps://api-stage.bimplus.net/v2/messages/<message_id>/markasread objectview/tablecontent 

Examplehttps://api-stage.bimplus.net/v2/messages/<message_id>/markasreadobjectview/tablecontent

Card
labelDescription
 Mark a message as read. Get the object's details from input object list of an "Object Navigator" item
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "tablename": "onProjectElements_Building",
    "elementsguid": [
        "1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",
        "54978C4C-B18B-4420-819D-405234FC11B4",
        "EB0472BE-1353-4E47-BE76-875924E0586F"
    ]
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    },
    {
        "objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    },
    {
        "objectid": "eb0472be-1353-4e47-be76-875924e0586f",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    }
]

 

{

   "tablename": "onProjectElements_Building",

   "elementsguid":

    [

      "1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",

      "54978C4C-B18B-4420-819D-405234FC11B4",

      "EB0472BE-1353-4E47-BE76-875924E0586F"

    ]

}