Page History

...

Deck of Cards

id	bimGetIssueTypest

Card

label	HTTP Method

GET

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

label	HTTP Method

GET

Card

label	Description

Get all the available issue types.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Deck of Cards

id	bimGetIssueTypeDetails

HTTP Method

Card

label

GET

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

label	HTTP Method

GET

Card

label	Description

Get details of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

POST

Deck of Cards

id	bimCreatePin

Card

label	HTTP Method

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

label	HTTP Method

POST

Card

label	Description

Create a new pin for an issue for relating the issue with its object.

Card

label	Request

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

label	Response

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

...

Deck of Cards

id	bimGetAllPins

Card

label	HTTP Method

GET

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

label	HTTP Method

GET

Card

label	Description

Get all the pins of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

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

...

Deck of Cards

id	bimDeleteAllPins

DELETE

Card

label	HTTP Method

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

label	HTTP Method

DELETE

Card

label	Description

Delete all the pins from a specified issue.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Deck of Cards

id	bimCreateCommentForIssue

label

Card

HTTP Method

POST

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

label	HTTP Method

POST

Card

label	Description

Create a new comment for a specified issue.

Card

label	Request

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

label	Response

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

...

Get all the comments of a specified issue.

Deck of Cards

id	bimGetAllCommentsFromIssue

Card

label	Description

HTTP Method

Card

label

GET

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

label	HTTP Method

GET

Card

label	Description

Get all the comments of a specified issue.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

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

...

DELETE

Deck of Cards

id	bimDeleteCommentFromIssue

Card

label	HTTP Method

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

label	HTTP Method

DELETE

Card

label	Description

Delete all the comments from the issue.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Deck of Cards

id	bimCreateAttachmentForIssue

HTTP Method

Card

label

POST

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

label	HTTP Method

POST

Card

label	Description

Creates a new attachment for a specified issue.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Card

label	Response

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

Deck of Cards

id	bimGetAttachmentListFromIssue

Card

label	HTTP Method

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

label	HTTP Method

GET

Card

label	Description

Gets the attachment list from a specified issue.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

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

Deck of Cards

id	bimDeleteAttachmentFromIssue

Card

label	HTTP Method

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

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments from a specified issue.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 507

New Version 508

Key