# Clash.ClashTestAssignedClashGroupsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**addAssignedClashGroupBatch**](ClashTestAssignedClashGroupsApi.md#addAssignedClashGroupBatch) | **POST** /v3/containers/{containerId}/tests/{testId}/clashes:assign | Assign clash groups to issues in batch
[**getAssignedClashGroupBatch**](ClashTestAssignedClashGroupsApi.md#getAssignedClashGroupBatch) | **POST** /v3/containers/{containerId}/tests/{testId}/clashes/assigned | Get assigned clash group clash detail (results) batch
[**getClashTestAssignedClashGroupIntersection**](ClashTestAssignedClashGroupsApi.md#getClashTestAssignedClashGroupIntersection) | **GET** /v3/containers/{containerId}/tests/{testId}/clashes/assigned | Get assigned clash group state relative to specified test
[**searchContainerIssueClashGroups**](ClashTestAssignedClashGroupsApi.md#searchContainerIssueClashGroups) | **GET** /v3/containers/{containerId}/modelsets/{modelSetId}/clashes/assigned | Search assigned clash groups in model set



## addAssignedClashGroupBatch

> ClashGroupJob addAssignedClashGroupBatch(containerId, testId, opts)

Assign clash groups to issues in batch

Adds a batch of new assigned clash groups to the given clash test.  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.  Clash groups which need resolving via a design change are stored as assigned clash groups. In addition a BIM 360 issue is created and associated with the assigned clash group.  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.ClashTestAssignedClashGroupsApi();
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 = {
  'newAssignedClashGroup': [new Clash.NewAssignedClashGroup()] // [NewAssignedClashGroup] | 
};
apiInstance.addAssignedClashGroupBatch(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 | 
 **newAssignedClashGroup** | [**[NewAssignedClashGroup]**](NewAssignedClashGroup.md)|  | [optional] 

### Return type

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

### Authorization

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

### HTTP request headers

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


## getAssignedClashGroupBatch

> [AssignedClashGroupClashData] getAssignedClashGroupBatch(containerId, testId, opts)

Get assigned clash group clash detail (results) batch

Gets the state of the specified assigned clash groups, relative to a specified clash test.  This endpoint takes the clashes contained within each specified assigned 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.  This method can accept either a list of assigned clash group IDs or a list of BIM 360 Issue service Issue GUIDs. To retrieve results by BIM 360 Issue GUID, set the `issues` query parameter to true.  The response contains a list of assigned 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.ClashTestAssignedClashGroupsApi();
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 = {
  'issues': true, // Boolean | If set to true, the query will be performed on issue IDs instead of clash group IDs.
  'requestBody': ["null"] // [String] | 
};
apiInstance.getAssignedClashGroupBatch(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 | 
 **issues** | **Boolean**| If set to true, the query will be performed on issue IDs instead of clash group IDs. | [optional] 
 **requestBody** | [**[String]**](String.md)|  | [optional] 

### Return type

[**[AssignedClashGroupClashData]**](AssignedClashGroupClashData.md)

### Authorization

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

### HTTP request headers

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


## getClashTestAssignedClashGroupIntersection

> ClashGroupClashIntersectionCollection getClashTestAssignedClashGroupIntersection(containerId, testId, opts)

Get assigned clash group state relative to specified test

Gets the state of all assigned clash groups in a particular model set, relative to a specified clash test.  This endpoint takes the clashes contained within each assigned 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 assigned 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.ClashTestAssignedClashGroupsApi();
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 assigned 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.getClashTestAssignedClashGroupIntersection(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 assigned 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


## searchContainerIssueClashGroups

> AssignedClashGroupCollection searchContainerIssueClashGroups(containerId, modelSetId, opts)

Search assigned clash groups in model set

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

### Return type

[**AssignedClashGroupCollection**](AssignedClashGroupCollection.md)

### Authorization

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

### HTTP request headers

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