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
langxml
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatuslangxml
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSONlangxml
{
    "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>/comment/<comment_id>issues/export/excel

Example: https://api-stage.bimplus.net/v2/bimplus/comments/db540336-47a3-426e-b3bf-1e532bfac8eaissues/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
issuesIdmandatoryJSON arrayList of Topic ids

excelFileName

ignored

string

Name of the excel file

author

optional

object

The author of the comment

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
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Red
Code Block
borderColor
titleJSONlangxml
{
    "issueIdexcelFileName": "8415bd8d-7e27-4975-bddb-b1b365719770ExportedProject.xlsx",
    "textissuesId": "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:004744b3a2-db5f-46d4-8da1-38d9cfe5aafa",
    "author": {
        "id": "132a78a5-b523-4bf2-8382-7098fac3f803b98616dc-17c0-d4bc-6d2c-abb4aa017447"
    }]
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "attachment_id": "134c6df9-7952-4b2b-844b-a6b47f69fd5e"
}Status: 200 OK

Anchor
deleteCommentexcelAllObjectsdeleteComment
excelAllObjects

...

Export all the objects of a particular element-type inside a project into Excel
Deck of Cards
idbimDeleteCommentbimExcelAllObjects
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: comments/<comment_id> objects/export/excel?typeId=<elementType_guid>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/commentsprojects/<comment<project_id>/objects/export/excel?typeId=<elementType_guid>

Example: https://api-stage.bimplus.net/v2/bimplus/comments/8836308d-f09f-4bb7-b6d2-354a2db205a6/projects/de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a/objects/export/excel?typeId=10074eef-9418-4d64-9c6d-23932835a7f1

The same output, could be got in the form of JSON response (not in excel format) using v2/<team_slug>/projects/<project_id>/ elements?typeId=xxx

Card
labelHTTP Method
 DELETE GET
Card
labelDescription
 Deletes a specified comment.Export all the Bimplus model objects of a particular element-type(eg: wall) inside a project into Excel. The response contains the attachment_id which could be downloaded using the Attachment Service The element-types id could be got from the Element-Type Service The same output, could be got in the form of JSON response (not in excel format) using v2/<team_slug>/projects/<project_id>/ elements?typeId=xxx
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "attachment_id": "134c6df9-7952-4b2b-844b-a6b47f69fd5e"
}Status: 200 OK