Page History

Project Service

...

Anchor

	projectService
	projectService

Project Service

...

A Project is basically a holder which contains building models.

...

Deck of Cards

id	bimDeleteAttachmentListFromProject

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments

Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments belonging to a specified 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

Anchor

	createObjectType
	createObjectType

Create a new objecttype in the project

Deck of Cards

id	bimCreateObjectTypeInProject

Card

label	URL / Resource / JSON Structure

Resource: projects/<project_id>/objecttypes

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string (guid)	Id of the objecttype
projectId	will be ignored	string (guid)	The id of the project the objecttype belongs to
type	optional	string	Type of the objecttype. Can be one of the 'DocumentType', 'GroupType' or 'ModelType'
name	mandatory	string	Name of the objecttype
description	optional	string	Description of the objecttype
customModeType	optional	boolean	When this flag is true the objectype is custom and can be modified
definedBy	optional	JSON array	Array of the definition layers (disciplines) for which the objecttype is valid

Card

label	HTTP Method

POST

Card

label	Description

Creates a new objecttype in a project.

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

{
  "name":"UpdateTestObjectType",
  "definedBy":[{
      "id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
    },
    {
      "id":"2e5d5f07-6431-4bc6-b17c-49b5b8c585b7"
    }
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id":"c7d15b4e-02da-42c6-a1be-9082d3668cda",
  "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
  "type":"ModelType",
  "name":"TestObjectType",
  "customModeType":true,
  "definedBy":[{
      "name":"CommonMEP",
      "id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
    },
    {
      "name":"Heating",
      "id":"2e5d5f07-6431-4bc6-b17c-49b5b8c585b7"
    }
  ]
}

Anchor

	updateObjectType
	updateObjectType

Update the objecttype

Deck of Cards

id	bimUpdateObjectType

Card

default	true
label	URL / Resource / JSON Structure

Resource: objecttypes/<objecttype_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objecttypes/<objecttype_id>

Example: https://api-stage.bimplus.net/v2/bimplus/objecttypes/c7d15b4e-02da-42c6-a1be-9082d3668cda

JSON Structure: See Create a new objecttype in the project

Card

label	HTTP Method

PUT

Card

label	Description

Update properties of the specified objecttype.

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

{
  "name":"UpdateTestModelType",
  "description":"update",
  "definedBy":[{
      "id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
    }
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "id":"c7d15b4e-02da-42c6-a1be-9082d3668cda",
  "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
  "type":"ModelType",
  "name":"UpdateTestModelType",
  "description":"update",
  "customModeType":false,
  "definedBy":[{
      "name":"CommonMEP",
      "id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
    }
  ]
}

Anchor

	getObjectType
	getObjectType

Get the objecttype

Deck of Cards

id	bimGetObjectType

Card

default	true
label	URL / Resource / JSON Structure

Resource: objecttypes/<objecttype_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objecttypes/<objecttype_id>

Example: https://api-stage.bimplus.net/v2/bimplus/objecttypes/c7d15b4e-02da-42c6-a1be-9082d3668cda

Card

label	HTTP Method

GET

Card

label	Description

Get requested objecttype

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

{
  "id":"c7d15b4e-02da-42c6-a1be-9082d3668cda",
  "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
  "type":"ModelType",
  "name":"UpdateTestModelType",
  "description":"update",
  "customModeType":true,
  "definedBy":[{
      "name":"CommonMEP",
      "id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
    }
  ]
}

Anchor

	getObjectTypesFromProject
	getObjectTypesFromProject

Get all objecttypes from the project

Deck of Cards

id	bimGetObjectTypesFromProject

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/objecttypes

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

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

Card

label	HTTP Method

GET

Card

label	Description

Get allobjecttypes belonging to a specified 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

[{
    "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
  },
  ...
]

Anchor

	deleteObjectType
	deleteObjectType

Delete all the attachments from the project

Deck of Cards

id	bimDeleteObjectType

Card

default	true
label	URL / Resource / JSON Structure

Resource: objecttypes/<objecttype_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objecttypes/<objecttype_id>

Example: https://api-stage.bimplus.net/v2/bimplus/objecttypes/c7d15b4e-02da-42c6-a1be-9082d3668cda

Card

label	HTTP Method

DELETE

Card

label	Description

Delete a specified objecttype

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 46

New Version 47

Key

Project Service

Create a new objecttype in the project

Update the objecttype

Get the objecttype

Get all objecttypes from the project

Delete all the attachments from the project