Versions Compared

Key

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

...

Deck of Cards
idbimcreateStructure


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

URLhttps://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

typeoptionalstringType of the structure (eg: costStructure, specificationStructure)
nrwill be ignoredintegerThe index of the structure
coloroptionalintegerColor of the structure
idwill be ignoredstring(guid)Unique guid of the structure
startDateoptionalstring (date)Start date ( depends on type of structure )
endDateoptionalstring (date)End date ( depends on type of structure )
attributeIdoptionalstring(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.

variantTypeoptionalstring(guid)Variant Type Id to whom the object will be assigned.
Used only when attributeId is defined.



Card
labelHTTP Method
 POST


Card
labelDescription

 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
labelRequest


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


Code Block
borderColorRed
langxml
titleJSON
  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
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
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",
      "children": [],
      "elements": [],
      "parentId": "ee209608-19b1-40da-a089-53b20a858d41",
      "name": "in planning stage",
      "description": "1",
      "type": "mainStructure2",
      "nr": 0,
      "id": "ecf9c518-1e24-4706-8557-d29d75fb7ddc"
    },
    ......
  ],

  "elements": []
}



...

Deck of Cards
idbimRemoveAssignedObject


Card
labelUrl / Resource

Resource: structures/<structureElement_id>/delete/<object_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/structures/<structureElement_id>/delete/<object_id> 

Example: https://api-stage.bimplus.net/v2/bimplus/structures/35b986c2-e9cd-482e-9281-6000671a49f0/delete/df4a81d6-42fb-4187-bbce-82a2fc093b2f



Card
labelHttpMethod

 DELETE


Card
labelresponse

HttpStatusCode.OK


...

Deck of Cards
idbimDeleteStructure


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: structures/<structure_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/db540336-47a3-426e-b3bf-1e532bfac8ea

JSON Structure

Name

Mandatory / Optional

Type

Description

parentId

optional

string(guid)

Parent node id of the structure (for the first structure, projectId is the parentId)

name

optional

string

Name of the structure

description

optional

string

Description of the structure

typeoptionalstringType of the structure (eg: costStructure, specificationStructure)
nroptionalintegerThe index of the structure
coloroptionalintegerColor of the structure
idwill be ignoredstring(guid)Unique guid of the structure


Optional query parameters

NameTypeDefault valueDescription
forceDeletestring(boolean)false

if true delete also all attachments which are under structure and are not lock, if under structure are locked document return 207 and delete just 

not locked document and structure.

deleteAllstring (boolean)falseif true delete also all attachments which are under structure and are not lock, if under structure are locked document return forbidden.



Card
labelHTTP Method
 DELETE


Card
labelDescription
 Deletes a specified structure.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



...

Deck of Cards
idbimDownloadStructureAttachments


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: structures/<structure_id>/downloadattachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/downloadattachments

Examplehttps://api-stage.bimplus.net/v2/bimplus/structures/db540336-47a3-426e-b3bf-1e532bfac8ea/downloadattachments


Card
labelHTTP Method
 GET


Card
labelDescription

Downloads all attachments assigned to the required structure node including all children.

Downloaded content is a compressed zip file. The directory structure in downloaded zip file reflects hierarchy of the structure nodes where structure names represent folder names. As a attachment name are used original filenames of the attachments.
The requested attachment types includede included in result zip file can be defined in query parameters.
e..g. https://api-stage.bimplus.net/v2/bimplus/structures/db540336-47a3-426e-b3bf-1e532bfac8ea/downloadattachments?attachmentType=AllplanLayout&attachmentType=AllplanDrawing
When query parameter is missing will be returned all attachments of the structure node tree.

More about attachmentType can be found here Filter for getting project-only attachments & attachments that belong to a particular attachment-type

Details about created attachments can be found in 4.4 Object service, e.g. Create a new attachment in the object or in 4.8 Attachment Service
If there are not any attachments in required structure tree the return code is 404 Not Found.


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

The response format is application/octet-stream.


...

Deck of Cards
idbimCreateVariant


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

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

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

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the variant type

description

optional

string

Description of the variant type

idwill be ignoredstring(guid)Unique guid of the variant type



Card
labelHTTP Method
 POST


Card
labelDescription
 Create a new variant type of defined structure(eg: cost structure, specification structure) under a project


Card
labelRequest


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


Code Block
borderColorRed
langxml
titleJSON
{
    "name": "TestVariant type",
    "description": "Description of the Test variant type"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
{
  "name": "TestVariant type",
  "description": "Description of the Test variant type",
  "id": "733e429a-e232-4e5d-a41e-9bd50aa9763c"
}



...