Page History

...

Deck of Cards

id	bimcreateStructure

card

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/structures

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/structures

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentId	mandatory	string(guid)	Parent node id of the structure (for the first structure, projectId is the parentId)
name	mandatory	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	will be ignored	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure
startDate	optional	string (date)	Start date ( depends on type of structure )
endDate	optional	string (date)	End date ( depends on type of structure )

attributeId

label	HTTP Method

POST

Card

label	Description

Create a new structure(eg: cost structure, specification structure) under a project

optional	string(guid)	Free attribute Id. When this value is set, the corresponding attribute must have a suitable controlType to define set of structures to be created. At a moment is supported only controlType "Enumeration", for all other controlType-s is returned status 404 Not found.
variantType	optional	string(guid)	Variant Type Id to whom the object will be assigned. Used only when attributeId is defined.

Card

label	HTTP Method

POST

Card

label	Description

Create a new structure(eg: cost structure, specification structure) under a project.

NOTE :
When is defined attributeId of attribute with controlType "Enumeration" will be created structure hierarchy.
The structure will be created under parent element (structure or project) together with its child structures.
Child structures will be created according enumDefinition (enumeration list) of attribute (defined by attributeId).

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

A) Sample to create single structure:
{
   "parentId": "3904db18-cf1a-4665-9c2b-152b84293259",
   "name": "TestStructure",
   "description": "FullLifeCycleTest",
   "type": "CostStructure"
}
 
B) Sample to create structure hierarchy:
{
   "parentId": "3904db18-cf1a-4665-9c2b-152b84293259",
   "name": "Status structure",
   "attributeId": "02bbe8de-c623-489f-9baa-87f8ff3205f2",
   "description": "Status of the project (enumeration)"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

A) Sample to create single structure:
{
   "parentId": "3904db18-cf1a-4665-9c2b-152b84293259",
    "name": "TestStructure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}
 
B) Sample to create structure hierarchy:
{
  "projectId": "3904db18-cf1a-4665-9c2b-152b84293259",
  "name": "Status structure",
  "description": "Status of the project (enumeration)",
  "type": "mainStructure2",
  "nr": 0,
  "id": "ee209608-19b1-40da-a089-53b20a858d41",
  "structuretypeid": "14c1ca64-4001-438f-a2f6-77ca951c488d",


  "children": [
    {
      "structuretypeid": "14c1ca64-4001-438f-a2f6-77ca951c488d",
      "children": [],
      "elements": [],
      "parentId": "ee209608-19b1-40da-a089-53b20a858d41",
      "name": "Undefined",
      "description": "0",
      "type": "mainStructure2",
      "nr": 0,
      "id": "40da49c5-3f3a-4e12-a4f8-94fb829c7c1e"
    },
    {
      "structuretypeid": "14c1ca64-4001-438f-a2f6-77ca951c488d

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": "TestStructure",
      "descriptionchildren": "FullLifeCycleTest"[],
      "typeelements": "CostStructure"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
[],
      "parentId": "622272daee209608-f1ff19b1-45ab40da-a3f0a089-c8f1255c80e853b20a858d41",
      "name": "TestStructurein planning stage",
      "description": "FullLifeCycleTest1",
      "type": "CostStructuremainStructure2",
      "nr": 10,
      "colorid": 0"ecf9c518-1e24-4706-8557-d29d75fb7ddc"
    },
    ......
  ],

  "idelements": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}[]
}

Anchor

	getStructureDetails
	getStructureDetails

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 40

New Version 41

Key