# Clash.ClashTestClashGroupsSharedApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**addScreenShot**](ClashTestClashGroupsSharedApi.md#addScreenShot) | **POST** /v3/containers/{containerId}/modelsets/{modelSetId}/screenshots | Add Screen Shot
[**getClashGroupJob**](ClashTestClashGroupsSharedApi.md#getClashGroupJob) | **GET** /v3/containers/{containerId}/clashes/jobs/{jobId} | Get Clash Group Job
[**getScreenShot**](ClashTestClashGroupsSharedApi.md#getScreenShot) | **GET** /v3/containers/{containerId}/modelsets/{modelSetId}/screenshots/{screenShotId} | Get Screen Shot



## 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 closed clash group. It can also be associated with an assigned clash group, 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 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.ClashTestClashGroupsSharedApi();
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


## getClashGroupJob

> ClashGroupJob getClashGroupJob(containerId, jobId)

Get Clash Group Job

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

### 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.ClashTestClashGroupsSharedApi();
var containerId = null; // String | The GUID that uniquely identifies the container
var jobId = null; // String | The GUID that uniquely identifies the job
apiInstance.getClashGroupJob(containerId, 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 | 
 **jobId** | [**String**](.md)| The GUID that uniquely identifies the job | 

### Return type

[**ClashGroupJob**](ClashGroupJob.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 closed clash group.  Returns the requested screenshot file.

### 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.ClashTestClashGroupsSharedApi();
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