Versions Compared

Key

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

...

Deck of Cards
idbimGetObjectTypesFromProject


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/objecttypes

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/objecttypes

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes

Optional query parameters:

Following query parameter allows reduce set of returned objecttypes. By default will be returned all defined objecttypes of the project.

Name

Type

Default value

Description

type

string

none

When query parameter "type=<type of the object type>" is defined, the API call will returns all objecttypes which have defined requested type.
Type of the objecttype can be one of the 'DocumentType', 'GroupType' or 'ModelType'
e.g:
https://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes?type=DocumentType
https://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes?type=GroupType
https://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes?type=ModelType



Card
labelHTTP Method
 GET


Card
labelDescription

 Get allobjecttypes belonging to a specified project.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
[{
    "id":"ef37183d-8c74-473a-80de-03ba98b9eb6d",
    "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
    "type":"DocumentType",
    "name":"Report",
    "description":"documenttype",
    "customModeType":true
  },
  {
    "id":"d4d2204a-6352-4252-8b44-3746c0d7fd16",
    "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
    "type":"DocumentType",
    "name":"5486",
    "customModeType":true
  },
  {
    "id":"0b329478-6643-474c-b580-41ccc9dad750",
    "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
    "type":"DocumentType",
    "name":"Specification",
    "description":"documenttype",
    "customModeType":true
  },
  {
    "id":"90d5c7d8-2430-4c87-984e-76ae4e8dd72a",
    "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
    "type":"DocumentType",
    "name":"Presentation",
    "description":"documenttype",
    "customModeType":true
  },
  {
    "id":"64b85111-8570-45ca-9c30-86f85bfb666f",
    "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
    "type":"DocumentType",
    "name":"Contract",
    "description":"documenttype",
    "customModeType":true
  },
  ...
]



...