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

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 22

New Version 23

Key