Versions Compared

Old Version 9

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 10

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

...

Deck of Cards
idbimCreateIssue
Card
defaulttrue
labelURL / 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

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. 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.
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
Card
labelHTTP Method
 POST
Card
labelDescription
 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
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "name" : "Wall info wrong",
    "authordescription" : {
"This wall is  wrong",
    "idresponsible" : "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",{
        "emailid" : "jayaraj.purushothaman@gmail.com",0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82"
    },
    "status" : "ActiveOpen",
        "firstnametype" : "JayarajProblem",
        "lastnamesolution" : "PurushothamanMySolution",
        "companypriority" : "Jay CompanyHigh",
        "fullnametag" : "JayarajWall Purushothamanproblems",
    "classification" : "Problems",
    "displaynamecc" : "Jayaraj Purushothaman [Jay Company]",
        "info": null,testuser@bimplus.net"
    ]
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
  "gendername": "MRWall info wrong",
  "author": {
     "phoneWorkid": null"7c555899-5a5f-44d1-930e-284930678bed",
        "phoneHomeemail": null"testuser1@allplan.com",
        "faxfirstname": null"Test",
        "mobilelastname": "User1",
        "birthDatecompany": null"Allplan Bratislava",
    "fullname": "Test User1"
  },
  "addressresponsible": {
      "id": "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
      "streetemail": "testuser1@allplan.com",
            "streetNr"firstname": "Test",
            "ziplastname": "User2",
            "citycompany": "Allplan Bratislava",
            "countryfullname": "Test User2"
  },
  "scene": null,
  "attachmentsCount": }0,
  "pinsCount": 0,
     "preferedLanguagecommentsCount": "en"0,
    }"hyperlinksCount": 0,
    "responsibleshortId": {4,
        "id"projectId": "6e67ba07de87fc4d-50c3cb5d-d51d44ba-23f0b2ea-3ac0d87882021d96ac564a8a",
        "emaildescription": "jayaraj.purushothaman@bimplus.netThis wall is wrong",
        "status": "ActiveOpen",
        "firstname"createdAt": "Jayaraj2016-02-15T08:12:49.9831726+01:00",
        "lastname"modifiedAt": "Purushothaman2016-02-15T08:12:49.9831726+01:00",
        "company"dueDate": "Bimplus GmbH"null,
        "fullnamesolution": "Jayaraj PurushothamanMySolution",
        "displaynametype": "Jayaraj Purushothaman [Bimplus GmbH]Problem",
        "infoclassification": null"Problems",
        "genderpriority": "MRHigh",
        "phoneWorkcc": null,[
    "abc@bimplus.net"
  ],
  "phoneHomeid": null,
        "fax": null,
        "mobile": "",
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": "de"
    },
    "scene": null"01b5768a-bd19-4049-b72e-b44485514ef8"
}

Anchor
getIssueDetails
getIssueDetails

Get details of the issue
Deck of Cards
idbimGetIssueDetails
Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET
Card
labelDescription
 Get details of an issue present in a project.
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
{
  "name": "Wall info wrong",
  "author": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "testuser1@allplan.com",
    "firstname": "Test",
    "lastname": "User1",
    "attachmentsCountcompany": "Allplan 0Bratislava",
    "pinsCountfullname": 4,
    "commentsCount": 1,"Test User1"
    "hyperlinksCount": 0},
    "shortIdresponsible": 1,{
    "projectIdid": "5cd37c770132ecbe-d3412ac5-4ab24ae1-9f0d945d-44467955b218d38fc3bc1e82",
    "descriptionemail": "test1testuser1@allplan.com",
    "statusfirstname": "OpenTest",
    "createdAtlastname": "2014-05-09T10:15:24+02:00User2",
    "modifiedAt": "2015-07-30T07:04:27+02:00",
    "dueDate": null,
    "solution": null,
    "type": "Remark",
    "classification": null,
    "priority": "Medium",
    "cc": [
        "ssudha84@gmail.com",
        "rush2jayaraj@yahoo.co.in"
    ],
    "clashId": "70d07604-cf68-4d94-abc0-c783f8cc548b",
    "id": "5eac4d92-c65b-49c8-927c-9f255879a5c2"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
    "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" },
    "responsible" : { "id" : "11fa66c6-4114-d68e-974c-0ff78a49fda8" },  
    "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 details of the issue
Deck of Cards
idbimGetIssueDetails
Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET
Card
labelDescription
 Get details of an issue present in a project.
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
{
    "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "name": "Fire Exit Wrong",
   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": "TheThis fire exitwall is in the wrong place",
    "authorstatus": "Mr. SmartOpen",
    "createdAt"status": "open: "2016-02-15T08:12:49.9831726+01:00",
    "createdAtmodifiedAt": "20132016-0602-02T1015T08:0512:0049.9831726+0001:00",
    "dueDate": null,
 "2013-06-05T10:05:00+00:00 "solution": "MySolution",
    "solutiontype": null"Problem",
    "classification": "Problems",
    "priority": "very highHigh",
    "revisioncc": null [
    "abc@bimplus.net"
  ],
    "id": "8ead8bfe01b5768a-ab23bd19-43404049-ac47b72e-38181e83bff3b44485514ef8"
}

Anchor
getIssueTypes
getIssueTypes

...