Versions Compared

Old Version 3

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version Current

changes.mady.by.user Stanislav Slacky

Saved on

Key

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

This page is under construction

Export to Excel Service

...

...

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

URL: https://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
titleHeaderslangxml
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"
}

...

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

URL: https://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


JSON Structure:

Name

Mandatory / Optional

Type

Description

issuesIdmandatoryJSON arrayList of Topic ids

excelFileName

ignored

string

Name of the excel file

Card
labelHTTP Method
 POST
Card
labelDescription
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
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Red
Code Block
borderColor
titleJSONlangxml
{
  "excelFileName": "ExportedProject.xlsx",
  "attachment_idissuesId": [
    "134c6df9-7952-4b2b-844b-a6b47f69fd5e""4744b3a2-db5f-46d4-8da1-38d9cfe5aafa",
    "b98616dc-17c0-d4bc-6d2c-abb4aa017447"
  ]
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatuslangxml
Status: 200 OK

...

Code Block

...

borderColor

...

Red

...

Resource: comments/<comment_id> 

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

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

lang
Deck of Cards
idbimDeleteComment
Card
defaulttrue
labelURL / Resource / JSON Structure
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
xml
titleJSON
{
    "attachment_id": "134c6df9-7952-4b2b-844b-a6b47f69fd5e"
}

Anchor
excelAllObjects
excelAllObjects

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

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issuesobjects/export/excel?typeId=<elementType_guid>

Example:https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77de87fc4d-d341cb5d-4ab244ba-9f0db2ea-44467955b2181d96ac564a8a/issuesobjects/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
 GET
Card
labelDescription
 EExport 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
titleStatuslangxml
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSONlangxml
{
    "attachment_id": "134c6df9-7952-4b2b-844b-a6b47f69fd5e"
}