# Equisoft\SDK\EquisoftConnect\FieldValuesApi

All URIs are relative to http://localhost, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createGroup()**](FieldValuesApi.md#createGroup) | **POST** /crm/api/v1/fields/{fieldName}/groups | Create a group |
| [**createGroupValue()**](FieldValuesApi.md#createGroupValue) | **POST** /crm/api/v1/fields/{fieldName}/groups/{id}/values | Create a group value |
| [**createValue()**](FieldValuesApi.md#createValue) | **POST** /crm/api/v1/fields/{fieldName}/values | Create a value |
| [**deleteGroup()**](FieldValuesApi.md#deleteGroup) | **DELETE** /crm/api/v1/fields/{fieldName}/groups/{id} | Delete single group for a specific field name and group id |
| [**deleteValue()**](FieldValuesApi.md#deleteValue) | **DELETE** /crm/api/v1/fields/{fieldName}/values/{id} | Delete single value for a specific field name and value id |
| [**getGroup()**](FieldValuesApi.md#getGroup) | **GET** /crm/api/v1/fields/{fieldName}/groups/{id} | Get single group for a specific field name and group id |
| [**getValue()**](FieldValuesApi.md#getValue) | **GET** /crm/api/v1/fields/{fieldName}/values/{id} | Get single value for a specific field name and value id |
| [**linkValueGroup()**](FieldValuesApi.md#linkValueGroup) | **PUT** /crm/api/v1/fields/{fieldName}/values/{id}/groups | Link a value to a group |
| [**listFields()**](FieldValuesApi.md#listFields) | **GET** /crm/api/v1/fields | List fields with values list (values domain). |
| [**listGroupValues()**](FieldValuesApi.md#listGroupValues) | **GET** /crm/api/v1/fields/{fieldName}/groups/{id}/values | List values for a specific field name and group |
| [**listGroups()**](FieldValuesApi.md#listGroups) | **GET** /crm/api/v1/fields/{fieldName}/groups | List groups for a specific field name |
| [**listValues()**](FieldValuesApi.md#listValues) | **GET** /crm/api/v1/fields/{fieldName}/values | List values for a specific field name |
| [**updateGroup()**](FieldValuesApi.md#updateGroup) | **PUT** /crm/api/v1/fields/{fieldName}/groups/{id} | Update a group |
| [**updateValue()**](FieldValuesApi.md#updateValue) | **PUT** /crm/api/v1/fields/{fieldName}/values/{id} | Update a value |


## `createGroup()`

```php
createGroup($fieldName, $fieldValueCreateGroupPayload): \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateGroupResponse
```

Create a group

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$fieldValueCreateGroupPayload = new \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateGroupPayload(); // \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateGroupPayload

try {
    $result = $apiInstance->createGroup($fieldName, $fieldValueCreateGroupPayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->createGroup: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **fieldValueCreateGroupPayload** | [**\Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateGroupPayload**](../Model/FieldValueCreateGroupPayload.md)|  | |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateGroupResponse**](../Model/FieldValueCreateOrUpdateGroupResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `createGroupValue()`

```php
createGroupValue($fieldName, $id, $fieldValueCreateValuePayload): \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateValueResponse
```

Create a group value

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | group unique identifier.
$fieldValueCreateValuePayload = new \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateValuePayload(); // \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateValuePayload

try {
    $result = $apiInstance->createGroupValue($fieldName, $id, $fieldValueCreateValuePayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->createGroupValue: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| group unique identifier. | |
| **fieldValueCreateValuePayload** | [**\Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateValuePayload**](../Model/FieldValueCreateValuePayload.md)|  | |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateValueResponse**](../Model/FieldValueCreateOrUpdateValueResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `createValue()`

```php
createValue($fieldName, $fieldValueCreateValuePayload): \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateValueResponse
```

Create a value

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$fieldValueCreateValuePayload = new \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateValuePayload(); // \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateValuePayload

try {
    $result = $apiInstance->createValue($fieldName, $fieldValueCreateValuePayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->createValue: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **fieldValueCreateValuePayload** | [**\Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateValuePayload**](../Model/FieldValueCreateValuePayload.md)|  | |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateValueResponse**](../Model/FieldValueCreateOrUpdateValueResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `deleteGroup()`

```php
deleteGroup($fieldName, $id)
```

Delete single group for a specific field name and group id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | group unique identifier.

try {
    $apiInstance->deleteGroup($fieldName, $id);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->deleteGroup: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| group unique identifier. | |

### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `deleteValue()`

```php
deleteValue($fieldName, $id)
```

Delete single value for a specific field name and value id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | value unique identifier.

try {
    $apiInstance->deleteValue($fieldName, $id);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->deleteValue: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| value unique identifier. | |

### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getGroup()`

```php
getGroup($fieldName, $id): \Equisoft\SDK\EquisoftConnect\Model\FieldValueGroup
```

Get single group for a specific field name and group id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | group unique identifier.

try {
    $result = $apiInstance->getGroup($fieldName, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->getGroup: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| group unique identifier. | |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueGroup**](../Model/FieldValueGroup.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `getValue()`

```php
getValue($fieldName, $id): \Equisoft\SDK\EquisoftConnect\Model\FieldValueValue
```

Get single value for a specific field name and value id

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | value unique identifier.

try {
    $result = $apiInstance->getValue($fieldName, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->getValue: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| value unique identifier. | |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueValue**](../Model/FieldValueValue.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `linkValueGroup()`

```php
linkValueGroup($fieldName, $id, $fieldValueLinkGroupValuePayload)
```

Link a value to a group

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | value unique identifier.
$fieldValueLinkGroupValuePayload = new \Equisoft\SDK\EquisoftConnect\Model\FieldValueLinkGroupValuePayload(); // \Equisoft\SDK\EquisoftConnect\Model\FieldValueLinkGroupValuePayload

try {
    $apiInstance->linkValueGroup($fieldName, $id, $fieldValueLinkGroupValuePayload);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->linkValueGroup: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| value unique identifier. | |
| **fieldValueLinkGroupValuePayload** | [**\Equisoft\SDK\EquisoftConnect\Model\FieldValueLinkGroupValuePayload**](../Model/FieldValueLinkGroupValuePayload.md)|  | |

### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `listFields()`

```php
listFields(): \Equisoft\SDK\EquisoftConnect\Model\FieldValueListFieldResponse
```

List fields with values list (values domain).

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listFields();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->listFields: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueListFieldResponse**](../Model/FieldValueListFieldResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `listGroupValues()`

```php
listGroupValues($fieldName, $id): \Equisoft\SDK\EquisoftConnect\Model\FieldValueListValueResponse
```

List values for a specific field name and group

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | group unique identifier.

try {
    $result = $apiInstance->listGroupValues($fieldName, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->listGroupValues: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| group unique identifier. | |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueListValueResponse**](../Model/FieldValueListValueResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `listGroups()`

```php
listGroups($fieldName, $systemName): \Equisoft\SDK\EquisoftConnect\Model\FieldValueListGroupResponse
```

List groups for a specific field name

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$systemName = 'systemName_example'; // string | Value unique identifier.

try {
    $result = $apiInstance->listGroups($fieldName, $systemName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->listGroups: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **systemName** | **string**| Value unique identifier. | [optional] |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueListGroupResponse**](../Model/FieldValueListGroupResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `listValues()`

```php
listValues($fieldName, $systemName, $privateValue): \Equisoft\SDK\EquisoftConnect\Model\FieldValueListValueResponse
```

List values for a specific field name

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$systemName = 'systemName_example'; // string | Value unique identifier.
$privateValue = True; // bool | Private value only.

try {
    $result = $apiInstance->listValues($fieldName, $systemName, $privateValue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->listValues: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **systemName** | **string**| Value unique identifier. | [optional] |
| **privateValue** | **bool**| Private value only. | [optional] |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueListValueResponse**](../Model/FieldValueListValueResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `updateGroup()`

```php
updateGroup($fieldName, $id, $fieldValueUpdateGroupPayload): \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateGroupResponse
```

Update a group

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | group unique identifier.
$fieldValueUpdateGroupPayload = new \Equisoft\SDK\EquisoftConnect\Model\FieldValueUpdateGroupPayload(); // \Equisoft\SDK\EquisoftConnect\Model\FieldValueUpdateGroupPayload

try {
    $result = $apiInstance->updateGroup($fieldName, $id, $fieldValueUpdateGroupPayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->updateGroup: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| group unique identifier. | |
| **fieldValueUpdateGroupPayload** | [**\Equisoft\SDK\EquisoftConnect\Model\FieldValueUpdateGroupPayload**](../Model/FieldValueUpdateGroupPayload.md)|  | |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateGroupResponse**](../Model/FieldValueCreateOrUpdateGroupResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `updateValue()`

```php
updateValue($fieldName, $id, $fieldValueUpdateValuePayload): \Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateValueResponse
```

Update a value

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\FieldValuesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$fieldName = 'fieldName_example'; // string | Field unique identifier.
$id = 56; // int | value unique identifier.
$fieldValueUpdateValuePayload = new \Equisoft\SDK\EquisoftConnect\Model\FieldValueUpdateValuePayload(); // \Equisoft\SDK\EquisoftConnect\Model\FieldValueUpdateValuePayload

try {
    $result = $apiInstance->updateValue($fieldName, $id, $fieldValueUpdateValuePayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldValuesApi->updateValue: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fieldName** | **string**| Field unique identifier. | |
| **id** | **int**| value unique identifier. | |
| **fieldValueUpdateValuePayload** | [**\Equisoft\SDK\EquisoftConnect\Model\FieldValueUpdateValuePayload**](../Model/FieldValueUpdateValuePayload.md)|  | |

### Return type

[**\Equisoft\SDK\EquisoftConnect\Model\FieldValueCreateOrUpdateValueResponse**](../Model/FieldValueCreateOrUpdateValueResponse.md)

### Authorization

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

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)