Skip to content

ProjectApi.md

Latest commit

 

History

History
1600 lines (1157 loc) · 45.8 KB

ProjectApi.md

File metadata and controls

1600 lines (1157 loc) · 45.8 KB
Raw

bimdata.ProjectApi

All URIs are relative to https://api-beta.bimdata.io

Method HTTP request Description
createClassification POST /cloud/{cloud_pk}/project/{project_pk}/classification
createDocument POST /cloud/{cloud_pk}/project/{project_pk}/document
createFolder POST /cloud/{cloud_pk}/project/{project_pk}/folder
createProject POST /cloud/{cloud_pk}/project
deleteClassification DELETE /cloud/{cloud_pk}/project/{project_pk}/classification/{id}
deleteDocument DELETE /cloud/{cloud_pk}/project/{project_pk}/document/{id}
deleteFolder DELETE /cloud/{cloud_pk}/project/{project_pk}/folder/{id}
deleteProject DELETE /cloud/{cloud_pk}/project/{id}
deleteProjectUser DELETE /cloud/{cloud_pk}/project/{project_pk}/user/{id}
fullUpdateClassification PUT /cloud/{cloud_pk}/project/{project_pk}/classification/{id}
fullUpdateDocument PUT /cloud/{cloud_pk}/project/{project_pk}/document/{id}
fullUpdateFolder PUT /cloud/{cloud_pk}/project/{project_pk}/folder/{id}
fullUpdateProject PUT /cloud/{cloud_pk}/project/{id}
fullUpdateProjectUser PUT /cloud/{cloud_pk}/project/{project_pk}/user/{id}
getClassification GET /cloud/{cloud_pk}/project/{project_pk}/classification/{id}
getClassifications GET /cloud/{cloud_pk}/project/{project_pk}/classification
getDocument GET /cloud/{cloud_pk}/project/{project_pk}/document/{id}
getDocuments GET /cloud/{cloud_pk}/project/{project_pk}/document
getFolder GET /cloud/{cloud_pk}/project/{project_pk}/folder/{id}
getFolders GET /cloud/{cloud_pk}/project/{project_pk}/folder
getProject GET /cloud/{cloud_pk}/project/{id}
getProjectTree GET /cloud/{cloud_pk}/project/{id}/tree
getProjectUser GET /cloud/{cloud_pk}/project/{project_pk}/user/{id}
getProjectUsers GET /cloud/{cloud_pk}/project/{project_pk}/user
getProjects GET /cloud/{cloud_pk}/project
projectInvite POST /cloud/{cloud_pk}/project/{id}/invite
updateClassification PATCH /cloud/{cloud_pk}/project/{project_pk}/classification/{id}
updateDocument PATCH /cloud/{cloud_pk}/project/{project_pk}/document/{id}
updateFolder PATCH /cloud/{cloud_pk}/project/{project_pk}/folder/{id}
updateProject PATCH /cloud/{cloud_pk}/project/{id}
updateProjectUser PATCH /cloud/{cloud_pk}/project/{project_pk}/user/{id}

createClassification

[Classification] createClassification(cloudPk, projectPk, classification)

     Bulk create available.         You can either post an object or a list of objects.         Is you post a list, the response will be a list (in the same order) of created objects or of errors if any         If at least one create succeeded, the status code will be 201. If every create failed, the status code we'll be 400 with the list of errors          If created classification already exists, it will not be duplicated and the previous one will be returned.     You also can add a 'classification' filter on this endpoint. By ex: /classification?name='untec'. The name is case sensitive

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var projectPk = "projectPk_example"; // String | 
var classification = [new bimdata.Classification()]; // [Classification] | 
apiInstance.createClassification(cloudPk, projectPk, classification).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
projectPk String
classification [Classification]

Return type

[Classification]

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createDocument

Document createDocument(cloudPk, projectPk, name, opts)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var projectPk = "projectPk_example"; // String | 
var name = "name_example"; // String | 
var opts = {
  'parent': 56, // Number | 
  'parentId': 56, // Number | 
  'creator': 56, // Number | 
  'project': 56, // Number | 
  'fileName': "fileName_example", // String | 
  'description': "description_example", // String | 
  'file': "/path/to/file", // File | 
  'size': 56 // Number | 
};
apiInstance.createDocument(cloudPk, projectPk, name, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
projectPk String
name String
parent Number [optional]
parentId Number [optional]
creator Number [optional]
project Number [optional]
fileName String [optional]
description String [optional]
file File [optional]
size Number [optional]

Return type

Document

Authorization

Bearer

HTTP request headers

  • Content-Type: multipart/form-data, application/x-www-form-urlencoded
  • Accept: application/json

createFolder

Folder createFolder(cloudPk, projectPk, folder)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var projectPk = "projectPk_example"; // String | 
var folder = new bimdata.Folder(); // Folder | 
apiInstance.createFolder(cloudPk, projectPk, folder).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
projectPk String
folder Folder

Return type

Folder

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createProject

Project createProject(cloudPk, project)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var project = new bimdata.Project(); // Project | 
apiInstance.createProject(cloudPk, project).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
project Project

Return type

Project

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteClassification

deleteClassification(cloudPk, id, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this classification.
var projectPk = "projectPk_example"; // String | 
apiInstance.deleteClassification(cloudPk, id, projectPk).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this classification.
projectPk String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteDocument

Document deleteDocument(cloudPk, id, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this document.
var projectPk = "projectPk_example"; // String | 
apiInstance.deleteDocument(cloudPk, id, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this document.
projectPk String

Return type

Document

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteFolder

deleteFolder(cloudPk, id, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this folder.
var projectPk = "projectPk_example"; // String | 
apiInstance.deleteFolder(cloudPk, id, projectPk).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this folder.
projectPk String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteProject

deleteProject(cloudPk, id)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this project.
apiInstance.deleteProject(cloudPk, id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this project.

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteProjectUser

deleteProjectUser(cloudPk, id, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = "id_example"; // String | 
var projectPk = "projectPk_example"; // String | 
apiInstance.deleteProjectUser(cloudPk, id, projectPk).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id String
projectPk String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

fullUpdateClassification

Classification fullUpdateClassification(cloudPk, id, projectPk, classification)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this classification.
var projectPk = "projectPk_example"; // String | 
var classification = new bimdata.Classification(); // Classification | 
apiInstance.fullUpdateClassification(cloudPk, id, projectPk, classification).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this classification.
projectPk String
classification Classification

Return type

Classification

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

fullUpdateDocument

Document fullUpdateDocument(cloudPk, id, projectPk, name, opts)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this document.
var projectPk = "projectPk_example"; // String | 
var name = "name_example"; // String | 
var opts = {
  'parent': 56, // Number | 
  'parentId': 56, // Number | 
  'creator': 56, // Number | 
  'project': 56, // Number | 
  'fileName': "fileName_example", // String | 
  'description': "description_example", // String | 
  'file': "/path/to/file", // File | 
  'size': 56 // Number | 
};
apiInstance.fullUpdateDocument(cloudPk, id, projectPk, name, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this document.
projectPk String
name String
parent Number [optional]
parentId Number [optional]
creator Number [optional]
project Number [optional]
fileName String [optional]
description String [optional]
file File [optional]
size Number [optional]

Return type

Document

Authorization

Bearer

HTTP request headers

  • Content-Type: multipart/form-data, application/x-www-form-urlencoded
  • Accept: application/json

fullUpdateFolder

Folder fullUpdateFolder(cloudPk, id, projectPk, folder)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this folder.
var projectPk = "projectPk_example"; // String | 
var folder = new bimdata.Folder(); // Folder | 
apiInstance.fullUpdateFolder(cloudPk, id, projectPk, folder).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this folder.
projectPk String
folder Folder

Return type

Folder

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

fullUpdateProject

Project fullUpdateProject(cloudPk, id, project)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this project.
var project = new bimdata.Project(); // Project | 
apiInstance.fullUpdateProject(cloudPk, id, project).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this project.
project Project

Return type

Project

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

fullUpdateProjectUser

User fullUpdateProjectUser(cloudPk, id, projectPk, userProjectUpdate)

Change the user role in the cloud

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = "id_example"; // String | 
var projectPk = "projectPk_example"; // String | 
var userProjectUpdate = new bimdata.UserProjectUpdate(); // UserProjectUpdate | 
apiInstance.fullUpdateProjectUser(cloudPk, id, projectPk, userProjectUpdate).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id String
projectPk String
userProjectUpdate UserProjectUpdate

Return type

User

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getClassification

Classification getClassification(cloudPk, id, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this classification.
var projectPk = "projectPk_example"; // String | 
apiInstance.getClassification(cloudPk, id, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this classification.
projectPk String

Return type

Classification

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getClassifications

[Classification] getClassifications(cloudPk, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var projectPk = "projectPk_example"; // String | 
apiInstance.getClassifications(cloudPk, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
projectPk String

Return type

[Classification]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getDocument

Document getDocument(cloudPk, id, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this document.
var projectPk = "projectPk_example"; // String | 
apiInstance.getDocument(cloudPk, id, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this document.
projectPk String

Return type

Document

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getDocuments

Document getDocuments(cloudPk, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var projectPk = "projectPk_example"; // String | 
apiInstance.getDocuments(cloudPk, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
projectPk String

Return type

Document

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getFolder

Folder getFolder(cloudPk, id, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this folder.
var projectPk = "projectPk_example"; // String | 
apiInstance.getFolder(cloudPk, id, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this folder.
projectPk String

Return type

Folder

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getFolders

[Folder] getFolders(cloudPk, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var projectPk = "projectPk_example"; // String | 
apiInstance.getFolders(cloudPk, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
projectPk String

Return type

[Folder]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getProject

Project getProject(cloudPk, id)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this project.
apiInstance.getProject(cloudPk, id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this project.

Return type

Project

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getProjectTree

Folder getProjectTree(cloudPk, id)

Returns the document tree from root folder

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this project.
apiInstance.getProjectTree(cloudPk, id).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this project.

Return type

Folder

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getProjectUser

User getProjectUser(cloudPk, id, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = "id_example"; // String | 
var projectPk = "projectPk_example"; // String | 
apiInstance.getProjectUser(cloudPk, id, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id String
projectPk String

Return type

User

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getProjectUsers

[User] getProjectUsers(cloudPk, projectPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var projectPk = "projectPk_example"; // String | 
apiInstance.getProjectUsers(cloudPk, projectPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
projectPk String

Return type

[User]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getProjects

[Project] getProjects(cloudPk)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
apiInstance.getProjects(cloudPk).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String

Return type

[Project]

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

projectInvite

projectInvite(cloudPk, id, projectInvitation)

Invite a user to collaborate in the project. The cloud role will be USER

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this project.
var projectInvitation = new bimdata.ProjectInvitation(); // ProjectInvitation | 
apiInstance.projectInvite(cloudPk, id, projectInvitation).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this project.
projectInvitation ProjectInvitation

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

updateClassification

Classification updateClassification(cloudPk, id, projectPk, classification)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this classification.
var projectPk = "projectPk_example"; // String | 
var classification = new bimdata.Classification(); // Classification | 
apiInstance.updateClassification(cloudPk, id, projectPk, classification).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this classification.
projectPk String
classification Classification

Return type

Classification

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateDocument

Document updateDocument(cloudPk, id, projectPk, document)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this document.
var projectPk = "projectPk_example"; // String | 
var document = new bimdata.Document(); // Document | 
apiInstance.updateDocument(cloudPk, id, projectPk, document).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this document.
projectPk String
document Document

Return type

Document

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateFolder

Folder updateFolder(cloudPk, id, projectPk, folder)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this folder.
var projectPk = "projectPk_example"; // String | 
var folder = new bimdata.Folder(); // Folder | 
apiInstance.updateFolder(cloudPk, id, projectPk, folder).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this folder.
projectPk String
folder Folder

Return type

Folder

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateProject

Project updateProject(cloudPk, id, project)

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = 56; // Number | A unique integer value identifying this project.
var project = new bimdata.Project(); // Project | 
apiInstance.updateProject(cloudPk, id, project).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id Number A unique integer value identifying this project.
project Project

Return type

Project

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateProjectUser

User updateProjectUser(cloudPk, id, projectPk, userProjectUpdate)

Change the user role in the cloud

Example

var bimdata = require('@bimdata/bimdata-api-client');
var defaultClient = bimdata.ApiClient.instance;
// Configure API key authorization: Bearer
var 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';

var apiInstance = new bimdata.ProjectApi();
var cloudPk = "cloudPk_example"; // String | 
var id = "id_example"; // String | 
var projectPk = "projectPk_example"; // String | 
var userProjectUpdate = new bimdata.UserProjectUpdate(); // UserProjectUpdate | 
apiInstance.updateProjectUser(cloudPk, id, projectPk, userProjectUpdate).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
cloudPk String
id String
projectPk String
userProjectUpdate UserProjectUpdate

Return type

User

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json