Page History

...

Deck of Cards

id	bimCreateIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues

Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues

JSON Structure:

Name	Mandatory / Optional	Type	Description
shortId	will be ignored	number	Readable 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
responsible	optional	object	Responsible person for the issue
responsibles	optional	object	List 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
type	optional	string	Type 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
tag	optional	string	custom classification
modifiedAt	optional	string	Modified date of the issue
scene	optional	Fixed template	Scene/View of this topic. The pre-defined template is present here
cc	optional	array of string	List of emails, of users that will be additionally informed about changes in the issue.
viewers	optional	object	List of viewer people for the issue, they have to be members of project
clashId	optional	string ( guid )	Id of the clash ( only if issue type = Clash )
attachmentsCount	will be ignored	int	Count of attachments attached to the issue
pinsCount	will be ignored	int	Count of pins of the issue
commentsCount	will be ignored	int	Count of comments to the issue
hyperlinksCount	will be ignored	int	Count of hyperlinks attached to the issue
published	optional false	string (bool)	Set issue as draft or published. When published is not defined is default set how published (published = true).

Card

label	HTTP Method

POST

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	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

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "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" : [
   {
      "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"
   }
],
  "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"
  ],
  "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"
}

...

Deck of Cards

id	bimCreatePin

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

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

Example: https://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

label	HTTP Method

POST

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	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

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "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+00:00",
    "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}

...

Deck of Cards

id	bimCreateCommentForIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string(guid)	The id of the issue
text	mandatory	string	The comment text
createdAt	will be ignored	string (date)	Creation date of the comment
modifiedAt	will be ignored	string (date)	Modified date of the comment
author	will be ignored	object	The author of the comment

Card

label	HTTP Method

POST

Card

label	Description

Create a new comment for a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "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": "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"
}

...

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

Anchor

	updateIssue
	updateIssue

...

Deck of Cards

id	bimUpdateIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

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

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

JSON Structure: see Create issue

Optional query parameters

Name	Type	Default value	Description
withoutscene	string (boolean)	false	if true return response body without scene

Card

label	HTTP Method

PUT

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "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

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "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"
}

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 23

New Version Current

Key