POST /rest/v1.0/bim_viewpoints/batch
Create a batch of BIM Viewpoints
Servers
- https://api.procore.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
bim_viewpoints[] |
Array | Yes |
An array of BIM Viewpoint payloads. Limited to 100 items per request |
bim_viewpoints[].visibility |
Object | No |
Object visibility settings |
bim_viewpoints[].visibility.exceptions |
Object | No |
Group of model objects represented as an array of object ids, or object ranges |
bim_viewpoints[].visibility.exceptions.object_ranges[] |
Array | No |
Array of object ranges. A range is an array containing two numbers, the first represents object id, the second represents the number of objects in the range. |
bim_viewpoints[].visibility.exceptions.object_ids[] |
Array | No |
Array of object ids |
bim_viewpoints[].visibility.default_visibility |
Boolean | No | |
bim_viewpoints[].bim_file_id |
Integer | Yes |
ID of a BIM File to be associated to the viewpoint |
bim_viewpoints[].sections_data |
String | No |
JSON string representation of sections applied to a 3d model as a set of clipping planes |
bim_viewpoints[].name |
String | No |
Viewpoint name |
bim_viewpoints[].upload_uuid |
String | Yes |
UUID of uploaded snapshot |
bim_viewpoints[].view_folder_id |
Integer | No |
ID of the BIM View Folder the viewpoint belongs to |
bim_viewpoints[].render_mode |
String | No |
Viewer render mode when viewpoint is applied Possible values:
|
bim_viewpoints[].camera_data |
String | Yes |
JSON string representation of camera position |
bim_viewpoints[].redlines_data |
String | No |
JSON string representation of markup |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.