BIM Property File Objects

Version:

List BIM Property File Objects

GET /rest/v1.0/bim_property_files/{id}/objects

Description

Lists objects from a specific BIM Property File.
A BIM Property File is a resource that represents a 3d-model database. For models published to the Models tool, the property file id can be found in BIM Model Revision object_definition -> id. For models uploaded and extracted with Procore Documents, the property file id can be found in BIM File Extraction extraction_items -> artifact -> properties -> id.

Header Parameters

Procore-Company-Idinteger*

Unique company identifier associated with the Procore User Account.

Path Parameters

idinteger*

BIM Property File ID.

Query Parameters

project_idinteger*

Unique identifier for the project.

pageinteger

Page

per_pageinteger

Elements per page

object_search_idinteger

Object search id

filters[id]array[integer]

Return item(s) with the specified IDs.

filters[query]string

Filter item(s) containing query. Searchable fields include Object Value

Example Requests

1const request = require('request');
2
3const options = {
4  method: 'GET',
5  url: 'https://api.procore.com/rest/v1.0/bim_property_files/%7Bid%7D/objects',
6  qs: {
7    project_id: 'SOME_INTEGER_VALUE',
8    page: 'SOME_INTEGER_VALUE',
9    per_page: 'SOME_INTEGER_VALUE',
10    object_search_id: 'SOME_INTEGER_VALUE',
11    'filters[id]': 'SOME_ARRAY_VALUE',
12    'filters[query]': 'SOME_STRING_VALUE'
13  }
14};
15
16request(options, function (error, response, body) {
17  if (error) throw new Error(error);
18
19  console.log(body);
20});
21

Responses

Body

idinteger

valuestring

Value

Example Response

1[
2  {
3    "id": 19,
4    "value": "A_Interior_1001_SBA_Hexa.nwd"
5  }
6]