# bimdata.BcfApi All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**createComment**](BcfApi.md#createComment) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments | Create a comment [**createExtensionLabel**](BcfApi.md#createExtensionLabel) | **POST** /bcf/2.1/projects/{projects_pk}/extension/label | Create a Label [**createExtensionPriority**](BcfApi.md#createExtensionPriority) | **POST** /bcf/2.1/projects/{projects_pk}/extension/priority | Create a Priority [**createExtensionStage**](BcfApi.md#createExtensionStage) | **POST** /bcf/2.1/projects/{projects_pk}/extension/stage | Create a Stage [**createExtensionStatus**](BcfApi.md#createExtensionStatus) | **POST** /bcf/2.1/projects/{projects_pk}/extension/status | Create a TopicStatus [**createExtensionType**](BcfApi.md#createExtensionType) | **POST** /bcf/2.1/projects/{projects_pk}/extension/type | Create a TopicType [**createFullTopic**](BcfApi.md#createFullTopic) | **POST** /bcf/2.1/projects/{projects_pk}/full-topic | Create a Topic with viewpoints and comments [**createPin**](BcfApi.md#createPin) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin | Create a Pin [**createTopic**](BcfApi.md#createTopic) | **POST** /bcf/2.1/projects/{projects_pk}/topics | Create a topic [**createViewpoint**](BcfApi.md#createViewpoint) | **POST** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints | Create a Viewpoint [**deleteComment**](BcfApi.md#deleteComment) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Delete a comment [**deleteExtensionLabel**](BcfApi.md#deleteExtensionLabel) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/label/{id} | Delete a Label [**deleteExtensionPriority**](BcfApi.md#deleteExtensionPriority) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/priority/{id} | Delete a Priority [**deleteExtensionStage**](BcfApi.md#deleteExtensionStage) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/stage/{id} | Delete a Stage [**deleteExtensionStatus**](BcfApi.md#deleteExtensionStatus) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/status/{id} | Delete a TopicStatus [**deleteExtensionType**](BcfApi.md#deleteExtensionType) | **DELETE** /bcf/2.1/projects/{projects_pk}/extension/type/{id} | Delete a TopicType [**deletePin**](BcfApi.md#deletePin) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Delete a Pin [**deleteTopic**](BcfApi.md#deleteTopic) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Delete a topic [**deleteViewpoint**](BcfApi.md#deleteViewpoint) | **DELETE** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Delete a Viewpoint [**downloadBcfExport**](BcfApi.md#downloadBcfExport) | **GET** /bcf/2.1/projects/{id}/export | Export project's topics in bcf-xml format [**downloadBcfExportXlsx**](BcfApi.md#downloadBcfExportXlsx) | **GET** /bcf/2.1/projects/{id}/export-xlsx | Export project's topics in excel format [**fullUpdateBcfProject**](BcfApi.md#fullUpdateBcfProject) | **PUT** /bcf/2.1/projects/{id} | Update all fields of a BCF project [**fullUpdateComment**](BcfApi.md#fullUpdateComment) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Update all fields of a comment [**fullUpdateFullTopic**](BcfApi.md#fullUpdateFullTopic) | **PUT** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update all fields of a topic [**fullUpdatePin**](BcfApi.md#fullUpdatePin) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Update all fields of a Pin [**fullUpdateTopic**](BcfApi.md#fullUpdateTopic) | **PUT** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update all fields of a topic [**getAuth**](BcfApi.md#getAuth) | **GET** /bcf/2.1/auth | Retrieve Authentication Information [**getBcfProject**](BcfApi.md#getBcfProject) | **GET** /bcf/2.1/projects/{id} | Retrieve a BCF project [**getBcfProjects**](BcfApi.md#getBcfProjects) | **GET** /bcf/2.1/projects | Retrieve all BCF projects [**getColorings**](BcfApi.md#getColorings) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/coloring | Retrieve all colorings of a viewpoint [**getComment**](BcfApi.md#getComment) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Retrieve a comment [**getComments**](BcfApi.md#getComments) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments | Retrieve all comments [**getDetailedExtensions**](BcfApi.md#getDetailedExtensions) | **GET** /bcf/2.1/projects/{id}/detailed-extensions | Retrieve project detailed extensions [**getExtensions**](BcfApi.md#getExtensions) | **GET** /bcf/2.1/projects/{id}/extensions | Retrieve project extensions [**getFullTopic**](BcfApi.md#getFullTopic) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Retrieve a full topic [**getFullTopics**](BcfApi.md#getFullTopics) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic | Retrieve all full topics [**getPins**](BcfApi.md#getPins) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin | Retrieve all Pins of a viewpoint [**getRelatedTopics**](BcfApi.md#getRelatedTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/related_topics | Get all related topics [**getSelections**](BcfApi.md#getSelections) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selection | Retrieve all selections of a viewpoint [**getSnapshot**](BcfApi.md#getSnapshot) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshot | Retrieve the viewpoint' snapshot [**getTopic**](BcfApi.md#getTopic) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Retrieve a topic [**getTopicDocumentReferences**](BcfApi.md#getTopicDocumentReferences) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Get all related documents [**getTopicViewpoints**](BcfApi.md#getTopicViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic [**getTopics**](BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics [**getUser**](BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info [**getVersions**](BcfApi.md#getVersions) | **GET** /bcf/versions | Retrieve all supported BCF versions by this API [**getViewpoinPin**](BcfApi.md#getViewpoinPin) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Retrieve a Pin [**getViewpoint**](BcfApi.md#getViewpoint) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Retrieve a Viewpoint [**getViewpoints**](BcfApi.md#getViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints | Retrieve all Viewpoints of a topic [**getVisibilities**](BcfApi.md#getVisibilities) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/visibility | Retrieve all visibilities of a viewpoint [**importBcf**](BcfApi.md#importBcf) | **POST** /bcf/2.1/projects/{id}/import | Import bcf-xml format into this project [**updateBcfProject**](BcfApi.md#updateBcfProject) | **PATCH** /bcf/2.1/projects/{id} | Update some fields of a BCF project [**updateComment**](BcfApi.md#updateComment) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/comments/{guid} | Update some fields of a comment [**updateExtensionLabel**](BcfApi.md#updateExtensionLabel) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/label/{id} | Update a Label [**updateExtensionPriority**](BcfApi.md#updateExtensionPriority) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/priority/{id} | Update a Priority [**updateExtensionStage**](BcfApi.md#updateExtensionStage) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/stage/{id} | Update a Stage [**updateExtensionStatus**](BcfApi.md#updateExtensionStatus) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/status/{id} | Update a TopicStatus [**updateExtensionType**](BcfApi.md#updateExtensionType) | **PATCH** /bcf/2.1/projects/{projects_pk}/extension/type/{id} | Update a TopicType [**updateFullTopic**](BcfApi.md#updateFullTopic) | **PATCH** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Update some fields of a topic [**updatePin**](BcfApi.md#updatePin) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{viewpoints_guid}/pin/{guid} | Update some fields of a Pin [**updateTopic**](BcfApi.md#updateTopic) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Update some fields of a topic [**updateViewpoint**](BcfApi.md#updateViewpoint) | **PATCH** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid} | Update some fields of a Viewpoint ## createComment > Comment createComment(projectsPk, topicsGuid, opts) Create a comment Create a comment Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | A unique integer value identifying this project. let topicsGuid = "topicsGuid_example"; // String | let opts = { 'commentRequest': new bimdata.CommentRequest() // CommentRequest | }; apiInstance.createComment(projectsPk, topicsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| A unique integer value identifying this project. | **topicsGuid** | **String**| | **commentRequest** | [**CommentRequest**](CommentRequest.md)| | [optional] ### Return type [**Comment**](Comment.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createExtensionLabel > Label createExtensionLabel(projectsPk, labelRequest) Create a Label This is not a standard route. Create a Label available for the project Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let labelRequest = new bimdata.LabelRequest(); // LabelRequest | apiInstance.createExtensionLabel(projectsPk, labelRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **labelRequest** | [**LabelRequest**](LabelRequest.md)| | ### Return type [**Label**](Label.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createExtensionPriority > Priority createExtensionPriority(projectsPk, priorityRequest) Create a Priority This is not a standard route. Create a Priority available for the project Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let priorityRequest = new bimdata.PriorityRequest(); // PriorityRequest | apiInstance.createExtensionPriority(projectsPk, priorityRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **priorityRequest** | [**PriorityRequest**](PriorityRequest.md)| | ### Return type [**Priority**](Priority.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createExtensionStage > Stage createExtensionStage(projectsPk, stageRequest) Create a Stage This is not a standard route. Create a Stage available for the project Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let stageRequest = new bimdata.StageRequest(); // StageRequest | apiInstance.createExtensionStage(projectsPk, stageRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **stageRequest** | [**StageRequest**](StageRequest.md)| | ### Return type [**Stage**](Stage.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createExtensionStatus > TopicStatus createExtensionStatus(projectsPk, topicStatusRequest) Create a TopicStatus This is not a standard route. Create a TopicStatus available for the project Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let topicStatusRequest = new bimdata.TopicStatusRequest(); // TopicStatusRequest | apiInstance.createExtensionStatus(projectsPk, topicStatusRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **topicStatusRequest** | [**TopicStatusRequest**](TopicStatusRequest.md)| | ### Return type [**TopicStatus**](TopicStatus.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createExtensionType > TopicType createExtensionType(projectsPk, topicTypeRequest) Create a TopicType This is not a standard route. Create a TopicType available for the project Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let topicTypeRequest = new bimdata.TopicTypeRequest(); // TopicTypeRequest | apiInstance.createExtensionType(projectsPk, topicTypeRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **topicTypeRequest** | [**TopicTypeRequest**](TopicTypeRequest.md)| | ### Return type [**TopicType**](TopicType.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createFullTopic > FullTopic createFullTopic(projectsPk, fullTopicRequest, opts) Create a Topic with viewpoints and comments This is not a standard route. You can send a topic, viewpoints and comments in a single call Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let fullTopicRequest = new bimdata.FullTopicRequest(); // FullTopicRequest | let opts = { 'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64 }; apiInstance.createFullTopic(projectsPk, fullTopicRequest, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **fullTopicRequest** | [**FullTopicRequest**](FullTopicRequest.md)| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] ### Return type [**FullTopic**](FullTopic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createPin > Pin createPin(projectsPk, topicsGuid, viewpointsGuid, pinRequest) Create a Pin This is not a standard route. Create a Pin Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let viewpointsGuid = "viewpointsGuid_example"; // String | let pinRequest = new bimdata.PinRequest(); // PinRequest | apiInstance.createPin(projectsPk, topicsGuid, viewpointsGuid, pinRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **topicsGuid** | **String**| | **viewpointsGuid** | **String**| | **pinRequest** | [**PinRequest**](PinRequest.md)| | ### Return type [**Pin**](Pin.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createTopic > Topic createTopic(projectsPk, topicRequest) Create a topic Create a topic Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let topicRequest = new bimdata.TopicRequest(); // TopicRequest | apiInstance.createTopic(projectsPk, topicRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **topicRequest** | [**TopicRequest**](TopicRequest.md)| | ### Return type [**Topic**](Topic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## createViewpoint > Viewpoint createViewpoint(projectsPk, topicsGuid, opts) Create a Viewpoint Create a Viewpoint Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let opts = { 'imgFormat': "imgFormat_example", // String | All snapshot_data will be returned as url instead of base64 'viewpointRequest': new bimdata.ViewpointRequest() // ViewpointRequest | }; apiInstance.createViewpoint(projectsPk, topicsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **topicsGuid** | **String**| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] **viewpointRequest** | [**ViewpointRequest**](ViewpointRequest.md)| | [optional] ### Return type [**Viewpoint**](Viewpoint.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## deleteComment > deleteComment(guid, projectsPk, topicsGuid) Delete a comment Delete a comment Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | A unique integer value identifying this project. let topicsGuid = "topicsGuid_example"; // String | apiInstance.deleteComment(guid, projectsPk, topicsGuid).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| A unique integer value identifying this project. | **topicsGuid** | **String**| | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deleteExtensionLabel > deleteExtensionLabel(id, projectsPk) Delete a Label This is not a standard route. Delete a Label. Topics using this label won't be deleted Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this label. let projectsPk = 56; // Number | apiInstance.deleteExtensionLabel(id, projectsPk).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this label. | **projectsPk** | **Number**| | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deleteExtensionPriority > deleteExtensionPriority(id, projectsPk) Delete a Priority This is not a standard route. Delete a Priority. Topics using this priority won't be deleted Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this priority. let projectsPk = 56; // Number | apiInstance.deleteExtensionPriority(id, projectsPk).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this priority. | **projectsPk** | **Number**| | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deleteExtensionStage > deleteExtensionStage(id, projectsPk) Delete a Stage This is not a standard route. Delete a Stage. Topics using this stage won't be deleted Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this stage. let projectsPk = 56; // Number | apiInstance.deleteExtensionStage(id, projectsPk).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this stage. | **projectsPk** | **Number**| | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deleteExtensionStatus > deleteExtensionStatus(id, projectsPk) Delete a TopicStatus This is not a standard route. Delete a TopicStatus. Topics using this status won't be deleted Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this topic status. let projectsPk = 56; // Number | apiInstance.deleteExtensionStatus(id, projectsPk).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this topic status. | **projectsPk** | **Number**| | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deleteExtensionType > deleteExtensionType(id, projectsPk) Delete a TopicType This is not a standard route. Delete a TopicType. Topics using this type won't be deleted Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this topic type. let projectsPk = 56; // Number | apiInstance.deleteExtensionType(id, projectsPk).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this topic type. | **projectsPk** | **Number**| | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deletePin > deletePin(guid, projectsPk, topicsGuid, viewpointsGuid) Delete a Pin This is not a standard route. Delete a Pin Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let viewpointsGuid = "viewpointsGuid_example"; // String | apiInstance.deletePin(guid, projectsPk, topicsGuid, viewpointsGuid).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | **viewpointsGuid** | **String**| | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deleteTopic > deleteTopic(guid, projectsPk) Delete a topic Delete a topic Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | apiInstance.deleteTopic(guid, projectsPk).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deleteViewpoint > deleteViewpoint(guid, projectsPk, topicsGuid, opts) Delete a Viewpoint This is not a standard route. Delete a Viewpoint Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let opts = { 'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64 }; apiInstance.deleteViewpoint(guid, projectsPk, topicsGuid, opts).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## downloadBcfExport > File downloadBcfExport(id, opts) Export project's topics in bcf-xml format This is not a standard route. Export project's topics in bcf-xml format Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this project. let opts = { 'format': "format_example", // String | topic format to export, comma separated. Default = standard 'topics': "topics_example" // String | topic guids to export, comma separated. Default = all }; apiInstance.downloadBcfExport(id, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this project. | **format** | **String**| topic format to export, comma separated. Default = standard | [optional] **topics** | **String**| topic guids to export, comma separated. Default = all | [optional] ### Return type **File** ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## downloadBcfExportXlsx > File downloadBcfExportXlsx(id, opts) Export project's topics in excel format This is not a standard route. Export project's topics in excel format Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this project. let opts = { 'format': "format_example", // String | topic format to export, comma separated. Default = standard 'locale': "locale_example", // String | Locale of the exported file. Available locales are 'en' and 'fr'. If set locale is not supported, 'en' will be used 'topics': "topics_example" // String | topic guids to export, comma separated. Default = all }; apiInstance.downloadBcfExportXlsx(id, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this project. | **format** | **String**| topic format to export, comma separated. Default = standard | [optional] **locale** | **String**| Locale of the exported file. Available locales are 'en' and 'fr'. If set locale is not supported, 'en' will be used | [optional] **topics** | **String**| topic guids to export, comma separated. Default = all | [optional] ### Return type **File** ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## fullUpdateBcfProject > BcfProject fullUpdateBcfProject(id, bcfProjectRequest) Update all fields of a BCF project Update all fields of a BCF project Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this project. let bcfProjectRequest = new bimdata.BcfProjectRequest(); // BcfProjectRequest | apiInstance.fullUpdateBcfProject(id, bcfProjectRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this project. | **bcfProjectRequest** | [**BcfProjectRequest**](BcfProjectRequest.md)| | ### Return type [**BcfProject**](BcfProject.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## fullUpdateComment > Comment fullUpdateComment(guid, projectsPk, topicsGuid, opts) Update all fields of a comment Update all fields of a comment Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | A unique integer value identifying this project. let topicsGuid = "topicsGuid_example"; // String | let opts = { 'commentRequest': new bimdata.CommentRequest() // CommentRequest | }; apiInstance.fullUpdateComment(guid, projectsPk, topicsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| A unique integer value identifying this project. | **topicsGuid** | **String**| | **commentRequest** | [**CommentRequest**](CommentRequest.md)| | [optional] ### Return type [**Comment**](Comment.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## fullUpdateFullTopic > FullTopic fullUpdateFullTopic(guid, projectsPk, fullTopicRequest, opts) Update all fields of a topic This is not a standard route. You can update topic, viewpoints and comment is a signle call Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let fullTopicRequest = new bimdata.FullTopicRequest(); // FullTopicRequest | let opts = { 'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64 }; apiInstance.fullUpdateFullTopic(guid, projectsPk, fullTopicRequest, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **fullTopicRequest** | [**FullTopicRequest**](FullTopicRequest.md)| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] ### Return type [**FullTopic**](FullTopic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## fullUpdatePin > Pin fullUpdatePin(guid, projectsPk, topicsGuid, viewpointsGuid, pinRequest) Update all fields of a Pin This is not a standard route. Update all fields of a Pin Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let viewpointsGuid = "viewpointsGuid_example"; // String | let pinRequest = new bimdata.PinRequest(); // PinRequest | apiInstance.fullUpdatePin(guid, projectsPk, topicsGuid, viewpointsGuid, pinRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | **viewpointsGuid** | **String**| | **pinRequest** | [**PinRequest**](PinRequest.md)| | ### Return type [**Pin**](Pin.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## fullUpdateTopic > Topic fullUpdateTopic(guid, projectsPk, topicRequest) Update all fields of a topic Update all fields of a topic Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicRequest = new bimdata.TopicRequest(); // TopicRequest | apiInstance.fullUpdateTopic(guid, projectsPk, topicRequest).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicRequest** | [**TopicRequest**](TopicRequest.md)| | ### Return type [**Topic**](Topic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## getAuth > [Auth] getAuth() Retrieve Authentication Information oauth2_dynamic_client_reg_url is not supported, http_basic_supported is always set to false, ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); apiInstance.getAuth().then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters This endpoint does not need any parameter. ### Return type [**[Auth]**](Auth.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getBcfProject > BcfProject getBcfProject(id) Retrieve a BCF project Retrieve a BCF project Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this project. apiInstance.getBcfProject(id).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this project. | ### Return type [**BcfProject**](BcfProject.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getBcfProjects > [BcfProject] getBcfProjects() Retrieve all BCF projects Retrieve all BCF projects Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); apiInstance.getBcfProjects().then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters This endpoint does not need any parameter. ### Return type [**[BcfProject]**](BcfProject.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getColorings > [Coloring] getColorings(guid, projectsPk, topicsGuid) Retrieve all colorings of a viewpoint Retrieve all colorings of a viewpoint Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | apiInstance.getColorings(guid, projectsPk, topicsGuid).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | ### Return type [**[Coloring]**](Coloring.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getComment > Comment getComment(guid, projectsPk, topicsGuid) Retrieve a comment Retrieve a comment Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | A unique integer value identifying this project. let topicsGuid = "topicsGuid_example"; // String | apiInstance.getComment(guid, projectsPk, topicsGuid).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| A unique integer value identifying this project. | **topicsGuid** | **String**| | ### Return type [**Comment**](Comment.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getComments > [Comment] getComments(projectsPk, topicsGuid) Retrieve all comments Retrieve all comments Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | A unique integer value identifying this project. let topicsGuid = "topicsGuid_example"; // String | apiInstance.getComments(projectsPk, topicsGuid).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| A unique integer value identifying this project. | **topicsGuid** | **String**| | ### Return type [**[Comment]**](Comment.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getDetailedExtensions > DetailedExtensions getDetailedExtensions(id) Retrieve project detailed extensions This is not a standard route. Retrieve project detailed extensions Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this project. apiInstance.getDetailedExtensions(id).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this project. | ### Return type [**DetailedExtensions**](DetailedExtensions.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getExtensions > Extensions getExtensions(id) Retrieve project extensions Retrieve project extensions Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this project. apiInstance.getExtensions(id).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this project. | ### Return type [**Extensions**](Extensions.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getFullTopic > FullTopic getFullTopic(guid, projectsPk, opts) Retrieve a full topic This is not a standard route. It responds with a topic, its viewpoints and its comments Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let opts = { 'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64 }; apiInstance.getFullTopic(guid, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] ### Return type [**FullTopic**](FullTopic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getFullTopics > [FullTopic] getFullTopics(projectsPk, opts) Retrieve all full topics This is not a standard route. It responds with all topics, their viewpoints and their comments Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let opts = { 'format': "format_example", // String | 'ifcs': [null], // [Number] | 'imgFormat': "imgFormat_example", // String | All snapshot_data will be returned as url instead of base64 'models': [null] // [Number] | }; apiInstance.getFullTopics(projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **format** | **String**| | [optional] **ifcs** | [**[Number]**](Number.md)| | [optional] **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] **models** | [**[Number]**](Number.md)| | [optional] ### Return type [**[FullTopic]**](FullTopic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getPins > [Pin] getPins(projectsPk, topicsGuid, viewpointsGuid) Retrieve all Pins of a viewpoint This is not a standard route. Retrieve all Pins of a viewpoint Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let viewpointsGuid = "viewpointsGuid_example"; // String | apiInstance.getPins(projectsPk, topicsGuid, viewpointsGuid).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **topicsGuid** | **String**| | **viewpointsGuid** | **String**| | ### Return type [**[Pin]**](Pin.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getRelatedTopics > [String] getRelatedTopics(guid, projectsPk, opts) Get all related topics This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let opts = { 'format': "format_example", // String | 'ifcs': [null], // [Number] | 'models': [null] // [Number] | }; apiInstance.getRelatedTopics(guid, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **format** | **String**| | [optional] **ifcs** | [**[Number]**](Number.md)| | [optional] **models** | [**[Number]**](Number.md)| | [optional] ### Return type **[String]** ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getSelections > [Component] getSelections(guid, projectsPk, topicsGuid) Retrieve all selections of a viewpoint Retrieve all selections of a viewpoint Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | apiInstance.getSelections(guid, projectsPk, topicsGuid).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | ### Return type [**[Component]**](Component.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getSnapshot > File getSnapshot(guid, projectsPk, topicsGuid) Retrieve the viewpoint' snapshot Retrieve the viewpoint' snapshot Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | apiInstance.getSnapshot(guid, projectsPk, topicsGuid).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | ### Return type **File** ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getTopic > Topic getTopic(guid, projectsPk) Retrieve a topic Retrieve a topic Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | apiInstance.getTopic(guid, projectsPk).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | ### Return type [**Topic**](Topic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getTopicDocumentReferences > [String] getTopicDocumentReferences(guid, projectsPk, opts) Get all related documents This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let opts = { 'format': "format_example", // String | 'ifcs': [null], // [Number] | 'models': [null] // [Number] | }; apiInstance.getTopicDocumentReferences(guid, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **format** | **String**| | [optional] **ifcs** | [**[Number]**](Number.md)| | [optional] **models** | [**[Number]**](Number.md)| | [optional] ### Return type **[String]** ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getTopicViewpoints > [Viewpoint] getTopicViewpoints(projectsPk, topicsGuid, opts) Retrieve all viewpoints attached to the topic This is not a standard route. It returns all viewpoints of the topic that are not attached to a comment. Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let opts = { 'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64 }; apiInstance.getTopicViewpoints(projectsPk, topicsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **topicsGuid** | **String**| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] ### Return type [**[Viewpoint]**](Viewpoint.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getTopics > [Topic] getTopics(projectsPk, opts) Retrieve all topics Retrieve all topics Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let opts = { 'format': "format_example", // String | 'ifcs': [null], // [Number] | 'models': [null] // [Number] | }; apiInstance.getTopics(projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **format** | **String**| | [optional] **ifcs** | [**[Number]**](Number.md)| | [optional] **models** | [**[Number]**](Number.md)| | [optional] ### Return type [**[Topic]**](Topic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getUser > SelfBcfUser getUser() Get current user info Get current user info. If request comes from an App, the response is always:{ \"id\": None, \"name\": None, \"is_client\": True,} Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); apiInstance.getUser().then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters This endpoint does not need any parameter. ### Return type [**SelfBcfUser**](SelfBcfUser.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getVersions > [Version] getVersions() Retrieve all supported BCF versions by this API Spoiler: it's only v2.1 ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); apiInstance.getVersions().then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters This endpoint does not need any parameter. ### Return type [**[Version]**](Version.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getViewpoinPin > Pin getViewpoinPin(guid, projectsPk, topicsGuid, viewpointsGuid) Retrieve a Pin This is not a standard route. Retrieve a Pin Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let viewpointsGuid = "viewpointsGuid_example"; // String | apiInstance.getViewpoinPin(guid, projectsPk, topicsGuid, viewpointsGuid).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | **viewpointsGuid** | **String**| | ### Return type [**Pin**](Pin.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getViewpoint > Viewpoint getViewpoint(guid, projectsPk, topicsGuid, opts) Retrieve a Viewpoint Retrieve a Viewpoint Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let opts = { 'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64 }; apiInstance.getViewpoint(guid, projectsPk, topicsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] ### Return type [**Viewpoint**](Viewpoint.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getViewpoints > [Viewpoint] getViewpoints(projectsPk, topicsGuid, opts) Retrieve all Viewpoints of a topic Retrieve all Viewpoints of a topic Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let opts = { 'imgFormat': "imgFormat_example" // String | All snapshot_data will be returned as url instead of base64 }; apiInstance.getViewpoints(projectsPk, topicsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **projectsPk** | **Number**| | **topicsGuid** | **String**| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] ### Return type [**[Viewpoint]**](Viewpoint.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getVisibilities > Visibility getVisibilities(guid, projectsPk, topicsGuid) Retrieve all visibilities of a viewpoint Retrieve all visibilities of a viewpoint Required scopes: bcf:read ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | apiInstance.getVisibilities(guid, projectsPk, topicsGuid).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | ### Return type [**Visibility**](Visibility.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## importBcf > importBcf(id, name) Import bcf-xml format into this project This is not a standard route. Import bcf-xml format into this project. If there are guid conflict, an error will be raised. If there are index conflicts, indexes of the imported file will be overriden with a new index. Author and assigned_to fields will be linked to existing users in the project. If no matching user are found, fields will be emptied. Only BCF 2.1 is supported Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this project. let name = "name_example"; // String | Name of the project apiInstance.importBcf(id, name).then(() => { console.log('API called successfully.'); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this project. | **name** | **String**| Name of the project | ### Return type null (empty response body) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded - **Accept**: Not defined ## updateBcfProject > BcfProject updateBcfProject(id, opts) Update some fields of a BCF project Update some fields of a BCF project Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this project. let opts = { 'patchedBcfProjectRequest': new bimdata.PatchedBcfProjectRequest() // PatchedBcfProjectRequest | }; apiInstance.updateBcfProject(id, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this project. | **patchedBcfProjectRequest** | [**PatchedBcfProjectRequest**](PatchedBcfProjectRequest.md)| | [optional] ### Return type [**BcfProject**](BcfProject.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateComment > Comment updateComment(guid, projectsPk, topicsGuid, opts) Update some fields of a comment Update some fields of a comment Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | A unique integer value identifying this project. let topicsGuid = "topicsGuid_example"; // String | let opts = { 'patchedCommentRequest': new bimdata.PatchedCommentRequest() // PatchedCommentRequest | }; apiInstance.updateComment(guid, projectsPk, topicsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| A unique integer value identifying this project. | **topicsGuid** | **String**| | **patchedCommentRequest** | [**PatchedCommentRequest**](PatchedCommentRequest.md)| | [optional] ### Return type [**Comment**](Comment.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateExtensionLabel > Label updateExtensionLabel(id, projectsPk, opts) Update a Label This is not a standard route. Update a Label. All topics using this label will be updated Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this label. let projectsPk = 56; // Number | let opts = { 'patchedLabelRequest': new bimdata.PatchedLabelRequest() // PatchedLabelRequest | }; apiInstance.updateExtensionLabel(id, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this label. | **projectsPk** | **Number**| | **patchedLabelRequest** | [**PatchedLabelRequest**](PatchedLabelRequest.md)| | [optional] ### Return type [**Label**](Label.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateExtensionPriority > Priority updateExtensionPriority(id, projectsPk, opts) Update a Priority This is not a standard route. Update a Priority. All topics using this priority will be updated Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this priority. let projectsPk = 56; // Number | let opts = { 'patchedPriorityRequest': new bimdata.PatchedPriorityRequest() // PatchedPriorityRequest | }; apiInstance.updateExtensionPriority(id, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this priority. | **projectsPk** | **Number**| | **patchedPriorityRequest** | [**PatchedPriorityRequest**](PatchedPriorityRequest.md)| | [optional] ### Return type [**Priority**](Priority.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateExtensionStage > Stage updateExtensionStage(id, projectsPk, opts) Update a Stage This is not a standard route. Update a Stage. All topics using this stage will be updated Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this stage. let projectsPk = 56; // Number | let opts = { 'patchedStageRequest': new bimdata.PatchedStageRequest() // PatchedStageRequest | }; apiInstance.updateExtensionStage(id, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this stage. | **projectsPk** | **Number**| | **patchedStageRequest** | [**PatchedStageRequest**](PatchedStageRequest.md)| | [optional] ### Return type [**Stage**](Stage.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateExtensionStatus > TopicStatus updateExtensionStatus(id, projectsPk, opts) Update a TopicStatus This is not a standard route. Update a TopicStatus. All topics using this status will be updated Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this topic status. let projectsPk = 56; // Number | let opts = { 'patchedTopicStatusRequest': new bimdata.PatchedTopicStatusRequest() // PatchedTopicStatusRequest | }; apiInstance.updateExtensionStatus(id, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this topic status. | **projectsPk** | **Number**| | **patchedTopicStatusRequest** | [**PatchedTopicStatusRequest**](PatchedTopicStatusRequest.md)| | [optional] ### Return type [**TopicStatus**](TopicStatus.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateExtensionType > TopicType updateExtensionType(id, projectsPk, opts) Update a TopicType This is not a standard route. Update a TopicType. All topics using this type will be updated Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let id = 56; // Number | A unique integer value identifying this topic type. let projectsPk = 56; // Number | let opts = { 'patchedTopicTypeRequest': new bimdata.PatchedTopicTypeRequest() // PatchedTopicTypeRequest | }; apiInstance.updateExtensionType(id, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Number**| A unique integer value identifying this topic type. | **projectsPk** | **Number**| | **patchedTopicTypeRequest** | [**PatchedTopicTypeRequest**](PatchedTopicTypeRequest.md)| | [optional] ### Return type [**TopicType**](TopicType.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateFullTopic > FullTopic updateFullTopic(guid, projectsPk, opts) Update some fields of a topic This is not a standard route. You can update topic, viewpoints and comment is a signle call Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let opts = { 'imgFormat': "imgFormat_example", // String | All snapshot_data will be returned as url instead of base64 'patchedFullTopicRequest': new bimdata.PatchedFullTopicRequest() // PatchedFullTopicRequest | }; apiInstance.updateFullTopic(guid, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] **patchedFullTopicRequest** | [**PatchedFullTopicRequest**](PatchedFullTopicRequest.md)| | [optional] ### Return type [**FullTopic**](FullTopic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updatePin > Pin updatePin(guid, projectsPk, topicsGuid, viewpointsGuid, opts) Update some fields of a Pin This is not a standard route. Update some fields of a Pin Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let viewpointsGuid = "viewpointsGuid_example"; // String | let opts = { 'patchedPinRequest': new bimdata.PatchedPinRequest() // PatchedPinRequest | }; apiInstance.updatePin(guid, projectsPk, topicsGuid, viewpointsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | **viewpointsGuid** | **String**| | **patchedPinRequest** | [**PatchedPinRequest**](PatchedPinRequest.md)| | [optional] ### Return type [**Pin**](Pin.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateTopic > Topic updateTopic(guid, projectsPk, opts) Update some fields of a topic Update some fields of a topic Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let opts = { 'patchedTopicRequest': new bimdata.PatchedTopicRequest() // PatchedTopicRequest | }; apiInstance.updateTopic(guid, projectsPk, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **patchedTopicRequest** | [**PatchedTopicRequest**](PatchedTopicRequest.md)| | [optional] ### Return type [**Topic**](Topic.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## updateViewpoint > Viewpoint updateViewpoint(guid, projectsPk, topicsGuid, opts) Update some fields of a Viewpoint This is not a standard route. Update some fields of a Viewpoint Required scopes: bcf:write ### Example ```javascript import bimdata from '@bimdata/bimdata-api-client'; let defaultClient = bimdata.ApiClient.instance; // Configure API key authorization: ApiKey let ApiKey = defaultClient.authentications['ApiKey']; ApiKey.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //ApiKey.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure OAuth2 access token for authorization: BIMData_Connect let BIMData_Connect = defaultClient.authentications['BIMData_Connect']; BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN'; // Configure API key authorization: Bearer let Bearer = defaultClient.authentications['Bearer']; Bearer.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Bearer.apiKeyPrefix = 'Token'; let apiInstance = new bimdata.BcfApi(); let guid = "guid_example"; // String | let projectsPk = 56; // Number | let topicsGuid = "topicsGuid_example"; // String | let opts = { 'imgFormat': "imgFormat_example", // String | All snapshot_data will be returned as url instead of base64 'patchedViewpointRequest': new bimdata.PatchedViewpointRequest() // PatchedViewpointRequest | }; apiInstance.updateViewpoint(guid, projectsPk, topicsGuid, opts).then((data) => { console.log('API called successfully. Returned data: ' + data); }, (error) => { console.error(error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **guid** | **String**| | **projectsPk** | **Number**| | **topicsGuid** | **String**| | **imgFormat** | **String**| All snapshot_data will be returned as url instead of base64 | [optional] **patchedViewpointRequest** | [**PatchedViewpointRequest**](PatchedViewpointRequest.md)| | [optional] ### Return type [**Viewpoint**](Viewpoint.md) ### Authorization [ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json