Versions Compared

Old Version 6

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 7

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

Topic Service

...

...

  • Please use the Bimplus Project Service for creating/deleting an issue or for getting all the issues assigned to a project

Anchor
createIssue
createIssue
Create issue
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

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

tagoptionalstringcustom classification
modifiedAtoptionalstringModified date of the issue
sceneoptionalFixed templateScene/View of this topic. The pre-defined template is present here
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",
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "status": "Active",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": null,
        "gender": "MR",
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": "",
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": "en"
    },
    "responsible": {
        "id": "6e67ba07-50c3-d51d-23f0-3ac0d8788202",
        "email": "jayaraj.purushothaman@bimplus.net",
        "status": "Active",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Bimplus GmbH",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Bimplus GmbH]",
        "info": null,
        "gender": "MR",
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": "",
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": "de"
    },
    "scene": null,
    "attachmentsCount": 0,
    "pinsCount": 4,
    "commentsCount": 1,
    "hyperlinksCount": 0,
    "shortId": 1,
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "description": "test1",
    "status": "Open",
    "createdAt": "2014-05-09T10:15:24+02:00",
    "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"
}

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

...