Page History

...

Anchor

	issueService
	issueService

Issue Service

...

Get details of the issue
Get all the issue types
Get details of the issue type
Create a new pin for the issue
Get all the pins of the issue
Delete all the pins from the issue
Create a new comment for the issue
Get all the comments of the issue
Delete the comment
Create a new attachment for the issue
Get the attachment list from the issue
Delete all the attachments from the issue
Update the issue
Delete the issue
Anchor
getIssueDetails
getIssueDetails

Get details of the issue

Deck of Cards

id	bimGetIssueDetails

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>

Example:

Card

label	Description

Get details of an issue present in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	getIssueTypes
	getIssueTypes

Get all the issue types

Deck of Cards

id	bimGetIssueTypest

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types

URL: https://api.bimplus.net/v2/<team>/issues/types

Example: https://api.bimplus.net/v2/bimplus/issues/types

Card

label	Description

Get all the available issue types.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	getIssueTypeDetails
	getIssueTypeDetails

Get details of the issue type

Deck of Cards

id	bimGetIssueTypeDetails

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types/<type_id>

URL: https://api.bimplus.net/v2/<team>/issues/types/<type_id>

Example:

Card

label	Description

Get details of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	createPin
	createPin

Create a new pin for the issue

Deck of Cards

id	bimCreatePin

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/pin

Example:

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId		string (guid)	The id of the issue to which the pin is related
objectId			The id of the object to which the pin is related
position	optional
normalVector	optional
createdAt	optional	date	The creation date

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	getPins
	getPins

Get all the pins of the issue

Deck of Cards

id	bimGetAllPins

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/pins

Example:

Card

label	Description

Get all the pins of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	deletePins
	deletePins

Delete all the pins from the issue

Deck of Cards

id	bimDeleteAllPins

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/pins

Example:

Card

label	Description

Delete all the pins from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	createComment
	createComment

Create a new comment for the issue

Deck of Cards

id	bimCreateComment

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/comments

Example:

JSON Structure:

Name	Type	Description
issueId	string (guid)	The id of the issue to which the comment is related
text	string	The comment text
createdAt	string (date)	Creation date of the comment
author	string	The author of the comment

Card

label	Description

Create a new comment for a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	getComments
	getComments

Get all the comments of the issue

Deck of Cards

id	bimGetAllComments

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/comments

Example:

Card

label	Description

Get all the comments of a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	deleteComment
	deleteComment

Delete the comment

Deck of Cards

id	bimDeleteComment

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments/<comment_id>

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/comments/<comment_id>

Example:

Card

label	Description

Deletes a specified comment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	createAttachmentForIssue
	createAttachmentForIssue

Create a new attachment for the issue

Deck of Cards

id	bimCreateAttachmentForIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments

Example:

JSON Structure:

Name	Mandatory / Optional	Type	Description
objectIds	optional	string	The id of the issue 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

label	Description

Creates a new attachment for a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	getAttachmentsFromIssue
	getAttachmentsFromIssue

Get the attachment list from the issue

Deck of Cards

id	bimGetAttachmentListFromIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments

Example:

Card

label	Description

Gets the attachment list from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	deleteAttachmentsFromIssue
	deleteAttachmentsFromIssue

Delete all the attachments from the issue

Deck of Cards

id	bimDeleteAttachmentFromIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments

Example:

Card

label	Description

Delete all the attachments from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	updateIssue
	updateIssue

Update the issue

Deck of Cards

id	bimUpdateIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>

Example:

JSON Structure:

Name	Type	Description
projectId	string (guid)	Id of the project
name	string	Name of the issue
description	string	Description of the issue
author	string	Author of the issue
status	string	Status of the issue
createdAt	string (date)	Creation date of the issue
dueDate	string (date)	The date in which the issue is planned to be finished
solution
classification	string
priority	string

Card

label	Description

Update or replace a specified existing issue with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	deleteIssue
	deleteIssue

Delete the issue

Deck of Cards

id	bimDeleteIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>

Example:

Card

label	Description

Deletes a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 42

New Version 43

Key

Issue Service

Get details of the issue

Get all the issue types

Get details of the issue type

Create a new pin for the issue

Get all the pins of the issue

Delete all the pins from the issue

Create a new comment for the issue

Get all the comments of the issue

Delete the comment

Create a new attachment for the issue

Get the attachment list from the issue

Delete all the attachments from the issue

Update the issue

Delete the issue