Versions Compared

Old Version 14

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 15

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

...

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

...

Deck of Cards
idbimDeleteIssue
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
 DELETE
Card
labelDescription
 Deletes a specified issue.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

Anchor
IssueRights
IssueRights

Get rights for issue
Deck of Cards
idbimGetIssueRights
Card
defaulttrue
labelURL / 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
labelHTTP Method
GET
Card
labelDescription

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
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
titleJSON
{
  "editableProperties": [
    {
      "name": "name"
    },
    {
      "name": "description"
    },
    {
      "name": "priority",
      "enumValues": [
        "Low",
        "Medium",
        "High"
      ]
    },
    {
      "name": "responsible"
    },
    {
      "name": "cc"
    },
    {
      "name": "dueDate"
    },
    {
      "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",
   ...
  ]
}