Skip to content
This repository was archived by the owner on Nov 18, 2025. It is now read-only.

Commit 251c204

Browse files
committed
PATCH: add model.binary_2d_file field
1 parent 8a7a2d8 commit 251c204

19 files changed

+424
-13
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,11 @@ Class | Method | HTTP request | Description
174174
*bimdata.BcfApi* | [**getExtensions**](docs/BcfApi.md#getExtensions) | **GET** /bcf/2.1/projects/{id}/extensions | Retrieve project extensions
175175
*bimdata.BcfApi* | [**getFullTopic**](docs/BcfApi.md#getFullTopic) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Retrieve a full topic
176176
*bimdata.BcfApi* | [**getFullTopics**](docs/BcfApi.md#getFullTopics) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic | Retrieve all full topics
177+
*bimdata.BcfApi* | [**getRelatedTopics**](docs/BcfApi.md#getRelatedTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/related_topics | Get all related topics
177178
*bimdata.BcfApi* | [**getSelections**](docs/BcfApi.md#getSelections) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selection | Retrieve all selections of a viewpoint
178179
*bimdata.BcfApi* | [**getSnapshot**](docs/BcfApi.md#getSnapshot) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshot | Retrieve the viewpoint' snapshot
179180
*bimdata.BcfApi* | [**getTopic**](docs/BcfApi.md#getTopic) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Retrieve a topic
181+
*bimdata.BcfApi* | [**getTopicDocumentReferences**](docs/BcfApi.md#getTopicDocumentReferences) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Get all related documents
180182
*bimdata.BcfApi* | [**getTopicViewpoints**](docs/BcfApi.md#getTopicViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
181183
*bimdata.BcfApi* | [**getTopics**](docs/BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
182184
*bimdata.BcfApi* | [**getUser**](docs/BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info

docs/BcfApi.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,11 @@ Method | HTTP request | Description
3737
[**getExtensions**](BcfApi.md#getExtensions) | **GET** /bcf/2.1/projects/{id}/extensions | Retrieve project extensions
3838
[**getFullTopic**](BcfApi.md#getFullTopic) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic/{guid} | Retrieve a full topic
3939
[**getFullTopics**](BcfApi.md#getFullTopics) | **GET** /bcf/2.1/projects/{projects_pk}/full-topic | Retrieve all full topics
40+
[**getRelatedTopics**](BcfApi.md#getRelatedTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/related_topics | Get all related topics
4041
[**getSelections**](BcfApi.md#getSelections) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/selection | Retrieve all selections of a viewpoint
4142
[**getSnapshot**](BcfApi.md#getSnapshot) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/viewpoints/{guid}/snapshot | Retrieve the viewpoint' snapshot
4243
[**getTopic**](BcfApi.md#getTopic) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid} | Retrieve a topic
44+
[**getTopicDocumentReferences**](BcfApi.md#getTopicDocumentReferences) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references | Get all related documents
4345
[**getTopicViewpoints**](BcfApi.md#getTopicViewpoints) | **GET** /bcf/2.1/projects/{projects_pk}/topics/{topics_guid}/topic-viewpoints | Retrieve all viewpoints attached to the topic
4446
[**getTopics**](BcfApi.md#getTopics) | **GET** /bcf/2.1/projects/{projects_pk}/topics | Retrieve all topics
4547
[**getUser**](BcfApi.md#getUser) | **GET** /bcf/2.1/current-user | Get current user info
@@ -2204,6 +2206,77 @@ Name | Type | Description | Notes
22042206
- **Accept**: application/json
22052207

22062208

2209+
## getRelatedTopics
2210+
2211+
> [String] getRelatedTopics(guid, projectsPk, opts)
2212+
2213+
Get all related topics
2214+
2215+
This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read
2216+
2217+
### Example
2218+
2219+
```javascript
2220+
import bimdata from '@bimdata/bimdata-api-client';
2221+
let defaultClient = bimdata.ApiClient.instance;
2222+
// Configure API key authorization: ApiKey
2223+
let ApiKey = defaultClient.authentications['ApiKey'];
2224+
ApiKey.apiKey = 'YOUR API KEY';
2225+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2226+
//ApiKey.apiKeyPrefix = 'Token';
2227+
// Configure OAuth2 access token for authorization: BIMData_Connect
2228+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
2229+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
2230+
// Configure OAuth2 access token for authorization: BIMData_Connect
2231+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
2232+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
2233+
// Configure API key authorization: Bearer
2234+
let Bearer = defaultClient.authentications['Bearer'];
2235+
Bearer.apiKey = 'YOUR API KEY';
2236+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2237+
//Bearer.apiKeyPrefix = 'Token';
2238+
2239+
let apiInstance = new bimdata.BcfApi();
2240+
let guid = "guid_example"; // String |
2241+
let projectsPk = 56; // Number |
2242+
let opts = {
2243+
'format': "format_example", // String |
2244+
'ifcs': [null], // [Number] |
2245+
'models': [null] // [Number] |
2246+
};
2247+
apiInstance.getRelatedTopics(guid, projectsPk, opts).then((data) => {
2248+
console.log('API called successfully. Returned data: ' + data);
2249+
}, (error) => {
2250+
console.error(error);
2251+
});
2252+
2253+
```
2254+
2255+
### Parameters
2256+
2257+
2258+
Name | Type | Description | Notes
2259+
------------- | ------------- | ------------- | -------------
2260+
**guid** | **String**| |
2261+
**projectsPk** | **Number**| |
2262+
**format** | **String**| | [optional]
2263+
**ifcs** | [**[Number]**](Number.md)| | [optional]
2264+
**models** | [**[Number]**](Number.md)| | [optional]
2265+
2266+
### Return type
2267+
2268+
**[String]**
2269+
2270+
### Authorization
2271+
2272+
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
2273+
2274+
### HTTP request headers
2275+
2276+
- **Content-Type**: Not defined
2277+
- **Accept**: application/json
2278+
2279+
22072280
## getSelections
22082281

22092282
> [Component] getSelections(guid, projectsPk, topicsGuid)
@@ -2397,6 +2470,77 @@ Name | Type | Description | Notes
23972470
- **Accept**: application/json
23982471

23992472

2473+
## getTopicDocumentReferences
2474+
2475+
> [String] getTopicDocumentReferences(guid, projectsPk, opts)
2476+
2477+
Get all related documents
2478+
2479+
This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read
2480+
2481+
### Example
2482+
2483+
```javascript
2484+
import bimdata from '@bimdata/bimdata-api-client';
2485+
let defaultClient = bimdata.ApiClient.instance;
2486+
// Configure API key authorization: ApiKey
2487+
let ApiKey = defaultClient.authentications['ApiKey'];
2488+
ApiKey.apiKey = 'YOUR API KEY';
2489+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2490+
//ApiKey.apiKeyPrefix = 'Token';
2491+
// Configure OAuth2 access token for authorization: BIMData_Connect
2492+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
2493+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
2494+
// Configure OAuth2 access token for authorization: BIMData_Connect
2495+
let BIMData_Connect = defaultClient.authentications['BIMData_Connect'];
2496+
BIMData_Connect.accessToken = 'YOUR ACCESS TOKEN';
2497+
// Configure API key authorization: Bearer
2498+
let Bearer = defaultClient.authentications['Bearer'];
2499+
Bearer.apiKey = 'YOUR API KEY';
2500+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
2501+
//Bearer.apiKeyPrefix = 'Token';
2502+
2503+
let apiInstance = new bimdata.BcfApi();
2504+
let guid = "guid_example"; // String |
2505+
let projectsPk = 56; // Number |
2506+
let opts = {
2507+
'format': "format_example", // String |
2508+
'ifcs': [null], // [Number] |
2509+
'models': [null] // [Number] |
2510+
};
2511+
apiInstance.getTopicDocumentReferences(guid, projectsPk, opts).then((data) => {
2512+
console.log('API called successfully. Returned data: ' + data);
2513+
}, (error) => {
2514+
console.error(error);
2515+
});
2516+
2517+
```
2518+
2519+
### Parameters
2520+
2521+
2522+
Name | Type | Description | Notes
2523+
------------- | ------------- | ------------- | -------------
2524+
**guid** | **String**| |
2525+
**projectsPk** | **Number**| |
2526+
**format** | **String**| | [optional]
2527+
**ifcs** | [**[Number]**](Number.md)| | [optional]
2528+
**models** | [**[Number]**](Number.md)| | [optional]
2529+
2530+
### Return type
2531+
2532+
**[String]**
2533+
2534+
### Authorization
2535+
2536+
[ApiKey](../README.md#ApiKey), [BIMData_Connect](../README.md#BIMData_Connect), [BIMData_Connect](../README.md#BIMData_Connect), [Bearer](../README.md#Bearer)
2537+
2538+
### HTTP request headers
2539+
2540+
- **Content-Type**: Not defined
2541+
- **Accept**: application/json
2542+
2543+
24002544
## getTopicViewpoints
24012545

24022546
> [Viewpoint] getTopicViewpoints(projectsPk, topicsGuid, opts)

docs/CollaborationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -958,7 +958,7 @@ Name | Type | Description | Notes
958958
959959
Create a document
960960

961-
Create a document. If the document is one of {'BFX', 'DXF', 'IFC', 'DWG', 'GLTF', 'POINT_CLOUD', 'OBJ', 'DAE'}, a model will be created and attached to this document Required scopes: document:write
961+
Create a document. If the document is one of {'POINT_CLOUD', 'BFX', 'OBJ', 'DAE', 'DXF', 'GLTF', 'DWG', 'IFC'}, a model will be created and attached to this document Required scopes: document:write
962962

963963
### Example
964964

docs/Extensions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,9 @@ Name | Type | Description | Notes
1212
**userIdType** | **[String]** | | [readonly]
1313
**priorityColors** | **[String]** | Non standard field. Arrays of priorities and this array are in the same order. |
1414
**topicStatusColors** | **[String]** | Non standard field. Arrays of statuses and this array are in the same order. |
15+
**snippetType** | **[String]** | Snippet are not yet supported. This field will always be null. | [readonly]
16+
**projectActions** | **[String]** | | [readonly]
17+
**topicActions** | **[String]** | | [readonly]
18+
**commentActions** | **[String]** | | [readonly]
1519

1620

docs/IfcApi.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9883,7 +9883,8 @@ let opts = {
98839883
'mapFile': "/path/to/file", // File |
98849884
'gltfFile': "/path/to/file", // File |
98859885
'previewFile': "/path/to/file", // File |
9886-
'xktFile': "/path/to/file" // File |
9886+
'xktFile': "/path/to/file", // File |
9887+
'binary2dFile': "/path/to/file" // File |
98879888
};
98889889
apiInstance.updateIfcFilesDeprecated(cloudPk, id, projectPk, opts).then((data) => {
98899890
console.log('API called successfully. Returned data: ' + data);
@@ -9907,6 +9908,7 @@ Name | Type | Description | Notes
99079908
**gltfFile** | **File**| | [optional]
99089909
**previewFile** | **File**| | [optional]
99099910
**xktFile** | **File**| | [optional]
9911+
**binary2dFile** | **File**| | [optional]
99109912

99119913
### Return type
99129914

docs/Model.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
2121
**previewFile** | **String** | | [readonly]
2222
**viewer360File** | **String** | DEPRECATED: Use 'preview_file' instead. | [readonly]
2323
**xktFile** | **String** | | [readonly]
24+
**binary2dFile** | **String** | | [readonly]
2425
**projectId** | **Number** | | [readonly]
2526
**worldPosition** | **[Number]** | [x,y,z] array of the position of the local_placement in world coordinates | [optional]
2627
**sizeRatio** | **Number** | How many meters a unit represents | [optional]

docs/ModelApi.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9176,7 +9176,8 @@ let opts = {
91769176
'mapFile': "/path/to/file", // File |
91779177
'gltfFile': "/path/to/file", // File |
91789178
'previewFile': "/path/to/file", // File |
9179-
'xktFile': "/path/to/file" // File |
9179+
'xktFile': "/path/to/file", // File |
9180+
'binary2dFile': "/path/to/file" // File |
91809181
};
91819182
apiInstance.updateModelFiles(cloudPk, id, projectPk, opts).then((data) => {
91829183
console.log('API called successfully. Returned data: ' + data);
@@ -9200,6 +9201,7 @@ Name | Type | Description | Notes
92009201
**gltfFile** | **File**| | [optional]
92019202
**previewFile** | **File**| | [optional]
92029203
**xktFile** | **File**| | [optional]
9204+
**binary2dFile** | **File**| | [optional]
92039205

92049206
### Return type
92059207

docs/ModelFiles.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
1010
**gltfFile** | **String** | | [optional]
1111
**previewFile** | **String** | | [optional]
1212
**xktFile** | **String** | | [optional]
13+
**binary2dFile** | **String** | | [optional]
1314

1415

src/api/BcfApi.js

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1987,6 +1987,73 @@ export default class BcfApi {
19871987
}
19881988

19891989

1990+
/**
1991+
* Get all related topics
1992+
* This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read
1993+
* @param {String} guid
1994+
* @param {Number} projectsPk
1995+
* @param {Object} opts Optional parameters
1996+
* @param {String} opts.format
1997+
* @param {Array.<Number>} opts.ifcs
1998+
* @param {Array.<Number>} opts.models
1999+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<String>} and HTTP response
2000+
*/
2001+
getRelatedTopicsWithHttpInfo(guid, projectsPk, opts) {
2002+
opts = opts || {};
2003+
let postBody = null;
2004+
// verify the required parameter 'guid' is set
2005+
if (guid === undefined || guid === null) {
2006+
throw new Error("Missing the required parameter 'guid' when calling getRelatedTopics");
2007+
}
2008+
// verify the required parameter 'projectsPk' is set
2009+
if (projectsPk === undefined || projectsPk === null) {
2010+
throw new Error("Missing the required parameter 'projectsPk' when calling getRelatedTopics");
2011+
}
2012+
2013+
let pathParams = {
2014+
'guid': guid,
2015+
'projects_pk': projectsPk
2016+
};
2017+
let queryParams = {
2018+
'format': opts['format'],
2019+
'ifcs': this.apiClient.buildCollectionParam(opts['ifcs'], 'multi'),
2020+
'models': this.apiClient.buildCollectionParam(opts['models'], 'multi')
2021+
};
2022+
let headerParams = {
2023+
};
2024+
let formParams = {
2025+
};
2026+
2027+
let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
2028+
let contentTypes = [];
2029+
let accepts = ['application/json'];
2030+
let returnType = ['String'];
2031+
return this.apiClient.callApi(
2032+
'/bcf/2.1/projects/{projects_pk}/topics/{guid}/related_topics', 'GET',
2033+
pathParams, queryParams, headerParams, formParams, postBody,
2034+
authNames, contentTypes, accepts, returnType, null
2035+
);
2036+
}
2037+
2038+
/**
2039+
* Get all related topics
2040+
* This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read
2041+
* @param {String} guid
2042+
* @param {Number} projectsPk
2043+
* @param {Object} opts Optional parameters
2044+
* @param {String} opts.format
2045+
* @param {Array.<Number>} opts.ifcs
2046+
* @param {Array.<Number>} opts.models
2047+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<String>}
2048+
*/
2049+
getRelatedTopics(guid, projectsPk, opts) {
2050+
return this.getRelatedTopicsWithHttpInfo(guid, projectsPk, opts)
2051+
.then(function(response_and_data) {
2052+
return response_and_data.data;
2053+
});
2054+
}
2055+
2056+
19902057
/**
19912058
* Retrieve all selections of a viewpoint
19922059
* Retrieve all selections of a viewpoint Required scopes: bcf:read
@@ -2166,6 +2233,73 @@ export default class BcfApi {
21662233
}
21672234

21682235

2236+
/**
2237+
* Get all related documents
2238+
* This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read
2239+
* @param {String} guid
2240+
* @param {Number} projectsPk
2241+
* @param {Object} opts Optional parameters
2242+
* @param {String} opts.format
2243+
* @param {Array.<Number>} opts.ifcs
2244+
* @param {Array.<Number>} opts.models
2245+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<String>} and HTTP response
2246+
*/
2247+
getTopicDocumentReferencesWithHttpInfo(guid, projectsPk, opts) {
2248+
opts = opts || {};
2249+
let postBody = null;
2250+
// verify the required parameter 'guid' is set
2251+
if (guid === undefined || guid === null) {
2252+
throw new Error("Missing the required parameter 'guid' when calling getTopicDocumentReferences");
2253+
}
2254+
// verify the required parameter 'projectsPk' is set
2255+
if (projectsPk === undefined || projectsPk === null) {
2256+
throw new Error("Missing the required parameter 'projectsPk' when calling getTopicDocumentReferences");
2257+
}
2258+
2259+
let pathParams = {
2260+
'guid': guid,
2261+
'projects_pk': projectsPk
2262+
};
2263+
let queryParams = {
2264+
'format': opts['format'],
2265+
'ifcs': this.apiClient.buildCollectionParam(opts['ifcs'], 'multi'),
2266+
'models': this.apiClient.buildCollectionParam(opts['models'], 'multi')
2267+
};
2268+
let headerParams = {
2269+
};
2270+
let formParams = {
2271+
};
2272+
2273+
let authNames = ['ApiKey', 'BIMData_Connect', 'BIMData_Connect', 'Bearer'];
2274+
let contentTypes = [];
2275+
let accepts = ['application/json'];
2276+
let returnType = ['String'];
2277+
return this.apiClient.callApi(
2278+
'/bcf/2.1/projects/{projects_pk}/topics/{guid}/document_references', 'GET',
2279+
pathParams, queryParams, headerParams, formParams, postBody,
2280+
authNames, contentTypes, accepts, returnType, null
2281+
);
2282+
}
2283+
2284+
/**
2285+
* Get all related documents
2286+
* This feature is not supported yet and will always respond with an empty array Required scopes: bcf:read
2287+
* @param {String} guid
2288+
* @param {Number} projectsPk
2289+
* @param {Object} opts Optional parameters
2290+
* @param {String} opts.format
2291+
* @param {Array.<Number>} opts.ifcs
2292+
* @param {Array.<Number>} opts.models
2293+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<String>}
2294+
*/
2295+
getTopicDocumentReferences(guid, projectsPk, opts) {
2296+
return this.getTopicDocumentReferencesWithHttpInfo(guid, projectsPk, opts)
2297+
.then(function(response_and_data) {
2298+
return response_and_data.data;
2299+
});
2300+
}
2301+
2302+
21692303
/**
21702304
* Retrieve all viewpoints attached to the topic
21712305
* This is not a standard route. It returns all viewpoints of the topic that are not attached to a comment. Required scopes: bcf:read

0 commit comments

Comments
 (0)