# Clash.ClashTestApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**getClashTest**](ClashTestApi.md#getClashTest) | **GET** /v3/containers/{containerId}/tests/{testId} | Get clash test by ID
[**getClashTestResources**](ClashTestApi.md#getClashTestResources) | **GET** /v3/containers/{containerId}/tests/{testId}/resources | Get clash test result resources
[**getModelSetClashTests**](ClashTestApi.md#getModelSetClashTests) | **GET** /v3/containers/{containerId}/modelsets/{modelSetId}/tests | Get model set clash test summaries
[**getModelSetVersionClashTests**](ClashTestApi.md#getModelSetVersionClashTests) | **GET** /v3/containers/{containerId}/modelsets/{modelSetId}/versions/{version}/tests | Get model set version clash test summaries



## getClashTest

> ClashTestSummary getClashTest(containerId, testId)

Get clash test by ID

Gets a requested clash test based on the clash test's ID.  Returns the requested clash test object.

### Example

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

var apiInstance = new Clash.ClashTestApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var testId = null; // String | The GUID that uniquely identifies the clash test
apiInstance.getClashTest(containerId, testId).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 | 
 **testId** | [**String**](.md)| The GUID that uniquely identifies the clash test | 

### Return type

[**ClashTestSummary**](ClashTestSummary.md)

### Authorization

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

### HTTP request headers

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


## getClashTestResources

> ClashTestResourceCollection getClashTestResources(containerId, testId)

Get clash test result resources

Gets information about a given clash test's result resources.  When a clash test against a model set version is successful it produces three file resources which contain the raw clash instances and the documents (models) these clash results pertain to. See the Field Guide section of the API documentation for details.  Returns a list of URLs and secure headers necessary to access the resources generated for the given clash test.

### Example

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

var apiInstance = new Clash.ClashTestApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var testId = null; // String | The GUID that uniquely identifies the clash test
apiInstance.getClashTestResources(containerId, testId).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 | 
 **testId** | [**String**](.md)| The GUID that uniquely identifies the clash test | 

### Return type

[**ClashTestResourceCollection**](ClashTestResourceCollection.md)

### Authorization

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

### HTTP request headers

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


## getModelSetClashTests

> ClashTestSummaryCollection getModelSetClashTests(containerId, modelSetId, opts)

Get model set clash test summaries

Gets a list of summaries for all clash tests which have been executed for a given model set. If no tests have yet been completed for the specified model set then no tests will returned.  The response contains a list of matching clash test summaries, 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 Clash = require('forge-bim360-modelcoordination-clash');
var defaultClient = Clash.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Clash.ClashTestApi();
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 = {
  'pageLimit': 56, // Number | The maximum number of clash tests 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.
};
apiInstance.getModelSetClashTests(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 | 
 **pageLimit** | **Number**| The maximum number of clash tests 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] 

### Return type

[**ClashTestSummaryCollection**](ClashTestSummaryCollection.md)

### Authorization

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

### HTTP request headers

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


## getModelSetVersionClashTests

> ClashTestSummaryCollection getModelSetVersionClashTests(containerId, modelSetId, version, opts)

Get model set version clash test summaries

Gets a list of summaries for all clash tests which have been executed for a given model set version. If no tests have yet been completed for the specified model set version then no tests will returned.  The response contains a list of matching clash test summaries, 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 Clash = require('forge-bim360-modelcoordination-clash');
var defaultClient = Clash.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2AuthCode
var oauth2AuthCode = defaultClient.authentications['oauth2AuthCode'];
oauth2AuthCode.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Clash.ClashTestApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var modelSetId = null; // String | The GUID that uniquely identifies the model set
var version = 56; // Number | The model set version number
var opts = {
  'pageLimit': 56, // Number | The maximum number of clash tests 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.
};
apiInstance.getModelSetVersionClashTests(containerId, modelSetId, version, 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 | 
 **version** | **Number**| The model set version number | 
 **pageLimit** | **Number**| The maximum number of clash tests 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] 

### Return type

[**ClashTestSummaryCollection**](ClashTestSummaryCollection.md)

### Authorization

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

### HTTP request headers

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