# ModelSet.ModelSetApi

All URIs are relative to *https://developer.api.autodesk.com/bim360/modelset*

Method | HTTP request | Description
------------- | ------------- | -------------
[**addModelSetIssue**](ModelSetApi.md#addModelSetIssue) | **POST** /v3/containers/{containerId}/modelsets/{modelSetId}/issues | Add model set issue
[**addScreenShot**](ModelSetApi.md#addScreenShot) | **POST** /v3/containers/{containerId}/modelsets/{modelSetId}/screenshots | Add Screen Shot
[**createModelSet**](ModelSetApi.md#createModelSet) | **POST** /v3/containers/{containerId}/modelsets | Create Model Set
[**getContainerJobByContainer**](ModelSetApi.md#getContainerJobByContainer) | **GET** /v3/containers/{containerId}/jobs/{jobId} | Get Container Job
[**getModelSet**](ModelSetApi.md#getModelSet) | **GET** /v3/containers/{containerId}/modelsets/{modelSetId} | Get Model Set
[**getModelSetJob**](ModelSetApi.md#getModelSetJob) | **GET** /v3/containers/{containerId}/modelsets/{modelSetId}/jobs/{jobId} | Get Model Set Job
[**getModelSets**](ModelSetApi.md#getModelSets) | **GET** /v3/containers/{containerId}/modelsets | Get Model Sets
[**getScreenShot**](ModelSetApi.md#getScreenShot) | **GET** /v3/containers/{containerId}/modelsets/{modelSetId}/screenshots/{screenShotId} | Get Screen Shot
[**patchModelSetNameDescription**](ModelSetApi.md#patchModelSetNameDescription) | **PATCH** /v3/containers/{containerId}/modelsets/{modelSetId} | Update Model Set Name and or Description



## addModelSetIssue

> ModelSetJob addModelSetIssue(containerId, modelSetId, opts)

Add model set issue

Adds a model set visual inspection issue, represented as a BIM360 issue.  The data associated with `pushpin` is supported by the Viewer's Pushpin extension. See the [pushpin tutorial](https://forge.autodesk.com/en/docs/bim360/v1/tutorials/pushpins/) for more information.  The created job will perform the following steps: 1. Create a BIM 360 Issue with the requested information. 2. Upload any provided screenshots to the project's photos folder, and attach them to the newly created BIM 360 Issue.  The response contains information about the created model set job.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var modelSetId = null; // String | The GUID that uniquely identifies the model set
var opts = {
  'newModelSetIssue': [new ModelSet.NewModelSetIssue()] // [NewModelSetIssue] | The new model set issues
};
apiInstance.addModelSetIssue(containerId, modelSetId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container | 
 **modelSetId** | [**String**](.md)| The GUID that uniquely identifies the model set | 
 **newModelSetIssue** | [**[NewModelSetIssue]**](NewModelSetIssue.md)| The new model set issues | [optional] 

### Return type

[**ModelSetJob**](ModelSetJob.md)

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

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


## addScreenShot

> ScreenshotToken addScreenShot(containerId, modelSetId, opts)

Add Screen Shot

Uploads a screenshot, associating it with a given model set.  The new screenshot cannot be retrieved from the service until it has been associated with a model set view. It can also be associated with a model set issue, in which case it will become available as an attachment to the created BIM 360 Issue.  Returns a token representing the uploaded screenshot.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var modelSetId = null; // String | The GUID that uniquely identifies the model set
var opts = {
  'body': "/path/to/file" // File | 
};
apiInstance.addScreenShot(containerId, modelSetId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container | 
 **modelSetId** | [**String**](.md)| The GUID that uniquely identifies the model set | 
 **body** | **File**|  | [optional] 

### Return type

[**ScreenshotToken**](ScreenshotToken.md)

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

- **Content-Type**: image/png
- **Accept**: application/json


## createModelSet

> ModelSetJob createModelSet(containerId, opts)

Create Model Set

Create a Model Set within a given Container specifying the Folder which will be used to determine the set of Model Document lineages comprising the Model Set. Currently only a single folder is supported, however this does include sub-folders. Multiple folder support to be included at a future date. The response contains information about the created model set job.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var containerId = null; // String | The GUID that uniquely identifies the container in which the model set will be created
var opts = {
  'newModelSet': new ModelSet.NewModelSet() // NewModelSet | Create Model Set request body parameters.
};
apiInstance.createModelSet(containerId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container in which the model set will be created | 
 **newModelSet** | [**NewModelSet**](NewModelSet.md)| Create Model Set request body parameters. | [optional] 

### Return type

[**ModelSetJob**](ModelSetJob.md)

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

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


## getContainerJobByContainer

> ContainerJob getContainerJobByContainer(xAdsRegion, containerId, jobId)

Get Container Job

Retrieves information about a given container job.  All calls to the containers resource will result in a job. This endpoint can be used to track the progress of these jobs.  You can find the `x-ads-region` to use from the `GET hubs` endpoint, under `data.attributes.region`. Please see [GET hubs/:hub_id](https://forge.autodesk.com/en/docs/data/v2/reference/http/hubs-hub_id-GET/) for more information.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var xAdsRegion = new ModelSet.ContainerRegion(); // ContainerRegion | The region the container resides in
var containerId = null; // String | The GUID that uniquely identifies the container
var jobId = null; // String | The GUID that uniquely identifies the job
apiInstance.getContainerJobByContainer(xAdsRegion, containerId, jobId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xAdsRegion** | [**ContainerRegion**](.md)| The region the container resides in | 
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container | 
 **jobId** | [**String**](.md)| The GUID that uniquely identifies the job | 

### Return type

[**ContainerJob**](ContainerJob.md)

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

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


## getModelSet

> ModelSet getModelSet(containerId, modelSetId)

Get Model Set

Gets a requested model set based on the model set's ID.  Returns the requested model set object.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var modelSetId = null; // String | The GUID that uniquely identifies the model set
apiInstance.getModelSet(containerId, modelSetId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container | 
 **modelSetId** | [**String**](.md)| The GUID that uniquely identifies the model set | 

### Return type

[**ModelSet**](ModelSet.md)

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

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


## getModelSetJob

> ModelSetJob getModelSetJob(containerId, modelSetId, jobId)

Get Model Set Job

Retrieves information about a given model set job.  Many PATCH and POST calls to model sets endpoints will result in a job. This endpoint can be used to track the progress of these jobs.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var modelSetId = null; // String | The GUID that uniquely identifies the model set
var jobId = null; // String | The GUID that uniquely identifies the job
apiInstance.getModelSetJob(containerId, modelSetId, jobId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container | 
 **modelSetId** | [**String**](.md)| The GUID that uniquely identifies the model set | 
 **jobId** | [**String**](.md)| The GUID that uniquely identifies the job | 

### Return type

[**ModelSetJob**](ModelSetJob.md)

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

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


## getModelSets

> ModelSetSummaryCollection getModelSets(containerId, opts)

Get Model Sets

Gets a list of model sets in a given container which match the provided search parameters.  The response contains a list of matching model sets, restricted by the number specified by the `pageLimit` property. If set (i.e. there are more results than can be displayed at once), the `continuationToken` property in the response can be provided in an additional call in order to retrieve additional results.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var opts = {
  'pageLimit': 56, // Number | The maximum number of model sets to return in a page. If not set, the default page limit is used, as determined by the server.
  'continuationToken': 10, // String | The token indicating the start of the page. If not set, the first page will be retrieved.
  'name': Formal Coordination, // String | A model set name filter. This is an equality filter.
  'folderUrn': urn:adsk.wipprod:fs.folder:co.WI8roO18TU2Cl3P9y64z4w, // String | A folder URN filter
  'includeDisabled': true // Boolean | Whether or not to include disabled model sets
};
apiInstance.getModelSets(containerId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container | 
 **pageLimit** | **Number**| The maximum number of model sets to return in a page. If not set, the default page limit is used, as determined by the server. | [optional] 
 **continuationToken** | **String**| The token indicating the start of the page. If not set, the first page will be retrieved. | [optional] 
 **name** | **String**| A model set name filter. This is an equality filter. | [optional] 
 **folderUrn** | **String**| A folder URN filter | [optional] 
 **includeDisabled** | **Boolean**| Whether or not to include disabled model sets | [optional] 

### Return type

[**ModelSetSummaryCollection**](ModelSetSummaryCollection.md)

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

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


## getScreenShot

> File getScreenShot(containerId, modelSetId, screenShotId)

Get Screen Shot

Gets a specific screenshot based on the screenshot's ID.  Newly uploaded screenshots can be retrieved with this endpoint and must first be associated with a model set view.  Returns the requested screenshot file.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var modelSetId = null; // String | The GUID that uniquely identifies the model set
var screenShotId = null; // String | The GUID that uniquely identifies the screenshot
apiInstance.getScreenShot(containerId, modelSetId, screenShotId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container | 
 **modelSetId** | [**String**](.md)| The GUID that uniquely identifies the model set | 
 **screenShotId** | [**String**](.md)| The GUID that uniquely identifies the screenshot | 

### Return type

**File**

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: image/png, application/json


## patchModelSetNameDescription

> ModelSetJob patchModelSetNameDescription(containerId, modelSetId, opts)

Update Model Set Name and or Description

Updates a given model set's name and/or description. * If `oldName` and `newName` are supplied, the name will be updated (both must be supplied, the name cannot be null) * If `oldDescription` or `newDescription` is supplied, the description will be updated (one can be null or omitted, description can be set to null)  If no property changes are supplied, an error is returned.  If successful, the response contains information about the created model set job.

### Example

```javascript
var ModelSet = require('forge-bim360-modelcoordination-modelset');
var defaultClient = ModelSet.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new ModelSet.ModelSetApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var modelSetId = null; // String | The GUID that uniquely identifies the model set
var opts = {
  'newModelSetName': new ModelSet.NewModelSetName() // NewModelSetName | Model Set display text update.
};
apiInstance.patchModelSetNameDescription(containerId, modelSetId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters



Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **containerId** | [**String**](.md)| The GUID that uniquely identifies the container | 
 **modelSetId** | [**String**](.md)| The GUID that uniquely identifies the model set | 
 **newModelSetName** | [**NewModelSetName**](NewModelSetName.md)| Model Set display text update. | [optional] 

### Return type

[**ModelSetJob**](ModelSetJob.md)

### Authorization

[oauth2AuthCode](../README.md#oauth2AuthCode)

### HTTP request headers

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