Page History

Project Service

...

Deck of Cards

id	bimCreateProject

Card

label	URL / Resource / JSON Structure

Resource: projects

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string (guid)	Id of the project
name	mandatory	string	Name of the project
shortDescr	optional	string	Short description of the project
teamName	will be ignored	string	Name of the team to which the project belongs
teamSlug	will be ignored	string	Slug of the team to which the project belongs
hasWriteAccess	will be ignored	boolean	Don't use this property. This property is not deleted to support the older clients
thumbnail	will be ignored	string	Direct download link to project thumbnail
created	will be ignored	string (date)	Creation date of the project
createdBy	will be ignored	JSON object	Details of the Bimplus user who has created the project
changed	will be ignored	string(date)	Modified date of the project
changedBy	will be ignored	JSON object	Details of the Bimplus user who has created the project
address	optional	string	Address of the project
modelCount	will be ignored	int	Number of models in this project
memberCount	will be ignored	int	Number of members in this project
topicCount	will be ignored	int	Number of topics in this project
attachmentCount	will be ignored	int	Number of attachments in this project
size	will be ignored	int	Size of the project in bytes
sizeInMB	will be ignored	string	Size of the project in MB
disciplines	will be ignored	JSON object	Disciplines found under this project
rights	will be ignored	JSON object	The rights the user has for this project

Card

label	HTTP Method

POST

Card

default	true
label	Description

Creates a new 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" : "Your Awesome Building",
    "shortDescr" : "Example for creating a project",
    "address" : "My address somewhere"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "Your Awesome Building",
    "shortDescr": "Example for creating a project",
    "teamName": "Best Company",
    "teamSlug": "best-company",
    "hasWriteAccess" : true,
    "thumbnail": null,
    "created": "2013-06-01T10:05:00",
    "createdby" : {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email" : "testuser@bimplus.net"
    },
    "changed": "2013-06-01T10:05:00",
    "changedby" : {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email" : "testuser@bimplus.net"
    },
    "address" : "My address somewhere",
    "modelCount": 0,
    "memberCount": 1,
    "topicCount": 0,
    "attachmentCount": 0,
    "size": 0,
    "sizeMB": "0",
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Anchor

	createCopyProjectFromSourceProject
	createCopyProjectFromSourceProject

Create copy of the source project

Deck of Cards

id	bimCreateCopyProjectFromSourceProject

Card

label	Url / Resource /Json

Resource: projects/copyfrom

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/copyfrom

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	string(guid)	Id of the source project
teamSlug	mandatory	string	Team slug of the source project (source team slug)
name	mandatory	string	Unique name of the newly created project
shortDescr	optional	string	Description of the newly created project

Card

label	HttpMethod

POST

Card

label	Description

Creates new project as copy of the source 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

{
  "id":"1eb8efe0-7611-47e7-a06d-102ec8e2fff6",
  "teamSlug":"bimplus-demo",
  "name":"Copy of the Mallorca V1",
  "shortDescr":"Description of the new copy of the Mallorca V1"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "topicCount": 0,
    "attachmentCount": 2,
    "projectAttachmentCount": 0,
    "name": "Copy of the Mallorca V1",
    "shortDescr": "Description of the new copy of the Mallorca V1",
    "hasWriteAccess": false,
    "teamSlug": null,
    "thumbnail": null,
    "created": "2014-02-13T12:39:36",
    "createdby": {
        "id": "e0837206-4bff-65d4-b79f-f3878c3567fd",
        "email": "demo@bimplus.net",
        "firstname": "bim+",
        "lastname": "a service by Allplan"
    },
    "changed": "2019-01-24T11:51:40.55",
    "changedby": {
        "id": "e0837206-4bff-65d4-b79f-f3878c3567fd",
        "email": "demo@bimplus.net",
        "firstname": "bim+",
        "lastname": "a service by Allplan"
    },
    "modelCount": 2,
    "memberCount": 1,
    "size": 32839680,
    "attachmentsSize": 0,
    "sizeMB": "31.32",
    "approvalProcess": 0,
    "id": "990d0772-8b87-479a-9ed6-b0b46a204301"
}

Anchor

	getCurrentProjectList
	getCurrentProjectList

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 56

New Version 57

Key

Create copy of the source project