# Clash.ClashTestClosedClashGroupsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**addClosedClashGroupBatch**](ClashTestClosedClashGroupsApi.md#addClosedClashGroupBatch) | **POST** /v3/containers/{containerId}/tests/{testId}/clashes:close | Add closed clash group in batch
[**getClashTestClosedClashGroupIntersection**](ClashTestClosedClashGroupsApi.md#getClashTestClosedClashGroupIntersection) | **GET** /v3/containers/{containerId}/tests/{testId}/clashes/closed | Get closed clash group state relative to specified test
[**getClosedClashGroupDataBatch**](ClashTestClosedClashGroupsApi.md#getClosedClashGroupDataBatch) | **POST** /v3/containers/{containerId}/tests/{testId}/clashes/closed | Get closed clash group clash detail (results) batch
[**reopenClosedClashGroupBatch**](ClashTestClosedClashGroupsApi.md#reopenClosedClashGroupBatch) | **POST** /v3/containers/{containerId}/modelsets/{modelSetId}/clashes:reopen | Re-open a closed clash group batch
[**searchContainerModelSetClosedClashGroups**](ClashTestClosedClashGroupsApi.md#searchContainerModelSetClosedClashGroups) | **GET** /v3/containers/{containerId}/modelsets/{modelSetId}/clashes/closed | Search closed clash groups in model set



## addClosedClashGroupBatch

> ClashGroupJob addClosedClashGroupBatch(containerId, testId, opts)

Add closed clash group in batch

Adds a batch of new closed clash groups to the given clash test.  Clash groups which are closed will not be presented should they occur in subsequent clash tests. The clash will still be present in the model however it is not deemed necessary to remove it.  The response contains information about the created clash group job.

### 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.ClashTestClosedClashGroupsApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var testId = null; // String | The GUID that uniquely identifies the clash test
var opts = {
  'newClosedClashGroup': [new Clash.NewClosedClashGroup()] // [NewClosedClashGroup] | 
};
apiInstance.addClosedClashGroupBatch(containerId, testId, 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 | 
 **testId** | [**String**](.md)| The GUID that uniquely identifies the clash test | 
 **newClosedClashGroup** | [**[NewClosedClashGroup]**](NewClosedClashGroup.md)|  | [optional] 

### Return type

[**ClashGroupJob**](ClashGroupJob.md)

### Authorization

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

### HTTP request headers

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


## getClashTestClosedClashGroupIntersection

> ClashGroupClashIntersectionCollection getClashTestClosedClashGroupIntersection(containerId, testId, opts)

Get closed clash group state relative to specified test

Gets the state of all closed clash groups in a particular model set, relative to a specified clash test.  This endpoint takes the clashes contained within each closed clash group stored in the system for all clash tests on the same model set, and intersects them with the results of the specified clash test. Clashes which were present when the clash group was first defined may now be resolved.  The response contains a list of closed clash groups, 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.ClashTestClosedClashGroupsApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var testId = null; // String | The GUID that uniquely identifies the clash test
var opts = {
  'pageLimit': 56, // Number | The maximum number of closed clash groups 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.getClashTestClosedClashGroupIntersection(containerId, testId, 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 | 
 **testId** | [**String**](.md)| The GUID that uniquely identifies the clash test | 
 **pageLimit** | **Number**| The maximum number of closed clash groups 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

[**ClashGroupClashIntersectionCollection**](ClashGroupClashIntersectionCollection.md)

### Authorization

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

### HTTP request headers

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


## getClosedClashGroupDataBatch

> [ClosedClashGroupClashData] getClosedClashGroupDataBatch(containerId, testId, opts)

Get closed clash group clash detail (results) batch

Gets the state of the specified closed clash groups, relative to a specified clash test.  This endpoint takes the clashes contained within each specified closed clash group, and intersects them with the results of the specified clash test. Clashes which were present when the clash group was first defined may now be resolved.  The response contains a list of closed clash groups.

### 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.ClashTestClosedClashGroupsApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var testId = null; // String | The GUID that uniquely identifies the clash test
var opts = {
  'requestBody': ["null"] // [String] | 
};
apiInstance.getClosedClashGroupDataBatch(containerId, testId, 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 | 
 **testId** | [**String**](.md)| The GUID that uniquely identifies the clash test | 
 **requestBody** | [**[String]**](String.md)|  | [optional] 

### Return type

[**[ClosedClashGroupClashData]**](ClosedClashGroupClashData.md)

### Authorization

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

### HTTP request headers

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


## reopenClosedClashGroupBatch

> ClashGroupJob reopenClosedClashGroupBatch(containerId, modelSetId, opts)

Re-open a closed clash group batch

Re-opens a batch of existing closed clash groups.  This endpoint essentially deletes the specified closed clash groups. This operation cannot be undone, but the closed clash groups can be recreated identically if necessary.  The response contains information about the created clash group job.

### 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.ClashTestClosedClashGroupsApi();
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 = {
  'requestBody': ["null"] // [String] | 
};
apiInstance.reopenClosedClashGroupBatch(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 | 
 **requestBody** | [**[String]**](String.md)|  | [optional] 

### Return type

[**ClashGroupJob**](ClashGroupJob.md)

### Authorization

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

### HTTP request headers

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


## searchContainerModelSetClosedClashGroups

> ClosedClashGroupCollection searchContainerModelSetClosedClashGroups(containerId, modelSetId, opts)

Search closed clash groups in model set

Gets a list of closed clash groups in a given model set which match the provided search parameters.  The response contains a list of matching closed clash groups, 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.ClashTestClosedClashGroupsApi();
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 closed clash groups 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.
  'clashTestId': null, // String | Filters the returned closed clash groups by the clashTestId property
  'reason': VALID_INTERFACE, // String | Filters the returned closed clash groups by the reason property
  'createdBy': PD23PXGV8V3V, // String | Filters the returned closed clash groups by the createdBy property
  'after': new Date("2013-10-20T19:20:30+01:00"), // Date | Filters the returned closed clash groups to those created or modified after the given time
  'before': new Date("2013-10-20T19:20:30+01:00"), // Date | Filters the returned closed clash groups to those created or modified before the given time
  'sort': new Clash.SortDirection() // SortDirection | Defines the sort direction
};
apiInstance.searchContainerModelSetClosedClashGroups(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 closed clash groups 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] 
 **clashTestId** | [**String**](.md)| Filters the returned closed clash groups by the clashTestId property | [optional] 
 **reason** | **String**| Filters the returned closed clash groups by the reason property | [optional] 
 **createdBy** | **String**| Filters the returned closed clash groups by the createdBy property | [optional] 
 **after** | **Date**| Filters the returned closed clash groups to those created or modified after the given time | [optional] 
 **before** | **Date**| Filters the returned closed clash groups to those created or modified before the given time | [optional] 
 **sort** | [**SortDirection**](.md)| Defines the sort direction | [optional] 

### Return type

[**ClosedClashGroupCollection**](ClosedClashGroupCollection.md)

### Authorization

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

### HTTP request headers

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