dapla-toolbelt-metadata 0.2.1__py3-none-any.whl → 0.9.11__py3-none-any.whl

dapla_metadata/variable_definitions/_generated/vardef_client/docs/Draft.md

@@ -0,0 +1,42 @@
+# Draft
+
+Create a Draft Variable Definition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**LanguageStringType**](LanguageStringType.md) | Name of the variable. Must be unique for a given Unit Type and Owner combination. |
+**short_name** | **str** | Recommended short name. Must be unique within an organization. |
+**definition** | [**LanguageStringType**](LanguageStringType.md) | Definition of the variable. |
+**classification_reference** | **str** | ID of a classification or code list from Klass. The given classification defines all possible values for the defined variable. | [optional]
+**unit_types** | **List[str]** | A list of one or more unit types, e.g. person, vehicle, household. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/702. |
+**subject_fields** | **List[str]** | A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618. |
+**contains_special_categories_of_personal_data** | **bool** | True if variable instances contain particularly sensitive information. Applies even if the information or identifiers are pseudonymized. Information within the following categories are regarded as particularly sensitive: Ethnicity, Political alignment, Religion, Philosophical beliefs, Union membership, Genetics, Biometrics, Health, Sexual relations, Sexual orientation |
+**measurement_type** | **str** | Type of measurement for the variable, e.g. length, volume, currency. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/303 | [optional]
+**valid_from** | **date** | The variable definition is valid from this date inclusive |
+**external_reference_uri** | **str** | A link (URI) to an external definition/documentation | [optional]
+**comment** | [**LanguageStringType**](LanguageStringType.md) | Optional comment to explain the definition or communicate potential changes. | [optional]
+**related_variable_definition_uris** | **List[str]** | Link(s) to related definitions of variables - a list of one or more definitions. For example for a variable after-tax income it could be relevant to link to definitions of income from work, property income etc. | [optional]
+**contact** | [**Contact**](Contact.md) | Contact details | [optional]
+
+## Example
+
+```python
+from vardef_client.models.draft import Draft
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Draft from a JSON string
+draft_instance = Draft.from_json(json)
+# print the JSON string representation of the object
+print(Draft.to_json())
+
+# convert the object into a dict
+draft_dict = draft_instance.to_dict()
+# create an instance of Draft from a dict
+draft_from_dict = Draft.from_dict(draft_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/DraftVariableDefinitionsApi.md

@@ -0,0 +1,259 @@
+# vardef_client.DraftVariableDefinitionsApi
+
+All URIs are relative to *https://metadata.intern.test.ssb.no*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_variable_definition**](DraftVariableDefinitionsApi.md#create_variable_definition) | **POST** /variable-definitions | Create a variable definition.
+[**delete_variable_definition_by_id**](DraftVariableDefinitionsApi.md#delete_variable_definition_by_id) | **DELETE** /variable-definitions/{variable-definition-id} | Delete a variable definition.
+[**update_variable_definition_by_id**](DraftVariableDefinitionsApi.md#update_variable_definition_by_id) | **PATCH** /variable-definitions/{variable-definition-id} | Update a variable definition.
+
+
+# **create_variable_definition**
+> create_variable_definition(active_group, draft)
+
+Create a variable definition.
+
+Create a variable definition. New variable definitions are automatically assigned status DRAFT and must include all required fields. Attempts to specify id or variable_status in a request will receive 400 BAD REQUEST responses.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.models.draft import Draft
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.DraftVariableDefinitionsApi(api_client)
+    active_group = 'dapla-felles-developers' # str | The group which the user currently represents.
+    draft = vardef_client.Draft() # Draft | 
+
+    try:
+        # Create a variable definition.
+        api_instance.create_variable_definition(active_group, draft)
+    except Exception as e:
+        print("Exception when calling DraftVariableDefinitionsApi->create_variable_definition: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **active_group** | **str**| The group which the user currently represents. | 
+ **draft** | [**Draft**](Draft.md)|  | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Successfully created. |  -  |
+**400** | Malformed data, missing data or attempt to specify disallowed fields. |  -  |
+**409** | Short name is already in use by another variable definition. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **delete_variable_definition_by_id**
+> object delete_variable_definition_by_id(variable_definition_id, active_group)
+
+Delete a variable definition.
+
+Delete a variable definition.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.DraftVariableDefinitionsApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    active_group = 'dapla-felles-developers' # str | The group which the user currently represents.
+
+    try:
+        # Delete a variable definition.
+        api_response = api_instance.delete_variable_definition_by_id(variable_definition_id, active_group)
+        print("The response of DraftVariableDefinitionsApi->delete_variable_definition_by_id:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DraftVariableDefinitionsApi->delete_variable_definition_by_id: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **active_group** | **str**| The group which the user currently represents. | 
+
+### Return type
+
+**object**
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Successfully deleted |  -  |
+**404** | No such variable definition found |  -  |
+**405** | Attempt to delete a variable definition with status unlike DRAFT. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **update_variable_definition_by_id**
+> CompleteResponse update_variable_definition_by_id(variable_definition_id, active_group, update_draft)
+
+Update a variable definition.
+
+Update a variable definition. Only the fields which need updating should be supplied.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.models.complete_response import CompleteResponse
+from vardef_client.models.update_draft import UpdateDraft
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.DraftVariableDefinitionsApi(api_client)
+    variable_definition_id = 'variable_definition_id_example' # str | 
+    active_group = 'dapla-felles-developers' # str | The group which the user currently represents.
+    update_draft = vardef_client.UpdateDraft() # UpdateDraft | 
+
+    try:
+        # Update a variable definition.
+        api_response = api_instance.update_variable_definition_by_id(variable_definition_id, active_group, update_draft)
+        print("The response of DraftVariableDefinitionsApi->update_variable_definition_by_id:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DraftVariableDefinitionsApi->update_variable_definition_by_id: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**|  | 
+ **active_group** | **str**| The group which the user currently represents. | 
+ **update_draft** | [**UpdateDraft**](UpdateDraft.md)|  | 
+
+### Return type
+
+[**CompleteResponse**](CompleteResponse.md)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successfully updated |  -  |
+**400** | Bad request. Examples of these are: - Reference to a Klass classification which doesn't exist. - Owner information missing. - Malformed email addresses. |  -  |
+**404** | No such variable definition found |  -  |
+**405** | Attempt to patch a variable definition with status unlike DRAFT. |  -  |
+**409** | Short name is already in use by another variable definition. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/LanguageStringType.md

@@ -0,0 +1,31 @@
+# LanguageStringType
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nb** | **str** |  | [optional] 
+**nn** | **str** |  | [optional] 
+**en** | **str** |  | [optional] 
+
+## Example
+
+```python
+from vardef_client.models.language_string_type import LanguageStringType
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of LanguageStringType from a JSON string
+language_string_type_instance = LanguageStringType.from_json(json)
+# print the JSON string representation of the object
+print(LanguageStringType.to_json())
+
+# convert the object into a dict
+language_string_type_dict = language_string_type_instance.to_dict()
+# create an instance of LanguageStringType from a dict
+language_string_type_from_dict = LanguageStringType.from_dict(language_string_type_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/Owner.md

@@ -0,0 +1,31 @@
+# Owner
+
+Owner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**team** | **str** |  | 
+**groups** | **List[str]** |  | 
+
+## Example
+
+```python
+from vardef_client.models.owner import Owner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Owner from a JSON string
+owner_instance = Owner.from_json(json)
+# print the JSON string representation of the object
+print(Owner.to_json())
+
+# convert the object into a dict
+owner_dict = owner_instance.to_dict()
+# create an instance of Owner from a dict
+owner_from_dict = Owner.from_dict(owner_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/Patch.md

@@ -0,0 +1,43 @@
+# Patch
+
+Create a new Patch version on a Published Variable Definition.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**LanguageStringType**](LanguageStringType.md) | Name of the variable. Must be unique for a given Unit Type and Owner combination. | [optional]
+**definition** | [**LanguageStringType**](LanguageStringType.md) | Definition of the variable. | [optional]
+**classification_reference** | **str** | ID of a classification or code list from Klass. The given classification defines all possible values for the defined variable. | [optional]
+**unit_types** | **List[str]** | A list of one or more unit types, e.g. person, vehicle, household. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/702. | [optional]
+**subject_fields** | **List[str]** | A list of subject fields that the variable is used in. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/618. | [optional]
+**contains_special_categories_of_personal_data** | **bool** | True if variable instances contain particularly sensitive information. Applies even if the information or identifiers are pseudonymized. Information within the following categories are regarded as particularly sensitive: Ethnicity, Political alignment, Religion, Philosophical beliefs, Union membership, Genetics, Biometrics, Health, Sexual relations, Sexual orientation | [optional]
+**variable_status** | [**VariableStatus**](VariableStatus.md) | Status of the life cycle of the variable | [optional] [readonly]
+**measurement_type** | **str** | Type of measurement for the variable, e.g. length, volume, currency. Must be defined as codes from https://www.ssb.no/klass/klassifikasjoner/303 | [optional]
+**valid_until** | **date** | The variable definition is valid until this date inclusive | [optional]
+**external_reference_uri** | **str** | A link (URI) to an external definition/documentation | [optional]
+**comment** | [**LanguageStringType**](LanguageStringType.md) | Optional comment to explain the definition or communicate potential changes. | [optional]
+**related_variable_definition_uris** | **List[str]** | Link(s) to related definitions of variables - a list of one or more definitions. For example for a variable after-tax income it could be relevant to link to definitions of income from work, property income etc. | [optional]
+**owner** | [**Owner**](Owner.md) | Owner of the definition, i.e. responsible Dapla team (statistics team) and information about access management groups. | [optional]
+**contact** | [**Contact**](Contact.md) | Contact details | [optional]
+
+## Example
+
+```python
+from vardef_client.models.patch import Patch
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Patch from a JSON string
+patch_instance = Patch.from_json(json)
+# print the JSON string representation of the object
+print(Patch.to_json())
+
+# convert the object into a dict
+patch_dict = patch_instance.to_dict()
+# create an instance of Patch from a dict
+patch_from_dict = Patch.from_dict(patch_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/PatchesApi.md

@@ -0,0 +1,249 @@
+# vardef_client.PatchesApi
+
+All URIs are relative to *https://metadata.intern.test.ssb.no*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_patch**](PatchesApi.md#create_patch) | **POST** /variable-definitions/{variable-definition-id}/patches | Create a new patch for a variable definition.
+[**get_all_patches**](PatchesApi.md#get_all_patches) | **GET** /variable-definitions/{variable-definition-id}/patches | List all patches for the given variable definition.
+[**get_one_patch**](PatchesApi.md#get_one_patch) | **GET** /variable-definitions/{variable-definition-id}/patches/{patch-id} | Get one concrete patch for the given variable definition.
+
+
+# **create_patch**
+> create_patch(variable_definition_id, active_group, patch, valid_from=valid_from)
+
+Create a new patch for a variable definition.
+
+Create a new patch for a variable definition.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.models.patch import Patch
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.PatchesApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    active_group = 'dapla-felles-developers' # str | The group which the user currently represents.
+    patch = vardef_client.Patch() # Patch | 
+    valid_from = '1970-01-01' # date | Valid from date for the specific validity period to be patched. (optional)
+
+    try:
+        # Create a new patch for a variable definition.
+        api_instance.create_patch(variable_definition_id, active_group, patch, valid_from=valid_from)
+    except Exception as e:
+        print("Exception when calling PatchesApi->create_patch: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **active_group** | **str**| The group which the user currently represents. | 
+ **patch** | [**Patch**](Patch.md)|  | 
+ **valid_from** | **date**| Valid from date for the specific validity period to be patched. | [optional] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**201** | Successfully created. |  -  |
+**400** | Bad request. |  -  |
+**405** | Method only allowed for published variables. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_all_patches**
+> get_all_patches(variable_definition_id)
+
+List all patches for the given variable definition.
+
+List all patches for the given variable definition. The full object is returned for comparison purposes.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.PatchesApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+
+    try:
+        # List all patches for the given variable definition.
+        api_instance.get_all_patches(variable_definition_id)
+    except Exception as e:
+        print("Exception when calling PatchesApi->get_all_patches: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**404** | No such variable definition found |  -  |
+**200** | Ok |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_one_patch**
+> get_one_patch(variable_definition_id, patch_id)
+
+Get one concrete patch for the given variable definition.
+
+Get one concrete patch for the given variable definition. The full object is returned for comparison purposes.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.PatchesApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    patch_id = 1 # int | ID of the patch to retrieve
+
+    try:
+        # Get one concrete patch for the given variable definition.
+        api_instance.get_one_patch(variable_definition_id, patch_id)
+    except Exception as e:
+        print("Exception when calling PatchesApi->get_one_patch: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **patch_id** | **int**| ID of the patch to retrieve | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Ok |  -  |
+**404** | No such variable definition found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+