# OmsorgCoreClient\ValueListsApi

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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**apiValueListsGet()**](ValueListsApi.md#apiValueListsGet) | **GET** /api/value-lists |  |
| [**apiValueListsKeyItemsGet()**](ValueListsApi.md#apiValueListsKeyItemsGet) | **GET** /api/value-lists/{key}/items |  |
| [**apiValueListsKeyItemsIdDelete()**](ValueListsApi.md#apiValueListsKeyItemsIdDelete) | **DELETE** /api/value-lists/{key}/items/{id} |  |
| [**apiValueListsKeyItemsIdPut()**](ValueListsApi.md#apiValueListsKeyItemsIdPut) | **PUT** /api/value-lists/{key}/items/{id} |  |
| [**apiValueListsKeyItemsIdUsagesGet()**](ValueListsApi.md#apiValueListsKeyItemsIdUsagesGet) | **GET** /api/value-lists/{key}/items/{id}/usages |  |
| [**apiValueListsKeyItemsPost()**](ValueListsApi.md#apiValueListsKeyItemsPost) | **POST** /api/value-lists/{key}/items |  |
| [**apiValueListsKeyTransitionsGet()**](ValueListsApi.md#apiValueListsKeyTransitionsGet) | **GET** /api/value-lists/{key}/transitions |  |
| [**apiValueListsKeyTransitionsPut()**](ValueListsApi.md#apiValueListsKeyTransitionsPut) | **PUT** /api/value-lists/{key}/transitions |  |


## `apiValueListsGet()`

```php
apiValueListsGet(): \OmsorgCoreClient\Model\ValueListResponse[]
```



### Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\ValueListsApi(
    // 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->apiValueListsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValueListsApi->apiValueListsGet: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**\OmsorgCoreClient\Model\ValueListResponse[]**](../Model/ValueListResponse.md)

### Authorization

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

### HTTP request headers

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

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

## `apiValueListsKeyItemsGet()`

```php
apiValueListsKeyItemsGet($key): \OmsorgCoreClient\Model\ValueListItemResponse[]
```



### Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\ValueListsApi(
    // 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
);
$key = 'key_example'; // string

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **key** | **string**|  | |

### Return type

[**\OmsorgCoreClient\Model\ValueListItemResponse[]**](../Model/ValueListItemResponse.md)

### Authorization

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

### HTTP request headers

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

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

## `apiValueListsKeyItemsIdDelete()`

```php
apiValueListsKeyItemsIdDelete($key, $id)
```



### Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\ValueListsApi(
    // 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
);
$key = 'key_example'; // string
$id = 'id_example'; // string

try {
    $apiInstance->apiValueListsKeyItemsIdDelete($key, $id);
} catch (Exception $e) {
    echo 'Exception when calling ValueListsApi->apiValueListsKeyItemsIdDelete: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **key** | **string**|  | |
| **id** | **string**|  | |

### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

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

## `apiValueListsKeyItemsIdPut()`

```php
apiValueListsKeyItemsIdPut($key, $id, $update_value_list_item_request): \OmsorgCoreClient\Model\ValueListItemResponse
```



### Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\ValueListsApi(
    // 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
);
$key = 'key_example'; // string
$id = 'id_example'; // string
$update_value_list_item_request = new \OmsorgCoreClient\Model\UpdateValueListItemRequest(); // \OmsorgCoreClient\Model\UpdateValueListItemRequest

try {
    $result = $apiInstance->apiValueListsKeyItemsIdPut($key, $id, $update_value_list_item_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ValueListsApi->apiValueListsKeyItemsIdPut: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **key** | **string**|  | |
| **id** | **string**|  | |
| **update_value_list_item_request** | [**\OmsorgCoreClient\Model\UpdateValueListItemRequest**](../Model/UpdateValueListItemRequest.md)|  | [optional] |

### Return type

[**\OmsorgCoreClient\Model\ValueListItemResponse**](../Model/ValueListItemResponse.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: `application/json`, `text/json`, `application/*+json`
- **Accept**: `text/plain`, `application/json`, `text/json`

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

## `apiValueListsKeyItemsIdUsagesGet()`

```php
apiValueListsKeyItemsIdUsagesGet($key, $id): \OmsorgCoreClient\Model\ValueListUsageResponse[]
```



### Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\ValueListsApi(
    // 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
);
$key = 'key_example'; // string
$id = 'id_example'; // string

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **key** | **string**|  | |
| **id** | **string**|  | |

### Return type

[**\OmsorgCoreClient\Model\ValueListUsageResponse[]**](../Model/ValueListUsageResponse.md)

### Authorization

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

### HTTP request headers

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

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

## `apiValueListsKeyItemsPost()`

```php
apiValueListsKeyItemsPost($key, $create_value_list_item_request): \OmsorgCoreClient\Model\ValueListItemResponse
```



### Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\ValueListsApi(
    // 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
);
$key = 'key_example'; // string
$create_value_list_item_request = new \OmsorgCoreClient\Model\CreateValueListItemRequest(); // \OmsorgCoreClient\Model\CreateValueListItemRequest

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **key** | **string**|  | |
| **create_value_list_item_request** | [**\OmsorgCoreClient\Model\CreateValueListItemRequest**](../Model/CreateValueListItemRequest.md)|  | [optional] |

### Return type

[**\OmsorgCoreClient\Model\ValueListItemResponse**](../Model/ValueListItemResponse.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: `application/json`, `text/json`, `application/*+json`
- **Accept**: `text/plain`, `application/json`, `text/json`

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

## `apiValueListsKeyTransitionsGet()`

```php
apiValueListsKeyTransitionsGet($key): \OmsorgCoreClient\Model\ValueListTransitionResponse[]
```



### Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\ValueListsApi(
    // 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
);
$key = 'key_example'; // string

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **key** | **string**|  | |

### Return type

[**\OmsorgCoreClient\Model\ValueListTransitionResponse[]**](../Model/ValueListTransitionResponse.md)

### Authorization

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

### HTTP request headers

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

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

## `apiValueListsKeyTransitionsPut()`

```php
apiValueListsKeyTransitionsPut($key, $value_list_transition_request)
```



### Example

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


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\ValueListsApi(
    // 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
);
$key = 'key_example'; // string
$value_list_transition_request = array(new \OmsorgCoreClient\Model\ValueListTransitionRequest()); // \OmsorgCoreClient\Model\ValueListTransitionRequest[]

try {
    $apiInstance->apiValueListsKeyTransitionsPut($key, $value_list_transition_request);
} catch (Exception $e) {
    echo 'Exception when calling ValueListsApi->apiValueListsKeyTransitionsPut: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **key** | **string**|  | |
| **value_list_transition_request** | [**\OmsorgCoreClient\Model\ValueListTransitionRequest[]**](../Model/ValueListTransitionRequest.md)|  | [optional] |

### Return type

void (empty response body)

### Authorization

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

### HTTP request headers

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

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