Versions Compared

Old Version 515

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 516

changes.mady.by.user Jayaraj Purushothaman

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

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
labelHTTP Method
 POST
Card
labelDescription
 Creates a new issue in a project. While creating an issue in a project, the view of the model is automatically saved.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
"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",
"dueDate": "2013-06-05T10:05:00",
"classification": "",
"priority": "very high"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
    "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"
}

...