...
Anchor |
---|
| getAttachmentInfo |
---|
| getAttachmentInfo |
---|
|
GET
Card |
---|
|
|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
...
...
Card |
---|
Get detailed information about a specified attachment. |
|
|
|
|
Card |
---|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"objectIds": [
"7cf910cb-e357-43f6-aa3a-b45c26380f75"
],
"fileName": "Door_Model.jpg",
"type": "image/jpeg",
"size": 211258,
"id": "d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2"
}
|
|
|
...
Anchor |
---|
| downloadAttachment |
---|
| downloadAttachment |
---|
|
Download the attachment
GET
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
|
Card |
---|
|
|
...
Card |
---|
Download the content of a specified attachment. |
|
|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
Card |
deck | | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
Anchor |
---|
| updateAttachment |
---|
| updateAttachment |
---|
|
Update the attachment
GET
Card |
---|
|
|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
Resource: attachments/<attachment_id> URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id> Example: JSON Structure: Name | Mandatory / Optional | Type | Description |
---|
objectIds | optional | string | The id of the objects to which the file has to be attached | fileName | optional | string | Name of the file to be attached to the project | type | optional | string | Mime type | size | optional | integer | Size of the file to be attached to the project |
|
|
|
Card |
---|
|
|
...
Update or replace a specified existing attachment with a new one. |
|
...
Card |
---|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
Card |
---|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
...
Anchor |
---|
| deleteAttachment |
---|
| deleteAttachment |
---|
|
Delete the Attachment
GET
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
...
...
Card |
---|
Deletes a specified attachment. |
|
|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
Card |
deck | | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
...
- Please use the Bimplus Project Service for creating/deleting an issue or for getting all the issues assigned to a project
Anchor |
---|
| getIssueDetails |
---|
| getIssueDetails |
---|
|
Get details of the issue
GET
Card |
---|
|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
|
|
|
...
Get details of an issue present in a project. |
|
...
Card |
---|
| | Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
Card |
---|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"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"
}
|
|
|
...
Anchor |
---|
| getIssueTypes |
---|
| getIssueTypes |
---|
|
Get all the issue types (Not implemented)
GET
Card |
---|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
|
|
|
...
Card |
---|
Get all the available issue types. |
|
|
|
|
Card |
---|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
|
borderColor | Red |
---|
title | JSON | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
| Code Block |
---|
|
lang | xml |
---|
| card |
deck |
Anchor |
---|
| getIssueTypeDetails |
---|
| getIssueTypeDetails |
---|
|
Get details of the issue type (Not implemented)
GET
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
...
...
Card |
---|
Get details of a specified issue type. |
|
|
Card |
---|
| | Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
|
borderColor | Red |
---|
title | JSON | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
| Code Block |
---|
|
lang | xml |
---|
| Card |
---|
|
deck |
Create a new pin for the issue
POST
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
Resource: issues/<issue_id>/pins URL: https://api.bimplus.net/v2//issues//pins Example: https://api.bimplus.net/v2//issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins JSON Structure: Name | Mandatory / Optional | Type | Description |
---|
issueId | will be ignored | string (guid) | The id of the issue to which the pin is related | objectId | mandatory | string (guid) | The id of the object to which the pin is related | topologyNodeId | will be ignored | string (guid) | The id of the topology to which the pin is attached | position | optional | object | The position of the issue in the building (x,y,z co-ordinates) | normalVector | optional | object | The direction of the issue in the 3D space (x,y,z co-ordinates) | createdAt | will be ignored | date | The creation date |
|
|
...
...
Card |
---|
Create a new pin for an issue for relating the issue with its object. |
|
|
| | Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"position": {
"x": "123.45",
"y": "234.56",
"z": "345.67"
},
"normalVector": {
"x": "0",
"y": "1",
"z": "2"
}
}
|
|
|
|
Card |
deck | | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
"objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
"topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
"position": {
"x": "123.45",
"y": "234.56",
"z": "345.67"
},
"normalVector": {
"x": "0",
"y": "1",
"z": "2"
},
"createdAt": "2013-06-07T10:07:00+00:00",
"id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}
|
|
|
Get all the pins of the issue
GET
Card |
---|
|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
|
|
|
...
Get all the pins of a specified issue type. |
|
...
Card |
---|
| | Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
Card |
---|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
"issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
"objectId": "00000000-0000-0000-0000-000000000000",
"topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
"position": {
"x": 123.45,
"y": 234.56,
"z": 345.67
},
"normalVector": {
"x": 0,
"y": 1,
"z": 2
},
"createdAt": "2013-06-07T10:07:00",
"id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}
]
|
|
|
...
Delete all the pins from the issue
DELETE
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
...
...
Card |
---|
Delete all the pins from a specified issue. |
|
|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
Card |
deck | | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
Anchor |
---|
| createComment |
---|
| createComment |
---|
|
POST
Card |
---|
|
|
Card |
---|
| | Create a new comment for a specified issue. |
|
|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"text": "The fire exit should be x:120, y: 120; z: 340"
}
|
|
|
Card |
deck | | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
"text": "The fire exit should be x:120, y: 120; z: 340",
"createdAt": "2013-07-02T13:26:18.8932853+00:00",
"author": "132a78a5-b523-4bf2-8382-7098fac3f803",
"id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}
|
|
|
Deck of Cards |
---|
|
Card |
---|
| Get all the comments of a specified issue. | |
GET
|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
...
Card |
---|
Card |
---|
label | | Description |
---|
|
Get all the comments of a specified issue.
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
Card |
---|
| | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
"issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
"text": "The fire exit should be x:120, y: 120; z: 340",
"createdAt": "2013-07-02T13:26:18+00:00",
"author": "132a78a5-b523-4bf2-8382-7098fac3f803",
"id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}
]
|
|
|
card |
Anchor |
---|
| deleteComment |
---|
| deleteComment |
---|
|
DELETE
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
...
...
Card |
---|
Deletes a specified comment. |
|
|
|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
Card |
---|
| | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
card |
...
...
Anchor |
---|
| createAttachmentForIssue |
---|
| createAttachmentForIssue |
---|
|
Create a new attachment for the issue
Deck of Cards |
---|
id | bimCreateAttachmentForIssue |
---|
| |
|
|
...
Card |
---|
|
|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
|
Card |
---|
|
|
...
Creates a new attachment for a specified issue. |
|
|
Card |
---|
| | Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
|
|
|
Card |
---|
| | Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 201 Created
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
"objectIds": [
"8ead8bfe-ab23-4340-ac47-38181e83bff3"
],
"fileName": "FireExit_Wrong.jpg",
"type": "image/jpeg",
"size": 211258,
"id": "db9e340a-08a6-4306-92b2-c51c0063c206"
}
]
|
|
|
card |
Anchor |
---|
| getAttachmentsFromIssue |
---|
| getAttachmentsFromIssue |
---|
|
Get the attachment list from the issue
Deck of Cards |
---|
id | bimGetAttachmentListFromIssue |
---|
| |
|
GET
Card |
---|
|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| |
|
|
|
|
...
Gets the attachment list from a specified issue. |
|
...
Card |
---|
| | Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
|
|
Card |
---|
|
|
deck Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| [
{
"objectIds": [
"8ead8bfe-ab23-4340-ac47-38181e83bff3"
],
"fileName": "FireExit_Wrong.jpg",
"type": "image/jpeg",
"size": 211258,
"id": "db9e340a-08a6-4306-92b2-c51c0063c206"
}
]
|
|
|
Anchor |
---|
| deleteAttachmentsFromIssue |
---|
| deleteAttachmentsFromIssue |
---|
|
...