...
Anchor |
---|
elementTypeService | elementTypeService | ElementType Service
Element type describes the type of predefined building elements required to build a building (eg: wall, window, door etc) Each element type have an unique id. Please see the detailed structure of the ElementType in the Object Model
...
...
Get the element types
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: element-types URL: https://api-stage.bimplus.net/v2/<team_slug>/element-types Example: https://api-stage.bimplus.net/v2/bimplus/element-types |
Card |
---|
| Gets the list of existing element types. |
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 |
---|
| [3]
0: [3]
0: {
type: "GeometryObject"
category: "/1/30/4/"
name: "3D object"
ifcType: "ID_IFCBuildingElementProxy"
id: "5a8a8670-cb9f-4f04-a467-04a9e416a6d0"
}-
1: {
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
}-
2: {
type: "Column"
category: "/1/10/2/"
name: "Column"
ifcType: "ID_IFCColumn"
id: "2e308afe-d078-4c20-b53c-76b2da66d848"
}
...
|
|
|
...
Get the element type properties
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: element-types/<element_type_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/element-types/<element_id> Example: https://api-stage.bimplus.net/v2/bimplus/element-types/e504f24c-e643-452b-b901-6a18883dc7e9 |
Card |
---|
| Get the properties of a specified element 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 |
---|
| {
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
} |
|
|
...
Get the list of existing layers
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: element-types/disciplines URL: https://api-stage.bimplus.net/v2/<team_slug>/element-types/disciplines Example: https://api-stage.bimplus.net/v2/bimplus/element-types/disciplines |
Card |
---|
| Gets the list of existing layers. |
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 |
---|
| {
-e79a4e18-383f-49c4-aabf-e15b27850423: {
category: "/14/"
name: "Airconditionermodel"
ifcType: null
id: "e79a4e18-383f-49c4-aabf-e15b27850423"
}
-63b069d2-81df-4418-91de-8a954fa12924: {
category: "/5/"
name: "Wood Construction Model"
ifcType: null
id: "63b069d2-81df-4418-91de-8a954fa12924"
}
-dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f: {
category: "/4/"
name: "Massiveconstructionmodel"
ifcType: null
id: "dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f"
}
-6a6e4d09-3550-4483-8134-98ac1e6c1afb: {
category: "/60/"
name: "Production model"
ifcType: null
id: "6a6e4d09-3550-4483-8134-98ac1e6c1afb"
}
-09e623d4-1e12-4a77-b358-ea1d0b28e4a7: {
category: "/2/"
name: "Roommodel"
ifcType: null
id: "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
}
-687c6451-3fa1-47e0-9f13-406833bb06f3: {
category: "/13/"
name: "TGA_Wastewatermodel"
ifcType: null
id: "687c6451-3fa1-47e0-9f13-406833bb06f3"
}
}
...
|
|
|
...
Attachment Service
Attachments are mostly documents or any media files with additional information which can be assigned to any project, object, issue or slide. Please see the detailed structure of the attachment in the Object Model
- Please use the Bimplus Project Service for creating an attachment or for getting/deleting all the attachments of a project
- Please use the Bimplus Object Service for creating an attachment or for getting/deleting all the attachments of an object, issue or slide
...
Get Attachment information
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: attachments/<attachment_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id> Example: https://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2 |
Card |
---|
| Get detailed information about a specified attachment. |
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 |
---|
| {
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
} |
|
|
...
Download the attachment
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: attachments/<attachment_id>/download URL: https://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id>/download Example: https://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/download |
Card |
---|
| Download the content of a specified attachment. There also exists a POST method for downloading the attachment where you have to pass the "token" as a form parameter. |
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
|
|
|
...
Update the attachment
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: attachments/<attachment_id> URL: https://api-stage.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 | createdAt | will be ignored | string | Creation date of the attachment | creator | will be ignored | object | The user who created the attachment |
|
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
|
|
|
...
Delete the Attachment
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: attachments/<attachment_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id> Example: https://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2 |
Card |
---|
| Deletes a specified attachment. |
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
|
|
|
...
Issue 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
...
Get details of the issue
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / 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 |
---|
| 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"
}
|
|
|
...
Get all the issue types (Not implemented)
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/types URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/types Example: https://api-stage.bimplus.net/v2/bimplus/issues/types |
Card |
---|
| Get all the available issue types. |
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
|
|
|
...
Get details of the issue type (Not implemented)
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/types/<type_id> URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/types/<type_id> |
Card |
---|
| Get details 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
|
|
|
...
Create a new pin for the issue
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/pins URL: https://api-stage.bimplus.net/v2//issues//pins Example: https://api-stage.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 | Creation date of the pin |
|
Card |
---|
| Create a new pin for an issue for relating the issue with its object. |
Card |
---|
| 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 |
---|
| 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
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/pins URL: https://api-stage.bimplus.net/v2//issues//pins Example: https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins |
Card |
---|
| 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
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/pins URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/pins Example: https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins |
Card |
---|
| Delete all the pins from a specified issue. |
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
|
|
|
...
Please note that you can also use the Bimplus Object Service for working with the comments belonging to an issue
Deck of Cards |
---|
id | bimCreateCommentForIssue |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/comments URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments Example: https://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments JSON Structure: Name | Mandatory / Optional | Type | Description |
---|
issueId | will be ignored | string(guid) | The id of the issue | text | mandatory | string | The comment text | createdAt | will be ignored | string (date) | Creation date of the comment | modifiedAt | will be ignored | string (date) | Modified date of the comment | author | will be ignored | object | The author of the comment |
|
Card |
---|
| Create a new comment for a specified issue. |
Card |
---|
| 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 |
---|
| 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": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "",
"firstname": "Unknown",
"lastname": "User",
"company": "",
"fullname": "Unknown User",
"displayname": "Unknown User",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}
|
|
|
...
Deck of Cards |
---|
id | bimGetAllCommentsFromIssue |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/comments URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments Example: https://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments |
Card |
---|
| Get all the comments of a specified issue. |
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": "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",
"modifiedAt": "2013-07-03T13:26:18+00:00",
"author": {
"id": "00000000-0000-0000-0000-000000000000",
"email": "",
"firstname": "Unknown",
"lastname": "User",
"company": "",
"fullname": "Unknown User",
"displayname": "Unknown User",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}
]
|
|
|
...
Deck of Cards |
---|
id | bimDeleteCommentFromIssue |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/comments URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments Example: https://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments |
Card |
---|
| Delete all the comments from the issue. |
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
|
|
|
...
Create a new attachment for the issue
Please note that you can also use the Bimplus Object Service for working with the attachments belonging to an issue
Deck of Cards |
---|
id | bimCreateAttachmentForIssue |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/attachments URL: https://api-stage.bimplus.net/v2//issues//attachments Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body. Name | Mandatory / Optional | Type | Description |
---|
objectIds | will be ignored | string | The id of the project objects to which the file has to be attached | fileName | will be ignored | string | Name of the file to be attached to the project | type | will be ignored | string | Mime type | size | will be ignored | integer | Size of the file to be attached to the project | createdAt | will be ignored | string | Creation date of the attachment | creator | will be ignored | object | The user who created the attachment |
|
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": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
} |
|
|
...
Get the attachment list from the issue
Deck of Cards |
---|
id | bimGetAttachmentListFromIssue |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/attachments URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>/attachments Example: https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments |
Card |
---|
| 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 |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"objectIds": [
"0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
],
"fileName": "Building_Plan.jpg",
"type": "image/jpeg",
"size": 211258,
"createdAt": "2013-12-11T10:47:39",
"creator": {
"id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
"email": "test@bimplus.net",
"firstname": "First Name",
"lastname": "Second Name",
"company": "Best-Company",
"fullname": "First Name Second Name",
"displayname": "Best-Company",
"info": "",
"gender": "",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Westermeier str.",
"streetNr": "10",
"zip": "81829",
"city": "München",
"country": "Germany"
},
"preferedLanguage": "en"
},
"id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
} |
|
|
...
Delete all the attachments from the issue
Deck of Cards |
---|
id | bimDeleteAttachmentFromIssue |
---|
|
Card |
---|
default | true |
---|
label | URL / Resource / JSON Structure |
---|
| Resource: issues/<issue_id>/attachments URL: https://api-stage.bimplus.net/v2//issues//attachments Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments |
Card |
---|
| Delete all the attachments from a specified issue. |
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
|
|
|
...
Working with hyperlinks belonging to an issue
Please use the Bimplus Object Service for working with hyperlinks belonging to an issue
...
Update the issue
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / 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 JSON Structure: Name | Mandatory / Optional | Type | Description |
---|
shortId | will be ignored | number | Readable 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 | responsible | optional | object | Responsible 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 |
---|
| Update or replace a specified existing issue with a new one. |
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
lang | xml |
---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
Code Block |
---|
borderColor | Red |
---|
title | JSON |
---|
lang | xml |
---|
| {
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place(x:120, y: 120; z: 340)",
"author": "Mr. Smart",
"status": "open"
}
|
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
lang | xml |
---|
| Status: 200 OK
|
|
|
...
Delete the issue
Deck of Cards |
---|
|
Card |
---|
default | true |
---|
label | URL / 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 |
---|
| Deletes a specified issue. |
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
|
|
|
...
Pin Service
...
Pins are relation between an issue and an object. It defines position of an issue in the 3D space. Please see the detailed structure of the pin in the Object Model
...