Versions Compared

Key

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

Topic Service

...

Topic Service

...

Issues are problems or remarks which can be assigned to any project. Comments or attachments can be added to the issue. Please see the detailed structure of the issue in the Object Model

...

Anchor

...

createIssue

...

createIssue
Create

...

issue
Deck of Cards
idbimGetIssueDetailsbimCreateIssue


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues projects/<issue<project_id> id>issues

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issuesprojects/<issue<project_id>/issues

Examplehttps://api-stage.bimplus.net/v2/bimplus/issuesprojects/8ead8bfe0d2ce2cc-ab233588-434045d6-ac47a59a-38181e83bff3

Card
labelHTTP Method
 GET
Card
labelDescription
 Get details of an issue present in a project.
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
{
    "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place",
    "author": "Mr. Smart",
    "status": "open",
    "createdAt": "2013-06-02T10:05:00+00:00",
    "dueDate": "2013-06-05T10:05:00+00:00",
    "solution": null,
    "classification": "",
    "priority": "very high",
    "revision": null,
    "id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
}

...

Get all the issue types (Not implemented)

f6b89ebed34e/issues

JSON Structure

Name

Mandatory / Optional

Type

Description

shortIdwill be ignorednumberReadable unique issue number (always starts with 1 for each project)

projectId

will be ignored

string (guid)

Id of the project

name

optional

string

Name of the issue

description

optional

string

Description of the issue

author

optional

object

Author of the issue

responsibleoptionalobjectResponsible person for the issue
responsiblesoptionalobjectList of responsible people for the issue, they have to be members of project

status

optional

string

Status of the issue. Should have one of the values: Open, Solved or Closed. Default value is Open.

createdAt

will be ignored

string (date)

Creation date of the issue

dueDate

optional

string (date)

The date in which the issue is planned to be finished

typeoptionalstringType of the issues. Possible values : Problem, Remark, Task, Appointment, Document, Contact, Clash. Default values is Problem.

solution

optional

string

The proposed solution for the issue

classification

optional

string

The classification to which the issues belongs

priority

optional

string

The priority of the issue. Should have one of the values: Low, Medium or High

tagoptionalstringcustom classification
modifiedAtoptionalstringModified date of the issue
sceneoptionalFixed templateScene/View of this topic. The pre-defined template is present here
ccoptionalarray of stringList of emails, of users that will be additionally informed about changes in the issue.
viewersoptionalobjectList of viewer people for the issue, they have to be members of project
clashIdoptionalstring ( guid )Id of the clash ( only if issue type = Clash )
attachmentsCountwill be ignoredintCount of attachments attached to the issue
pinsCountwill be ignoredintCount of pins of the issue
commentsCountwill be ignoredintCount of comments to the issue
hyperlinksCountwill be ignoredintCount of hyperlinks attached to the issue
publishedoptional falsestring (bool)Set issue as draft or published. When published is not defined is default set how published (published = true).
Deck of Cards
idbimGetIssueTypest
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/types 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/types

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/types



Card
labelHTTP Method
 GET POST


Card
labelDescription
 Get all the available issue types.
 Creates a new issue in a project. While creating an issue in a project, a view of an object can be created & included as a property in the topic similar to the Slideshow. This is similar to creating slides & the template for creating slides is present here


Response
Cardcard
labelRequest


Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
label


Code Block
borderColorGreenRed
titlelangStatusxml
langtitlexml
Status: 200 OK

...

Get details of the issue type (Not implemented)
Deck of Cards
idbimGetIssueTypeDetails
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/types/<type_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/types/<type_id>

Card
labelHTTP Method
 GET
Card
labelDescription
 Get details of a specified issue type.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
JSON
{
    "name" : "Wall info wrong",
    "description" : "This wall is wrong",
    "responsible" : {
        "id" : "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82"
    },
	"responsibles" : [
		{"id" : "07C38B65-423F-41C1-99E7-07B09C22C297"},
		{"id" : "72EBC3C7-2492-4068-9A05-7A4D27555415"}
	],
    "status" : "Open",
    "type" : "Problem",
    "solution" : "MySolution",
    "priority" : "High",
	"published": true,
    "tag" : "Wall problems",
    "classification" : "Problems",
    "cc" : [
        "testuser@bimplus.net"
    ],
	"viewers" : [
		{"id" : "29C9EC49-773F-4B80-9180-C634BCA1428C"},
		{"id" : "2E256E70-3576-4CA6-860B-CCA813A08711"}
	]
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
{
  "name": "Wall info wrong",
  "author": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "testuser1@allplan.com",
    "firstname": "Test",
    "lastname": "User1",
    "company": "Allplan Bratislava

...

Create a new pin for the issue
Deck of Cards
idbimCreatePin
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/pins 

URLhttps://api-stage.bimplus.net/v2//issues//pins

Examplehttps://api-stage.bimplus.net/v2//issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins

JSON Structure

Name

Mandatory / Optional

Type

Description

issueId

will be ignored

string (guid)

The id of the issue to which the pin is related

objectId

mandatory

string (guid)

The id of the object to which the pin is related

topologyNodeId

will be ignored

string (guid)

The id of the topology to which the pin is attached

position

optional

object

The position of the issue in the building (x,y,z co-ordinates)

normalVector

optional

object

The direction of the issue in the 3D space (x,y,z co-ordinates)

createdAt

will be ignored

date

Creation date of the pin

Card
labelHTTP Method
 POST
Card
labelDescription
 Create a new pin for an issue for relating the issue with its object.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "positionfullname": {"Test User1"
  },
  "responsible": {
    "xid": "123.450132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
        "yemail": "234testuser1@allplan.56com",
        "zfirstname": "345.67"
    }Test",
    "normalVectorlastname": {
    "User2",
    "xcompany": "0Allplan Bratislava",
    "fullname": "Test User2"
  },
	"yresponsibles" : "1",[
   {
      "zid": "2"
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
"07C38B65-423F-41C1-99E7-07B09C22C297",
      "issueIdemail": "8ead8bfe-ab23-4340-ac47-38181e83bff3"testuser3@allplan.com",
      "objectIdfirstname": "7cf910cb-e357-43f6-aa3a-b45c26380f75"Test",
      "topologyNodeIdlastname": "387fa6cc-b6f9-4470-8c42-c07982aba660"User3",
      "positioncompany":"Allplan {Bratislava",
        "xfullname":"Test "123.45"User3"
   },
   {
      "yid": "234.56"72EBC3C7-2492-4068-9A05-7A4D27555415",
        "zemail": "345testuser4@allplan.67com",
    },
    "normalVectorfirstname": {
 "Test",
       "xlastname": "0User4",
        "ycompany":"Allplan Bratislava"1",,
        "zfullname":"Test "2User4"
    }
],
  "scene": null,
  "createdAtattachmentsCount": 0,
  "pinsCount"2013-06-07T10:07:00+00:00",
    "id: 0,
  "commentsCount": 0,
  "hyperlinksCount": 0,
  "shortId": 4,
  "projectId": "8836308dde87fc4d-f09fcb5d-4bb744ba-b6d2b2ea-354a2db205a61d96ac564a8a"
}

...

Get all the pins of the issue
Deck of Cards
idbimGetAllPins
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/pins 

URLhttps://api-stage.bimplus.net/v2//issues//pins

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins

Card
labelHTTP Method
 GET
Card
labelDescription
 Get all the pins of a specified issue type.
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
[
    {
        "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
        "position": {
            "x": 123.45,
            "y": 234.56,
            "z": 345.67
        },
        "normalVector": {
            "x": 0,
            "y": 1,
            "z": 2
        },
        "createdAt": "2013-06-07T10:07:00",
        "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
    }
]

...

Delete all the pins from the issue
,
  "description": "This wall is wrong",
  "status": "Open",
  "createdAt": "2016-02-15T08:12:49.9831726+01:00",
  "modifiedAt": "2016-02-15T08:12:49.9831726+01:00",
  "dueDate": null,
  "solution": "MySolution",
  "type": "Problem",
  "classification": "Problems",
  "priority": "High",
  "published": true,
  "cc": [
    "abc@bimplus.net"
  ],
  "viewers" : [
   {
      "id":"07C38B65-423F-41C1-99E7-07B09C22C297",
      "email":"testuser3@allplan.com",
      "firstname":"Test",
      "lastname":"User3",
      "company":"Allplan Bratislava",
      "fullname":"Test User3"
   },
   {
      "id":"72EBC3C7-2492-4068-9A05-7A4D27555415",
      "email":"testuser4@allplan.com",
      "firstname":"Test",
      "lastname":"User4",
      "company":"Allplan Bratislava",
      "fullname":"Test User4"
   }
],
  "id": "01b5768a-bd19-4049-b72e-b44485514ef8"
}



Anchor
getIssueDetails
getIssueDetails

Get details of the issue
Deck of Cards
idbimGetIssueDetails
Deck of Cards
idbimDeleteAllPins


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/pins id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/pins

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins


Card
labelHTTP Method
 DELETE GET


Card
labelDescription
 Delete all the pins from a specified issue Get details of an issue present in a project.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatuslangxml
Status: 200 OK

...


Code Block

...

borderColor

...

Create a new comment for the issue

Please note that you can also use the Bimplus Object Service for working with the comments belonging to an issue

Red
langxml
titleJSON
{
  "name": "Wall info wrong",
  "author": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "testuser1@allplan.com",
    "firstname": "Test",
    "lastname": "User1",
    "company": "Allplan Bratislava",
    "fullname": "Test User1"
  },
  "responsible": {
    "id": "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
    "email": "testuser1@allplan.com",
    "firstname": "Test",
    "lastname": "User2",
    "company": "Allplan Bratislava",
    "fullname": "Test User2"
  },
	"responsibles" : [
   {
Deck of Cards
idbimCreateCommentForIssue
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/comments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments

Examplehttps://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

JSON Structure:

Name

Mandatory / Optional

Type

Description

issueIdwill be ignoredstring(guid)The id of the issue

text

mandatory

string

The comment text

createdAt

will be ignored

string (date)

Creation date of the comment

modifiedAtwill be ignoredstring (date)Modified date of the comment

author

will be ignored

object

The author of the comment

Card
labelHTTP Method
 POST
Card
labelDescription
Create a new comment for a specified issue.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
        "id": "0000000007C38B65-0000423F-000041C1-000099E7-00000000000007B09C22C297",
        "email": "testuser3@allplan.com",
        "firstname": "UnknownTest",
        "lastname": "UserUser3",
        "company":"Allplan "Bratislava",
        "fullname":"Test User3"Unknown User"
   },
   {
      "displaynameid": "Unknown User"72EBC3C7-2492-4068-9A05-7A4D27555415",
        "infoemail": "testuser4@allplan.com",
        "genderfirstname": "Test",
        "phoneWorklastname": "User4",
        "phoneHomecompany":"Allplan Bratislava"",
        "faxfullname":"Test "User4",
   }
],
  "scene": null,
  "mobileattachmentsCount": ""0,
     "pinsCount": 0,
   "birthDatecommentsCount": "0000-00-00"0,
        "addresshyperlinksCount": {0,
          "shortId": 4,
  "streetprojectId": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a",
            "streetNrdescription": "This wall is wrong",
            "zipstatus": "Open",
            "citycreatedAt": "2016-02-15T08:12:49.9831726+01:00",
            "countrymodifiedAt": "2016-02-15T08:12:49.9831726+01:00",
  "dueDate": null,
     }"solution": "MySolution",
  "type": "Problem",
  "classification": "Problems",
  "preferedLanguagepriority": null"High",
    }"published": true,
    "idcc": [
   "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

...

Get all the comments of the issue
Deck of Cards
idbimGetAllCommentsFromIssue
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/comments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments

Examplehttps://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Card
labelHTTP Method
 GET
Card
labelDescription
 Get all the comments of a specified issue.
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
[
    {
        "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",
        "modifiedAt": "2013-07-03T13:26:18+00:00",
        "author": {
       "abc@bimplus.net"
  ],
	"viewers" : [
   {
      "id":"07C38B65-423F-41C1-99E7-07B09C22C297",
      "email":"testuser3@allplan.com",
      "firstname":"Test",
      "lastname":"User3",
      "company":"Allplan Bratislava",
      "fullname":"Test User3"
   },
   {
      "id":"72EBC3C7-2492-4068-9A05-7A4D27555415",
      "email":"testuser4@allplan.com",
      "firstname":"Test",
      "lastname":"User4",
      "company":"Allplan Bratislava",
      "fullname":"Test User4"
   }
],
  "id": "0000000001b5768a-0000bd19-00004049-0000b72e-000000000000b44485514ef8",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
        "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
    }
]

...


}



Anchor
getIssueTypes
getIssueTypes

Get all the issue types (Not implemented)
Deck of Cards
idbimGetIssueTypest


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/types 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/types

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/types


Card
labelHTTP Method
 GET


Card
labelDescription
 Get all the available issue types.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



Anchor
getIssueTypeDetails
getIssueTypeDetails

Get details of the issue type (Not implemented)
Deck of Cards
idbimGetIssueTypeDetails


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/types/<type_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/types/<type_id>


Card
labelHTTP Method
 GET


Card
labelDescription
 Get details of a specified issue type.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



Anchor
createPin
createPin

Create a new pin for the issue
Deck of Cards
idbimCreatePin


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/pins 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/pins

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins

JSON Structure

Name

Mandatory / Optional

Type

Description

issueId

will be ignored

string (guid)

The id of the issue to which the pin is related

objectId

mandatory

string (guid)

The id of the object to which the pin is related

topologyNodeId

will be ignored

string (guid)

The id of the topology to which the pin is attached

position

optional

object

The position of the issue in the building (x,y,z co-ordinates)

normalVector

optional

object

The direction of the issue in the 3D space (x,y,z co-ordinates)

createdAt

will be ignored

date

Creation date of the pin



Card
labelHTTP Method
 POST


Card
labelDescription
 Create a new pin for an issue for relating the issue with its object

...

Delete all the comments from the issue
Deck of Cards
idbimDeleteCommentFromIssue
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/comments

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments

Examplehttps://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Delete all the comments from the issue.


Response
Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
label


Code Block
borderColorGreenRed
titlelangStatusxml
langtitlexml
Status: 200 OK

...

Create a new attachment for the issue

Please note that you can also use the Bimplus Object Service for working with the attachments belonging to an issue

JSON
{
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "position": {
        "x": "123.45",
        "y": "234.56",
        "z": "345.67"
    },
    "normalVector": {
        "x": "0",
        "y": "1",
        "z": "2"
    }
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
{
    "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
    "position": {
Deck of Cards
idbimCreateAttachmentForIssue
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/attachments 

URLhttps://api-stage.bimplus.net/v2//issues//attachments

Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name

Mandatory / Optional

Type

Description

objectIds

will be ignored

string

The id of the project objects to which the file has to be attached

fileName

will be ignored

string

Name of the file to be attached to the project

type

will be ignored

string

Mime type

size

will be ignored

integer

Size of the file to be attached to the project

createdAtwill be ignoredstringCreation date of the attachment
creatorwill be ignoredobjectThe user who created the attachment
Card
labelHTTP Method
 POST
Card
labelDescription
 Creates a new attachment for a specified issue.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
"x": "123.45",
         ]"y": "234.56",
        "fileNamez": "Building_Plan345.jpg67",
    },
    "typenormalVector": "image/jpeg",{
        "sizex": 211258"0",
        "createdAty": "2013-12-11T10:47:391",
        "creatorz": {"2"
    },
    "idcreatedAt": "e18941f42013-a809-2d01-d27d-cd251f2b6cb606-07T10:07:00+00:00",
        "email"id": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}



Anchor
getPins
getPins

Get all the pins of the issue
Deck of Cards
idbimGetAllPins


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/pins 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/pins

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins


Card
labelHTTP Method
 GET


Card
labelDescription
 Get all the pins of a specified issue type.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
[
    {
        "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "phoneHometopologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
        "position": {
            "faxx": ""123.45,
              "mobiley": ""234.56,
              "birthDatez": "0000-00-00",
        "address345.67
        },
        "normalVector": {
                   "streetx": "Westermeier str."0,
                   "streetNry": "10"1,
                   "zipz": "81829",2
        },
            "citycreatedAt": "München2013-06-07T10:07:00",
              "country    "id": "Germany8836308d-f09f-4bb7-b6d2-354a2db205a6"
           },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }
]



Anchor
getAttachmentsFromIssuedeletePinsgetAttachmentsFromIssue
deletePins

...

Delete all the

...

pins from the issue
Deck of Cards
idbimGetAttachmentListFromIssuebimDeleteAllPins


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/attachments pins 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/attachmentspins

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachmentspins


Card
labelHTTP Method
 GET DELETE


Card
labelDescription
 Gets  Delete all the attachment list pins from a specified issue.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreentitleStatus
langxml
titleStatus
Status: 200 OK



Anchor
createComment
createComment

Create a new comment for the issue

Please note that you can also use the Bimplus Object Service for working with the comments belonging to an issue

Deck of Cards
idbimCreateCommentForIssue


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/comments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments

Examplehttps://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

JSON Structure:

Name

Mandatory / Optional

Type

Description

issueIdwill be ignoredstring(guid)The id of the issue

text

mandatory

string

The comment text

createdAt

will be ignored

string (date)

Creation date of the comment

modifiedAtwill be ignoredstring (date)Modified date of the comment

author

will be ignored

object

The author of the comment



Card
labelHTTP Method
 POST


Card
labelDescription
Create a new comment for a specified issue.


Card
labelRequest


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


Code Block
borderColorRed
langxml
titleJSON
{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
Code Block
borderColorRed
titleJSON
langxml
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displaynameid": "Best-Company00000000-0000-0000-0000-000000000000",
        "infoemail": "",
        "genderfirstname": "Unknown",
        "phoneWorklastname": "User",
        "phoneHomecompany": "",
        "faxfullname": "Unknown User",
        "mobiledisplayname": "Unknown User",
        "birthDateinfo": "0000-00-00",
        "addressgender": {
    "",
        "streetphoneWork": "Westermeier str.",
        "phoneHome": "",
        "streetNrfax": "10",
        "mobile": "",
        "zipbirthDate": "81829",0000-00-00",
        "address": {
            "citystreet": "München",
            "countrystreetNr": "Germany",
            } "zip": "",
            "preferedLanguagecity": "en",
       },
        "idcountry": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

...

"
        },
        "preferedLanguage": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}



Anchor
getComments
getComments

Get all the comments of

...

the issue
Deck of Cards
idbimDeleteAttachmentFromIssuebimGetAllCommentsFromIssue


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/attachments comments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/attachmentscomments

Example: https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfecb96a9b1-ab2348c9-43404d97-ac478c9e-38181e83bff3262476c1c6b2/attachmentscomments


Card
labelHTTP Method
 DELETE GET


Card
labelDescription
Delete  Get all the attachments from comments of a specified issue.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatuslangxml
Status: 200 OK

...


Code Block

...

borderColor

...

Working with hyperlinks belonging to an issue

Please use the  Bimplus Object Service for working with hyperlinks belonging to an issue

 

...

Red
langxml
titleJSON
[
    {
        "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",
        "modifiedAt": "2013-07-03T13:26:18+00:00",
        "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
        "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
    }
]



Anchor
createAttachmentForIssue
createAttachmentForIssue

Create a new attachment for the issue

Please note that you can also use the Bimplus Object Service for working with the attachments belonging to an issue

Deck of Cards
idbimCreateAttachmentForIssue


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/issues/<issue_id>/attachments

Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments


Card
labelHTTP Method
 POST


Card
labelDescription
 Creates a new attachment for a specified issue.


Card
labelRequest

Bimplus supports creating and updating of attachments only using requests with multipart/form-data content type. By standard, multipart/form-data content consists of several parts, each part containing a file data.

But Bimplus supports only one file sent per call, so only first part of multipart form data content is used, the rest are ignored. The parts are separated by boundaries, each part contains content headers and content data.

Examples :

Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW


Code Block
titleContent
------MyFormBoundarytlTJWL8i2mvYwGPW
Content-Disposition: form-data; name="TestFile"; filename="TestFile.xml"; classification="Report"; tag="ABCDE"
Content-Type: application/xml
 
**** Here are file data  ******
 
------MyFormBoundarytlTJWL8i2mvYwGPW

Where :

  • name and filename are mandatory saved as attachment's "name" and "filename" properties
  • classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
  • Content-Type is mandatory and is saved as attachment's property "type"


Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
{
 
     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "size": 211258,
     "createdAt": "2013-12-11T10:47:39",
     "creator": {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
         "firstname": "First Name",
         "lastname": "Second Name",
         "company": "Best-Company",
         "fullname": "First Name Second Name",
         "displayname": "Best-Company",
     },
     "changed" : "2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     },
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
  }



Anchor
getAttachmentsFromIssue
getAttachmentsFromIssue

Get the attachment list from the issue
Deck of Cards
idbimGetAttachmentListFromIssue


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/attachments

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments


Card
labelHTTP Method
 GET


Card
labelDescription
 Gets the attachment list from a specified issue.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
[
   {
 
     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "size": 211258,
     "createdAt": "2013-12-11T10:47:39",
     "creator": {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
         "firstname": "First Name",
         "lastname": "Second Name",
         "company": "Best-Company",
         "fullname": "First Name Second Name",
         "displayname": "Best-Company",
     },
     "changed" : "2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     },
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
  },
  ...
]



Anchor
deleteAttachmentsFromIssue
deleteAttachmentsFromIssue

Delete all the attachments from the issue
Deck of Cards
idbimDeleteAttachmentFromIssue


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/issues/<issue_id>/attachments

Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments


Card
labelHTTP Method
 DELETE


Card
labelDescription
Delete all the attachments from a specified issue.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



Anchor
issueHyperlink
issueHyperlink

Working with hyperlinks belonging to an issue

Please use the  Bimplus Object Service for working with hyperlinks belonging to an issue


Anchor
updateIssue
updateIssue

Update the issue
Deck of Cards
idbimUpdateIssue


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3

JSON Structure: see Create issue

Optional query parameters

NameTypeDefault valueDescription
withoutscenestring (boolean)falseif true return response body without scene



Card
labelHTTP Method
 PUT


Card
labelDescription
 Update or replace a specified existing issue with a new one.


Card
labelRequest


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


Code Block
borderColorRed
langxml
titleJSON
{
    "name" : "Wall info wrong",
    "description" : "This wall is wrong",
    "responsible" : {
        "id" : "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82"
    },
    "status" : "Open",
    "type" : "Problem",
    "solution" : "MySolution",
    "priority" : "High",
	"published": true,
    "tag" : "Wall problems",
    "classification" : "Problems",
    "cc" : [
        "testuser@bimplus.net"
    ]
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
titleJSON
{
  "name": "Wall info wrong",
  "author": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "testuser1@allplan.com",
    "firstname": "Test",
    "lastname": "User1",
    "company": "Allplan Bratislava",
    "fullname": "Test User1"
  },
  "responsible": {
    "id": "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
    "email": "testuser1@allplan.com",
    "firstname": "Test",
    "lastname": "User2",
    "company": "Allplan Bratislava",
    "fullname": "Test User2"
  },
  "scene": null,
  "attachmentsCount": 0,
  "pinsCount": 0,
  "commentsCount": 0,
  "hyperlinksCount": 0,
  "shortId": 4,
  "projectId": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a",
  "description": "This wall is wrong",
  "status": "Open",
  "createdAt": "2016-02-15T08:12:49.9831726+01:00",
  "modifiedAt": "2016-02-15T08:12:49.9831726+01:00",
  "dueDate": null,
  "solution": "MySolution",
  "type": "Problem",
  "classification": "Problems",
  "priority": "High",
  "published": true,
  "cc": [
    "abc@bimplus.net"
  ],
  "id": "01b5768a-bd19-4049-b72e-b44485514ef8"
}



Anchor
deleteIssue
deleteIssue

Delete the issue
Deck of Cards
idbimDeleteIssue


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id or selection_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id or selection_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3


Card
labelHTTP Method
 DELETE


Card
labelDescription
 Deletes a specified issue or the issues belonging to the selection object (type of 'Elements').


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



Anchor
IssueRights
IssueRights

Get rights for issue
Deck of Cards
idbimGetIssueRights


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id>/rights

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/rights

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/rights


Card
labelHTTP Method
GET


Card
labelDescription

This API that returns list of allowed actions and editable properties the user might use for the given issue.
Returns two lists :

  • "editableProperties"
    • list of issue properties the user is allowed to change ( the rest will be readonly )
    • it can also return list of allowed enum values for a property - in the optional property variable "enumValue"
    • name of the properties are identical with the property names of an issue json
  • "actions"
    • list of actions the user is allowed to execute for the issue
    • the action names are identical with the actions returned in api call for project action rights

Clients can use this call to automatically handle user access to an issue, e.g. disabling/enabling buttons or edit/combo boxes. So once something will change on the Bimplus server, it will be automatically reflected on the client side, without need for code change.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
titleJSON
{
  "editableProperties": [
    {
      "name": "name"
    },
    {
      "name": "description"
    },
    {
      "name": "priority",
      "enumValues": [
        "Low",
        "Medium",
        "High"
      ]
    },
    {
      "name": "responsible"
    },
    {
      "name": "cc"
    },
    {
      "name": "dueDate"
    },
    {
      "name": "type",
      "enumValues": [
        "Problem",
        "Remark",
        "Task",
        "Appointment",
        "Document",
        "Contact",
        "Clash"
      ]
    },
    {
      "name": "solution"
    },
    {
      "name": "scene"
    },
    {
      "name": "status",
      "enumValues": [
        "Open",
        "Solved",
        "Closed"
      ]
    }
  ],
  "actions": [
    "GET_COMMENT",
    "GET_COMMENTS",
    "CREATE_COMMENT",
    "GET_ATTACHMENT",
    "GET_ATTACHMENTS",
    "DOWNLOAD_ATTACHMENT",
    "GET_HYPERLINK",
    "GET_HYPERLINKS",
    "GET_PIN",
    "GET_PINS",
    "CREATE_ATTACHMENT",
    "UPDATE_ATTACHMENT",
    "DELETE_ATTACHMENT",
    "CREATE_HYPERLINK",
    "UPDATE_HYPERLINK",
    "DELETE_HYPERLINK",
    "CREATE_PIN",
    "UPDATE_PIN",
    "DELETE_PIN",
    "DELETE_ISSUE",
   ...
  ]
}

...

Update the issue
Deck of Cards
idbimUpdateIssue
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3

JSON Structure

Name

Mandatory / Optional

Type

Description

shortIdwill be ignorednumberReadable unique issue number(always starts with 1 for each project)

projectId

will be ignored

string (guid)

Id of the project

name

optional

string

Name of the issue

description

optional

string

Description of the issue

author

optional

object

Author of the issue

responsibleoptionalobjectResponsible person for the issue

status

optional

string

Status of the issue. Should have one of the values: Open, Solved or Closed

createdAt

will be ignored

string (date)

Creation date of the issue

dueDate

optional

string (date)

The date in which the issue is planned to be finished

solution

optional

string

The proposed solution for the issue

classification

optional

string

The classification to which the issues belongs

priority

optional

string

The priority of the issue. Should have one of the values: Low, Medium or High

Card
labelHTTP Method
 PUT
Card
labelDescription
 Update or replace a specified existing issue with a new one.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place(x:120, y: 120; z: 340)",
    "author": "Mr. Smart",
    "status": "open"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

...

Delete the issue
Deck of Cards
idbimDeleteIssue
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/<issue_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Deletes a specified issue.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK