Versions Compared

Key

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

This page is under construction

Export to Excel Service

...

Export to Excel Service

...

Topics or geometry objects in Bimplus can be exported into Excel using this service.

...

Deck of Cards
idbimExcelAllTopics
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/export/excel

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues/export/excel

Example:https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955b218/issues/export/excel

Card
labelHTTP Method
 GET
Card
labelDescription
 Export all the Bimplus Topics inside a project into Excel. The response contains the attachment_id which could be downloaded using the Attachment Service
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "attachment_id": "134c6df9-7952-4b2b-844b-a6b47f69fd5e"
}

Anchor
updateCommentexcelTopicListupdateComment
excelTopicList

...

Export the list of Bimplus Topics to Excel
Deck of Cards
idbimCommentUpdatebimExcelTopicList
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: comments/<comment_id> issues/export/excel

URLhttps://api-stage.bimplus.net/v2/<team_slug>/commentprojects/<comment<project_id>/issues/export/excel

Example: https://api-stage.bimplus.net/v2/bimplus/commentsprojects/db5403365cd37c77-47a3d341-426e4ab2-b3bf-1e532bfac8ea9f0d-44467955b218/issues/export/excel


JSON Structure:

Name

Mandatory / Optional

Type

Description

issueIdwill be ignoredstring(guid)The id of the issue

text

mandatory

string

The comment text

createdAt

will be ignored

string (date)

Creation date of the comment

modifiedAtwill be ignoredstring (date)Modified date of the comment

author

optional

object

The author of the comment

issuesIdmandatoryJSON arrayList of Topic ids

excelFileName

ignored

string

Name of the excel file

Card
labelHTTP Method
 PUT POST
Card
labelDescription
Update the specified comment.Export the list of Bimplus Topics into Excel. The response contains the attachment_id which could be downloaded using the Attachment Service
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
    "text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-11-20T08:17:36+00:00",
    "modifiedAt": "2013-11-20T08:17:36+00:00",
    "author": {
        "attachment_id": "132a78a5134c6df9-b5237952-4bf24b2b-8382844b-7098fac3f803"
    }a6b47f69fd5e"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

...

Deck of Cards
idbimDeleteComment
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: comments/<comment_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/comments/<comment_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/comments/8836308d-f09f-4bb7-b6d2-354a2db205a6


Card
labelHTTP Method
 DELETE
Card
labelDescription
 Deletes a specified comment.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
excelAllObjects
excelAllObjects

Export all the objects inside a project into Excel
Deck of Cards
idbimExcelAllTopics
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: issues/export/excel

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues/export/excel

Example:https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955b218/issues/export/excel

Card
labelHTTP Method
 GET
Card
labelDescription
 Export all the Bimplus model objects inside a project into Excel. The response contains the attachment_id which could be downloaded using the Attachment Service
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "attachment_id": "134c6df9-7952-4b2b-844b-a6b47f69fd5e"
}