Page History

...

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

...

Deck of Cards

id	bimCreateIssue

card

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

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

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

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",
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "status": "Active",
    "description" : "This wall "firstname": "Jayarajis wrong",
        "lastnameresponsible" : "Purushothaman",{
        "companyid" : "Jay Company",0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82"
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]"},
	"responsibles" : [
		{"id" : "07C38B65-423F-41C1-99E7-07B09C22C297"},
		{"id" : "72EBC3C7-2492-4068-9A05-7A4D27555415"}
	],
    "status"   : "infoOpen": null,
        "gendertype" : "MRProblem",
    "solution"   : "phoneWorkMySolution": null,
    "priority"   : "phoneHomeHigh": null,
        "fax	"published": nulltrue,
    "tag" :   "mobile":Wall problems"",
    "classification"   : "birthDateProblems": null,
        "addresscc" : {[
        "testuser@bimplus.net"
    ],
	"streetviewers" : [
		{"id",
            "streetNr": "29C9EC49-773F-4B80-9180-C634BCA1428C"},
		{"id" : "2E256E70-3576-4CA6-860B-CCA813A08711"}
	]
}

card

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            "zip": "",
            "city": "",
    "email": "testuser1@allplan.com",
       "countryfirstname": "Test",
    "lastname": "User1",
   },
    "company": "Allplan Bratislava",
     "preferedLanguagefullname": "enTest User1"
    },
    "responsible": {
        "id": "6e67ba070132ecbe-50c32ac5-d51d4ae1-23f0945d-3ac0d8788202d38fc3bc1e82",
        "email": "jayarajtestuser1@allplan.purushothaman@bimplus.netcom",
        "statusfirstname": "ActiveTest",
        "firstnamelastname": "JayarajUser2",
        "lastnamecompany": "PurushothamanAllplan Bratislava",
        "companyfullname": "BimplusTest GmbHUser2"
  },
	"responsibles" : [
   {
      "fullnameid": "Jayaraj Purushothaman"07C38B65-423F-41C1-99E7-07B09C22C297",
        "displaynameemail": "Jayaraj Purushothaman [Bimplus GmbH]"testuser3@allplan.com",
        "infofirstname": null"Test",
        "genderlastname": "MRUser3",
        "phoneWorkcompany":"Allplan nullBratislava",
        "phoneHomefullname": null"Test User3"
   },
   {
      "faxid": null"72EBC3C7-2492-4068-9A05-7A4D27555415",
        "mobileemail": "testuser4@allplan.com",
        "birthDate": null"firstname":"Test",
        "addresslastname": {"User4",
            "street"company":"Allplan Bratislava"",
      "fullname":"Test User4"
   }
],
  "streetNrscene": ""null,
  "attachmentsCount": 0,
  "pinsCount": 0,
    "commentsCount": 0,
  "ziphyperlinksCount": ""0,
            "city"shortId": ""4,
          "projectId": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a",
  "countrydescription": ""
This wall       }is wrong",
        "preferedLanguage"status": "deOpen",
    },
  "createdAt": "2016-02-15T08:12:49.9831726+01:00",
  "scenemodifiedAt": null"2016-02-15T08:12:49.9831726+01:00",
    "attachmentsCountdueDate": 0null,
    "pinsCountsolution": 4"MySolution",
  "type": "Problem",
  "commentsCountclassification": 1"Problems",
  "priority": "High",
  "hyperlinksCountpublished": 0true,
  "cc": [
  "shortId": 1,  "abc@bimplus.net"
  ],
  "viewers" : [
   {
      "projectIdid": "5cd37c7707C38B65-d341423F-4ab241C1-9f0d99E7-44467955b21807B09C22C297",
      "descriptionemail": "test1testuser3@allplan.com",
      "statusfirstname": "OpenTest",
      "createdAtlastname": "2014-05-09T10:15:24+02:00"User3",
      "modifiedAtcompany":"Allplan "2015-07-30T07:04:27+02:00"Bratislava",
      "dueDatefullname": null"Test User3"
   },
   {
 "solution": null,
    "typeid": "Remark"72EBC3C7-2492-4068-9A05-7A4D27555415",
      "classificationemail": null"testuser4@allplan.com",
      "priorityfirstname": "MediumTest",
      "cclastname": [
  "User4",
      "ssudha84@gmail.comcompany":"Allplan Bratislava",
        "rush2jayaraj@yahoo.co.in""fullname":"Test User4"
    }
],
    "clashId": "70d07604-cf68-4d94-abc0-c783f8cc548b",
    "id": "5eac4d9201b5768a-c65bbd19-49c84049-927cb72e-9f255879a5c2b44485514ef8"
}

Anchor

...

	getIssueDetails
	getIssueDetails

Get details of the issue

Deck of Cards

id	bimGetIssueDetails

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of an issue present in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name": "Wall info wrong",
  "author": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed"

Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "shortId": 1
    "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place",
    "author" : { "id" : "92fa66c6-4114-d68e-974c-0ff78a49fda8" },
    "responsibleemail" : { "id" : "11fa66c6-4114-d68e-974c-0ff78a49fda8" },  testuser1@allplan.com",
    "statusfirstname": "openTest",
    "createdAtlastname": "2013-06-02T10:05:00+00:00User1",
    "dueDatecompany": "2013-06-05T10:05:00+00:00Allplan Bratislava",
    "fullname": "Test User1"
  },
  "responsible": {
    "id": "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
    "solutionemail": null"testuser1@allplan.com",
    "classificationfirstname": "Test",
    "prioritylastname": "very highUser2",
    "revisioncompany": null"Allplan Bratislava",
    "idfullname": "8ead8bfe-ab23-4340-ac47-38181e83bff3Test User2"
  }

...

Get details of the issue

Deck of Cards

id	bimGetIssueDetails

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of an issue present in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

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

Deck of Cards

id	bimGetIssueTypest

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types

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

Example: https://api-stage.bimplus.net/v2/bimplus/issues/types

Card

label	HTTP Method

GET

Card

label	Description

Get all the available issue types.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Get details of the issue type (Not implemented)

Deck of Cards

id	bimGetIssueTypeDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types/<type_id>

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Create a new pin for the issue

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//issues//pins

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

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,
	"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",
        "ycompany": "234.56"Allplan Bratislava",
        "zfullname":"Test User4"345.67"
    }
],
    "normalVectorid": {
        "x": "0",
        "y": "1",
        "z": "2"
    }
}
"01b5768a-bd19-4049-b72e-b44485514ef8"
}

Anchor

	getIssueTypes
	getIssueTypes

Get all the issue types (Not implemented)

Deck of Cards

id	bimGetIssueTypest

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types

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

Example: https://api-stage.bimplus.net/v2/bimplus/issues/types

Card

label	HTTP Method

GET

Card

label	Description

Get all the available issue types.

Card

label	Request

Code Block

borderColor	Green

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSONHeaders

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

...

BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	getIssueTypeDetails
	getIssueTypeDetails

Get details of the issue type (Not implemented)

Deck of Cards

id	bimGetIssueTypeDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types/<type_id>

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	createPin
	createPin

Create a new pin for the issue

Deck of Cards

id	bimCreatePin

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/

...

Get all the pins of the issue

Deck of Cards

id	bimGetAllPins

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

Card

label	HTTP Method

GET

Card

label	Description

Get all the pins of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "topologyNodeIdx": "387fa6cc-b6f9-4470-8c42-c07982aba660123.45",
        "position": {
            "x"y": 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"
    }
]

...

}
}

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

Anchor

	getPins
	getPins

Get all the pins of the issue

Deck of Cards

id	bimGetAllPins

...

Delete all the pins from the issue

Deck of Cards

id	bimDeleteAllPins

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the pins from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

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

id	bimCreateCommentForIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments pins

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

Example: https://api-stage.bimplus.net/v2/bimplus/issues/cb96a9b18ead8bfe-48c9ab23-4d974340-8c9eac47-262476c1c6b238181e83bff3/commentspinsJSON Structure:

Card

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.

label	HTTP Method

GET

Card

label	Description

Get all the pins of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	HeadersStatus

AuthorizationStatus: BimPlus200 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
OK

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": "cb96a9b18ead8bfe-48c9ab23-4d974340-8c9eac47-262476c1c6b238181e83bff3",
        "textobjectId": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author00000000-0000-0000-0000-000000000000",
        "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
        "position": {
              "idx": "00000000-0000-0000-0000-000000000000"123.45,
              "emaily": ""234.56,
              "firstnamez": "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"
}

...

345.67
        },
        "normalVector": {
            "x": 0,
            "y": 1,
            "z": 2
        },
        "createdAt": "2013-06-07T10:07:00",
        "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
    }
]

Anchor

	deletePins
	deletePins

Delete all the pins from the issue

Deck of Cards

id	bimDeleteAllPins

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the pins from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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

id	bimCreateCommentForIssue

...

Get all the comments of the issue

Deck of Cards

id	bimGetAllCommentsFromIssue

card

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

label	HTTP Method

GET

Card

label	Description

Get all the comments of 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: 200201 OKCreated

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": {
        "modifiedAtid": "201300000000-0000-07-03T13:26:18+00:00",
        "author": {
        "id": "00000000-0000-0000-00000000-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

	deleteCommentsgetCommentsdeleteComments
	getComments

...

Get all the comments

...

of the issue

Deck of Cards

id	bimDeleteCommentFromIssuebimGetAllCommentsFromIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/commentscomments

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

Card

label	HTTP Method

DELETE GET

Card

label	Description

Delete Get all the comments from the of a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

...

borderColor	Red

...

lang

...

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

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+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

id	bimCreateAttachmentForIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

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

label	HTTP Method

POST

Card

label	Description

Creates a new attachment for a specified issue.

Card

label	Request

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

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW

Code Block

title	Content

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

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

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

id	bimGetAttachmentListFromIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

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

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

Card

label	HTTP Method

GET

Card

label	Description

Gets the attachment list from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

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

id	bimDeleteAttachmentFromIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

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

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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

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

Deck of Cards

id	bimCreateAttachmentForIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://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
createdAt	will be ignored	string	Creation date of the attachment
creator	will be ignored	object	The user who created the attachment

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attachment for a specified issue.

Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipartapplication/form-data

Card

label

json

Code Block

borderColor	GreenRed
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

JSON

{
    "name" : "Wall info wrong",
    "description" : "This wall is wrong",
    "responsible" : {
        "id" : "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82"
    },    {
    "status" : "Open",
    "objectIdstype" : ["Problem",
    "solution" : "MySolution",
    "priority" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
 High",
	"published": true,
    "tag" : "Wall ]problems",
        "fileNameclassification" : "Building_Plan.jpgProblems",
        "typecc" : "image/jpeg",[
        "size": 211258,testuser@bimplus.net"
    ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "createdAtname": "2013-12-11T10:47:39",
      Wall info wrong",
  "creatorauthor": {
        "id": "e18941f47c555899-a8095a5f-2d0144d1-d27d930e-cd251f2b6cb6284930678bed",
        "email": "test@bimplustestuser1@allplan.netcom",
    "firstname": "Test",
    "firstnamelastname": "First NameUser1",
    "company": "Allplan Bratislava",
    "lastnamefullname": "SecondTest NameUser1"
  },
    "responsible": {
    "companyid": "Best-Company0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
        "fullnameemail": "First Name Second Nametestuser1@allplan.com",
        "displaynamefirstname": "Best-CompanyTest",
    "lastname": "User2",
    "infocompany": "Allplan Bratislava",
    "fullname": "Test User2"
  },
  "genderscene": ""null,
  "attachmentsCount": 0,
  "pinsCount": 0,
  "phoneWorkcommentsCount": ""0,
  "hyperlinksCount": 0,
  "shortId": 4,
  "phoneHomeprojectId": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a",
        "faxdescription": "This wall is wrong",
        "mobilestatus": "Open",
        "birthDatecreatedAt": "00002016-00-02-15T08:12:49.9831726+01:00",
        "address"modifiedAt": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "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": "6cea110a01b5768a-88f4bd19-43ac4049-9a00b72e-ebaf677be333b44485514ef8"
    }

Anchor

	getAttachmentsFromIssuedeleteIssue	getAttachmentsFromIssue

...

	deleteIssue

Delete the issue

Deck of Cards

id	bimGetAttachmentListFromIssuebimDeleteIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments _id or selection_id>

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

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

Card

label	HTTP Method

GET DELETE

Card

label	Description

Gets the attachment list from Deletes a specified issue or the issues belonging to the selection object (type of 'Elements').

Status: 200 OK

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

	Request

Code Block

borderColor	Green
lang	xml
title	Status

Code Block

borderColor	RedGreen
lang	xml
title	JSON	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	IssueRights
	IssueRights

Get rights for issue

Deck of Cards

id	bimGetIssueRights

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/rights

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

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

Card

label	HTTP Method

GET

Card

label	Description

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

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "editableProperties": [
    {
      "name": "name"
    },
    {
      "name": "description"
    },
    {
      "name": "priority    {
        "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",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDateenumValues": "0000-00-00",[
        "addressLow": {,
            "street": "Westermeier str."Medium",
            "streetNr": "10",High"
      ]
      "zip": "81829"},
      {
      "cityname": "Münchenresponsible",
    },
    {
      "countryname": "Germanycc"
      },
  },
  {
      "preferedLanguagename": "endueDate"
       },
    {
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

...

Delete all the attachments from the issue

Deck of Cards

id	bimDeleteAttachmentFromIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api-stage.bimplus.net/v2//issues//attachments

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Working with hyperlinks belonging to an issue

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

...

Update the issue

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:

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

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": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place(x:120, y: 120; z: 340)",
    "author": "Mr. Smart",
    "status": "open"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Delete the issue

Deck of Cards

id	bimDeleteIssue

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

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK
 "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",
   ...
  ]
}

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 7

New Version Current

Key

Topic Service

Anchor
createIssue
createIssue

Get details of the issue

Get details of the issue

Get all the issue types (Not implemented)

Get details of the issue type (Not implemented)

Create a new pin for the issue

Get all the issue types (Not implemented)

Get details of the issue type (Not implemented)

Create a new pin for the issue

Get all the pins of the issue

Get all the pins of the issue

Delete all the pins from the issue

Create a new comment for the issue

Delete all the pins from the issue

Create a new comment for the issue

Get all the comments of the issue

Get all the comments

of the issue

Create a new attachment for the issue

Create a new attachment for the issue

Get the attachment list from the issue

Delete all the attachments from the issue

Working with hyperlinks belonging to an issue

Update the issue

Delete the issue

Get rights for issue

Delete all the attachments from the issue

Working with hyperlinks belonging to an issue

Update the issue

Delete the issue

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 7

New Version Current

Key

Topic Service

AnchorcreateIssuecreateIssue

Get details of the issue

Get details of the issue

Get all the issue types (Not implemented)

Get details of the issue type (Not implemented)

Create a new pin for the issue

Get all the issue types (Not implemented)

Get details of the issue type (Not implemented)

Create a new pin for the issue

Get all the pins of the issue

Get all the pins of the issue

Delete all the pins from the issue

Create a new comment for the issue

Delete all the pins from the issue

Create a new comment for the issue

Get all the comments of the issue

Get all the comments

of the issue

Create a new attachment for the issue

Create a new attachment for the issue

Get the attachment list from the issue

Delete all the attachments from the issue

Working with hyperlinks belonging to an issue

Update the issue

Delete the issue

Get rights for issue

Delete all the attachments from the issue

Working with hyperlinks belonging to an issue

Update the issue

Delete the issue

Anchor
createIssue
createIssue