# IbmWorkloadSchedulerApi.SynchGroupApi

All URIs are relative to *https://localhost/ibm/TWSWebUI/Simple/rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**synchGroupDelete**](SynchGroupApi.md#synchGroupDelete) | **DELETE** /SynchGroup/{SYNCHGROUP_ID} | 
[**synchGroupIdGet**](SynchGroupApi.md#synchGroupIdGet) | **GET** /SynchGroup/{SYNCHGROUP_ID} | 
[**synchGroupsGet**](SynchGroupApi.md#synchGroupsGet) | **GET** /SynchGroup | 
[**synchGroupsPost**](SynchGroupApi.md#synchGroupsPost) | **POST** /SynchGroup | 
[**synchGroupsResourceLink**](SynchGroupApi.md#synchGroupsResourceLink) | **POST** /SynchGroup/{SYNCHGROUP_ID} | 
[**synchGroupsUpdate**](SynchGroupApi.md#synchGroupsUpdate) | **PUT** /SynchGroup/{SYNCHGROUP_ID} | 


<a name="synchGroupDelete"></a>
# **synchGroupDelete**
> synchGroupDelete(SYNCHGROUP_ID, tenantId, opts)



Delete a SynchGroup 

### Example
```javascript
var IbmWorkloadSchedulerApi = require('ibm-workload-scheduler-api');
var defaultClient = IbmWorkloadSchedulerApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new IbmWorkloadSchedulerApi.SynchGroupApi();

var SYNCHGROUP_ID = "SYNCHGROUP_ID_example"; // String | Id of synchgroup to fetch

var tenantId = "tenantId_example"; // String | The id of the Tenant that is making the call

var opts = { 
  'processId': "processId_example", // String | Id of the process
  'engineName': "engineName_example", // String | The name of the engine to connect to. Leave default in cloud environments
  'engineOwner': "engineOwner_example" // String | The owner of the engine definition. Leave default in cloud environments.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.synchGroupDelete(SYNCHGROUP_ID, tenantId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SYNCHGROUP_ID** | **String**| Id of synchgroup to fetch | 
 **tenantId** | **String**| The id of the Tenant that is making the call | 
 **processId** | **String**| Id of the process | [optional] 
 **engineName** | **String**| The name of the engine to connect to. Leave default in cloud environments | [optional] 
 **engineOwner** | **String**| The owner of the engine definition. Leave default in cloud environments. | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, mediatype/HTML

<a name="synchGroupIdGet"></a>
# **synchGroupIdGet**
> [SynchGroup] synchGroupIdGet(SYNCHGROUP_ID, tenantId, opts)



Return the SynchGroup identified by the SYNCHGROUP_ID 

### Example
```javascript
var IbmWorkloadSchedulerApi = require('ibm-workload-scheduler-api');
var defaultClient = IbmWorkloadSchedulerApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new IbmWorkloadSchedulerApi.SynchGroupApi();

var SYNCHGROUP_ID = "SYNCHGROUP_ID_example"; // String | Id of synchgroup to fetch

var tenantId = "tenantId_example"; // String | The id of the Tenant that is making the call

var opts = { 
  'engineName': "engineName_example", // String | The name of the engine to connect to. Leave default in cloud environments
  'engineOwner': "engineOwner_example" // String | The owner of the engine definition. Leave default in cloud environments.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.synchGroupIdGet(SYNCHGROUP_ID, tenantId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SYNCHGROUP_ID** | **String**| Id of synchgroup to fetch | 
 **tenantId** | **String**| The id of the Tenant that is making the call | 
 **engineName** | **String**| The name of the engine to connect to. Leave default in cloud environments | [optional] 
 **engineOwner** | **String**| The owner of the engine definition. Leave default in cloud environments. | [optional] 

### Return type

[**[SynchGroup]**](SynchGroup.md)

### Authorization

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

### HTTP request headers

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

<a name="synchGroupsGet"></a>
# **synchGroupsGet**
> [SynchGroup] synchGroupsGet(tenantId, opts)



The syncronization groups can be used to avoid two or more steps to run in parallel. Get the list of the SynchGroups 

### Example
```javascript
var IbmWorkloadSchedulerApi = require('ibm-workload-scheduler-api');
var defaultClient = IbmWorkloadSchedulerApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new IbmWorkloadSchedulerApi.SynchGroupApi();

var tenantId = "tenantId_example"; // String | The id of the Tenant that is making the call

var opts = { 
  'processId': "processId_example", // String | Id of the process
  'synchGroupName': "synchGroupName_example", // String | Name of the synchGroup
  'synchGroupId': "synchGroupId_example", // String | Id of the synchGroup
  'engineName': "engineName_example", // String | The name of the engine to connect to. Leave default in cloud environments
  'engineOwner': "engineOwner_example" // String | The owner of the engine definition. Leave default in cloud environments.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.synchGroupsGet(tenantId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **tenantId** | **String**| The id of the Tenant that is making the call | 
 **processId** | **String**| Id of the process | [optional] 
 **synchGroupName** | **String**| Name of the synchGroup | [optional] 
 **synchGroupId** | **String**| Id of the synchGroup | [optional] 
 **engineName** | **String**| The name of the engine to connect to. Leave default in cloud environments | [optional] 
 **engineOwner** | **String**| The owner of the engine definition. Leave default in cloud environments. | [optional] 

### Return type

[**[SynchGroup]**](SynchGroup.md)

### Authorization

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

### HTTP request headers

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

<a name="synchGroupsPost"></a>
# **synchGroupsPost**
> [SynchGroup] synchGroupsPost(synchGroup, tenantId, opts)



Create a new SynchGroups 

### Example
```javascript
var IbmWorkloadSchedulerApi = require('ibm-workload-scheduler-api');
var defaultClient = IbmWorkloadSchedulerApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new IbmWorkloadSchedulerApi.SynchGroupApi();

var synchGroup = new IbmWorkloadSchedulerApi.SynchGroup(); // SynchGroup | The SynchGroup to create

var tenantId = "tenantId_example"; // String | The id of the Tenant that is making the call

var opts = { 
  'engineName': "engineName_example", // String | The name of the engine to connect to. Leave default in cloud environments
  'engineOwner': "engineOwner_example" // String | The owner of the engine definition. Leave default in cloud environments.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.synchGroupsPost(synchGroup, tenantId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **synchGroup** | [**SynchGroup**](SynchGroup.md)| The SynchGroup to create | 
 **tenantId** | **String**| The id of the Tenant that is making the call | 
 **engineName** | **String**| The name of the engine to connect to. Leave default in cloud environments | [optional] 
 **engineOwner** | **String**| The owner of the engine definition. Leave default in cloud environments. | [optional] 

### Return type

[**[SynchGroup]**](SynchGroup.md)

### Authorization

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

### HTTP request headers

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

<a name="synchGroupsResourceLink"></a>
# **synchGroupsResourceLink**
> synchGroupsResourceLink(SYNCHGROUP_ID, body, tenantId, opts)



Create a new resource link for the ProcessIdList 

### Example
```javascript
var IbmWorkloadSchedulerApi = require('ibm-workload-scheduler-api');
var defaultClient = IbmWorkloadSchedulerApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new IbmWorkloadSchedulerApi.SynchGroupApi();

var SYNCHGROUP_ID = "SYNCHGROUP_ID_example"; // String | Id of synchgroup to fetch

var body = "body_example"; // String | List of the Processes's id

var tenantId = "tenantId_example"; // String | The id of the Tenant that is making the call

var opts = { 
  'engineName': "engineName_example", // String | The name of the engine to connect to. Leave default in cloud environments
  'engineOwner': "engineOwner_example" // String | The owner of the engine definition. Leave default in cloud environments.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.synchGroupsResourceLink(SYNCHGROUP_ID, body, tenantId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SYNCHGROUP_ID** | **String**| Id of synchgroup to fetch | 
 **body** | **String**| List of the Processes&#39;s id | 
 **tenantId** | **String**| The id of the Tenant that is making the call | 
 **engineName** | **String**| The name of the engine to connect to. Leave default in cloud environments | [optional] 
 **engineOwner** | **String**| The owner of the engine definition. Leave default in cloud environments. | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, mediatype/HTML

<a name="synchGroupsUpdate"></a>
# **synchGroupsUpdate**
> synchGroupsUpdate(SYNCHGROUP_ID, body, tenantId, opts)



Update the information of a SynchGroup response 

### Example
```javascript
var IbmWorkloadSchedulerApi = require('ibm-workload-scheduler-api');
var defaultClient = IbmWorkloadSchedulerApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new IbmWorkloadSchedulerApi.SynchGroupApi();

var SYNCHGROUP_ID = "SYNCHGROUP_ID_example"; // String | Id of synchgroup to fetch

var body = new IbmWorkloadSchedulerApi.SynchGroup(); // SynchGroup | The SynchGroup to update

var tenantId = "tenantId_example"; // String | The id of the Tenant that is making the call

var opts = { 
  'engineName': "engineName_example", // String | The name of the engine to connect to. Leave default in cloud environments
  'engineOwner': "engineOwner_example" // String | The owner of the engine definition. Leave default in cloud environments.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.synchGroupsUpdate(SYNCHGROUP_ID, body, tenantId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SYNCHGROUP_ID** | **String**| Id of synchgroup to fetch | 
 **body** | [**SynchGroup**](SynchGroup.md)| The SynchGroup to update | 
 **tenantId** | **String**| The id of the Tenant that is making the call | 
 **engineName** | **String**| The name of the engine to connect to. Leave default in cloud environments | [optional] 
 **engineOwner** | **String**| The owner of the engine definition. Leave default in cloud environments. | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, mediatype/HTML