diff --git a/python-restclient/.openapi-generator/FILES b/python-restclient/.openapi-generator/FILES index e23e849145..59cbba1451 100644 --- a/python-restclient/.openapi-generator/FILES +++ b/python-restclient/.openapi-generator/FILES @@ -8,21 +8,15 @@ docs/BatchSystemType.md docs/BioModel.md docs/BioModelResourceApi.md docs/BiomodelRef.md -docs/CartesianMesh.md -docs/Coordinate.md docs/DataIdentifier.md docs/DetailedState.md docs/Domain.md docs/Extent.md docs/ExternalDataIdentifier.md -docs/FieldDataDBOperationSpec.md -docs/FieldDataFileOperationSpec.md -docs/FieldDataInfo.md -docs/FieldDataNoCopyConflict.md -docs/FieldDataReferences.md +docs/FieldDataReference.md docs/FieldDataResourceApi.md docs/FieldDataSaveResults.md -docs/GroupAccess.md +docs/FieldDataShape.md docs/HelloWorldApi.md docs/HelloWorldMessage.md docs/HtcJobID.md @@ -43,7 +37,6 @@ docs/SimulationResourceApi.md docs/SimulationStatusPersistentRecord.md docs/Status.md docs/StatusMessage.md -docs/UCDInfo.md docs/User.md docs/UserIdentityJSONSafe.md docs/UserLoginInfoForMapping.md @@ -52,12 +45,9 @@ docs/UsersResourceApi.md docs/VCSimulationIdentifier.md docs/VariableDomain.md docs/VariableType.md -docs/Version.md -docs/VersionFlag.md -docs/VersionableType.md -docs/VersionableTypeVersion.md pyproject.toml test/__init__.py +test/test_field_data_shape.py tox.ini vcell_client/__init__.py vcell_client/api/__init__.py @@ -78,20 +68,14 @@ vcell_client/models/analyzed_results_from_field_data.py vcell_client/models/batch_system_type.py vcell_client/models/bio_model.py vcell_client/models/biomodel_ref.py -vcell_client/models/cartesian_mesh.py -vcell_client/models/coordinate.py vcell_client/models/data_identifier.py vcell_client/models/detailed_state.py vcell_client/models/domain.py vcell_client/models/extent.py vcell_client/models/external_data_identifier.py -vcell_client/models/field_data_db_operation_spec.py -vcell_client/models/field_data_file_operation_spec.py -vcell_client/models/field_data_info.py -vcell_client/models/field_data_no_copy_conflict.py -vcell_client/models/field_data_references.py +vcell_client/models/field_data_reference.py vcell_client/models/field_data_save_results.py -vcell_client/models/group_access.py +vcell_client/models/field_data_shape.py vcell_client/models/hello_world_message.py vcell_client/models/htc_job_id.py vcell_client/models/i_size.py @@ -109,7 +93,6 @@ vcell_client/models/simulation_queue_id.py vcell_client/models/simulation_status_persistent_record.py vcell_client/models/status.py vcell_client/models/status_message.py -vcell_client/models/ucd_info.py vcell_client/models/user.py vcell_client/models/user_identity_json_safe.py vcell_client/models/user_login_info_for_mapping.py @@ -117,9 +100,5 @@ vcell_client/models/user_registration_info.py vcell_client/models/variable_domain.py vcell_client/models/variable_type.py vcell_client/models/vc_simulation_identifier.py -vcell_client/models/version.py -vcell_client/models/version_flag.py -vcell_client/models/versionable_type.py -vcell_client/models/versionable_type_version.py vcell_client/py.typed vcell_client/rest.py diff --git a/python-restclient/README.md b/python-restclient/README.md index 1c20a5588d..835d131595 100644 --- a/python-restclient/README.md +++ b/python-restclient/README.md @@ -89,13 +89,11 @@ Class | Method | HTTP request | Description *BioModelResourceApi* | [**delete_bio_model**](docs/BioModelResourceApi.md#delete_bio_model) | **DELETE** /api/v1/bioModel/{bioModelID} | Delete the BioModel from VCell's database. *BioModelResourceApi* | [**get_biomodel_by_id**](docs/BioModelResourceApi.md#get_biomodel_by_id) | **GET** /api/v1/bioModel/{bioModelID} | Get BioModel information in JSON format by ID. *BioModelResourceApi* | [**upload_bio_model**](docs/BioModelResourceApi.md#upload_bio_model) | **POST** /api/v1/bioModel/upload_bioModel | Upload the BioModel to VCell database. Returns BioModel ID. -*FieldDataResourceApi* | [**copy_field_data**](docs/FieldDataResourceApi.md#copy_field_data) | **POST** /api/v1/fieldData/copy | Copy an existing field data entry. -*FieldDataResourceApi* | [**create_new_field_data_from_file_already_analyzed**](docs/FieldDataResourceApi.md#create_new_field_data_from_file_already_analyzed) | **POST** /api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed | -*FieldDataResourceApi* | [**create_new_field_data_from_simulation**](docs/FieldDataResourceApi.md#create_new_field_data_from_simulation) | **POST** /api/v1/fieldData/createFieldDataFromSimulation | Create new field data from a simulation. -*FieldDataResourceApi* | [**delete_field_data**](docs/FieldDataResourceApi.md#delete_field_data) | **DELETE** /api/v1/fieldData | Delete the selected field data. -*FieldDataResourceApi* | [**generate_field_data_estimate**](docs/FieldDataResourceApi.md#generate_field_data_estimate) | **POST** /api/v1/fieldData/analyzeFieldDataFromFile | +*FieldDataResourceApi* | [**analyze_field_data_file**](docs/FieldDataResourceApi.md#analyze_field_data_file) | **POST** /api/v1/fieldData/analyzeFieldDataFile | Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. +*FieldDataResourceApi* | [**create_field_data_from_analyzed_file**](docs/FieldDataResourceApi.md#create_field_data_from_analyzed_file) | **POST** /api/v1/fieldData/createFieldDataFromAnalyzedFile | Take the analyzed results of the field data, modify it to your liking, then save it on the server. +*FieldDataResourceApi* | [**delete_field_data**](docs/FieldDataResourceApi.md#delete_field_data) | **DELETE** /api/v1/fieldData/delete/{fieldDataID} | Delete the selected field data. *FieldDataResourceApi* | [**get_all_field_data_ids**](docs/FieldDataResourceApi.md#get_all_field_data_ids) | **GET** /api/v1/fieldData/IDs | Get all of the ids used to identify, and retrieve field data. -*FieldDataResourceApi* | [**get_field_data_from_id**](docs/FieldDataResourceApi.md#get_field_data_from_id) | **GET** /api/v1/fieldData | Get the field data from the selected field data ID. +*FieldDataResourceApi* | [**get_field_data_shape_from_id**](docs/FieldDataResourceApi.md#get_field_data_shape_from_id) | **GET** /api/v1/fieldData/fieldDataShape/{fieldDataID} | Get the shape of the field data. That is it's size, origin, extent, and data identifiers. *HelloWorldApi* | [**get_hello_world**](docs/HelloWorldApi.md#get_hello_world) | **GET** /api/v1/helloworld | Get hello world message. *PublicationResourceApi* | [**create_publication**](docs/PublicationResourceApi.md#create_publication) | **POST** /api/v1/publications | Create publication *PublicationResourceApi* | [**delete_publication**](docs/PublicationResourceApi.md#delete_publication) | **DELETE** /api/v1/publications/{id} | Delete publication @@ -124,20 +122,14 @@ Class | Method | HTTP request | Description - [BatchSystemType](docs/BatchSystemType.md) - [BioModel](docs/BioModel.md) - [BiomodelRef](docs/BiomodelRef.md) - - [CartesianMesh](docs/CartesianMesh.md) - - [Coordinate](docs/Coordinate.md) - [DataIdentifier](docs/DataIdentifier.md) - [DetailedState](docs/DetailedState.md) - [Domain](docs/Domain.md) - [Extent](docs/Extent.md) - [ExternalDataIdentifier](docs/ExternalDataIdentifier.md) - - [FieldDataDBOperationSpec](docs/FieldDataDBOperationSpec.md) - - [FieldDataFileOperationSpec](docs/FieldDataFileOperationSpec.md) - - [FieldDataInfo](docs/FieldDataInfo.md) - - [FieldDataNoCopyConflict](docs/FieldDataNoCopyConflict.md) - - [FieldDataReferences](docs/FieldDataReferences.md) + - [FieldDataReference](docs/FieldDataReference.md) - [FieldDataSaveResults](docs/FieldDataSaveResults.md) - - [GroupAccess](docs/GroupAccess.md) + - [FieldDataShape](docs/FieldDataShape.md) - [HelloWorldMessage](docs/HelloWorldMessage.md) - [HtcJobID](docs/HtcJobID.md) - [ISize](docs/ISize.md) @@ -155,7 +147,6 @@ Class | Method | HTTP request | Description - [SimulationStatusPersistentRecord](docs/SimulationStatusPersistentRecord.md) - [Status](docs/Status.md) - [StatusMessage](docs/StatusMessage.md) - - [UCDInfo](docs/UCDInfo.md) - [User](docs/User.md) - [UserIdentityJSONSafe](docs/UserIdentityJSONSafe.md) - [UserLoginInfoForMapping](docs/UserLoginInfoForMapping.md) @@ -163,10 +154,6 @@ Class | Method | HTTP request | Description - [VCSimulationIdentifier](docs/VCSimulationIdentifier.md) - [VariableDomain](docs/VariableDomain.md) - [VariableType](docs/VariableType.md) - - [Version](docs/Version.md) - - [VersionFlag](docs/VersionFlag.md) - - [VersionableType](docs/VersionableType.md) - - [VersionableTypeVersion](docs/VersionableTypeVersion.md) diff --git a/python-restclient/docs/BioModelResourceApi.md b/python-restclient/docs/BioModelResourceApi.md index 3e3f9a9ee9..7fb0b2e4b9 100644 --- a/python-restclient/docs/BioModelResourceApi.md +++ b/python-restclient/docs/BioModelResourceApi.md @@ -202,8 +202,8 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) diff --git a/python-restclient/docs/ExternalDataIdentifier.md b/python-restclient/docs/ExternalDataIdentifier.md index a9e915209b..72fd3bbbac 100644 --- a/python-restclient/docs/ExternalDataIdentifier.md +++ b/python-restclient/docs/ExternalDataIdentifier.md @@ -7,7 +7,6 @@ Name | Type | Description | Notes **key** | [**KeyValue**](KeyValue.md) | | [optional] **owner** | [**User**](User.md) | | [optional] **name** | **str** | | [optional] -**i_d** | **str** | | [optional] **job_index** | **int** | | [optional] **simulation_key** | [**KeyValue**](KeyValue.md) | | [optional] **parameter_scan_type** | **bool** | | [optional] diff --git a/python-restclient/docs/FieldDataReference.md b/python-restclient/docs/FieldDataReference.md new file mode 100644 index 0000000000..defad764b4 --- /dev/null +++ b/python-restclient/docs/FieldDataReference.md @@ -0,0 +1,30 @@ +# FieldDataReference + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**external_data_identifier** | [**ExternalDataIdentifier**](ExternalDataIdentifier.md) | | [optional] +**external_data_annotation** | **str** | | [optional] +**external_data_id_sim_ref** | [**List[KeyValue]**](KeyValue.md) | | [optional] + +## Example + +```python +from vcell_client.models.field_data_reference import FieldDataReference + +# TODO update the JSON string below +json = "{}" +# create an instance of FieldDataReference from a JSON string +field_data_reference_instance = FieldDataReference.from_json(json) +# print the JSON string representation of the object +print FieldDataReference.to_json() + +# convert the object into a dict +field_data_reference_dict = field_data_reference_instance.to_dict() +# create an instance of FieldDataReference from a dict +field_data_reference_form_dict = field_data_reference.from_dict(field_data_reference_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) + + diff --git a/python-restclient/docs/FieldDataResourceApi.md b/python-restclient/docs/FieldDataResourceApi.md index 6f6c8fbc14..773ae5c8b2 100644 --- a/python-restclient/docs/FieldDataResourceApi.md +++ b/python-restclient/docs/FieldDataResourceApi.md @@ -4,19 +4,17 @@ All URIs are relative to *https://vcell-dev.cam.uchc.edu* Method | HTTP request | Description ------------- | ------------- | ------------- -[**copy_field_data**](FieldDataResourceApi.md#copy_field_data) | **POST** /api/v1/fieldData/copy | Copy an existing field data entry. -[**create_new_field_data_from_file_already_analyzed**](FieldDataResourceApi.md#create_new_field_data_from_file_already_analyzed) | **POST** /api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed | -[**create_new_field_data_from_simulation**](FieldDataResourceApi.md#create_new_field_data_from_simulation) | **POST** /api/v1/fieldData/createFieldDataFromSimulation | Create new field data from a simulation. -[**delete_field_data**](FieldDataResourceApi.md#delete_field_data) | **DELETE** /api/v1/fieldData | Delete the selected field data. -[**generate_field_data_estimate**](FieldDataResourceApi.md#generate_field_data_estimate) | **POST** /api/v1/fieldData/analyzeFieldDataFromFile | +[**analyze_field_data_file**](FieldDataResourceApi.md#analyze_field_data_file) | **POST** /api/v1/fieldData/analyzeFieldDataFile | Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. +[**create_field_data_from_analyzed_file**](FieldDataResourceApi.md#create_field_data_from_analyzed_file) | **POST** /api/v1/fieldData/createFieldDataFromAnalyzedFile | Take the analyzed results of the field data, modify it to your liking, then save it on the server. +[**delete_field_data**](FieldDataResourceApi.md#delete_field_data) | **DELETE** /api/v1/fieldData/delete/{fieldDataID} | Delete the selected field data. [**get_all_field_data_ids**](FieldDataResourceApi.md#get_all_field_data_ids) | **GET** /api/v1/fieldData/IDs | Get all of the ids used to identify, and retrieve field data. -[**get_field_data_from_id**](FieldDataResourceApi.md#get_field_data_from_id) | **GET** /api/v1/fieldData | Get the field data from the selected field data ID. +[**get_field_data_shape_from_id**](FieldDataResourceApi.md#get_field_data_shape_from_id) | **GET** /api/v1/fieldData/fieldDataShape/{fieldDataID} | Get the shape of the field data. That is it's size, origin, extent, and data identifiers. -# **copy_field_data** -> FieldDataNoCopyConflict copy_field_data(field_data_db_operation_spec=field_data_db_operation_spec) +# **analyze_field_data_file** +> AnalyzedResultsFromFieldData analyze_field_data_file(file=file, file_name=file_name) -Copy an existing field data entry. +Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. ### Example @@ -24,8 +22,7 @@ Copy an existing field data entry. import time import os import vcell_client -from vcell_client.models.field_data_db_operation_spec import FieldDataDBOperationSpec -from vcell_client.models.field_data_no_copy_conflict import FieldDataNoCopyConflict +from vcell_client.models.analyzed_results_from_field_data import AnalyzedResultsFromFieldData from vcell_client.rest import ApiException from pprint import pprint @@ -40,15 +37,16 @@ configuration = vcell_client.Configuration( with vcell_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = vcell_client.FieldDataResourceApi(api_client) - field_data_db_operation_spec = vcell_client.FieldDataDBOperationSpec() # FieldDataDBOperationSpec | (optional) + file = None # bytearray | (optional) + file_name = 'file_name_example' # str | (optional) try: - # Copy an existing field data entry. - api_response = api_instance.copy_field_data(field_data_db_operation_spec=field_data_db_operation_spec) - print("The response of FieldDataResourceApi->copy_field_data:\n") + # Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. + api_response = api_instance.analyze_field_data_file(file=file, file_name=file_name) + print("The response of FieldDataResourceApi->analyze_field_data_file:\n") pprint(api_response) except Exception as e: - print("Exception when calling FieldDataResourceApi->copy_field_data: %s\n" % e) + print("Exception when calling FieldDataResourceApi->analyze_field_data_file: %s\n" % e) ``` @@ -57,11 +55,12 @@ with vcell_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **field_data_db_operation_spec** | [**FieldDataDBOperationSpec**](FieldDataDBOperationSpec.md)| | [optional] + **file** | **bytearray**| | [optional] + **file_name** | **str**| | [optional] ### Return type -[**FieldDataNoCopyConflict**](FieldDataNoCopyConflict.md) +[**AnalyzedResultsFromFieldData**](AnalyzedResultsFromFieldData.md) ### Authorization @@ -69,7 +68,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: multipart/form-data - **Accept**: application/json ### HTTP response details @@ -79,10 +78,10 @@ No authorization required [[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) -# **create_new_field_data_from_file_already_analyzed** -> FieldDataSaveResults create_new_field_data_from_file_already_analyzed(analyzed_results_from_field_data=analyzed_results_from_field_data) - +# **create_field_data_from_analyzed_file** +> FieldDataSaveResults create_field_data_from_analyzed_file(analyzed_results_from_field_data=analyzed_results_from_field_data) +Take the analyzed results of the field data, modify it to your liking, then save it on the server. ### Example @@ -109,11 +108,12 @@ with vcell_client.ApiClient(configuration) as api_client: analyzed_results_from_field_data = vcell_client.AnalyzedResultsFromFieldData() # AnalyzedResultsFromFieldData | (optional) try: - api_response = api_instance.create_new_field_data_from_file_already_analyzed(analyzed_results_from_field_data=analyzed_results_from_field_data) - print("The response of FieldDataResourceApi->create_new_field_data_from_file_already_analyzed:\n") + # Take the analyzed results of the field data, modify it to your liking, then save it on the server. + api_response = api_instance.create_field_data_from_analyzed_file(analyzed_results_from_field_data=analyzed_results_from_field_data) + print("The response of FieldDataResourceApi->create_field_data_from_analyzed_file:\n") pprint(api_response) except Exception as e: - print("Exception when calling FieldDataResourceApi->create_new_field_data_from_file_already_analyzed: %s\n" % e) + print("Exception when calling FieldDataResourceApi->create_field_data_from_analyzed_file: %s\n" % e) ``` @@ -144,74 +144,8 @@ No authorization required [[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) -# **create_new_field_data_from_simulation** -> ExternalDataIdentifier create_new_field_data_from_simulation(field_data_db_operation_spec=field_data_db_operation_spec) - -Create new field data from a simulation. - -### Example - -```python -import time -import os -import vcell_client -from vcell_client.models.external_data_identifier import ExternalDataIdentifier -from vcell_client.models.field_data_db_operation_spec import FieldDataDBOperationSpec -from vcell_client.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://vcell-dev.cam.uchc.edu -# See configuration.py for a list of all supported configuration parameters. -configuration = vcell_client.Configuration( - host = "https://vcell-dev.cam.uchc.edu" -) - - -# Enter a context with an instance of the API client -with vcell_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = vcell_client.FieldDataResourceApi(api_client) - field_data_db_operation_spec = vcell_client.FieldDataDBOperationSpec() # FieldDataDBOperationSpec | (optional) - - try: - # Create new field data from a simulation. - api_response = api_instance.create_new_field_data_from_simulation(field_data_db_operation_spec=field_data_db_operation_spec) - print("The response of FieldDataResourceApi->create_new_field_data_from_simulation:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling FieldDataResourceApi->create_new_field_data_from_simulation: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **field_data_db_operation_spec** | [**FieldDataDBOperationSpec**](FieldDataDBOperationSpec.md)| | [optional] - -### Return type - -[**ExternalDataIdentifier**](ExternalDataIdentifier.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**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) - # **delete_field_data** -> delete_field_data(body=body) +> delete_field_data(field_data_id) Delete the selected field data. @@ -235,11 +169,11 @@ configuration = vcell_client.Configuration( with vcell_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = vcell_client.FieldDataResourceApi(api_client) - body = 'body_example' # str | (optional) + field_data_id = 'field_data_id_example' # str | try: # Delete the selected field data. - api_instance.delete_field_data(body=body) + api_instance.delete_field_data(field_data_id) except Exception as e: print("Exception when calling FieldDataResourceApi->delete_field_data: %s\n" % e) ``` @@ -250,7 +184,7 @@ with vcell_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **str**| | [optional] + **field_data_id** | **str**| | ### Return type @@ -262,7 +196,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details @@ -272,74 +206,8 @@ No authorization required [[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) -# **generate_field_data_estimate** -> FieldDataFileOperationSpec generate_field_data_estimate(file=file, file_name=file_name) - - - -### Example - -```python -import time -import os -import vcell_client -from vcell_client.models.field_data_file_operation_spec import FieldDataFileOperationSpec -from vcell_client.rest import ApiException -from pprint import pprint - -# Defining the host is optional and defaults to https://vcell-dev.cam.uchc.edu -# See configuration.py for a list of all supported configuration parameters. -configuration = vcell_client.Configuration( - host = "https://vcell-dev.cam.uchc.edu" -) - - -# Enter a context with an instance of the API client -with vcell_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = vcell_client.FieldDataResourceApi(api_client) - file = None # bytearray | (optional) - file_name = 'file_name_example' # str | (optional) - - try: - api_response = api_instance.generate_field_data_estimate(file=file, file_name=file_name) - print("The response of FieldDataResourceApi->generate_field_data_estimate:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling FieldDataResourceApi->generate_field_data_estimate: %s\n" % e) -``` - - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **file** | **bytearray**| | [optional] - **file_name** | **str**| | [optional] - -### Return type - -[**FieldDataFileOperationSpec**](FieldDataFileOperationSpec.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: multipart/form-data - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**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_all_field_data_ids** -> FieldDataReferences get_all_field_data_ids() +> List[FieldDataReference] get_all_field_data_ids() Get all of the ids used to identify, and retrieve field data. @@ -349,7 +217,7 @@ Get all of the ids used to identify, and retrieve field data. import time import os import vcell_client -from vcell_client.models.field_data_references import FieldDataReferences +from vcell_client.models.field_data_reference import FieldDataReference from vcell_client.rest import ApiException from pprint import pprint @@ -381,7 +249,7 @@ This endpoint does not need any parameter. ### Return type -[**FieldDataReferences**](FieldDataReferences.md) +[**List[FieldDataReference]**](FieldDataReference.md) ### Authorization @@ -399,10 +267,10 @@ No authorization required [[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_field_data_from_id** -> FieldDataInfo get_field_data_from_id(body=body) +# **get_field_data_shape_from_id** +> FieldDataShape get_field_data_shape_from_id(field_data_id) -Get the field data from the selected field data ID. +Get the shape of the field data. That is it's size, origin, extent, and data identifiers. ### Example @@ -410,7 +278,7 @@ Get the field data from the selected field data ID. import time import os import vcell_client -from vcell_client.models.field_data_info import FieldDataInfo +from vcell_client.models.field_data_shape import FieldDataShape from vcell_client.rest import ApiException from pprint import pprint @@ -425,15 +293,15 @@ configuration = vcell_client.Configuration( with vcell_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = vcell_client.FieldDataResourceApi(api_client) - body = 'body_example' # str | (optional) + field_data_id = 'field_data_id_example' # str | try: - # Get the field data from the selected field data ID. - api_response = api_instance.get_field_data_from_id(body=body) - print("The response of FieldDataResourceApi->get_field_data_from_id:\n") + # Get the shape of the field data. That is it's size, origin, extent, and data identifiers. + api_response = api_instance.get_field_data_shape_from_id(field_data_id) + print("The response of FieldDataResourceApi->get_field_data_shape_from_id:\n") pprint(api_response) except Exception as e: - print("Exception when calling FieldDataResourceApi->get_field_data_from_id: %s\n" % e) + print("Exception when calling FieldDataResourceApi->get_field_data_shape_from_id: %s\n" % e) ``` @@ -442,11 +310,11 @@ with vcell_client.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | **str**| | [optional] + **field_data_id** | **str**| | ### Return type -[**FieldDataInfo**](FieldDataInfo.md) +[**FieldDataShape**](FieldDataShape.md) ### Authorization @@ -454,7 +322,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details diff --git a/python-restclient/docs/FieldDataShape.md b/python-restclient/docs/FieldDataShape.md new file mode 100644 index 0000000000..e02c7c2ed4 --- /dev/null +++ b/python-restclient/docs/FieldDataShape.md @@ -0,0 +1,32 @@ +# FieldDataShape + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**extent** | [**Extent**](Extent.md) | | [optional] +**origin** | [**Origin**](Origin.md) | | [optional] +**isize** | [**ISize**](ISize.md) | | [optional] +**data_identifier** | [**List[DataIdentifier]**](DataIdentifier.md) | | [optional] +**times** | **List[float]** | | [optional] + +## Example + +```python +from vcell_client.models.field_data_shape import FieldDataShape + +# TODO update the JSON string below +json = "{}" +# create an instance of FieldDataShape from a JSON string +field_data_shape_instance = FieldDataShape.from_json(json) +# print the JSON string representation of the object +print FieldDataShape.to_json() + +# convert the object into a dict +field_data_shape_dict = field_data_shape_instance.to_dict() +# create an instance of FieldDataShape from a dict +field_data_shape_form_dict = field_data_shape.from_dict(field_data_shape_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) + + diff --git a/python-restclient/docs/ISize.md b/python-restclient/docs/ISize.md index 6a5d64968b..adca67e859 100644 --- a/python-restclient/docs/ISize.md +++ b/python-restclient/docs/ISize.md @@ -7,7 +7,6 @@ Name | Type | Description | Notes **x** | **int** | | [optional] **y** | **int** | | [optional] **z** | **int** | | [optional] -**x_yz** | **int** | | [optional] ## Example diff --git a/python-restclient/docs/SimulationResourceApi.md b/python-restclient/docs/SimulationResourceApi.md index 6ff98f6be7..6d8316759f 100644 --- a/python-restclient/docs/SimulationResourceApi.md +++ b/python-restclient/docs/SimulationResourceApi.md @@ -79,8 +79,8 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) @@ -150,8 +150,8 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) @@ -221,8 +221,8 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) diff --git a/python-restclient/docs/User.md b/python-restclient/docs/User.md index c08eb10e92..4cdbaa42b6 100644 --- a/python-restclient/docs/User.md +++ b/python-restclient/docs/User.md @@ -6,7 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **user_name** | **str** | | [optional] **key** | [**KeyValue**](KeyValue.md) | | [optional] -**i_d** | [**KeyValue**](KeyValue.md) | | [optional] **name** | **str** | | [optional] **test_account** | **bool** | | [optional] diff --git a/python-restclient/docs/UsersResourceApi.md b/python-restclient/docs/UsersResourceApi.md index c43e72100f..4260e1d68a 100644 --- a/python-restclient/docs/UsersResourceApi.md +++ b/python-restclient/docs/UsersResourceApi.md @@ -208,8 +208,8 @@ This endpoint does not need any parameter. | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) @@ -275,8 +275,8 @@ This endpoint does not need any parameter. | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful, returning the identity | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) @@ -406,8 +406,8 @@ void (empty response body) |-------------|-------------|------------------| **200** | Successful, returning the identity | - | **409** | VCell Identity not mapped, userid already exists | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) @@ -477,8 +477,8 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) @@ -611,8 +611,8 @@ void (empty response body) |-------------|-------------|------------------| **200** | magic link sent in email if appropriate | - | **400** | unable to process request | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) @@ -681,8 +681,8 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | -**403** | Not Allowed | - | **401** | Not Authorized | - | +**403** | Not Allowed | - | [[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) diff --git a/python-restclient/test/test_field_data_reference.py b/python-restclient/test/test_field_data_reference.py new file mode 100644 index 0000000000..714789fb37 --- /dev/null +++ b/python-restclient/test/test_field_data_reference.py @@ -0,0 +1,72 @@ +# coding: utf-8 + +""" + VCell API + + VCell API + + The version of the OpenAPI document: 1.0.1 + Contact: vcell_support@uchc.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from vcell_client.models.field_data_reference import FieldDataReference + +class TestFieldDataReference(unittest.TestCase): + """FieldDataReference unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> FieldDataReference: + """Test FieldDataReference + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `FieldDataReference` + """ + model = FieldDataReference() + if include_optional: + return FieldDataReference( + external_data_identifier = vcell_client.models.external_data_identifier.ExternalDataIdentifier( + key = vcell_client.models.key_value.KeyValue( + value = 1.337, ), + owner = vcell_client.models.user.User( + user_name = '', + i_d = vcell_client.models.key_value.KeyValue( + value = 1.337, ), + name = '', + test_account = True, ), + name = '', + i_d = '', + job_index = 56, + simulation_key = , + parameter_scan_type = True, + data_key = , ), + external_data_annotation = '', + external_data_id_sim_ref = [ + vcell_client.models.key_value.KeyValue( + value = 1.337, ) + ] + ) + else: + return FieldDataReference( + ) + """ + + def testFieldDataReference(self): + """Test FieldDataReference""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/python-restclient/test/test_field_data_shape.py b/python-restclient/test/test_field_data_shape.py new file mode 100644 index 0000000000..27397f960c --- /dev/null +++ b/python-restclient/test/test_field_data_shape.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + VCell API + + VCell API + + The version of the OpenAPI document: 1.0.1 + Contact: vcell_support@uchc.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from vcell_client.models.field_data_shape import FieldDataShape + +class TestFieldDataShape(unittest.TestCase): + """FieldDataShape unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> FieldDataShape: + """Test FieldDataShape + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `FieldDataShape` + """ + model = FieldDataShape() + if include_optional: + return FieldDataShape( + extent = vcell_client.models.extent.Extent( + x = 1.337, + y = 1.337, + z = 1.337, ), + origin = vcell_client.models.origin.Origin( + x = 1.337, + y = 1.337, + z = 1.337, ), + isize = vcell_client.models.i_size.ISize( + x = 56, + y = 56, + z = 56, ), + data_identifier = [ + vcell_client.models.data_identifier.DataIdentifier( + name = '', + display_name = '', + variable_type = vcell_client.models.variable_type.VariableType( + type = 56, + variable_domain = 'VARIABLEDOMAIN_POSTPROCESSING', + name = '', + units = '', + label = '', + legacy_warn = True, + default_label = '', + default_units = '', + type_name = '', ), + domain = vcell_client.models.domain.Domain( + name = '', ), + b_function = True, + function = True, + visible = True, ) + ], + times = [ + 1.337 + ] + ) + else: + return FieldDataShape( + ) + """ + + def testFieldDataShape(self): + """Test FieldDataShape""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/python-restclient/vcell_client/__init__.py b/python-restclient/vcell_client/__init__.py index 0daa8d7bc1..3112d5aa16 100644 --- a/python-restclient/vcell_client/__init__.py +++ b/python-restclient/vcell_client/__init__.py @@ -43,20 +43,14 @@ from vcell_client.models.batch_system_type import BatchSystemType from vcell_client.models.bio_model import BioModel from vcell_client.models.biomodel_ref import BiomodelRef -from vcell_client.models.cartesian_mesh import CartesianMesh -from vcell_client.models.coordinate import Coordinate from vcell_client.models.data_identifier import DataIdentifier from vcell_client.models.detailed_state import DetailedState from vcell_client.models.domain import Domain from vcell_client.models.extent import Extent from vcell_client.models.external_data_identifier import ExternalDataIdentifier -from vcell_client.models.field_data_db_operation_spec import FieldDataDBOperationSpec -from vcell_client.models.field_data_file_operation_spec import FieldDataFileOperationSpec -from vcell_client.models.field_data_info import FieldDataInfo -from vcell_client.models.field_data_no_copy_conflict import FieldDataNoCopyConflict -from vcell_client.models.field_data_references import FieldDataReferences +from vcell_client.models.field_data_reference import FieldDataReference from vcell_client.models.field_data_save_results import FieldDataSaveResults -from vcell_client.models.group_access import GroupAccess +from vcell_client.models.field_data_shape import FieldDataShape from vcell_client.models.hello_world_message import HelloWorldMessage from vcell_client.models.htc_job_id import HtcJobID from vcell_client.models.i_size import ISize @@ -74,7 +68,6 @@ from vcell_client.models.simulation_status_persistent_record import SimulationStatusPersistentRecord from vcell_client.models.status import Status from vcell_client.models.status_message import StatusMessage -from vcell_client.models.ucd_info import UCDInfo from vcell_client.models.user import User from vcell_client.models.user_identity_json_safe import UserIdentityJSONSafe from vcell_client.models.user_login_info_for_mapping import UserLoginInfoForMapping @@ -82,7 +75,3 @@ from vcell_client.models.vc_simulation_identifier import VCSimulationIdentifier from vcell_client.models.variable_domain import VariableDomain from vcell_client.models.variable_type import VariableType -from vcell_client.models.version import Version -from vcell_client.models.version_flag import VersionFlag -from vcell_client.models.versionable_type import VersionableType -from vcell_client.models.versionable_type_version import VersionableTypeVersion diff --git a/python-restclient/vcell_client/api/bio_model_resource_api.py b/python-restclient/vcell_client/api/bio_model_resource_api.py index adbb65b599..c31ac2bb00 100644 --- a/python-restclient/vcell_client/api/bio_model_resource_api.py +++ b/python-restclient/vcell_client/api/bio_model_resource_api.py @@ -612,8 +612,8 @@ def upload_bio_model( _response_types_map: Dict[str, Optional[str]] = { '200': "str", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -681,8 +681,8 @@ def upload_bio_model_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "str", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -750,8 +750,8 @@ def upload_bio_model_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "str", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( diff --git a/python-restclient/vcell_client/api/field_data_resource_api.py b/python-restclient/vcell_client/api/field_data_resource_api.py index a9dd790a0c..38733f46f7 100644 --- a/python-restclient/vcell_client/api/field_data_resource_api.py +++ b/python-restclient/vcell_client/api/field_data_resource_api.py @@ -26,16 +26,12 @@ from pydantic import StrictBytes, StrictStr -from typing import Optional, Union +from typing import List, Optional, Union from vcell_client.models.analyzed_results_from_field_data import AnalyzedResultsFromFieldData -from vcell_client.models.external_data_identifier import ExternalDataIdentifier -from vcell_client.models.field_data_db_operation_spec import FieldDataDBOperationSpec -from vcell_client.models.field_data_file_operation_spec import FieldDataFileOperationSpec -from vcell_client.models.field_data_info import FieldDataInfo -from vcell_client.models.field_data_no_copy_conflict import FieldDataNoCopyConflict -from vcell_client.models.field_data_references import FieldDataReferences +from vcell_client.models.field_data_reference import FieldDataReference from vcell_client.models.field_data_save_results import FieldDataSaveResults +from vcell_client.models.field_data_shape import FieldDataShape from vcell_client.api_client import ApiClient from vcell_client.api_response import ApiResponse @@ -56,9 +52,10 @@ def __init__(self, api_client=None) -> None: @validate_call - def copy_field_data( + def analyze_field_data_file( self, - field_data_db_operation_spec: Optional[FieldDataDBOperationSpec] = None, + file: Optional[Union[StrictBytes, StrictStr]] = None, + file_name: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -71,12 +68,14 @@ def copy_field_data( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> FieldDataNoCopyConflict: - """Copy an existing field data entry. + ) -> AnalyzedResultsFromFieldData: + """Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. - :param field_data_db_operation_spec: - :type field_data_db_operation_spec: FieldDataDBOperationSpec + :param file: + :type file: bytearray + :param file_name: + :type file_name: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -99,8 +98,9 @@ def copy_field_data( :return: Returns the result object. """ # noqa: E501 - _param = self._copy_field_data_serialize( - field_data_db_operation_spec=field_data_db_operation_spec, + _param = self._analyze_field_data_file_serialize( + file=file, + file_name=file_name, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -108,7 +108,7 @@ def copy_field_data( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataNoCopyConflict" + '200': "AnalyzedResultsFromFieldData" } response_data = self.api_client.call_api( @@ -123,9 +123,10 @@ def copy_field_data( @validate_call - def copy_field_data_with_http_info( + def analyze_field_data_file_with_http_info( self, - field_data_db_operation_spec: Optional[FieldDataDBOperationSpec] = None, + file: Optional[Union[StrictBytes, StrictStr]] = None, + file_name: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -138,12 +139,14 @@ def copy_field_data_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[FieldDataNoCopyConflict]: - """Copy an existing field data entry. + ) -> ApiResponse[AnalyzedResultsFromFieldData]: + """Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. - :param field_data_db_operation_spec: - :type field_data_db_operation_spec: FieldDataDBOperationSpec + :param file: + :type file: bytearray + :param file_name: + :type file_name: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -166,8 +169,9 @@ def copy_field_data_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._copy_field_data_serialize( - field_data_db_operation_spec=field_data_db_operation_spec, + _param = self._analyze_field_data_file_serialize( + file=file, + file_name=file_name, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -175,7 +179,7 @@ def copy_field_data_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataNoCopyConflict" + '200': "AnalyzedResultsFromFieldData" } response_data = self.api_client.call_api( @@ -190,9 +194,10 @@ def copy_field_data_with_http_info( @validate_call - def copy_field_data_without_preload_content( + def analyze_field_data_file_without_preload_content( self, - field_data_db_operation_spec: Optional[FieldDataDBOperationSpec] = None, + file: Optional[Union[StrictBytes, StrictStr]] = None, + file_name: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -206,11 +211,13 @@ def copy_field_data_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Copy an existing field data entry. + """Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. - :param field_data_db_operation_spec: - :type field_data_db_operation_spec: FieldDataDBOperationSpec + :param file: + :type file: bytearray + :param file_name: + :type file_name: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -233,8 +240,9 @@ def copy_field_data_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._copy_field_data_serialize( - field_data_db_operation_spec=field_data_db_operation_spec, + _param = self._analyze_field_data_file_serialize( + file=file, + file_name=file_name, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -242,7 +250,7 @@ def copy_field_data_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataNoCopyConflict" + '200': "AnalyzedResultsFromFieldData" } response_data = self.api_client.call_api( @@ -252,9 +260,10 @@ def copy_field_data_without_preload_content( return response_data.response - def _copy_field_data_serialize( + def _analyze_field_data_file_serialize( self, - field_data_db_operation_spec, + file, + file_name, _request_auth, _content_type, _headers, @@ -278,9 +287,11 @@ def _copy_field_data_serialize( # process the query parameters # process the header parameters # process the form parameters + if file is not None: + _files['file'] = file + if file_name is not None: + _form_params.append(('fileName', file_name)) # process the body parameter - if field_data_db_operation_spec is not None: - _body_params = field_data_db_operation_spec # set the HTTP header `Accept` @@ -297,7 +308,7 @@ def _copy_field_data_serialize( _default_content_type = ( self.api_client.select_header_content_type( [ - 'application/json' + 'multipart/form-data' ] ) ) @@ -310,7 +321,7 @@ def _copy_field_data_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/api/v1/fieldData/copy', + resource_path='/api/v1/fieldData/analyzeFieldDataFile', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -327,7 +338,7 @@ def _copy_field_data_serialize( @validate_call - def create_new_field_data_from_file_already_analyzed( + def create_field_data_from_analyzed_file( self, analyzed_results_from_field_data: Optional[AnalyzedResultsFromFieldData] = None, _request_timeout: Union[ @@ -343,7 +354,7 @@ def create_new_field_data_from_file_already_analyzed( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> FieldDataSaveResults: - """create_new_field_data_from_file_already_analyzed + """Take the analyzed results of the field data, modify it to your liking, then save it on the server. :param analyzed_results_from_field_data: @@ -370,7 +381,7 @@ def create_new_field_data_from_file_already_analyzed( :return: Returns the result object. """ # noqa: E501 - _param = self._create_new_field_data_from_file_already_analyzed_serialize( + _param = self._create_field_data_from_analyzed_file_serialize( analyzed_results_from_field_data=analyzed_results_from_field_data, _request_auth=_request_auth, _content_type=_content_type, @@ -394,7 +405,7 @@ def create_new_field_data_from_file_already_analyzed( @validate_call - def create_new_field_data_from_file_already_analyzed_with_http_info( + def create_field_data_from_analyzed_file_with_http_info( self, analyzed_results_from_field_data: Optional[AnalyzedResultsFromFieldData] = None, _request_timeout: Union[ @@ -410,7 +421,7 @@ def create_new_field_data_from_file_already_analyzed_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[FieldDataSaveResults]: - """create_new_field_data_from_file_already_analyzed + """Take the analyzed results of the field data, modify it to your liking, then save it on the server. :param analyzed_results_from_field_data: @@ -437,7 +448,7 @@ def create_new_field_data_from_file_already_analyzed_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._create_new_field_data_from_file_already_analyzed_serialize( + _param = self._create_field_data_from_analyzed_file_serialize( analyzed_results_from_field_data=analyzed_results_from_field_data, _request_auth=_request_auth, _content_type=_content_type, @@ -461,7 +472,7 @@ def create_new_field_data_from_file_already_analyzed_with_http_info( @validate_call - def create_new_field_data_from_file_already_analyzed_without_preload_content( + def create_field_data_from_analyzed_file_without_preload_content( self, analyzed_results_from_field_data: Optional[AnalyzedResultsFromFieldData] = None, _request_timeout: Union[ @@ -477,7 +488,7 @@ def create_new_field_data_from_file_already_analyzed_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """create_new_field_data_from_file_already_analyzed + """Take the analyzed results of the field data, modify it to your liking, then save it on the server. :param analyzed_results_from_field_data: @@ -504,7 +515,7 @@ def create_new_field_data_from_file_already_analyzed_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._create_new_field_data_from_file_already_analyzed_serialize( + _param = self._create_field_data_from_analyzed_file_serialize( analyzed_results_from_field_data=analyzed_results_from_field_data, _request_auth=_request_auth, _content_type=_content_type, @@ -523,7 +534,7 @@ def create_new_field_data_from_file_already_analyzed_without_preload_content( return response_data.response - def _create_new_field_data_from_file_already_analyzed_serialize( + def _create_field_data_from_analyzed_file_serialize( self, analyzed_results_from_field_data, _request_auth, @@ -581,7 +592,7 @@ def _create_new_field_data_from_file_already_analyzed_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed', + resource_path='/api/v1/fieldData/createFieldDataFromAnalyzedFile', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -598,9 +609,9 @@ def _create_new_field_data_from_file_already_analyzed_serialize( @validate_call - def create_new_field_data_from_simulation( + def delete_field_data( self, - field_data_db_operation_spec: Optional[FieldDataDBOperationSpec] = None, + field_data_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -613,12 +624,12 @@ def create_new_field_data_from_simulation( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ExternalDataIdentifier: - """Create new field data from a simulation. + ) -> None: + """Delete the selected field data. - :param field_data_db_operation_spec: - :type field_data_db_operation_spec: FieldDataDBOperationSpec + :param field_data_id: (required) + :type field_data_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -641,8 +652,8 @@ def create_new_field_data_from_simulation( :return: Returns the result object. """ # noqa: E501 - _param = self._create_new_field_data_from_simulation_serialize( - field_data_db_operation_spec=field_data_db_operation_spec, + _param = self._delete_field_data_serialize( + field_data_id=field_data_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -650,7 +661,6 @@ def create_new_field_data_from_simulation( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ExternalDataIdentifier" } response_data = self.api_client.call_api( @@ -665,9 +675,9 @@ def create_new_field_data_from_simulation( @validate_call - def create_new_field_data_from_simulation_with_http_info( + def delete_field_data_with_http_info( self, - field_data_db_operation_spec: Optional[FieldDataDBOperationSpec] = None, + field_data_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -680,12 +690,12 @@ def create_new_field_data_from_simulation_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ExternalDataIdentifier]: - """Create new field data from a simulation. + ) -> ApiResponse[None]: + """Delete the selected field data. - :param field_data_db_operation_spec: - :type field_data_db_operation_spec: FieldDataDBOperationSpec + :param field_data_id: (required) + :type field_data_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -708,8 +718,8 @@ def create_new_field_data_from_simulation_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._create_new_field_data_from_simulation_serialize( - field_data_db_operation_spec=field_data_db_operation_spec, + _param = self._delete_field_data_serialize( + field_data_id=field_data_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -717,7 +727,6 @@ def create_new_field_data_from_simulation_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ExternalDataIdentifier" } response_data = self.api_client.call_api( @@ -732,9 +741,9 @@ def create_new_field_data_from_simulation_with_http_info( @validate_call - def create_new_field_data_from_simulation_without_preload_content( + def delete_field_data_without_preload_content( self, - field_data_db_operation_spec: Optional[FieldDataDBOperationSpec] = None, + field_data_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -748,11 +757,11 @@ def create_new_field_data_from_simulation_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Create new field data from a simulation. + """Delete the selected field data. - :param field_data_db_operation_spec: - :type field_data_db_operation_spec: FieldDataDBOperationSpec + :param field_data_id: (required) + :type field_data_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -775,8 +784,8 @@ def create_new_field_data_from_simulation_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._create_new_field_data_from_simulation_serialize( - field_data_db_operation_spec=field_data_db_operation_spec, + _param = self._delete_field_data_serialize( + field_data_id=field_data_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -784,7 +793,6 @@ def create_new_field_data_from_simulation_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ExternalDataIdentifier" } response_data = self.api_client.call_api( @@ -794,9 +802,9 @@ def create_new_field_data_from_simulation_without_preload_content( return response_data.response - def _create_new_field_data_from_simulation_serialize( + def _delete_field_data_serialize( self, - field_data_db_operation_spec, + field_data_id, _request_auth, _content_type, _headers, @@ -817,42 +825,23 @@ def _create_new_field_data_from_simulation_serialize( _body_params: Optional[bytes] = None # process the path parameters + if field_data_id is not None: + _path_params['fieldDataID'] = field_data_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if field_data_db_operation_spec is not None: - _body_params = field_data_db_operation_spec - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ ] return self.api_client.param_serialize( - method='POST', - resource_path='/api/v1/fieldData/createFieldDataFromSimulation', + method='DELETE', + resource_path='/api/v1/fieldData/delete/{fieldDataID}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -869,9 +858,8 @@ def _create_new_field_data_from_simulation_serialize( @validate_call - def delete_field_data( + def get_all_field_data_ids( self, - body: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -884,12 +872,10 @@ def delete_field_data( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Delete the selected field data. + ) -> List[FieldDataReference]: + """Get all of the ids used to identify, and retrieve field data. - :param body: - :type body: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -912,8 +898,7 @@ def delete_field_data( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_field_data_serialize( - body=body, + _param = self._get_all_field_data_ids_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -921,6 +906,7 @@ def delete_field_data( ) _response_types_map: Dict[str, Optional[str]] = { + '200': "List[FieldDataReference]" } response_data = self.api_client.call_api( @@ -935,9 +921,8 @@ def delete_field_data( @validate_call - def delete_field_data_with_http_info( + def get_all_field_data_ids_with_http_info( self, - body: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -950,12 +935,10 @@ def delete_field_data_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Delete the selected field data. + ) -> ApiResponse[List[FieldDataReference]]: + """Get all of the ids used to identify, and retrieve field data. - :param body: - :type body: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -978,8 +961,7 @@ def delete_field_data_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_field_data_serialize( - body=body, + _param = self._get_all_field_data_ids_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -987,6 +969,7 @@ def delete_field_data_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { + '200': "List[FieldDataReference]" } response_data = self.api_client.call_api( @@ -1001,9 +984,8 @@ def delete_field_data_with_http_info( @validate_call - def delete_field_data_without_preload_content( + def get_all_field_data_ids_without_preload_content( self, - body: Optional[StrictStr] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1017,11 +999,9 @@ def delete_field_data_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Delete the selected field data. + """Get all of the ids used to identify, and retrieve field data. - :param body: - :type body: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1044,8 +1024,7 @@ def delete_field_data_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_field_data_serialize( - body=body, + _param = self._get_all_field_data_ids_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1053,6 +1032,7 @@ def delete_field_data_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { + '200': "List[FieldDataReference]" } response_data = self.api_client.call_api( @@ -1062,9 +1042,8 @@ def delete_field_data_without_preload_content( return response_data.response - def _delete_field_data_serialize( + def _get_all_field_data_ids_serialize( self, - body, _request_auth, _content_type, _headers, @@ -1089,32 +1068,23 @@ def _delete_field_data_serialize( # process the header parameters # process the form parameters # process the body parameter - if body is not None: - _body_params = body + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'text/plain' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ ] return self.api_client.param_serialize( - method='DELETE', - resource_path='/api/v1/fieldData', + method='GET', + resource_path='/api/v1/fieldData/IDs', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1131,10 +1101,9 @@ def _delete_field_data_serialize( @validate_call - def generate_field_data_estimate( + def get_field_data_shape_from_id( self, - file: Optional[Union[StrictBytes, StrictStr]] = None, - file_name: Optional[StrictStr] = None, + field_data_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1147,14 +1116,12 @@ def generate_field_data_estimate( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> FieldDataFileOperationSpec: - """generate_field_data_estimate + ) -> FieldDataShape: + """Get the shape of the field data. That is it's size, origin, extent, and data identifiers. - :param file: - :type file: bytearray - :param file_name: - :type file_name: str + :param field_data_id: (required) + :type field_data_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1177,9 +1144,8 @@ def generate_field_data_estimate( :return: Returns the result object. """ # noqa: E501 - _param = self._generate_field_data_estimate_serialize( - file=file, - file_name=file_name, + _param = self._get_field_data_shape_from_id_serialize( + field_data_id=field_data_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1187,7 +1153,7 @@ def generate_field_data_estimate( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataFileOperationSpec" + '200': "FieldDataShape" } response_data = self.api_client.call_api( @@ -1202,10 +1168,9 @@ def generate_field_data_estimate( @validate_call - def generate_field_data_estimate_with_http_info( + def get_field_data_shape_from_id_with_http_info( self, - file: Optional[Union[StrictBytes, StrictStr]] = None, - file_name: Optional[StrictStr] = None, + field_data_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1218,14 +1183,12 @@ def generate_field_data_estimate_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[FieldDataFileOperationSpec]: - """generate_field_data_estimate + ) -> ApiResponse[FieldDataShape]: + """Get the shape of the field data. That is it's size, origin, extent, and data identifiers. - :param file: - :type file: bytearray - :param file_name: - :type file_name: str + :param field_data_id: (required) + :type field_data_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1248,9 +1211,8 @@ def generate_field_data_estimate_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._generate_field_data_estimate_serialize( - file=file, - file_name=file_name, + _param = self._get_field_data_shape_from_id_serialize( + field_data_id=field_data_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1258,7 +1220,7 @@ def generate_field_data_estimate_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataFileOperationSpec" + '200': "FieldDataShape" } response_data = self.api_client.call_api( @@ -1273,10 +1235,9 @@ def generate_field_data_estimate_with_http_info( @validate_call - def generate_field_data_estimate_without_preload_content( + def get_field_data_shape_from_id_without_preload_content( self, - file: Optional[Union[StrictBytes, StrictStr]] = None, - file_name: Optional[StrictStr] = None, + field_data_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1290,13 +1251,11 @@ def generate_field_data_estimate_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """generate_field_data_estimate + """Get the shape of the field data. That is it's size, origin, extent, and data identifiers. - :param file: - :type file: bytearray - :param file_name: - :type file_name: str + :param field_data_id: (required) + :type field_data_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1319,9 +1278,8 @@ def generate_field_data_estimate_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._generate_field_data_estimate_serialize( - file=file, - file_name=file_name, + _param = self._get_field_data_shape_from_id_serialize( + field_data_id=field_data_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1329,7 +1287,7 @@ def generate_field_data_estimate_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataFileOperationSpec" + '200': "FieldDataShape" } response_data = self.api_client.call_api( @@ -1339,10 +1297,9 @@ def generate_field_data_estimate_without_preload_content( return response_data.response - def _generate_field_data_estimate_serialize( + def _get_field_data_shape_from_id_serialize( self, - file, - file_name, + field_data_id, _request_auth, _content_type, _headers, @@ -1363,13 +1320,11 @@ def _generate_field_data_estimate_serialize( _body_params: Optional[bytes] = None # process the path parameters + if field_data_id is not None: + _path_params['fieldDataID'] = field_data_id # process the query parameters # process the header parameters # process the form parameters - if file is not None: - _files['file'] = file - if file_name is not None: - _form_params.append(('fileName', file_name)) # process the body parameter @@ -1380,533 +1335,6 @@ def _generate_field_data_estimate_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'multipart/form-data' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type - - # authentication setting - _auth_settings: List[str] = [ - ] - - return self.api_client.param_serialize( - method='POST', - resource_path='/api/v1/fieldData/analyzeFieldDataFromFile', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, - files=_files, - auth_settings=_auth_settings, - collection_formats=_collection_formats, - _host=_host, - _request_auth=_request_auth - ) - - - - - @validate_call - def get_all_field_data_ids( - self, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> FieldDataReferences: - """Get all of the ids used to identify, and retrieve field data. - - - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_all_field_data_ids_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataReferences" - - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ).data - - - @validate_call - def get_all_field_data_ids_with_http_info( - self, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[FieldDataReferences]: - """Get all of the ids used to identify, and retrieve field data. - - - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_all_field_data_ids_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataReferences" - - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ) - - - @validate_call - def get_all_field_data_ids_without_preload_content( - self, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> RESTResponseType: - """Get all of the ids used to identify, and retrieve field data. - - - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_all_field_data_ids_serialize( - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataReferences" - - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_all_field_data_ids_serialize( - self, - _request_auth, - _content_type, - _headers, - _host_index, - ) -> Tuple: - - _host = None - - _collection_formats: Dict[str, str] = { - - } - - _path_params: Dict[str, str] = {} - _query_params: List[Tuple[str, str]] = [] - _header_params: Dict[str, Optional[str]] = _headers or {} - _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - - # authentication setting - _auth_settings: List[str] = [ - ] - - return self.api_client.param_serialize( - method='GET', - resource_path='/api/v1/fieldData/IDs', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, - files=_files, - auth_settings=_auth_settings, - collection_formats=_collection_formats, - _host=_host, - _request_auth=_request_auth - ) - - - - - @validate_call - def get_field_data_from_id( - self, - body: Optional[StrictStr] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> FieldDataInfo: - """Get the field data from the selected field data ID. - - - :param body: - :type body: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_field_data_from_id_serialize( - body=body, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataInfo" - - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ).data - - - @validate_call - def get_field_data_from_id_with_http_info( - self, - body: Optional[StrictStr] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[FieldDataInfo]: - """Get the field data from the selected field data ID. - - - :param body: - :type body: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_field_data_from_id_serialize( - body=body, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataInfo" - - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ) - - - @validate_call - def get_field_data_from_id_without_preload_content( - self, - body: Optional[StrictStr] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - _request_auth: Optional[Dict[StrictStr, Any]] = None, - _content_type: Optional[StrictStr] = None, - _headers: Optional[Dict[StrictStr, Any]] = None, - _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> RESTResponseType: - """Get the field data from the selected field data ID. - - - :param body: - :type body: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the - authentication in the spec for a single request. - :type _request_auth: dict, optional - :param _content_type: force content-type for the request. - :type _content_type: str, Optional - :param _headers: set to override the headers for a single - request; this effectively ignores the headers - in the spec for a single request. - :type _headers: dict, optional - :param _host_index: set to override the host_index for a single - request; this effectively ignores the host_index - in the spec for a single request. - :type _host_index: int, optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._get_field_data_from_id_serialize( - body=body, - _request_auth=_request_auth, - _content_type=_content_type, - _headers=_headers, - _host_index=_host_index - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "FieldDataInfo" - - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - - def _get_field_data_from_id_serialize( - self, - body, - _request_auth, - _content_type, - _headers, - _host_index, - ) -> Tuple: - - _host = None - - _collection_formats: Dict[str, str] = { - - } - - _path_params: Dict[str, str] = {} - _query_params: List[Tuple[str, str]] = [] - _header_params: Dict[str, Optional[str]] = _headers or {} - _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, str] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if body is not None: - _body_params = body - - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'text/plain' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -1914,7 +1342,7 @@ def _get_field_data_from_id_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/api/v1/fieldData', + resource_path='/api/v1/fieldData/fieldDataShape/{fieldDataID}', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/python-restclient/vcell_client/api/simulation_resource_api.py b/python-restclient/vcell_client/api/simulation_resource_api.py index 0cc5e36691..1d2f938779 100644 --- a/python-restclient/vcell_client/api/simulation_resource_api.py +++ b/python-restclient/vcell_client/api/simulation_resource_api.py @@ -111,8 +111,8 @@ def get_simulation_status( _response_types_map: Dict[str, Optional[str]] = { '200': "SimulationStatusPersistentRecord", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -188,8 +188,8 @@ def get_simulation_status_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "SimulationStatusPersistentRecord", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -265,8 +265,8 @@ def get_simulation_status_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "SimulationStatusPersistentRecord", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -402,8 +402,8 @@ def start_simulation( _response_types_map: Dict[str, Optional[str]] = { '200': "List[StatusMessage]", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -471,8 +471,8 @@ def start_simulation_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "List[StatusMessage]", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -540,8 +540,8 @@ def start_simulation_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "List[StatusMessage]", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -667,8 +667,8 @@ def stop_simulation( _response_types_map: Dict[str, Optional[str]] = { '200': "List[StatusMessage]", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -736,8 +736,8 @@ def stop_simulation_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "List[StatusMessage]", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -805,8 +805,8 @@ def stop_simulation_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "List[StatusMessage]", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( diff --git a/python-restclient/vcell_client/api/users_resource_api.py b/python-restclient/vcell_client/api/users_resource_api.py index 77b2e2ff5f..4cf7621633 100644 --- a/python-restclient/vcell_client/api/users_resource_api.py +++ b/python-restclient/vcell_client/api/users_resource_api.py @@ -597,8 +597,8 @@ def get_legacy_api_token( _response_types_map: Dict[str, Optional[str]] = { '200': "AccesTokenRepresentationRecord", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -662,8 +662,8 @@ def get_legacy_api_token_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "AccesTokenRepresentationRecord", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -727,8 +727,8 @@ def get_legacy_api_token_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "AccesTokenRepresentationRecord", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -847,8 +847,8 @@ def get_mapped_user( _response_types_map: Dict[str, Optional[str]] = { '200': "UserIdentityJSONSafe", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -912,8 +912,8 @@ def get_mapped_user_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "UserIdentityJSONSafe", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -977,8 +977,8 @@ def get_mapped_user_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "UserIdentityJSONSafe", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -1607,8 +1607,8 @@ def map_user( _response_types_map: Dict[str, Optional[str]] = { '200': "bool", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -1676,8 +1676,8 @@ def map_user_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "bool", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -1745,8 +1745,8 @@ def map_user_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "bool", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -2405,8 +2405,8 @@ def unmap_user( _response_types_map: Dict[str, Optional[str]] = { '200': "bool", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -2474,8 +2474,8 @@ def unmap_user_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '200': "bool", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( @@ -2543,8 +2543,8 @@ def unmap_user_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '200': "bool", - '403': None, - '401': None + '401': None, + '403': None } response_data = self.api_client.call_api( diff --git a/python-restclient/vcell_client/models/__init__.py b/python-restclient/vcell_client/models/__init__.py index 999a81c145..3132b55049 100644 --- a/python-restclient/vcell_client/models/__init__.py +++ b/python-restclient/vcell_client/models/__init__.py @@ -20,20 +20,14 @@ from vcell_client.models.batch_system_type import BatchSystemType from vcell_client.models.bio_model import BioModel from vcell_client.models.biomodel_ref import BiomodelRef -from vcell_client.models.cartesian_mesh import CartesianMesh -from vcell_client.models.coordinate import Coordinate from vcell_client.models.data_identifier import DataIdentifier from vcell_client.models.detailed_state import DetailedState from vcell_client.models.domain import Domain from vcell_client.models.extent import Extent from vcell_client.models.external_data_identifier import ExternalDataIdentifier -from vcell_client.models.field_data_db_operation_spec import FieldDataDBOperationSpec -from vcell_client.models.field_data_file_operation_spec import FieldDataFileOperationSpec -from vcell_client.models.field_data_info import FieldDataInfo -from vcell_client.models.field_data_no_copy_conflict import FieldDataNoCopyConflict -from vcell_client.models.field_data_references import FieldDataReferences +from vcell_client.models.field_data_reference import FieldDataReference from vcell_client.models.field_data_save_results import FieldDataSaveResults -from vcell_client.models.group_access import GroupAccess +from vcell_client.models.field_data_shape import FieldDataShape from vcell_client.models.hello_world_message import HelloWorldMessage from vcell_client.models.htc_job_id import HtcJobID from vcell_client.models.i_size import ISize @@ -51,7 +45,6 @@ from vcell_client.models.simulation_status_persistent_record import SimulationStatusPersistentRecord from vcell_client.models.status import Status from vcell_client.models.status_message import StatusMessage -from vcell_client.models.ucd_info import UCDInfo from vcell_client.models.user import User from vcell_client.models.user_identity_json_safe import UserIdentityJSONSafe from vcell_client.models.user_login_info_for_mapping import UserLoginInfoForMapping @@ -59,7 +52,3 @@ from vcell_client.models.vc_simulation_identifier import VCSimulationIdentifier from vcell_client.models.variable_domain import VariableDomain from vcell_client.models.variable_type import VariableType -from vcell_client.models.version import Version -from vcell_client.models.version_flag import VersionFlag -from vcell_client.models.versionable_type import VersionableType -from vcell_client.models.versionable_type_version import VersionableTypeVersion diff --git a/python-restclient/vcell_client/models/external_data_identifier.py b/python-restclient/vcell_client/models/external_data_identifier.py index 37d4661c9b..2b0d88dbb5 100644 --- a/python-restclient/vcell_client/models/external_data_identifier.py +++ b/python-restclient/vcell_client/models/external_data_identifier.py @@ -36,12 +36,11 @@ class ExternalDataIdentifier(BaseModel): key: Optional[KeyValue] = None owner: Optional[User] = None name: Optional[StrictStr] = None - i_d: Optional[StrictStr] = Field(default=None, alias="iD") job_index: Optional[StrictInt] = Field(default=None, alias="jobIndex") simulation_key: Optional[KeyValue] = Field(default=None, alias="simulationKey") parameter_scan_type: Optional[StrictBool] = Field(default=None, alias="parameterScanType") data_key: Optional[KeyValue] = Field(default=None, alias="dataKey") - __properties: ClassVar[List[str]] = ["key", "owner", "name", "iD", "jobIndex", "simulationKey", "parameterScanType", "dataKey"] + __properties: ClassVar[List[str]] = ["key", "owner", "name", "jobIndex", "simulationKey", "parameterScanType", "dataKey"] model_config = { "populate_by_name": True, @@ -111,7 +110,6 @@ def from_dict(cls, obj: Dict) -> Self: "key": KeyValue.from_dict(obj.get("key")) if obj.get("key") is not None else None, "owner": User.from_dict(obj.get("owner")) if obj.get("owner") is not None else None, "name": obj.get("name"), - "iD": obj.get("iD"), "jobIndex": obj.get("jobIndex"), "simulationKey": KeyValue.from_dict(obj.get("simulationKey")) if obj.get("simulationKey") is not None else None, "parameterScanType": obj.get("parameterScanType"), diff --git a/python-restclient/vcell_client/models/field_data_reference.py b/python-restclient/vcell_client/models/field_data_reference.py new file mode 100644 index 0000000000..e2baf64494 --- /dev/null +++ b/python-restclient/vcell_client/models/field_data_reference.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + VCell API + + VCell API + + The version of the OpenAPI document: 1.0.1 + Contact: vcell_support@uchc.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from vcell_client.models.external_data_identifier import ExternalDataIdentifier +from vcell_client.models.key_value import KeyValue +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class FieldDataReference(BaseModel): + """ + FieldDataReference + """ # noqa: E501 + external_data_identifier: Optional[ExternalDataIdentifier] = Field(default=None, alias="externalDataIdentifier") + external_data_annotation: Optional[StrictStr] = Field(default=None, alias="externalDataAnnotation") + external_data_id_sim_ref: Optional[List[KeyValue]] = Field(default=None, alias="externalDataIDSimRef") + __properties: ClassVar[List[str]] = ["externalDataIdentifier", "externalDataAnnotation", "externalDataIDSimRef"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldDataReference from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of external_data_identifier + if self.external_data_identifier: + _dict['externalDataIdentifier'] = self.external_data_identifier.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in external_data_id_sim_ref (list) + _items = [] + if self.external_data_id_sim_ref: + for _item in self.external_data_id_sim_ref: + if _item: + _items.append(_item.to_dict()) + _dict['externalDataIDSimRef'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of FieldDataReference from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + # raise errors for additional fields in the input + for _key in obj.keys(): + if _key not in cls.__properties: + raise ValueError("Error due to additional fields (not defined in FieldDataReference) in the input: " + _key) + + _obj = cls.model_validate({ + "externalDataIdentifier": ExternalDataIdentifier.from_dict(obj.get("externalDataIdentifier")) if obj.get("externalDataIdentifier") is not None else None, + "externalDataAnnotation": obj.get("externalDataAnnotation"), + "externalDataIDSimRef": [KeyValue.from_dict(_item) for _item in obj.get("externalDataIDSimRef")] if obj.get("externalDataIDSimRef") is not None else None + }) + return _obj + + diff --git a/python-restclient/vcell_client/models/field_data_shape.py b/python-restclient/vcell_client/models/field_data_shape.py new file mode 100644 index 0000000000..5ac82d6283 --- /dev/null +++ b/python-restclient/vcell_client/models/field_data_shape.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + VCell API + + VCell API + + The version of the OpenAPI document: 1.0.1 + Contact: vcell_support@uchc.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictFloat, StrictInt +from pydantic import Field +from vcell_client.models.data_identifier import DataIdentifier +from vcell_client.models.extent import Extent +from vcell_client.models.i_size import ISize +from vcell_client.models.origin import Origin +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class FieldDataShape(BaseModel): + """ + FieldDataShape + """ # noqa: E501 + extent: Optional[Extent] = None + origin: Optional[Origin] = None + isize: Optional[ISize] = None + data_identifier: Optional[List[DataIdentifier]] = Field(default=None, alias="dataIdentifier") + times: Optional[List[Union[StrictFloat, StrictInt]]] = None + __properties: ClassVar[List[str]] = ["extent", "origin", "isize", "dataIdentifier", "times"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldDataShape from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of extent + if self.extent: + _dict['extent'] = self.extent.to_dict() + # override the default output from pydantic by calling `to_dict()` of origin + if self.origin: + _dict['origin'] = self.origin.to_dict() + # override the default output from pydantic by calling `to_dict()` of isize + if self.isize: + _dict['isize'] = self.isize.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in data_identifier (list) + _items = [] + if self.data_identifier: + for _item in self.data_identifier: + if _item: + _items.append(_item.to_dict()) + _dict['dataIdentifier'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of FieldDataShape from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + # raise errors for additional fields in the input + for _key in obj.keys(): + if _key not in cls.__properties: + raise ValueError("Error due to additional fields (not defined in FieldDataShape) in the input: " + _key) + + _obj = cls.model_validate({ + "extent": Extent.from_dict(obj.get("extent")) if obj.get("extent") is not None else None, + "origin": Origin.from_dict(obj.get("origin")) if obj.get("origin") is not None else None, + "isize": ISize.from_dict(obj.get("isize")) if obj.get("isize") is not None else None, + "dataIdentifier": [DataIdentifier.from_dict(_item) for _item in obj.get("dataIdentifier")] if obj.get("dataIdentifier") is not None else None, + "times": obj.get("times") + }) + return _obj + + diff --git a/python-restclient/vcell_client/models/i_size.py b/python-restclient/vcell_client/models/i_size.py index 284d188eee..251b108e6f 100644 --- a/python-restclient/vcell_client/models/i_size.py +++ b/python-restclient/vcell_client/models/i_size.py @@ -21,7 +21,6 @@ from typing import Any, ClassVar, Dict, List, Optional from pydantic import BaseModel, StrictInt -from pydantic import Field try: from typing import Self except ImportError: @@ -34,8 +33,7 @@ class ISize(BaseModel): x: Optional[StrictInt] = None y: Optional[StrictInt] = None z: Optional[StrictInt] = None - x_yz: Optional[StrictInt] = Field(default=None, alias="xYZ") - __properties: ClassVar[List[str]] = ["x", "y", "z", "xYZ"] + __properties: ClassVar[List[str]] = ["x", "y", "z"] model_config = { "populate_by_name": True, @@ -92,8 +90,7 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "x": obj.get("x"), "y": obj.get("y"), - "z": obj.get("z"), - "xYZ": obj.get("xYZ") + "z": obj.get("z") }) return _obj diff --git a/python-restclient/vcell_client/models/user.py b/python-restclient/vcell_client/models/user.py index dd783bc381..759c157d8d 100644 --- a/python-restclient/vcell_client/models/user.py +++ b/python-restclient/vcell_client/models/user.py @@ -34,10 +34,9 @@ class User(BaseModel): """ # noqa: E501 user_name: Optional[StrictStr] = Field(default=None, alias="userName") key: Optional[KeyValue] = None - i_d: Optional[KeyValue] = Field(default=None, alias="iD") name: Optional[StrictStr] = None test_account: Optional[StrictBool] = Field(default=None, alias="testAccount") - __properties: ClassVar[List[str]] = ["userName", "key", "iD", "name", "testAccount"] + __properties: ClassVar[List[str]] = ["userName", "key", "name", "testAccount"] model_config = { "populate_by_name": True, @@ -78,9 +77,6 @@ def to_dict(self) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of key if self.key: _dict['key'] = self.key.to_dict() - # override the default output from pydantic by calling `to_dict()` of i_d - if self.i_d: - _dict['iD'] = self.i_d.to_dict() return _dict @classmethod @@ -100,7 +96,6 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "userName": obj.get("userName"), "key": KeyValue.from_dict(obj.get("key")) if obj.get("key") is not None else None, - "iD": KeyValue.from_dict(obj.get("iD")) if obj.get("iD") is not None else None, "name": obj.get("name"), "testAccount": obj.get("testAccount") }) diff --git a/vcell-restclient/.openapi-generator/FILES b/vcell-restclient/.openapi-generator/FILES index 76763f2910..83638276d5 100644 --- a/vcell-restclient/.openapi-generator/FILES +++ b/vcell-restclient/.openapi-generator/FILES @@ -8,21 +8,15 @@ docs/BatchSystemType.md docs/BioModel.md docs/BioModelResourceApi.md docs/BiomodelRef.md -docs/CartesianMesh.md -docs/Coordinate.md docs/DataIdentifier.md docs/DetailedState.md docs/Domain.md docs/Extent.md docs/ExternalDataIdentifier.md -docs/FieldDataDBOperationSpec.md -docs/FieldDataFileOperationSpec.md -docs/FieldDataInfo.md -docs/FieldDataNoCopyConflict.md -docs/FieldDataReferences.md +docs/FieldDataReference.md docs/FieldDataResourceApi.md docs/FieldDataSaveResults.md -docs/GroupAccess.md +docs/FieldDataShape.md docs/HelloWorldApi.md docs/HelloWorldMessage.md docs/HtcJobID.md @@ -43,7 +37,6 @@ docs/SimulationResourceApi.md docs/SimulationStatusPersistentRecord.md docs/Status.md docs/StatusMessage.md -docs/UCDInfo.md docs/User.md docs/UserIdentityJSONSafe.md docs/UserLoginInfoForMapping.md @@ -52,10 +45,6 @@ docs/UsersResourceApi.md docs/VCSimulationIdentifier.md docs/VariableDomain.md docs/VariableType.md -docs/Version.md -docs/VersionFlag.md -docs/VersionableType.md -docs/VersionableTypeVersion.md src/main/AndroidManifest.xml src/main/java/org/vcell/restclient/ApiClient.java src/main/java/org/vcell/restclient/ApiException.java @@ -79,20 +68,14 @@ src/main/java/org/vcell/restclient/model/AnalyzedResultsFromFieldData.java src/main/java/org/vcell/restclient/model/BatchSystemType.java src/main/java/org/vcell/restclient/model/BioModel.java src/main/java/org/vcell/restclient/model/BiomodelRef.java -src/main/java/org/vcell/restclient/model/CartesianMesh.java -src/main/java/org/vcell/restclient/model/Coordinate.java src/main/java/org/vcell/restclient/model/DataIdentifier.java src/main/java/org/vcell/restclient/model/DetailedState.java src/main/java/org/vcell/restclient/model/Domain.java src/main/java/org/vcell/restclient/model/Extent.java src/main/java/org/vcell/restclient/model/ExternalDataIdentifier.java -src/main/java/org/vcell/restclient/model/FieldDataDBOperationSpec.java -src/main/java/org/vcell/restclient/model/FieldDataFileOperationSpec.java -src/main/java/org/vcell/restclient/model/FieldDataInfo.java -src/main/java/org/vcell/restclient/model/FieldDataNoCopyConflict.java -src/main/java/org/vcell/restclient/model/FieldDataReferences.java +src/main/java/org/vcell/restclient/model/FieldDataReference.java src/main/java/org/vcell/restclient/model/FieldDataSaveResults.java -src/main/java/org/vcell/restclient/model/GroupAccess.java +src/main/java/org/vcell/restclient/model/FieldDataShape.java src/main/java/org/vcell/restclient/model/HelloWorldMessage.java src/main/java/org/vcell/restclient/model/HtcJobID.java src/main/java/org/vcell/restclient/model/ISize.java @@ -110,7 +93,6 @@ src/main/java/org/vcell/restclient/model/SimulationQueueID.java src/main/java/org/vcell/restclient/model/SimulationStatusPersistentRecord.java src/main/java/org/vcell/restclient/model/Status.java src/main/java/org/vcell/restclient/model/StatusMessage.java -src/main/java/org/vcell/restclient/model/UCDInfo.java src/main/java/org/vcell/restclient/model/User.java src/main/java/org/vcell/restclient/model/UserIdentityJSONSafe.java src/main/java/org/vcell/restclient/model/UserLoginInfoForMapping.java @@ -118,9 +100,5 @@ src/main/java/org/vcell/restclient/model/UserRegistrationInfo.java src/main/java/org/vcell/restclient/model/VCSimulationIdentifier.java src/main/java/org/vcell/restclient/model/VariableDomain.java src/main/java/org/vcell/restclient/model/VariableType.java -src/main/java/org/vcell/restclient/model/Version.java -src/main/java/org/vcell/restclient/model/VersionFlag.java -src/main/java/org/vcell/restclient/model/VersionableType.java -src/main/java/org/vcell/restclient/model/VersionableTypeVersion.java -src/test/java/org/vcell/restclient/model/DataIdentifierTest.java -src/test/java/org/vcell/restclient/model/DomainTest.java +src/test/java/org/vcell/restclient/api/FieldDataResourceApiTest.java +src/test/java/org/vcell/restclient/model/FieldDataShapeTest.java diff --git a/vcell-restclient/README.md b/vcell-restclient/README.md index 61d18b2541..5a04f9aa2b 100644 --- a/vcell-restclient/README.md +++ b/vcell-restclient/README.md @@ -113,20 +113,16 @@ Class | Method | HTTP request | Description *BioModelResourceApi* | [**getBiomodelByIdWithHttpInfo**](docs/BioModelResourceApi.md#getBiomodelByIdWithHttpInfo) | **GET** /api/v1/bioModel/{bioModelID} | Get BioModel information in JSON format by ID. *BioModelResourceApi* | [**uploadBioModel**](docs/BioModelResourceApi.md#uploadBioModel) | **POST** /api/v1/bioModel/upload_bioModel | Upload the BioModel to VCell database. Returns BioModel ID. *BioModelResourceApi* | [**uploadBioModelWithHttpInfo**](docs/BioModelResourceApi.md#uploadBioModelWithHttpInfo) | **POST** /api/v1/bioModel/upload_bioModel | Upload the BioModel to VCell database. Returns BioModel ID. -*FieldDataResourceApi* | [**copyFieldData**](docs/FieldDataResourceApi.md#copyFieldData) | **POST** /api/v1/fieldData/copy | Copy an existing field data entry. -*FieldDataResourceApi* | [**copyFieldDataWithHttpInfo**](docs/FieldDataResourceApi.md#copyFieldDataWithHttpInfo) | **POST** /api/v1/fieldData/copy | Copy an existing field data entry. -*FieldDataResourceApi* | [**createNewFieldDataFromFileAlreadyAnalyzed**](docs/FieldDataResourceApi.md#createNewFieldDataFromFileAlreadyAnalyzed) | **POST** /api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed | -*FieldDataResourceApi* | [**createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo**](docs/FieldDataResourceApi.md#createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo) | **POST** /api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed | -*FieldDataResourceApi* | [**createNewFieldDataFromSimulation**](docs/FieldDataResourceApi.md#createNewFieldDataFromSimulation) | **POST** /api/v1/fieldData/createFieldDataFromSimulation | Create new field data from a simulation. -*FieldDataResourceApi* | [**createNewFieldDataFromSimulationWithHttpInfo**](docs/FieldDataResourceApi.md#createNewFieldDataFromSimulationWithHttpInfo) | **POST** /api/v1/fieldData/createFieldDataFromSimulation | Create new field data from a simulation. -*FieldDataResourceApi* | [**deleteFieldData**](docs/FieldDataResourceApi.md#deleteFieldData) | **DELETE** /api/v1/fieldData | Delete the selected field data. -*FieldDataResourceApi* | [**deleteFieldDataWithHttpInfo**](docs/FieldDataResourceApi.md#deleteFieldDataWithHttpInfo) | **DELETE** /api/v1/fieldData | Delete the selected field data. -*FieldDataResourceApi* | [**generateFieldDataEstimate**](docs/FieldDataResourceApi.md#generateFieldDataEstimate) | **POST** /api/v1/fieldData/analyzeFieldDataFromFile | -*FieldDataResourceApi* | [**generateFieldDataEstimateWithHttpInfo**](docs/FieldDataResourceApi.md#generateFieldDataEstimateWithHttpInfo) | **POST** /api/v1/fieldData/analyzeFieldDataFromFile | +*FieldDataResourceApi* | [**analyzeFieldDataFile**](docs/FieldDataResourceApi.md#analyzeFieldDataFile) | **POST** /api/v1/fieldData/analyzeFieldDataFile | Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. +*FieldDataResourceApi* | [**analyzeFieldDataFileWithHttpInfo**](docs/FieldDataResourceApi.md#analyzeFieldDataFileWithHttpInfo) | **POST** /api/v1/fieldData/analyzeFieldDataFile | Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. +*FieldDataResourceApi* | [**createFieldDataFromAnalyzedFile**](docs/FieldDataResourceApi.md#createFieldDataFromAnalyzedFile) | **POST** /api/v1/fieldData/createFieldDataFromAnalyzedFile | Take the analyzed results of the field data, modify it to your liking, then save it on the server. +*FieldDataResourceApi* | [**createFieldDataFromAnalyzedFileWithHttpInfo**](docs/FieldDataResourceApi.md#createFieldDataFromAnalyzedFileWithHttpInfo) | **POST** /api/v1/fieldData/createFieldDataFromAnalyzedFile | Take the analyzed results of the field data, modify it to your liking, then save it on the server. +*FieldDataResourceApi* | [**deleteFieldData**](docs/FieldDataResourceApi.md#deleteFieldData) | **DELETE** /api/v1/fieldData/delete/{fieldDataID} | Delete the selected field data. +*FieldDataResourceApi* | [**deleteFieldDataWithHttpInfo**](docs/FieldDataResourceApi.md#deleteFieldDataWithHttpInfo) | **DELETE** /api/v1/fieldData/delete/{fieldDataID} | Delete the selected field data. *FieldDataResourceApi* | [**getAllFieldDataIDs**](docs/FieldDataResourceApi.md#getAllFieldDataIDs) | **GET** /api/v1/fieldData/IDs | Get all of the ids used to identify, and retrieve field data. *FieldDataResourceApi* | [**getAllFieldDataIDsWithHttpInfo**](docs/FieldDataResourceApi.md#getAllFieldDataIDsWithHttpInfo) | **GET** /api/v1/fieldData/IDs | Get all of the ids used to identify, and retrieve field data. -*FieldDataResourceApi* | [**getFieldDataFromID**](docs/FieldDataResourceApi.md#getFieldDataFromID) | **GET** /api/v1/fieldData | Get the field data from the selected field data ID. -*FieldDataResourceApi* | [**getFieldDataFromIDWithHttpInfo**](docs/FieldDataResourceApi.md#getFieldDataFromIDWithHttpInfo) | **GET** /api/v1/fieldData | Get the field data from the selected field data ID. +*FieldDataResourceApi* | [**getFieldDataShapeFromID**](docs/FieldDataResourceApi.md#getFieldDataShapeFromID) | **GET** /api/v1/fieldData/fieldDataShape/{fieldDataID} | Get the shape of the field data. That is it's size, origin, extent, and data identifiers. +*FieldDataResourceApi* | [**getFieldDataShapeFromIDWithHttpInfo**](docs/FieldDataResourceApi.md#getFieldDataShapeFromIDWithHttpInfo) | **GET** /api/v1/fieldData/fieldDataShape/{fieldDataID} | Get the shape of the field data. That is it's size, origin, extent, and data identifiers. *HelloWorldApi* | [**getHelloWorld**](docs/HelloWorldApi.md#getHelloWorld) | **GET** /api/v1/helloworld | Get hello world message. *HelloWorldApi* | [**getHelloWorldWithHttpInfo**](docs/HelloWorldApi.md#getHelloWorldWithHttpInfo) | **GET** /api/v1/helloworld | Get hello world message. *PublicationResourceApi* | [**createPublication**](docs/PublicationResourceApi.md#createPublication) | **POST** /api/v1/publications | Create publication @@ -174,20 +170,14 @@ Class | Method | HTTP request | Description - [BatchSystemType](docs/BatchSystemType.md) - [BioModel](docs/BioModel.md) - [BiomodelRef](docs/BiomodelRef.md) - - [CartesianMesh](docs/CartesianMesh.md) - - [Coordinate](docs/Coordinate.md) - [DataIdentifier](docs/DataIdentifier.md) - [DetailedState](docs/DetailedState.md) - [Domain](docs/Domain.md) - [Extent](docs/Extent.md) - [ExternalDataIdentifier](docs/ExternalDataIdentifier.md) - - [FieldDataDBOperationSpec](docs/FieldDataDBOperationSpec.md) - - [FieldDataFileOperationSpec](docs/FieldDataFileOperationSpec.md) - - [FieldDataInfo](docs/FieldDataInfo.md) - - [FieldDataNoCopyConflict](docs/FieldDataNoCopyConflict.md) - - [FieldDataReferences](docs/FieldDataReferences.md) + - [FieldDataReference](docs/FieldDataReference.md) - [FieldDataSaveResults](docs/FieldDataSaveResults.md) - - [GroupAccess](docs/GroupAccess.md) + - [FieldDataShape](docs/FieldDataShape.md) - [HelloWorldMessage](docs/HelloWorldMessage.md) - [HtcJobID](docs/HtcJobID.md) - [ISize](docs/ISize.md) @@ -205,7 +195,6 @@ Class | Method | HTTP request | Description - [SimulationStatusPersistentRecord](docs/SimulationStatusPersistentRecord.md) - [Status](docs/Status.md) - [StatusMessage](docs/StatusMessage.md) - - [UCDInfo](docs/UCDInfo.md) - [User](docs/User.md) - [UserIdentityJSONSafe](docs/UserIdentityJSONSafe.md) - [UserLoginInfoForMapping](docs/UserLoginInfoForMapping.md) @@ -213,10 +202,6 @@ Class | Method | HTTP request | Description - [VCSimulationIdentifier](docs/VCSimulationIdentifier.md) - [VariableDomain](docs/VariableDomain.md) - [VariableType](docs/VariableType.md) - - [Version](docs/Version.md) - - [VersionFlag](docs/VersionFlag.md) - - [VersionableType](docs/VersionableType.md) - - [VersionableTypeVersion](docs/VersionableTypeVersion.md) diff --git a/vcell-restclient/api/openapi.yaml b/vcell-restclient/api/openapi.yaml index 42d466a7f5..37be006158 100644 --- a/vcell-restclient/api/openapi.yaml +++ b/vcell-restclient/api/openapi.yaml @@ -46,10 +46,10 @@ paths: schema: $ref: '#/components/schemas/SimulationStatusPersistentRecord' description: OK - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -77,10 +77,10 @@ paths: $ref: '#/components/schemas/StatusMessage' type: array description: OK - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -108,10 +108,10 @@ paths: $ref: '#/components/schemas/StatusMessage' type: array description: OK - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -149,10 +149,10 @@ paths: schema: type: string description: OK - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -202,41 +202,6 @@ paths: tags: - Bio Model Resource x-accepts: application/json - /api/v1/fieldData: - delete: - operationId: deleteFieldData - requestBody: - content: - text/plain: - schema: - type: string - responses: - "204": - description: No Content - summary: Delete the selected field data. - tags: - - Field Data Resource - x-content-type: text/plain - x-accepts: application/json - get: - operationId: getFieldDataFromID - requestBody: - content: - text/plain: - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FieldDataInfo' - description: OK - summary: Get the field data from the selected field data ID. - tags: - - Field Data Resource - x-content-type: text/plain - x-accepts: application/json /api/v1/fieldData/IDs: get: operationId: getAllFieldDataIDs @@ -245,89 +210,96 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FieldDataReferences' + items: + $ref: '#/components/schemas/FieldDataReference' + type: array description: OK summary: "Get all of the ids used to identify, and retrieve field data." tags: - Field Data Resource x-accepts: application/json - /api/v1/fieldData/analyzeFieldDataFromFile: + /api/v1/fieldData/analyzeFieldDataFile: post: - operationId: generateFieldDataEstimate + operationId: analyzeFieldDataFile requestBody: content: multipart/form-data: schema: - $ref: '#/components/schemas/FieldDataFile' + $ref: '#/components/schemas/analyzeFieldDataFile_request' responses: "200": content: application/json: schema: - $ref: '#/components/schemas/FieldDataFileOperationSpec' + $ref: '#/components/schemas/AnalyzedResultsFromFieldData' description: OK + summary: "Analyze the field data from the uploaded file. Filenames must be lowercase\ + \ alphanumeric, and can contain underscores." tags: - Field Data Resource x-content-type: multipart/form-data x-accepts: application/json - /api/v1/fieldData/copy: + /api/v1/fieldData/createFieldDataFromAnalyzedFile: post: - operationId: copyFieldData + operationId: createFieldDataFromAnalyzedFile requestBody: content: application/json: schema: - $ref: '#/components/schemas/FieldDataDBOperationSpec' + $ref: '#/components/schemas/AnalyzedResultsFromFieldData' responses: "200": content: application/json: schema: - $ref: '#/components/schemas/FieldDataNoCopyConflict' + $ref: '#/components/schemas/FieldDataSaveResults' description: OK - summary: Copy an existing field data entry. + summary: "Take the analyzed results of the field data, modify it to your liking,\ + \ then save it on the server." tags: - Field Data Resource x-content-type: application/json x-accepts: application/json - /api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed: - post: - operationId: createNewFieldDataFromFileAlreadyAnalyzed - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AnalyzedResultsFromFieldData' + /api/v1/fieldData/delete/{fieldDataID}: + delete: + operationId: deleteFieldData + parameters: + - explode: false + in: path + name: fieldDataID + required: true + schema: + type: string + style: simple responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/FieldDataSaveResults' - description: OK + "204": + description: No Content + summary: Delete the selected field data. tags: - Field Data Resource - x-content-type: application/json x-accepts: application/json - /api/v1/fieldData/createFieldDataFromSimulation: - post: - operationId: createNewFieldDataFromSimulation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FieldDataDBOperationSpec' + /api/v1/fieldData/fieldDataShape/{fieldDataID}: + get: + operationId: getFieldDataShapeFromID + parameters: + - explode: false + in: path + name: fieldDataID + required: true + schema: + type: string + style: simple responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ExternalDataIdentifier' + $ref: '#/components/schemas/FieldDataShape' description: OK - summary: Create new field data from a simulation. + summary: "Get the shape of the field data. That is it's size, origin, extent,\ + \ and data identifiers." tags: - Field Data Resource - x-content-type: application/json x-accepts: application/json /api/v1/helloworld: get: @@ -449,10 +421,10 @@ paths: schema: $ref: '#/components/schemas/AccesTokenRepresentationRecord' description: OK - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -517,10 +489,10 @@ paths: schema: type: boolean description: OK - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -539,10 +511,10 @@ paths: schema: $ref: '#/components/schemas/UserIdentityJSONSafe' description: "Successful, returning the identity" - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -577,10 +549,10 @@ paths: description: "Successful, returning the identity" "409": description: "VCell Identity not mapped, userid already exists" - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -632,10 +604,10 @@ paths: description: magic link sent in email if appropriate "400": description: unable to process request - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -661,10 +633,10 @@ paths: schema: type: boolean description: OK - "403": - description: Not Allowed "401": description: Not Authorized + "403": + description: Not Allowed security: - openId: - user @@ -698,22 +670,21 @@ components: AnalyzedResultsFromFieldData: example: extent: - x: 0.8008281904610115 - "y": 6.027456183070403 - z: 1.4658129805029452 + x: 2.3021358869347655 + "y": 7.061401241503109 + z: 9.301444243932576 annotation: annotation times: - 6.027456183070403 - 6.027456183070403 origin: - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 + x: 1.4658129805029452 + "y": 5.962133916683182 + z: 5.637376656633329 isize: - x: 7 - xYZ: 2 - "y": 9 - z: 3 + x: 3 + "y": 2 + z: 4 name: name varNames: - varNames @@ -840,170 +811,6 @@ components: format: int32 type: integer type: object - CartesianMesh: - example: - iSize: - x: 7 - xYZ: 2 - "y": 9 - z: 3 - chomboMesh: true - uCDInfo: - numPointsXYZ: 7 - ucdGridNodes: - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - ucdMembraneQuads: - - - 7 - - 7 - - - 7 - - 7 - uCDGridNodes: - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - numVolumeNodesX: 3 - numVolumeNodesXY: 1 - numVolumeCells: 1 - reducedUCDGridNodesV: - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - uCDMembraneQuads: - - - 9 - - 9 - - - 9 - - 9 - numVolumeNodesY: 2 - numMembraneCells: 1 - numVolumeNodesZ: 4 - numVolumeElements: 5 - numMembraneRegions: 4 - outputFields: - - "" - - "" - sizeX: 9 - membraneRegionMapSubvolumesInOut: - key: "" - numVolumeRegions: 9 - membraneConnectivityOK: true - geometryDimension: 6 - numMembraneElements: 1 - compressedBytes: "" - volumeRegionMapSubvolume: - key: 7 - sizeY: 6 - sizeZ: 8 - properties: - compressedBytes: - format: binary - type: string - uCDInfo: - $ref: '#/components/schemas/UCDInfo' - geometryDimension: - format: int32 - type: integer - volumeRegionMapSubvolume: - additionalProperties: - format: int32 - type: integer - type: object - membraneRegionMapSubvolumesInOut: - additionalProperties: {} - type: object - numMembraneElements: - format: int32 - type: integer - numMembraneRegions: - format: int32 - type: integer - numVolumeElements: - format: int32 - type: integer - numVolumeRegions: - format: int32 - type: integer - iSize: - $ref: '#/components/schemas/ISize' - sizeX: - format: int32 - type: integer - sizeY: - format: int32 - type: integer - sizeZ: - format: int32 - type: integer - membraneConnectivityOK: - type: boolean - outputFields: - items: {} - type: array - chomboMesh: - type: boolean - type: object - Coordinate: - example: - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - properties: - x: - format: double - type: number - "y": - format: double - type: number - z: - format: double - type: number - type: object DataIdentifier: example: variableType: @@ -1013,7 +820,7 @@ components: defaultLabel: defaultLabel units: units label: label - type: 4 + type: 0 variableDomain: null legacyWarn: true visible: true @@ -1105,9 +912,9 @@ components: type: object Extent: example: - x: 0.8008281904610115 - "y": 6.027456183070403 - z: 1.4658129805029452 + x: 2.3021358869347655 + "y": 7.061401241503109 + z: 9.301444243932576 properties: x: format: double @@ -1130,8 +937,6 @@ components: owner: testAccount: true name: name - iD: - value: 0.8008281904610115 userName: userName key: value: 0.8008281904610115 @@ -1141,7 +946,6 @@ components: value: 0.8008281904610115 jobIndex: 0 name: name - iD: iD key: value: 0.8008281904610115 parameterScanType: true @@ -1152,8 +956,6 @@ components: $ref: '#/components/schemas/User' name: type: string - iD: - type: string jobIndex: format: int32 type: integer @@ -1164,28 +966,13 @@ components: dataKey: $ref: '#/components/schemas/KeyValue' type: object - FieldDataDBOperationSpec: + FieldDataReference: example: - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - annotation: annotation - sourceNames: - - sourceNames - - sourceNames - bIncludeSimRefs: true - opType: 0 - specEDI: + externalDataAnnotation: externalDataAnnotation + externalDataIdentifier: owner: testAccount: true name: name - iD: - value: 0.8008281904610115 userName: userName key: value: 0.8008281904610115 @@ -1195,373 +982,49 @@ components: value: 0.8008281904610115 jobIndex: 0 name: name - iD: iD key: value: 0.8008281904610115 parameterScanType: true - newExtDataIDName: newExtDataIDName - sourceOwner: - vType: - code: 1 - versionClass: "{}" - vType: 6 - bTopLevel: true - name: name - isTopLevel: true - typeName: typeName - vClass: "{}" - version: - date: 2022-03-10T00:00:00.000+00:00 - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - branchID: 9.301444243932576 - flag: - archived: true - current: true - intValue: 7 - versionFlag: 2 - published: true - versionGroupAccess: - groupid: 5.962133916683182 - description: description - versionFlag: - archived: true - current: true - intValue: 7 - versionFlag: 2 - published: true - versionName: versionName - annot: annot - versionDate: 2022-03-10T00:00:00.000+00:00 - versionKey: - value: 0.8008281904610115 - versionAnnot: versionAnnot - groupAccess: - groupid: 5.962133916683182 - description: description - versionBranchID: 5.637376656633329 - name: name - versionBranchPointRef: - value: 0.8008281904610115 - branchPointRefKey: - value: 0.8008281904610115 - versionOwner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 + externalDataIDSimRef: + - value: 0.8008281904610115 + - value: 0.8008281904610115 properties: - opType: - format: int32 - type: integer - specEDI: + externalDataIdentifier: $ref: '#/components/schemas/ExternalDataIdentifier' - owner: - $ref: '#/components/schemas/User' - newExtDataIDName: - type: string - annotation: + externalDataAnnotation: type: string - sourceNames: + externalDataIDSimRef: items: - type: string + $ref: '#/components/schemas/KeyValue' type: array - sourceOwner: - $ref: '#/components/schemas/VersionableTypeVersion' - bIncludeSimRefs: - type: boolean type: object - FieldDataFile: + FieldDataSaveResults: + example: + fieldDataName: fieldDataName + fieldDataID: fieldDataID properties: - file: - format: binary + fieldDataName: type: string - fileName: + fieldDataID: type: string type: object - FieldDataFileOperationSpec: + FieldDataShape: example: - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 extent: - x: 0.8008281904610115 - "y": 6.027456183070403 - z: 1.4658129805029452 - annotation: annotation - variableTypes: - - defaultUnits: defaultUnits - name: name - typeName: typeName - defaultLabel: defaultLabel - units: units - label: label - type: 4 - variableDomain: null - legacyWarn: true - - defaultUnits: defaultUnits - name: name - typeName: typeName - defaultLabel: defaultLabel - units: units - label: label - type: 4 - variableDomain: null - legacyWarn: true - doubleSpecData: - - - - 1.4658129805029452 - - 1.4658129805029452 - - - 1.4658129805029452 - - 1.4658129805029452 - - - - 1.4658129805029452 - - 1.4658129805029452 - - - 1.4658129805029452 - - 1.4658129805029452 - opType: 0 - specEDI: - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - dataKey: - value: 0.8008281904610115 - simulationKey: - value: 0.8008281904610115 - jobIndex: 0 - name: name - iD: iD - key: - value: 0.8008281904610115 - parameterScanType: true - origin: - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - varNames: - - varNames - - varNames - sourceOwner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - shortSpecData: - - - - 6 - - 6 - - - 6 - - 6 - - - - 6 - - 6 - - - 6 - - 6 - sourceSimParamScanJobIndex: 6 + x: 2.3021358869347655 + "y": 7.061401241503109 + z: 9.301444243932576 times: - - 9.018348186070783 - - 9.018348186070783 - fieldDataName: fieldDataName - sourceSimDataKey: - value: 0.8008281904610115 + - 6.027456183070403 + - 6.027456183070403 + origin: + x: 1.4658129805029452 + "y": 5.962133916683182 + z: 5.637376656633329 isize: - x: 7 - xYZ: 2 - "y": 9 - z: 3 - cartesianMesh: - iSize: - x: 7 - xYZ: 2 - "y": 9 - z: 3 - chomboMesh: true - uCDInfo: - numPointsXYZ: 7 - ucdGridNodes: - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - ucdMembraneQuads: - - - 7 - - 7 - - - 7 - - 7 - uCDGridNodes: - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - numVolumeNodesX: 3 - numVolumeNodesXY: 1 - numVolumeCells: 1 - reducedUCDGridNodesV: - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - uCDMembraneQuads: - - - 9 - - 9 - - - 9 - - 9 - numVolumeNodesY: 2 - numMembraneCells: 1 - numVolumeNodesZ: 4 - numVolumeElements: 5 - numMembraneRegions: 4 - outputFields: - - "" - - "" - sizeX: 9 - membraneRegionMapSubvolumesInOut: - key: "" - numVolumeRegions: 9 - membraneConnectivityOK: true - geometryDimension: 6 - numMembraneElements: 1 - compressedBytes: "" - volumeRegionMapSubvolume: - key: 7 - sizeY: 6 - sizeZ: 8 - properties: - opType: - format: int32 - type: integer - shortSpecData: - items: - items: - items: - type: integer - type: array - type: array - type: array - doubleSpecData: - items: - items: - items: - format: double - type: number - type: array - type: array - type: array - cartesianMesh: - $ref: '#/components/schemas/CartesianMesh' - specEDI: - $ref: '#/components/schemas/ExternalDataIdentifier' - varNames: - items: - type: string - type: array - variableTypes: - items: - $ref: '#/components/schemas/VariableType' - type: array - times: - items: - format: double - type: number - type: array - owner: - $ref: '#/components/schemas/User' - origin: - $ref: '#/components/schemas/Origin' - extent: - $ref: '#/components/schemas/Extent' - isize: - $ref: '#/components/schemas/ISize' - annotation: - type: string - sourceSimParamScanJobIndex: - format: int32 - type: integer - sourceSimDataKey: - $ref: '#/components/schemas/KeyValue' - sourceOwner: - $ref: '#/components/schemas/User' - fieldDataName: - type: string - type: object - FieldDataInfo: - example: - extent: - x: 0.8008281904610115 - "y": 6.027456183070403 - z: 1.4658129805029452 - times: - - 7.386281948385884 - - 7.386281948385884 - origin: - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - isize: - x: 7 - xYZ: 2 - "y": 9 - z: 3 + x: 3 + "y": 2 + z: 4 dataIdentifier: - variableType: defaultUnits: defaultUnits @@ -1570,7 +1033,7 @@ components: defaultLabel: defaultLabel units: units label: label - type: 4 + type: 0 variableDomain: null legacyWarn: true visible: true @@ -1587,7 +1050,7 @@ components: defaultLabel: defaultLabel units: units label: label - type: 4 + type: 0 variableDomain: null legacyWarn: true visible: true @@ -1614,123 +1077,6 @@ components: type: number type: array type: object - FieldDataNoCopyConflict: - example: - oldNameOldExtDataIDKeyHash: - key: - value: 0.8008281904610115 - oldNameNewIDHash: - key: - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - dataKey: - value: 0.8008281904610115 - simulationKey: - value: 0.8008281904610115 - jobIndex: 0 - name: name - iD: iD - key: - value: 0.8008281904610115 - parameterScanType: true - properties: - oldNameNewIDHash: - additionalProperties: - $ref: '#/components/schemas/ExternalDataIdentifier' - type: object - oldNameOldExtDataIDKeyHash: - additionalProperties: - $ref: '#/components/schemas/KeyValue' - type: object - type: object - FieldDataReferences: - example: - externalDataIdentifiers: - - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - dataKey: - value: 0.8008281904610115 - simulationKey: - value: 0.8008281904610115 - jobIndex: 0 - name: name - iD: iD - key: - value: 0.8008281904610115 - parameterScanType: true - - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - dataKey: - value: 0.8008281904610115 - simulationKey: - value: 0.8008281904610115 - jobIndex: 0 - name: name - iD: iD - key: - value: 0.8008281904610115 - parameterScanType: true - externalDataAnnotations: - - externalDataAnnotations - - externalDataAnnotations - externalDataIDSimRefs: - key: - - value: 0.8008281904610115 - - value: 0.8008281904610115 - properties: - externalDataIdentifiers: - items: - $ref: '#/components/schemas/ExternalDataIdentifier' - type: array - externalDataAnnotations: - items: - type: string - type: array - externalDataIDSimRefs: - additionalProperties: - items: - $ref: '#/components/schemas/KeyValue' - type: array - type: object - type: object - FieldDataSaveResults: - example: - fieldDataName: fieldDataName - fieldDataID: fieldDataID - properties: - fieldDataName: - type: string - fieldDataID: - type: string - type: object - GroupAccess: - example: - groupid: 5.962133916683182 - description: description - properties: - groupid: - type: number - description: - type: string - type: object HelloWorldMessage: example: message: message @@ -1754,10 +1100,9 @@ components: type: object ISize: example: - x: 7 - xYZ: 2 - "y": 9 - z: 3 + x: 3 + "y": 2 + z: 4 properties: x: format: int32 @@ -1768,9 +1113,6 @@ components: z: format: int32 type: integer - xYZ: - format: int32 - type: integer type: object Identity: example: @@ -1835,9 +1177,9 @@ components: type: object Origin: example: - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 + x: 1.4658129805029452 + "y": 5.962133916683182 + z: 5.637376656633329 properties: x: format: double @@ -1999,8 +1341,6 @@ components: owner: testAccount: true name: name - iD: - value: 0.8008281904610115 userName: userName key: value: 0.8008281904610115 @@ -2139,8 +1479,6 @@ components: owner: testAccount: true name: name - iD: - value: 0.8008281904610115 userName: userName key: value: 0.8008281904610115 @@ -2170,145 +1508,10 @@ components: format: double type: number type: object - UCDInfo: - example: - numPointsXYZ: 7 - ucdGridNodes: - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - ucdMembraneQuads: - - - 7 - - 7 - - - 7 - - 7 - uCDGridNodes: - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - numVolumeNodesX: 3 - numVolumeNodesXY: 1 - numVolumeCells: 1 - reducedUCDGridNodesV: - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - - x: 5.962133916683182 - "y": 5.637376656633329 - z: 2.3021358869347655 - uCDMembraneQuads: - - - 9 - - 9 - - - 9 - - 9 - numVolumeNodesY: 2 - numMembraneCells: 1 - numVolumeNodesZ: 4 - properties: - ucdGridNodes: - items: - items: - items: - $ref: '#/components/schemas/Coordinate' - type: array - type: array - type: array - ucdMembraneQuads: - items: - items: - format: int32 - type: integer - type: array - type: array - reducedUCDGridNodesV: - items: - $ref: '#/components/schemas/Coordinate' - type: array - uCDGridNodes: - items: - items: - items: - $ref: '#/components/schemas/Coordinate' - type: array - type: array - type: array - uCDMembraneQuads: - items: - items: - format: int32 - type: integer - type: array - type: array - numVolumeNodesX: - format: int32 - type: integer - numVolumeNodesY: - format: int32 - type: integer - numVolumeNodesZ: - format: int32 - type: integer - numPointsXYZ: - format: int32 - type: integer - numVolumeNodesXY: - format: int32 - type: integer - numVolumeCells: - format: int32 - type: integer - numMembraneCells: - format: int32 - type: integer - type: object User: example: testAccount: true name: name - iD: - value: 0.8008281904610115 userName: userName key: value: 0.8008281904610115 @@ -2317,8 +1520,6 @@ components: type: string key: $ref: '#/components/schemas/KeyValue' - iD: - $ref: '#/components/schemas/KeyValue' name: type: string testAccount: @@ -2377,8 +1578,6 @@ components: owner: testAccount: true name: name - iD: - value: 0.8008281904610115 userName: userName key: value: 0.8008281904610115 @@ -2411,7 +1610,7 @@ components: defaultLabel: defaultLabel units: units label: label - type: 4 + type: 0 variableDomain: null legacyWarn: true properties: @@ -2435,212 +1634,13 @@ components: typeName: type: string type: object - Version: - example: - date: 2022-03-10T00:00:00.000+00:00 - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - branchID: 9.301444243932576 - flag: - archived: true - current: true - intValue: 7 - versionFlag: 2 - published: true - versionGroupAccess: - groupid: 5.962133916683182 - description: description - versionFlag: - archived: true - current: true - intValue: 7 - versionFlag: 2 - published: true - versionName: versionName - annot: annot - versionDate: 2022-03-10T00:00:00.000+00:00 - versionKey: - value: 0.8008281904610115 - versionAnnot: versionAnnot - groupAccess: - groupid: 5.962133916683182 - description: description - versionBranchID: 5.637376656633329 - name: name - versionBranchPointRef: - value: 0.8008281904610115 - branchPointRefKey: - value: 0.8008281904610115 - versionOwner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - properties: - versionKey: - $ref: '#/components/schemas/KeyValue' - versionName: - type: string - versionOwner: - $ref: '#/components/schemas/User' - versionGroupAccess: - $ref: '#/components/schemas/GroupAccess' - versionBranchPointRef: - $ref: '#/components/schemas/KeyValue' - versionBranchID: - type: number - versionDate: - example: 2022-03-10 - format: date - type: string - versionFlag: - $ref: '#/components/schemas/VersionFlag' - versionAnnot: - type: string - annot: - type: string - branchID: - type: number - branchPointRefKey: - $ref: '#/components/schemas/KeyValue' - date: - example: 2022-03-10 - format: date - type: string - flag: - $ref: '#/components/schemas/VersionFlag' - groupAccess: - $ref: '#/components/schemas/GroupAccess' - name: - type: string - owner: - $ref: '#/components/schemas/User' - type: object - VersionFlag: - example: - archived: true - current: true - intValue: 7 - versionFlag: 2 - published: true - properties: - versionFlag: - format: int32 - type: integer - intValue: - format: int32 - type: integer - archived: - type: boolean - current: - type: boolean - published: - type: boolean - type: object - VersionableType: - example: - code: 1 - versionClass: "{}" - vType: 6 - bTopLevel: true - name: name - isTopLevel: true - typeName: typeName - vClass: "{}" + analyzeFieldDataFile_request: properties: - vType: - format: int32 - type: integer - name: + file: + format: binary type: string - vClass: - type: object - bTopLevel: - type: boolean - code: - format: int32 - type: integer - isTopLevel: - type: boolean - typeName: + fileName: type: string - versionClass: - type: object - type: object - VersionableTypeVersion: - example: - vType: - code: 1 - versionClass: "{}" - vType: 6 - bTopLevel: true - name: name - isTopLevel: true - typeName: typeName - vClass: "{}" - version: - date: 2022-03-10T00:00:00.000+00:00 - owner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - branchID: 9.301444243932576 - flag: - archived: true - current: true - intValue: 7 - versionFlag: 2 - published: true - versionGroupAccess: - groupid: 5.962133916683182 - description: description - versionFlag: - archived: true - current: true - intValue: 7 - versionFlag: 2 - published: true - versionName: versionName - annot: annot - versionDate: 2022-03-10T00:00:00.000+00:00 - versionKey: - value: 0.8008281904610115 - versionAnnot: versionAnnot - groupAccess: - groupid: 5.962133916683182 - description: description - versionBranchID: 5.637376656633329 - name: name - versionBranchPointRef: - value: 0.8008281904610115 - branchPointRefKey: - value: 0.8008281904610115 - versionOwner: - testAccount: true - name: name - iD: - value: 0.8008281904610115 - userName: userName - key: - value: 0.8008281904610115 - properties: - vType: - $ref: '#/components/schemas/VersionableType' - version: - $ref: '#/components/schemas/Version' type: object securitySchemes: openId: diff --git a/vcell-restclient/docs/BioModelResourceApi.md b/vcell-restclient/docs/BioModelResourceApi.md index c8041e9297..b2569706e5 100644 --- a/vcell-restclient/docs/BioModelResourceApi.md +++ b/vcell-restclient/docs/BioModelResourceApi.md @@ -337,8 +337,8 @@ public class Example { | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## uploadBioModelWithHttpInfo @@ -407,6 +407,6 @@ ApiResponse<**String**> | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | diff --git a/vcell-restclient/docs/ExternalDataIdentifier.md b/vcell-restclient/docs/ExternalDataIdentifier.md index 72587415ef..8b5ec63a51 100644 --- a/vcell-restclient/docs/ExternalDataIdentifier.md +++ b/vcell-restclient/docs/ExternalDataIdentifier.md @@ -10,7 +10,6 @@ |**key** | [**KeyValue**](KeyValue.md) | | [optional] | |**owner** | [**User**](User.md) | | [optional] | |**name** | **String** | | [optional] | -|**iD** | **String** | | [optional] | |**jobIndex** | **Integer** | | [optional] | |**simulationKey** | [**KeyValue**](KeyValue.md) | | [optional] | |**parameterScanType** | **Boolean** | | [optional] | diff --git a/vcell-restclient/docs/FieldDataReference.md b/vcell-restclient/docs/FieldDataReference.md new file mode 100644 index 0000000000..e836868f6b --- /dev/null +++ b/vcell-restclient/docs/FieldDataReference.md @@ -0,0 +1,15 @@ + + +# FieldDataReference + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**externalDataIdentifier** | [**ExternalDataIdentifier**](ExternalDataIdentifier.md) | | [optional] | +|**externalDataAnnotation** | **String** | | [optional] | +|**externalDataIDSimRef** | [**List<KeyValue>**](KeyValue.md) | | [optional] | + + + diff --git a/vcell-restclient/docs/FieldDataResourceApi.md b/vcell-restclient/docs/FieldDataResourceApi.md index 494855dbce..aa5dea000a 100644 --- a/vcell-restclient/docs/FieldDataResourceApi.md +++ b/vcell-restclient/docs/FieldDataResourceApi.md @@ -4,28 +4,24 @@ All URIs are relative to *https://vcell-dev.cam.uchc.edu* | Method | HTTP request | Description | |------------- | ------------- | -------------| -| [**copyFieldData**](FieldDataResourceApi.md#copyFieldData) | **POST** /api/v1/fieldData/copy | Copy an existing field data entry. | -| [**copyFieldDataWithHttpInfo**](FieldDataResourceApi.md#copyFieldDataWithHttpInfo) | **POST** /api/v1/fieldData/copy | Copy an existing field data entry. | -| [**createNewFieldDataFromFileAlreadyAnalyzed**](FieldDataResourceApi.md#createNewFieldDataFromFileAlreadyAnalyzed) | **POST** /api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed | | -| [**createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo**](FieldDataResourceApi.md#createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo) | **POST** /api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed | | -| [**createNewFieldDataFromSimulation**](FieldDataResourceApi.md#createNewFieldDataFromSimulation) | **POST** /api/v1/fieldData/createFieldDataFromSimulation | Create new field data from a simulation. | -| [**createNewFieldDataFromSimulationWithHttpInfo**](FieldDataResourceApi.md#createNewFieldDataFromSimulationWithHttpInfo) | **POST** /api/v1/fieldData/createFieldDataFromSimulation | Create new field data from a simulation. | -| [**deleteFieldData**](FieldDataResourceApi.md#deleteFieldData) | **DELETE** /api/v1/fieldData | Delete the selected field data. | -| [**deleteFieldDataWithHttpInfo**](FieldDataResourceApi.md#deleteFieldDataWithHttpInfo) | **DELETE** /api/v1/fieldData | Delete the selected field data. | -| [**generateFieldDataEstimate**](FieldDataResourceApi.md#generateFieldDataEstimate) | **POST** /api/v1/fieldData/analyzeFieldDataFromFile | | -| [**generateFieldDataEstimateWithHttpInfo**](FieldDataResourceApi.md#generateFieldDataEstimateWithHttpInfo) | **POST** /api/v1/fieldData/analyzeFieldDataFromFile | | +| [**analyzeFieldDataFile**](FieldDataResourceApi.md#analyzeFieldDataFile) | **POST** /api/v1/fieldData/analyzeFieldDataFile | Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. | +| [**analyzeFieldDataFileWithHttpInfo**](FieldDataResourceApi.md#analyzeFieldDataFileWithHttpInfo) | **POST** /api/v1/fieldData/analyzeFieldDataFile | Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. | +| [**createFieldDataFromAnalyzedFile**](FieldDataResourceApi.md#createFieldDataFromAnalyzedFile) | **POST** /api/v1/fieldData/createFieldDataFromAnalyzedFile | Take the analyzed results of the field data, modify it to your liking, then save it on the server. | +| [**createFieldDataFromAnalyzedFileWithHttpInfo**](FieldDataResourceApi.md#createFieldDataFromAnalyzedFileWithHttpInfo) | **POST** /api/v1/fieldData/createFieldDataFromAnalyzedFile | Take the analyzed results of the field data, modify it to your liking, then save it on the server. | +| [**deleteFieldData**](FieldDataResourceApi.md#deleteFieldData) | **DELETE** /api/v1/fieldData/delete/{fieldDataID} | Delete the selected field data. | +| [**deleteFieldDataWithHttpInfo**](FieldDataResourceApi.md#deleteFieldDataWithHttpInfo) | **DELETE** /api/v1/fieldData/delete/{fieldDataID} | Delete the selected field data. | | [**getAllFieldDataIDs**](FieldDataResourceApi.md#getAllFieldDataIDs) | **GET** /api/v1/fieldData/IDs | Get all of the ids used to identify, and retrieve field data. | | [**getAllFieldDataIDsWithHttpInfo**](FieldDataResourceApi.md#getAllFieldDataIDsWithHttpInfo) | **GET** /api/v1/fieldData/IDs | Get all of the ids used to identify, and retrieve field data. | -| [**getFieldDataFromID**](FieldDataResourceApi.md#getFieldDataFromID) | **GET** /api/v1/fieldData | Get the field data from the selected field data ID. | -| [**getFieldDataFromIDWithHttpInfo**](FieldDataResourceApi.md#getFieldDataFromIDWithHttpInfo) | **GET** /api/v1/fieldData | Get the field data from the selected field data ID. | +| [**getFieldDataShapeFromID**](FieldDataResourceApi.md#getFieldDataShapeFromID) | **GET** /api/v1/fieldData/fieldDataShape/{fieldDataID} | Get the shape of the field data. That is it's size, origin, extent, and data identifiers. | +| [**getFieldDataShapeFromIDWithHttpInfo**](FieldDataResourceApi.md#getFieldDataShapeFromIDWithHttpInfo) | **GET** /api/v1/fieldData/fieldDataShape/{fieldDataID} | Get the shape of the field data. That is it's size, origin, extent, and data identifiers. | -## copyFieldData +## analyzeFieldDataFile -> FieldDataNoCopyConflict copyFieldData(fieldDataDBOperationSpec) +> AnalyzedResultsFromFieldData analyzeFieldDataFile(_file, fileName) -Copy an existing field data entry. +Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. ### Example @@ -43,12 +39,13 @@ public class Example { defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - FieldDataDBOperationSpec fieldDataDBOperationSpec = new FieldDataDBOperationSpec(); // FieldDataDBOperationSpec | + File _file = new File("/path/to/file"); // File | + String fileName = "fileName_example"; // String | try { - FieldDataNoCopyConflict result = apiInstance.copyFieldData(fieldDataDBOperationSpec); + AnalyzedResultsFromFieldData result = apiInstance.analyzeFieldDataFile(_file, fileName); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#copyFieldData"); + System.err.println("Exception when calling FieldDataResourceApi#analyzeFieldDataFile"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -63,11 +60,12 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **fieldDataDBOperationSpec** | [**FieldDataDBOperationSpec**](FieldDataDBOperationSpec.md)| | [optional] | +| **_file** | **File**| | [optional] | +| **fileName** | **String**| | [optional] | ### Return type -[**FieldDataNoCopyConflict**](FieldDataNoCopyConflict.md) +[**AnalyzedResultsFromFieldData**](AnalyzedResultsFromFieldData.md) ### Authorization @@ -76,7 +74,7 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: multipart/form-data - **Accept**: application/json ### HTTP response details @@ -84,11 +82,11 @@ No authorization required |-------------|-------------|------------------| | **200** | OK | - | -## copyFieldDataWithHttpInfo +## analyzeFieldDataFileWithHttpInfo -> ApiResponse copyFieldData copyFieldDataWithHttpInfo(fieldDataDBOperationSpec) +> ApiResponse analyzeFieldDataFile analyzeFieldDataFileWithHttpInfo(_file, fileName) -Copy an existing field data entry. +Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. ### Example @@ -107,14 +105,15 @@ public class Example { defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - FieldDataDBOperationSpec fieldDataDBOperationSpec = new FieldDataDBOperationSpec(); // FieldDataDBOperationSpec | + File _file = new File("/path/to/file"); // File | + String fileName = "fileName_example"; // String | try { - ApiResponse response = apiInstance.copyFieldDataWithHttpInfo(fieldDataDBOperationSpec); + ApiResponse response = apiInstance.analyzeFieldDataFileWithHttpInfo(_file, fileName); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#copyFieldData"); + System.err.println("Exception when calling FieldDataResourceApi#analyzeFieldDataFile"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); @@ -129,11 +128,12 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **fieldDataDBOperationSpec** | [**FieldDataDBOperationSpec**](FieldDataDBOperationSpec.md)| | [optional] | +| **_file** | **File**| | [optional] | +| **fileName** | **String**| | [optional] | ### Return type -ApiResponse<[**FieldDataNoCopyConflict**](FieldDataNoCopyConflict.md)> +ApiResponse<[**AnalyzedResultsFromFieldData**](AnalyzedResultsFromFieldData.md)> ### Authorization @@ -142,7 +142,7 @@ No authorization required ### HTTP request headers -- **Content-Type**: application/json +- **Content-Type**: multipart/form-data - **Accept**: application/json ### HTTP response details @@ -151,11 +151,11 @@ No authorization required | **200** | OK | - | -## createNewFieldDataFromFileAlreadyAnalyzed - -> FieldDataSaveResults createNewFieldDataFromFileAlreadyAnalyzed(analyzedResultsFromFieldData) +## createFieldDataFromAnalyzedFile +> FieldDataSaveResults createFieldDataFromAnalyzedFile(analyzedResultsFromFieldData) +Take the analyzed results of the field data, modify it to your liking, then save it on the server. ### Example @@ -175,10 +175,10 @@ public class Example { FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); AnalyzedResultsFromFieldData analyzedResultsFromFieldData = new AnalyzedResultsFromFieldData(); // AnalyzedResultsFromFieldData | try { - FieldDataSaveResults result = apiInstance.createNewFieldDataFromFileAlreadyAnalyzed(analyzedResultsFromFieldData); + FieldDataSaveResults result = apiInstance.createFieldDataFromAnalyzedFile(analyzedResultsFromFieldData); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#createNewFieldDataFromFileAlreadyAnalyzed"); + System.err.println("Exception when calling FieldDataResourceApi#createFieldDataFromAnalyzedFile"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -214,11 +214,11 @@ No authorization required |-------------|-------------|------------------| | **200** | OK | - | -## createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo - -> ApiResponse createNewFieldDataFromFileAlreadyAnalyzed createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo(analyzedResultsFromFieldData) +## createFieldDataFromAnalyzedFileWithHttpInfo +> ApiResponse createFieldDataFromAnalyzedFile createFieldDataFromAnalyzedFileWithHttpInfo(analyzedResultsFromFieldData) +Take the analyzed results of the field data, modify it to your liking, then save it on the server. ### Example @@ -239,12 +239,12 @@ public class Example { FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); AnalyzedResultsFromFieldData analyzedResultsFromFieldData = new AnalyzedResultsFromFieldData(); // AnalyzedResultsFromFieldData | try { - ApiResponse response = apiInstance.createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo(analyzedResultsFromFieldData); + ApiResponse response = apiInstance.createFieldDataFromAnalyzedFileWithHttpInfo(analyzedResultsFromFieldData); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#createNewFieldDataFromFileAlreadyAnalyzed"); + System.err.println("Exception when calling FieldDataResourceApi#createFieldDataFromAnalyzedFile"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); @@ -281,139 +281,9 @@ No authorization required | **200** | OK | - | -## createNewFieldDataFromSimulation - -> ExternalDataIdentifier createNewFieldDataFromSimulation(fieldDataDBOperationSpec) - -Create new field data from a simulation. - -### Example - -```java -// Import classes: -import org.vcell.restclient.ApiClient; -import org.vcell.restclient.ApiException; -import org.vcell.restclient.Configuration; -import org.vcell.restclient.models.*; -import org.vcell.restclient.api.FieldDataResourceApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); - - FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - FieldDataDBOperationSpec fieldDataDBOperationSpec = new FieldDataDBOperationSpec(); // FieldDataDBOperationSpec | - try { - ExternalDataIdentifier result = apiInstance.createNewFieldDataFromSimulation(fieldDataDBOperationSpec); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#createNewFieldDataFromSimulation"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **fieldDataDBOperationSpec** | [**FieldDataDBOperationSpec**](FieldDataDBOperationSpec.md)| | [optional] | - -### Return type - -[**ExternalDataIdentifier**](ExternalDataIdentifier.md) - - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | - -## createNewFieldDataFromSimulationWithHttpInfo - -> ApiResponse createNewFieldDataFromSimulation createNewFieldDataFromSimulationWithHttpInfo(fieldDataDBOperationSpec) - -Create new field data from a simulation. - -### Example - -```java -// Import classes: -import org.vcell.restclient.ApiClient; -import org.vcell.restclient.ApiException; -import org.vcell.restclient.ApiResponse; -import org.vcell.restclient.Configuration; -import org.vcell.restclient.models.*; -import org.vcell.restclient.api.FieldDataResourceApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); - - FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - FieldDataDBOperationSpec fieldDataDBOperationSpec = new FieldDataDBOperationSpec(); // FieldDataDBOperationSpec | - try { - ApiResponse response = apiInstance.createNewFieldDataFromSimulationWithHttpInfo(fieldDataDBOperationSpec); - System.out.println("Status code: " + response.getStatusCode()); - System.out.println("Response headers: " + response.getHeaders()); - System.out.println("Response body: " + response.getData()); - } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#createNewFieldDataFromSimulation"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - System.err.println("Reason: " + e.getResponseBody()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **fieldDataDBOperationSpec** | [**FieldDataDBOperationSpec**](FieldDataDBOperationSpec.md)| | [optional] | - -### Return type - -ApiResponse<[**ExternalDataIdentifier**](ExternalDataIdentifier.md)> - - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | - - ## deleteFieldData -> void deleteFieldData(body) +> void deleteFieldData(fieldDataID) Delete the selected field data. @@ -433,9 +303,9 @@ public class Example { defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - String body = "body_example"; // String | + String fieldDataID = "fieldDataID_example"; // String | try { - apiInstance.deleteFieldData(body); + apiInstance.deleteFieldData(fieldDataID); } catch (ApiException e) { System.err.println("Exception when calling FieldDataResourceApi#deleteFieldData"); System.err.println("Status code: " + e.getCode()); @@ -452,7 +322,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **body** | **String**| | [optional] | +| **fieldDataID** | **String**| | | ### Return type @@ -465,7 +335,7 @@ No authorization required ### HTTP request headers -- **Content-Type**: text/plain +- **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details @@ -475,7 +345,7 @@ No authorization required ## deleteFieldDataWithHttpInfo -> ApiResponse deleteFieldData deleteFieldDataWithHttpInfo(body) +> ApiResponse deleteFieldData deleteFieldDataWithHttpInfo(fieldDataID) Delete the selected field data. @@ -496,9 +366,9 @@ public class Example { defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - String body = "body_example"; // String | + String fieldDataID = "fieldDataID_example"; // String | try { - ApiResponse response = apiInstance.deleteFieldDataWithHttpInfo(body); + ApiResponse response = apiInstance.deleteFieldDataWithHttpInfo(fieldDataID); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); } catch (ApiException e) { @@ -517,7 +387,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **body** | **String**| | [optional] | +| **fieldDataID** | **String**| | | ### Return type @@ -530,7 +400,7 @@ No authorization required ### HTTP request headers -- **Content-Type**: text/plain +- **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details @@ -539,143 +409,9 @@ No authorization required | **204** | No Content | - | -## generateFieldDataEstimate - -> FieldDataFileOperationSpec generateFieldDataEstimate(_file, fileName) - - - -### Example - -```java -// Import classes: -import org.vcell.restclient.ApiClient; -import org.vcell.restclient.ApiException; -import org.vcell.restclient.Configuration; -import org.vcell.restclient.models.*; -import org.vcell.restclient.api.FieldDataResourceApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); - - FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - File _file = new File("/path/to/file"); // File | - String fileName = "fileName_example"; // String | - try { - FieldDataFileOperationSpec result = apiInstance.generateFieldDataEstimate(_file, fileName); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#generateFieldDataEstimate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **_file** | **File**| | [optional] | -| **fileName** | **String**| | [optional] | - -### Return type - -[**FieldDataFileOperationSpec**](FieldDataFileOperationSpec.md) - - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | - -## generateFieldDataEstimateWithHttpInfo - -> ApiResponse generateFieldDataEstimate generateFieldDataEstimateWithHttpInfo(_file, fileName) - - - -### Example - -```java -// Import classes: -import org.vcell.restclient.ApiClient; -import org.vcell.restclient.ApiException; -import org.vcell.restclient.ApiResponse; -import org.vcell.restclient.Configuration; -import org.vcell.restclient.models.*; -import org.vcell.restclient.api.FieldDataResourceApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); - - FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - File _file = new File("/path/to/file"); // File | - String fileName = "fileName_example"; // String | - try { - ApiResponse response = apiInstance.generateFieldDataEstimateWithHttpInfo(_file, fileName); - System.out.println("Status code: " + response.getStatusCode()); - System.out.println("Response headers: " + response.getHeaders()); - System.out.println("Response body: " + response.getData()); - } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#generateFieldDataEstimate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - System.err.println("Reason: " + e.getResponseBody()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - - -| Name | Type | Description | Notes | -|------------- | ------------- | ------------- | -------------| -| **_file** | **File**| | [optional] | -| **fileName** | **String**| | [optional] | - -### Return type - -ApiResponse<[**FieldDataFileOperationSpec**](FieldDataFileOperationSpec.md)> - - -### Authorization - -No authorization required - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | - - ## getAllFieldDataIDs -> FieldDataReferences getAllFieldDataIDs() +> List getAllFieldDataIDs() Get all of the ids used to identify, and retrieve field data. @@ -696,7 +432,7 @@ public class Example { FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); try { - FieldDataReferences result = apiInstance.getAllFieldDataIDs(); + List result = apiInstance.getAllFieldDataIDs(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling FieldDataResourceApi#getAllFieldDataIDs"); @@ -715,7 +451,7 @@ This endpoint does not need any parameter. ### Return type -[**FieldDataReferences**](FieldDataReferences.md) +[**List<FieldDataReference>**](FieldDataReference.md) ### Authorization @@ -734,7 +470,7 @@ No authorization required ## getAllFieldDataIDsWithHttpInfo -> ApiResponse getAllFieldDataIDs getAllFieldDataIDsWithHttpInfo() +> ApiResponse> getAllFieldDataIDs getAllFieldDataIDsWithHttpInfo() Get all of the ids used to identify, and retrieve field data. @@ -756,7 +492,7 @@ public class Example { FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); try { - ApiResponse response = apiInstance.getAllFieldDataIDsWithHttpInfo(); + ApiResponse> response = apiInstance.getAllFieldDataIDsWithHttpInfo(); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); @@ -777,7 +513,7 @@ This endpoint does not need any parameter. ### Return type -ApiResponse<[**FieldDataReferences**](FieldDataReferences.md)> +ApiResponse<[**List<FieldDataReference>**](FieldDataReference.md)> ### Authorization @@ -795,11 +531,11 @@ No authorization required | **200** | OK | - | -## getFieldDataFromID +## getFieldDataShapeFromID -> FieldDataInfo getFieldDataFromID(body) +> FieldDataShape getFieldDataShapeFromID(fieldDataID) -Get the field data from the selected field data ID. +Get the shape of the field data. That is it's size, origin, extent, and data identifiers. ### Example @@ -817,12 +553,12 @@ public class Example { defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - String body = "body_example"; // String | + String fieldDataID = "fieldDataID_example"; // String | try { - FieldDataInfo result = apiInstance.getFieldDataFromID(body); + FieldDataShape result = apiInstance.getFieldDataShapeFromID(fieldDataID); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#getFieldDataFromID"); + System.err.println("Exception when calling FieldDataResourceApi#getFieldDataShapeFromID"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -837,11 +573,11 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **body** | **String**| | [optional] | +| **fieldDataID** | **String**| | | ### Return type -[**FieldDataInfo**](FieldDataInfo.md) +[**FieldDataShape**](FieldDataShape.md) ### Authorization @@ -850,7 +586,7 @@ No authorization required ### HTTP request headers -- **Content-Type**: text/plain +- **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -858,11 +594,11 @@ No authorization required |-------------|-------------|------------------| | **200** | OK | - | -## getFieldDataFromIDWithHttpInfo +## getFieldDataShapeFromIDWithHttpInfo -> ApiResponse getFieldDataFromID getFieldDataFromIDWithHttpInfo(body) +> ApiResponse getFieldDataShapeFromID getFieldDataShapeFromIDWithHttpInfo(fieldDataID) -Get the field data from the selected field data ID. +Get the shape of the field data. That is it's size, origin, extent, and data identifiers. ### Example @@ -881,14 +617,14 @@ public class Example { defaultClient.setBasePath("https://vcell-dev.cam.uchc.edu"); FieldDataResourceApi apiInstance = new FieldDataResourceApi(defaultClient); - String body = "body_example"; // String | + String fieldDataID = "fieldDataID_example"; // String | try { - ApiResponse response = apiInstance.getFieldDataFromIDWithHttpInfo(body); + ApiResponse response = apiInstance.getFieldDataShapeFromIDWithHttpInfo(fieldDataID); System.out.println("Status code: " + response.getStatusCode()); System.out.println("Response headers: " + response.getHeaders()); System.out.println("Response body: " + response.getData()); } catch (ApiException e) { - System.err.println("Exception when calling FieldDataResourceApi#getFieldDataFromID"); + System.err.println("Exception when calling FieldDataResourceApi#getFieldDataShapeFromID"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); System.err.println("Reason: " + e.getResponseBody()); @@ -903,11 +639,11 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| -| **body** | **String**| | [optional] | +| **fieldDataID** | **String**| | | ### Return type -ApiResponse<[**FieldDataInfo**](FieldDataInfo.md)> +ApiResponse<[**FieldDataShape**](FieldDataShape.md)> ### Authorization @@ -916,7 +652,7 @@ No authorization required ### HTTP request headers -- **Content-Type**: text/plain +- **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details diff --git a/vcell-restclient/docs/FieldDataShape.md b/vcell-restclient/docs/FieldDataShape.md new file mode 100644 index 0000000000..84902d0ac1 --- /dev/null +++ b/vcell-restclient/docs/FieldDataShape.md @@ -0,0 +1,17 @@ + + +# FieldDataShape + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**extent** | [**Extent**](Extent.md) | | [optional] | +|**origin** | [**Origin**](Origin.md) | | [optional] | +|**isize** | [**ISize**](ISize.md) | | [optional] | +|**dataIdentifier** | [**List<DataIdentifier>**](DataIdentifier.md) | | [optional] | +|**times** | **List<Double>** | | [optional] | + + + diff --git a/vcell-restclient/docs/ISize.md b/vcell-restclient/docs/ISize.md index a093a715c8..66a2ce5658 100644 --- a/vcell-restclient/docs/ISize.md +++ b/vcell-restclient/docs/ISize.md @@ -10,7 +10,6 @@ |**x** | **Integer** | | [optional] | |**y** | **Integer** | | [optional] | |**z** | **Integer** | | [optional] | -|**xYZ** | **Integer** | | [optional] | diff --git a/vcell-restclient/docs/SimulationResourceApi.md b/vcell-restclient/docs/SimulationResourceApi.md index 934d319186..1b3a3c3c5e 100644 --- a/vcell-restclient/docs/SimulationResourceApi.md +++ b/vcell-restclient/docs/SimulationResourceApi.md @@ -81,8 +81,8 @@ public class Example { | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## getSimulationStatusWithHttpInfo @@ -155,8 +155,8 @@ ApiResponse<[**SimulationStatusPersistentRecord**](SimulationStatusPersistentRec | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## startSimulation @@ -223,8 +223,8 @@ public class Example { | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## startSimulationWithHttpInfo @@ -293,8 +293,8 @@ ApiResponse<[**List<StatusMessage>**](StatusMessage.md)> | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## stopSimulation @@ -361,8 +361,8 @@ public class Example { | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## stopSimulationWithHttpInfo @@ -431,6 +431,6 @@ ApiResponse<[**List<StatusMessage>**](StatusMessage.md)> | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | diff --git a/vcell-restclient/docs/User.md b/vcell-restclient/docs/User.md index 61753d53d1..d8e81ee20d 100644 --- a/vcell-restclient/docs/User.md +++ b/vcell-restclient/docs/User.md @@ -9,7 +9,6 @@ |------------ | ------------- | ------------- | -------------| |**userName** | **String** | | [optional] | |**key** | [**KeyValue**](KeyValue.md) | | [optional] | -|**iD** | [**KeyValue**](KeyValue.md) | | [optional] | |**name** | **String** | | [optional] | |**testAccount** | **Boolean** | | [optional] | diff --git a/vcell-restclient/docs/UsersResourceApi.md b/vcell-restclient/docs/UsersResourceApi.md index d265979677..831c4b98c6 100644 --- a/vcell-restclient/docs/UsersResourceApi.md +++ b/vcell-restclient/docs/UsersResourceApi.md @@ -347,8 +347,8 @@ This endpoint does not need any parameter. | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## getLegacyApiTokenWithHttpInfo @@ -413,8 +413,8 @@ ApiResponse<[**AccesTokenRepresentationRecord**](AccesTokenRepresentationRecord. | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## getMappedUser @@ -477,8 +477,8 @@ This endpoint does not need any parameter. | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | Successful, returning the identity | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## getMappedUserWithHttpInfo @@ -543,8 +543,8 @@ ApiResponse<[**UserIdentityJSONSafe**](UserIdentityJSONSafe.md)> | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | Successful, returning the identity | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## getMe @@ -733,8 +733,8 @@ null (empty response body) |-------------|-------------|------------------| | **200** | Successful, returning the identity | - | | **409** | VCell Identity not mapped, userid already exists | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## mapNewUserWithHttpInfo @@ -803,8 +803,8 @@ ApiResponse |-------------|-------------|------------------| | **200** | Successful, returning the identity | - | | **409** | VCell Identity not mapped, userid already exists | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## mapUser @@ -871,8 +871,8 @@ public class Example { | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## mapUserWithHttpInfo @@ -941,8 +941,8 @@ ApiResponse<**Boolean**> | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## processMagicLink @@ -1141,8 +1141,8 @@ null (empty response body) |-------------|-------------|------------------| | **200** | magic link sent in email if appropriate | - | | **400** | unable to process request | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## requestRecoveryEmailWithHttpInfo @@ -1213,8 +1213,8 @@ ApiResponse |-------------|-------------|------------------| | **200** | magic link sent in email if appropriate | - | | **400** | unable to process request | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## unmapUser @@ -1281,8 +1281,8 @@ public class Example { | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | ## unmapUserWithHttpInfo @@ -1351,6 +1351,6 @@ ApiResponse<**Boolean**> | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | OK | - | -| **403** | Not Allowed | - | | **401** | Not Authorized | - | +| **403** | Not Allowed | - | diff --git a/vcell-restclient/src/main/java/org/vcell/restclient/api/FieldDataResourceApi.java b/vcell-restclient/src/main/java/org/vcell/restclient/api/FieldDataResourceApi.java index 10a6c6b4e5..5ac323fc3b 100644 --- a/vcell-restclient/src/main/java/org/vcell/restclient/api/FieldDataResourceApi.java +++ b/vcell-restclient/src/main/java/org/vcell/restclient/api/FieldDataResourceApi.java @@ -18,13 +18,9 @@ import org.vcell.restclient.Pair; import org.vcell.restclient.model.AnalyzedResultsFromFieldData; -import org.vcell.restclient.model.ExternalDataIdentifier; -import org.vcell.restclient.model.FieldDataDBOperationSpec; -import org.vcell.restclient.model.FieldDataFileOperationSpec; -import org.vcell.restclient.model.FieldDataInfo; -import org.vcell.restclient.model.FieldDataNoCopyConflict; -import org.vcell.restclient.model.FieldDataReferences; +import org.vcell.restclient.model.FieldDataReference; import org.vcell.restclient.model.FieldDataSaveResults; +import org.vcell.restclient.model.FieldDataShape; import java.io.File; import com.fasterxml.jackson.core.type.TypeReference; @@ -96,26 +92,28 @@ private String formatExceptionMessage(String operationId, int statusCode, String } /** - * Copy an existing field data entry. + * Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. * - * @param fieldDataDBOperationSpec (optional) - * @return FieldDataNoCopyConflict + * @param _file (optional) + * @param fileName (optional) + * @return AnalyzedResultsFromFieldData * @throws ApiException if fails to make API call */ - public FieldDataNoCopyConflict copyFieldData(FieldDataDBOperationSpec fieldDataDBOperationSpec) throws ApiException { - ApiResponse localVarResponse = copyFieldDataWithHttpInfo(fieldDataDBOperationSpec); + public AnalyzedResultsFromFieldData analyzeFieldDataFile(File _file, String fileName) throws ApiException { + ApiResponse localVarResponse = analyzeFieldDataFileWithHttpInfo(_file, fileName); return localVarResponse.getData(); } /** - * Copy an existing field data entry. + * Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. * - * @param fieldDataDBOperationSpec (optional) - * @return ApiResponse<FieldDataNoCopyConflict> + * @param _file (optional) + * @param fileName (optional) + * @return ApiResponse<AnalyzedResultsFromFieldData> * @throws ApiException if fails to make API call */ - public ApiResponse copyFieldDataWithHttpInfo(FieldDataDBOperationSpec fieldDataDBOperationSpec) throws ApiException { - HttpRequest.Builder localVarRequestBuilder = copyFieldDataRequestBuilder(fieldDataDBOperationSpec); + public ApiResponse analyzeFieldDataFileWithHttpInfo(File _file, String fileName) throws ApiException { + HttpRequest.Builder localVarRequestBuilder = analyzeFieldDataFileRequestBuilder(_file, fileName); try { HttpResponse localVarResponse = memberVarHttpClient.send( localVarRequestBuilder.build(), @@ -125,12 +123,12 @@ public ApiResponse copyFieldDataWithHttpInfo(FieldDataD } try { if (localVarResponse.statusCode()/ 100 != 2) { - throw getApiException("copyFieldData", localVarResponse); + throw getApiException("analyzeFieldDataFile", localVarResponse); } - return new ApiResponse( + return new ApiResponse( localVarResponse.statusCode(), localVarResponse.headers().map(), - localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream + localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream ); } finally { } @@ -143,23 +141,51 @@ public ApiResponse copyFieldDataWithHttpInfo(FieldDataD } } - private HttpRequest.Builder copyFieldDataRequestBuilder(FieldDataDBOperationSpec fieldDataDBOperationSpec) throws ApiException { + private HttpRequest.Builder analyzeFieldDataFileRequestBuilder(File _file, String fileName) throws ApiException { HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); - String localVarPath = "/api/v1/fieldData/copy"; + String localVarPath = "/api/v1/fieldData/analyzeFieldDataFile"; localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); - localVarRequestBuilder.header("Content-Type", "application/json"); localVarRequestBuilder.header("Accept", "application/json"); - try { - byte[] localVarPostBody = memberVarObjectMapper.writeValueAsBytes(fieldDataDBOperationSpec); - localVarRequestBuilder.method("POST", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody)); - } catch (IOException e) { - throw new ApiException(e); + MultipartEntityBuilder multiPartBuilder = MultipartEntityBuilder.create(); + boolean hasFiles = false; + multiPartBuilder.addBinaryBody("file", _file); + hasFiles = true; + multiPartBuilder.addTextBody("fileName", fileName.toString()); + HttpEntity entity = multiPartBuilder.build(); + HttpRequest.BodyPublisher formDataPublisher; + if (hasFiles) { + Pipe pipe; + try { + pipe = Pipe.open(); + } catch (IOException e) { + throw new RuntimeException(e); + } + new Thread(() -> { + try (OutputStream outputStream = Channels.newOutputStream(pipe.sink())) { + entity.writeTo(outputStream); + } catch (IOException e) { + e.printStackTrace(); + } + }).start(); + formDataPublisher = HttpRequest.BodyPublishers.ofInputStream(() -> Channels.newInputStream(pipe.source())); + } else { + ByteArrayOutputStream formOutputStream = new ByteArrayOutputStream(); + try { + entity.writeTo(formOutputStream); + } catch (IOException e) { + throw new RuntimeException(e); + } + formDataPublisher = HttpRequest.BodyPublishers + .ofInputStream(() -> new ByteArrayInputStream(formOutputStream.toByteArray())); } + localVarRequestBuilder + .header("Content-Type", entity.getContentType().getValue()) + .method("POST", formDataPublisher); if (memberVarReadTimeout != null) { localVarRequestBuilder.timeout(memberVarReadTimeout); } @@ -169,26 +195,26 @@ private HttpRequest.Builder copyFieldDataRequestBuilder(FieldDataDBOperationSpec return localVarRequestBuilder; } /** - * + * Take the analyzed results of the field data, modify it to your liking, then save it on the server. * * @param analyzedResultsFromFieldData (optional) * @return FieldDataSaveResults * @throws ApiException if fails to make API call */ - public FieldDataSaveResults createNewFieldDataFromFileAlreadyAnalyzed(AnalyzedResultsFromFieldData analyzedResultsFromFieldData) throws ApiException { - ApiResponse localVarResponse = createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo(analyzedResultsFromFieldData); + public FieldDataSaveResults createFieldDataFromAnalyzedFile(AnalyzedResultsFromFieldData analyzedResultsFromFieldData) throws ApiException { + ApiResponse localVarResponse = createFieldDataFromAnalyzedFileWithHttpInfo(analyzedResultsFromFieldData); return localVarResponse.getData(); } /** - * + * Take the analyzed results of the field data, modify it to your liking, then save it on the server. * * @param analyzedResultsFromFieldData (optional) * @return ApiResponse<FieldDataSaveResults> * @throws ApiException if fails to make API call */ - public ApiResponse createNewFieldDataFromFileAlreadyAnalyzedWithHttpInfo(AnalyzedResultsFromFieldData analyzedResultsFromFieldData) throws ApiException { - HttpRequest.Builder localVarRequestBuilder = createNewFieldDataFromFileAlreadyAnalyzedRequestBuilder(analyzedResultsFromFieldData); + public ApiResponse createFieldDataFromAnalyzedFileWithHttpInfo(AnalyzedResultsFromFieldData analyzedResultsFromFieldData) throws ApiException { + HttpRequest.Builder localVarRequestBuilder = createFieldDataFromAnalyzedFileRequestBuilder(analyzedResultsFromFieldData); try { HttpResponse localVarResponse = memberVarHttpClient.send( localVarRequestBuilder.build(), @@ -198,7 +224,7 @@ public ApiResponse createNewFieldDataFromFileAlreadyAnalyz } try { if (localVarResponse.statusCode()/ 100 != 2) { - throw getApiException("createNewFieldDataFromFileAlreadyAnalyzed", localVarResponse); + throw getApiException("createFieldDataFromAnalyzedFile", localVarResponse); } return new ApiResponse( localVarResponse.statusCode(), @@ -216,11 +242,11 @@ public ApiResponse createNewFieldDataFromFileAlreadyAnalyz } } - private HttpRequest.Builder createNewFieldDataFromFileAlreadyAnalyzedRequestBuilder(AnalyzedResultsFromFieldData analyzedResultsFromFieldData) throws ApiException { + private HttpRequest.Builder createFieldDataFromAnalyzedFileRequestBuilder(AnalyzedResultsFromFieldData analyzedResultsFromFieldData) throws ApiException { HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); - String localVarPath = "/api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed"; + String localVarPath = "/api/v1/fieldData/createFieldDataFromAnalyzedFile"; localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); @@ -241,98 +267,25 @@ private HttpRequest.Builder createNewFieldDataFromFileAlreadyAnalyzedRequestBuil } return localVarRequestBuilder; } - /** - * Create new field data from a simulation. - * - * @param fieldDataDBOperationSpec (optional) - * @return ExternalDataIdentifier - * @throws ApiException if fails to make API call - */ - public ExternalDataIdentifier createNewFieldDataFromSimulation(FieldDataDBOperationSpec fieldDataDBOperationSpec) throws ApiException { - ApiResponse localVarResponse = createNewFieldDataFromSimulationWithHttpInfo(fieldDataDBOperationSpec); - return localVarResponse.getData(); - } - - /** - * Create new field data from a simulation. - * - * @param fieldDataDBOperationSpec (optional) - * @return ApiResponse<ExternalDataIdentifier> - * @throws ApiException if fails to make API call - */ - public ApiResponse createNewFieldDataFromSimulationWithHttpInfo(FieldDataDBOperationSpec fieldDataDBOperationSpec) throws ApiException { - HttpRequest.Builder localVarRequestBuilder = createNewFieldDataFromSimulationRequestBuilder(fieldDataDBOperationSpec); - try { - HttpResponse localVarResponse = memberVarHttpClient.send( - localVarRequestBuilder.build(), - HttpResponse.BodyHandlers.ofInputStream()); - if (memberVarResponseInterceptor != null) { - memberVarResponseInterceptor.accept(localVarResponse); - } - try { - if (localVarResponse.statusCode()/ 100 != 2) { - throw getApiException("createNewFieldDataFromSimulation", localVarResponse); - } - return new ApiResponse( - localVarResponse.statusCode(), - localVarResponse.headers().map(), - localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream - ); - } finally { - } - } catch (IOException e) { - throw new ApiException(e); - } - catch (InterruptedException e) { - Thread.currentThread().interrupt(); - throw new ApiException(e); - } - } - - private HttpRequest.Builder createNewFieldDataFromSimulationRequestBuilder(FieldDataDBOperationSpec fieldDataDBOperationSpec) throws ApiException { - - HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); - - String localVarPath = "/api/v1/fieldData/createFieldDataFromSimulation"; - - localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); - - localVarRequestBuilder.header("Content-Type", "application/json"); - localVarRequestBuilder.header("Accept", "application/json"); - - try { - byte[] localVarPostBody = memberVarObjectMapper.writeValueAsBytes(fieldDataDBOperationSpec); - localVarRequestBuilder.method("POST", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody)); - } catch (IOException e) { - throw new ApiException(e); - } - if (memberVarReadTimeout != null) { - localVarRequestBuilder.timeout(memberVarReadTimeout); - } - if (memberVarInterceptor != null) { - memberVarInterceptor.accept(localVarRequestBuilder); - } - return localVarRequestBuilder; - } /** * Delete the selected field data. * - * @param body (optional) + * @param fieldDataID (required) * @throws ApiException if fails to make API call */ - public void deleteFieldData(String body) throws ApiException { - deleteFieldDataWithHttpInfo(body); + public void deleteFieldData(String fieldDataID) throws ApiException { + deleteFieldDataWithHttpInfo(fieldDataID); } /** * Delete the selected field data. * - * @param body (optional) + * @param fieldDataID (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call */ - public ApiResponse deleteFieldDataWithHttpInfo(String body) throws ApiException { - HttpRequest.Builder localVarRequestBuilder = deleteFieldDataRequestBuilder(body); + public ApiResponse deleteFieldDataWithHttpInfo(String fieldDataID) throws ApiException { + HttpRequest.Builder localVarRequestBuilder = deleteFieldDataRequestBuilder(fieldDataID); try { HttpResponse localVarResponse = memberVarHttpClient.send( localVarRequestBuilder.build(), @@ -365,121 +318,22 @@ public ApiResponse deleteFieldDataWithHttpInfo(String body) throws ApiExce } } - private HttpRequest.Builder deleteFieldDataRequestBuilder(String body) throws ApiException { - - HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); - - String localVarPath = "/api/v1/fieldData"; - - localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); - - localVarRequestBuilder.header("Content-Type", "text/plain"); - localVarRequestBuilder.header("Accept", "application/json"); - - localVarRequestBuilder.method("DELETE", HttpRequest.BodyPublishers.ofString(body)); - if (memberVarReadTimeout != null) { - localVarRequestBuilder.timeout(memberVarReadTimeout); - } - if (memberVarInterceptor != null) { - memberVarInterceptor.accept(localVarRequestBuilder); + private HttpRequest.Builder deleteFieldDataRequestBuilder(String fieldDataID) throws ApiException { + // verify the required parameter 'fieldDataID' is set + if (fieldDataID == null) { + throw new ApiException(400, "Missing the required parameter 'fieldDataID' when calling deleteFieldData"); } - return localVarRequestBuilder; - } - /** - * - * - * @param _file (optional) - * @param fileName (optional) - * @return FieldDataFileOperationSpec - * @throws ApiException if fails to make API call - */ - public FieldDataFileOperationSpec generateFieldDataEstimate(File _file, String fileName) throws ApiException { - ApiResponse localVarResponse = generateFieldDataEstimateWithHttpInfo(_file, fileName); - return localVarResponse.getData(); - } - - /** - * - * - * @param _file (optional) - * @param fileName (optional) - * @return ApiResponse<FieldDataFileOperationSpec> - * @throws ApiException if fails to make API call - */ - public ApiResponse generateFieldDataEstimateWithHttpInfo(File _file, String fileName) throws ApiException { - HttpRequest.Builder localVarRequestBuilder = generateFieldDataEstimateRequestBuilder(_file, fileName); - try { - HttpResponse localVarResponse = memberVarHttpClient.send( - localVarRequestBuilder.build(), - HttpResponse.BodyHandlers.ofInputStream()); - if (memberVarResponseInterceptor != null) { - memberVarResponseInterceptor.accept(localVarResponse); - } - try { - if (localVarResponse.statusCode()/ 100 != 2) { - throw getApiException("generateFieldDataEstimate", localVarResponse); - } - return new ApiResponse( - localVarResponse.statusCode(), - localVarResponse.headers().map(), - localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream - ); - } finally { - } - } catch (IOException e) { - throw new ApiException(e); - } - catch (InterruptedException e) { - Thread.currentThread().interrupt(); - throw new ApiException(e); - } - } - - private HttpRequest.Builder generateFieldDataEstimateRequestBuilder(File _file, String fileName) throws ApiException { HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); - String localVarPath = "/api/v1/fieldData/analyzeFieldDataFromFile"; + String localVarPath = "/api/v1/fieldData/delete/{fieldDataID}" + .replace("{fieldDataID}", ApiClient.urlEncode(fieldDataID.toString())); localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); localVarRequestBuilder.header("Accept", "application/json"); - MultipartEntityBuilder multiPartBuilder = MultipartEntityBuilder.create(); - boolean hasFiles = false; - multiPartBuilder.addBinaryBody("file", _file); - hasFiles = true; - multiPartBuilder.addTextBody("fileName", fileName.toString()); - HttpEntity entity = multiPartBuilder.build(); - HttpRequest.BodyPublisher formDataPublisher; - if (hasFiles) { - Pipe pipe; - try { - pipe = Pipe.open(); - } catch (IOException e) { - throw new RuntimeException(e); - } - new Thread(() -> { - try (OutputStream outputStream = Channels.newOutputStream(pipe.sink())) { - entity.writeTo(outputStream); - } catch (IOException e) { - e.printStackTrace(); - } - }).start(); - formDataPublisher = HttpRequest.BodyPublishers.ofInputStream(() -> Channels.newInputStream(pipe.source())); - } else { - ByteArrayOutputStream formOutputStream = new ByteArrayOutputStream(); - try { - entity.writeTo(formOutputStream); - } catch (IOException e) { - throw new RuntimeException(e); - } - formDataPublisher = HttpRequest.BodyPublishers - .ofInputStream(() -> new ByteArrayInputStream(formOutputStream.toByteArray())); - } - localVarRequestBuilder - .header("Content-Type", entity.getContentType().getValue()) - .method("POST", formDataPublisher); + localVarRequestBuilder.method("DELETE", HttpRequest.BodyPublishers.noBody()); if (memberVarReadTimeout != null) { localVarRequestBuilder.timeout(memberVarReadTimeout); } @@ -491,21 +345,21 @@ private HttpRequest.Builder generateFieldDataEstimateRequestBuilder(File _file, /** * Get all of the ids used to identify, and retrieve field data. * - * @return FieldDataReferences + * @return List<FieldDataReference> * @throws ApiException if fails to make API call */ - public FieldDataReferences getAllFieldDataIDs() throws ApiException { - ApiResponse localVarResponse = getAllFieldDataIDsWithHttpInfo(); + public List getAllFieldDataIDs() throws ApiException { + ApiResponse> localVarResponse = getAllFieldDataIDsWithHttpInfo(); return localVarResponse.getData(); } /** * Get all of the ids used to identify, and retrieve field data. * - * @return ApiResponse<FieldDataReferences> + * @return ApiResponse<List<FieldDataReference>> * @throws ApiException if fails to make API call */ - public ApiResponse getAllFieldDataIDsWithHttpInfo() throws ApiException { + public ApiResponse> getAllFieldDataIDsWithHttpInfo() throws ApiException { HttpRequest.Builder localVarRequestBuilder = getAllFieldDataIDsRequestBuilder(); try { HttpResponse localVarResponse = memberVarHttpClient.send( @@ -518,10 +372,10 @@ public ApiResponse getAllFieldDataIDsWithHttpInfo() throws if (localVarResponse.statusCode()/ 100 != 2) { throw getApiException("getAllFieldDataIDs", localVarResponse); } - return new ApiResponse( + return new ApiResponse>( localVarResponse.statusCode(), localVarResponse.headers().map(), - localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream + localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference>() {}) // closes the InputStream ); } finally { } @@ -554,26 +408,26 @@ private HttpRequest.Builder getAllFieldDataIDsRequestBuilder() throws ApiExcepti return localVarRequestBuilder; } /** - * Get the field data from the selected field data ID. + * Get the shape of the field data. That is it's size, origin, extent, and data identifiers. * - * @param body (optional) - * @return FieldDataInfo + * @param fieldDataID (required) + * @return FieldDataShape * @throws ApiException if fails to make API call */ - public FieldDataInfo getFieldDataFromID(String body) throws ApiException { - ApiResponse localVarResponse = getFieldDataFromIDWithHttpInfo(body); + public FieldDataShape getFieldDataShapeFromID(String fieldDataID) throws ApiException { + ApiResponse localVarResponse = getFieldDataShapeFromIDWithHttpInfo(fieldDataID); return localVarResponse.getData(); } /** - * Get the field data from the selected field data ID. + * Get the shape of the field data. That is it's size, origin, extent, and data identifiers. * - * @param body (optional) - * @return ApiResponse<FieldDataInfo> + * @param fieldDataID (required) + * @return ApiResponse<FieldDataShape> * @throws ApiException if fails to make API call */ - public ApiResponse getFieldDataFromIDWithHttpInfo(String body) throws ApiException { - HttpRequest.Builder localVarRequestBuilder = getFieldDataFromIDRequestBuilder(body); + public ApiResponse getFieldDataShapeFromIDWithHttpInfo(String fieldDataID) throws ApiException { + HttpRequest.Builder localVarRequestBuilder = getFieldDataShapeFromIDRequestBuilder(fieldDataID); try { HttpResponse localVarResponse = memberVarHttpClient.send( localVarRequestBuilder.build(), @@ -583,12 +437,12 @@ public ApiResponse getFieldDataFromIDWithHttpInfo(String body) th } try { if (localVarResponse.statusCode()/ 100 != 2) { - throw getApiException("getFieldDataFromID", localVarResponse); + throw getApiException("getFieldDataShapeFromID", localVarResponse); } - return new ApiResponse( + return new ApiResponse( localVarResponse.statusCode(), localVarResponse.headers().map(), - localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream + localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream ); } finally { } @@ -601,18 +455,22 @@ public ApiResponse getFieldDataFromIDWithHttpInfo(String body) th } } - private HttpRequest.Builder getFieldDataFromIDRequestBuilder(String body) throws ApiException { + private HttpRequest.Builder getFieldDataShapeFromIDRequestBuilder(String fieldDataID) throws ApiException { + // verify the required parameter 'fieldDataID' is set + if (fieldDataID == null) { + throw new ApiException(400, "Missing the required parameter 'fieldDataID' when calling getFieldDataShapeFromID"); + } HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder(); - String localVarPath = "/api/v1/fieldData"; + String localVarPath = "/api/v1/fieldData/fieldDataShape/{fieldDataID}" + .replace("{fieldDataID}", ApiClient.urlEncode(fieldDataID.toString())); localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath)); - localVarRequestBuilder.header("Content-Type", "text/plain"); localVarRequestBuilder.header("Accept", "application/json"); - localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.ofString(body)); + localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody()); if (memberVarReadTimeout != null) { localVarRequestBuilder.timeout(memberVarReadTimeout); } diff --git a/vcell-restclient/src/main/java/org/vcell/restclient/model/ExternalDataIdentifier.java b/vcell-restclient/src/main/java/org/vcell/restclient/model/ExternalDataIdentifier.java index ffd8f67d9b..55338ca90d 100644 --- a/vcell-restclient/src/main/java/org/vcell/restclient/model/ExternalDataIdentifier.java +++ b/vcell-restclient/src/main/java/org/vcell/restclient/model/ExternalDataIdentifier.java @@ -37,7 +37,6 @@ ExternalDataIdentifier.JSON_PROPERTY_KEY, ExternalDataIdentifier.JSON_PROPERTY_OWNER, ExternalDataIdentifier.JSON_PROPERTY_NAME, - ExternalDataIdentifier.JSON_PROPERTY_I_D, ExternalDataIdentifier.JSON_PROPERTY_JOB_INDEX, ExternalDataIdentifier.JSON_PROPERTY_SIMULATION_KEY, ExternalDataIdentifier.JSON_PROPERTY_PARAMETER_SCAN_TYPE, @@ -54,9 +53,6 @@ public class ExternalDataIdentifier { public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_I_D = "iD"; - private String iD; - public static final String JSON_PROPERTY_JOB_INDEX = "jobIndex"; private Integer jobIndex; @@ -147,31 +143,6 @@ public void setName(String name) { } - public ExternalDataIdentifier iD(String iD) { - this.iD = iD; - return this; - } - - /** - * Get iD - * @return iD - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_I_D) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getiD() { - return iD; - } - - - @JsonProperty(JSON_PROPERTY_I_D) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setiD(String iD) { - this.iD = iD; - } - - public ExternalDataIdentifier jobIndex(Integer jobIndex) { this.jobIndex = jobIndex; return this; @@ -287,7 +258,6 @@ public boolean equals(Object o) { return Objects.equals(this.key, externalDataIdentifier.key) && Objects.equals(this.owner, externalDataIdentifier.owner) && Objects.equals(this.name, externalDataIdentifier.name) && - Objects.equals(this.iD, externalDataIdentifier.iD) && Objects.equals(this.jobIndex, externalDataIdentifier.jobIndex) && Objects.equals(this.simulationKey, externalDataIdentifier.simulationKey) && Objects.equals(this.parameterScanType, externalDataIdentifier.parameterScanType) && @@ -296,7 +266,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(key, owner, name, iD, jobIndex, simulationKey, parameterScanType, dataKey); + return Objects.hash(key, owner, name, jobIndex, simulationKey, parameterScanType, dataKey); } @Override @@ -306,7 +276,6 @@ public String toString() { sb.append(" key: ").append(toIndentedString(key)).append("\n"); sb.append(" owner: ").append(toIndentedString(owner)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" iD: ").append(toIndentedString(iD)).append("\n"); sb.append(" jobIndex: ").append(toIndentedString(jobIndex)).append("\n"); sb.append(" simulationKey: ").append(toIndentedString(simulationKey)).append("\n"); sb.append(" parameterScanType: ").append(toIndentedString(parameterScanType)).append("\n"); @@ -373,11 +342,6 @@ public String toUrlQueryString(String prefix) { joiner.add(String.format("%sname%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getName()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); } - // add `iD` to the URL query string - if (getiD() != null) { - joiner.add(String.format("%siD%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getiD()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); - } - // add `jobIndex` to the URL query string if (getJobIndex() != null) { joiner.add(String.format("%sjobIndex%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getJobIndex()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); diff --git a/vcell-restclient/src/main/java/org/vcell/restclient/model/FieldDataReference.java b/vcell-restclient/src/main/java/org/vcell/restclient/model/FieldDataReference.java new file mode 100644 index 0000000000..930d4275dd --- /dev/null +++ b/vcell-restclient/src/main/java/org/vcell/restclient/model/FieldDataReference.java @@ -0,0 +1,239 @@ +/* + * VCell API + * VCell API + * + * The version of the OpenAPI document: 1.0.1 + * Contact: vcell_support@uchc.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.vcell.restclient.model; + +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.StringJoiner; +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import org.vcell.restclient.model.ExternalDataIdentifier; +import org.vcell.restclient.model.KeyValue; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +/** + * FieldDataReference + */ +@JsonPropertyOrder({ + FieldDataReference.JSON_PROPERTY_EXTERNAL_DATA_IDENTIFIER, + FieldDataReference.JSON_PROPERTY_EXTERNAL_DATA_ANNOTATION, + FieldDataReference.JSON_PROPERTY_EXTERNAL_DATA_I_D_SIM_REF +}) +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") +public class FieldDataReference { + public static final String JSON_PROPERTY_EXTERNAL_DATA_IDENTIFIER = "externalDataIdentifier"; + private ExternalDataIdentifier externalDataIdentifier; + + public static final String JSON_PROPERTY_EXTERNAL_DATA_ANNOTATION = "externalDataAnnotation"; + private String externalDataAnnotation; + + public static final String JSON_PROPERTY_EXTERNAL_DATA_I_D_SIM_REF = "externalDataIDSimRef"; + private List externalDataIDSimRef; + + public FieldDataReference() { + } + + public FieldDataReference externalDataIdentifier(ExternalDataIdentifier externalDataIdentifier) { + this.externalDataIdentifier = externalDataIdentifier; + return this; + } + + /** + * Get externalDataIdentifier + * @return externalDataIdentifier + **/ + @javax.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXTERNAL_DATA_IDENTIFIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public ExternalDataIdentifier getExternalDataIdentifier() { + return externalDataIdentifier; + } + + + @JsonProperty(JSON_PROPERTY_EXTERNAL_DATA_IDENTIFIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExternalDataIdentifier(ExternalDataIdentifier externalDataIdentifier) { + this.externalDataIdentifier = externalDataIdentifier; + } + + + public FieldDataReference externalDataAnnotation(String externalDataAnnotation) { + this.externalDataAnnotation = externalDataAnnotation; + return this; + } + + /** + * Get externalDataAnnotation + * @return externalDataAnnotation + **/ + @javax.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXTERNAL_DATA_ANNOTATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getExternalDataAnnotation() { + return externalDataAnnotation; + } + + + @JsonProperty(JSON_PROPERTY_EXTERNAL_DATA_ANNOTATION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExternalDataAnnotation(String externalDataAnnotation) { + this.externalDataAnnotation = externalDataAnnotation; + } + + + public FieldDataReference externalDataIDSimRef(List externalDataIDSimRef) { + this.externalDataIDSimRef = externalDataIDSimRef; + return this; + } + + public FieldDataReference addExternalDataIDSimRefItem(KeyValue externalDataIDSimRefItem) { + if (this.externalDataIDSimRef == null) { + this.externalDataIDSimRef = new ArrayList<>(); + } + this.externalDataIDSimRef.add(externalDataIDSimRefItem); + return this; + } + + /** + * Get externalDataIDSimRef + * @return externalDataIDSimRef + **/ + @javax.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXTERNAL_DATA_I_D_SIM_REF) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getExternalDataIDSimRef() { + return externalDataIDSimRef; + } + + + @JsonProperty(JSON_PROPERTY_EXTERNAL_DATA_I_D_SIM_REF) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExternalDataIDSimRef(List externalDataIDSimRef) { + this.externalDataIDSimRef = externalDataIDSimRef; + } + + + /** + * Return true if this FieldDataReference object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FieldDataReference fieldDataReference = (FieldDataReference) o; + return Objects.equals(this.externalDataIdentifier, fieldDataReference.externalDataIdentifier) && + Objects.equals(this.externalDataAnnotation, fieldDataReference.externalDataAnnotation) && + Objects.equals(this.externalDataIDSimRef, fieldDataReference.externalDataIDSimRef); + } + + @Override + public int hashCode() { + return Objects.hash(externalDataIdentifier, externalDataAnnotation, externalDataIDSimRef); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FieldDataReference {\n"); + sb.append(" externalDataIdentifier: ").append(toIndentedString(externalDataIdentifier)).append("\n"); + sb.append(" externalDataAnnotation: ").append(toIndentedString(externalDataAnnotation)).append("\n"); + sb.append(" externalDataIDSimRef: ").append(toIndentedString(externalDataIDSimRef)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `externalDataIdentifier` to the URL query string + if (getExternalDataIdentifier() != null) { + joiner.add(getExternalDataIdentifier().toUrlQueryString(prefix + "externalDataIdentifier" + suffix)); + } + + // add `externalDataAnnotation` to the URL query string + if (getExternalDataAnnotation() != null) { + joiner.add(String.format("%sexternalDataAnnotation%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getExternalDataAnnotation()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + } + + // add `externalDataIDSimRef` to the URL query string + if (getExternalDataIDSimRef() != null) { + for (int i = 0; i < getExternalDataIDSimRef().size(); i++) { + if (getExternalDataIDSimRef().get(i) != null) { + joiner.add(getExternalDataIDSimRef().get(i).toUrlQueryString(String.format("%sexternalDataIDSimRef%s%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix)))); + } + } + } + + return joiner.toString(); + } +} + diff --git a/vcell-restclient/src/main/java/org/vcell/restclient/model/FieldDataShape.java b/vcell-restclient/src/main/java/org/vcell/restclient/model/FieldDataShape.java new file mode 100644 index 0000000000..8bbc5717d2 --- /dev/null +++ b/vcell-restclient/src/main/java/org/vcell/restclient/model/FieldDataShape.java @@ -0,0 +1,325 @@ +/* + * VCell API + * VCell API + * + * The version of the OpenAPI document: 1.0.1 + * Contact: vcell_support@uchc.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.vcell.restclient.model; + +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.StringJoiner; +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import org.vcell.restclient.model.DataIdentifier; +import org.vcell.restclient.model.Extent; +import org.vcell.restclient.model.ISize; +import org.vcell.restclient.model.Origin; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +/** + * FieldDataShape + */ +@JsonPropertyOrder({ + FieldDataShape.JSON_PROPERTY_EXTENT, + FieldDataShape.JSON_PROPERTY_ORIGIN, + FieldDataShape.JSON_PROPERTY_ISIZE, + FieldDataShape.JSON_PROPERTY_DATA_IDENTIFIER, + FieldDataShape.JSON_PROPERTY_TIMES +}) +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") +public class FieldDataShape { + public static final String JSON_PROPERTY_EXTENT = "extent"; + private Extent extent; + + public static final String JSON_PROPERTY_ORIGIN = "origin"; + private Origin origin; + + public static final String JSON_PROPERTY_ISIZE = "isize"; + private ISize isize; + + public static final String JSON_PROPERTY_DATA_IDENTIFIER = "dataIdentifier"; + private List dataIdentifier; + + public static final String JSON_PROPERTY_TIMES = "times"; + private List times; + + public FieldDataShape() { + } + + public FieldDataShape extent(Extent extent) { + this.extent = extent; + return this; + } + + /** + * Get extent + * @return extent + **/ + @javax.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Extent getExtent() { + return extent; + } + + + @JsonProperty(JSON_PROPERTY_EXTENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExtent(Extent extent) { + this.extent = extent; + } + + + public FieldDataShape origin(Origin origin) { + this.origin = origin; + return this; + } + + /** + * Get origin + * @return origin + **/ + @javax.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ORIGIN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Origin getOrigin() { + return origin; + } + + + @JsonProperty(JSON_PROPERTY_ORIGIN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setOrigin(Origin origin) { + this.origin = origin; + } + + + public FieldDataShape isize(ISize isize) { + this.isize = isize; + return this; + } + + /** + * Get isize + * @return isize + **/ + @javax.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ISIZE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public ISize getIsize() { + return isize; + } + + + @JsonProperty(JSON_PROPERTY_ISIZE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsize(ISize isize) { + this.isize = isize; + } + + + public FieldDataShape dataIdentifier(List dataIdentifier) { + this.dataIdentifier = dataIdentifier; + return this; + } + + public FieldDataShape addDataIdentifierItem(DataIdentifier dataIdentifierItem) { + if (this.dataIdentifier == null) { + this.dataIdentifier = new ArrayList<>(); + } + this.dataIdentifier.add(dataIdentifierItem); + return this; + } + + /** + * Get dataIdentifier + * @return dataIdentifier + **/ + @javax.annotation.Nullable + @JsonProperty(JSON_PROPERTY_DATA_IDENTIFIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getDataIdentifier() { + return dataIdentifier; + } + + + @JsonProperty(JSON_PROPERTY_DATA_IDENTIFIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDataIdentifier(List dataIdentifier) { + this.dataIdentifier = dataIdentifier; + } + + + public FieldDataShape times(List times) { + this.times = times; + return this; + } + + public FieldDataShape addTimesItem(Double timesItem) { + if (this.times == null) { + this.times = new ArrayList<>(); + } + this.times.add(timesItem); + return this; + } + + /** + * Get times + * @return times + **/ + @javax.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TIMES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getTimes() { + return times; + } + + + @JsonProperty(JSON_PROPERTY_TIMES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTimes(List times) { + this.times = times; + } + + + /** + * Return true if this FieldDataShape object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FieldDataShape fieldDataShape = (FieldDataShape) o; + return Objects.equals(this.extent, fieldDataShape.extent) && + Objects.equals(this.origin, fieldDataShape.origin) && + Objects.equals(this.isize, fieldDataShape.isize) && + Objects.equals(this.dataIdentifier, fieldDataShape.dataIdentifier) && + Objects.equals(this.times, fieldDataShape.times); + } + + @Override + public int hashCode() { + return Objects.hash(extent, origin, isize, dataIdentifier, times); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FieldDataShape {\n"); + sb.append(" extent: ").append(toIndentedString(extent)).append("\n"); + sb.append(" origin: ").append(toIndentedString(origin)).append("\n"); + sb.append(" isize: ").append(toIndentedString(isize)).append("\n"); + sb.append(" dataIdentifier: ").append(toIndentedString(dataIdentifier)).append("\n"); + sb.append(" times: ").append(toIndentedString(times)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `extent` to the URL query string + if (getExtent() != null) { + joiner.add(getExtent().toUrlQueryString(prefix + "extent" + suffix)); + } + + // add `origin` to the URL query string + if (getOrigin() != null) { + joiner.add(getOrigin().toUrlQueryString(prefix + "origin" + suffix)); + } + + // add `isize` to the URL query string + if (getIsize() != null) { + joiner.add(getIsize().toUrlQueryString(prefix + "isize" + suffix)); + } + + // add `dataIdentifier` to the URL query string + if (getDataIdentifier() != null) { + for (int i = 0; i < getDataIdentifier().size(); i++) { + if (getDataIdentifier().get(i) != null) { + joiner.add(getDataIdentifier().get(i).toUrlQueryString(String.format("%sdataIdentifier%s%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix)))); + } + } + } + + // add `times` to the URL query string + if (getTimes() != null) { + for (int i = 0; i < getTimes().size(); i++) { + joiner.add(String.format("%stimes%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf(getTimes().get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + } + } + + return joiner.toString(); + } +} + diff --git a/vcell-restclient/src/main/java/org/vcell/restclient/model/ISize.java b/vcell-restclient/src/main/java/org/vcell/restclient/model/ISize.java index 806648c19f..cd299e8791 100644 --- a/vcell-restclient/src/main/java/org/vcell/restclient/model/ISize.java +++ b/vcell-restclient/src/main/java/org/vcell/restclient/model/ISize.java @@ -34,8 +34,7 @@ @JsonPropertyOrder({ ISize.JSON_PROPERTY_X, ISize.JSON_PROPERTY_Y, - ISize.JSON_PROPERTY_Z, - ISize.JSON_PROPERTY_X_Y_Z + ISize.JSON_PROPERTY_Z }) @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") public class ISize { @@ -48,9 +47,6 @@ public class ISize { public static final String JSON_PROPERTY_Z = "z"; private Integer z; - public static final String JSON_PROPERTY_X_Y_Z = "xYZ"; - private Integer xYZ; - public ISize() { } @@ -129,31 +125,6 @@ public void setZ(Integer z) { } - public ISize xYZ(Integer xYZ) { - this.xYZ = xYZ; - return this; - } - - /** - * Get xYZ - * @return xYZ - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_X_Y_Z) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getxYZ() { - return xYZ; - } - - - @JsonProperty(JSON_PROPERTY_X_Y_Z) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setxYZ(Integer xYZ) { - this.xYZ = xYZ; - } - - /** * Return true if this ISize object is equal to o. */ @@ -168,13 +139,12 @@ public boolean equals(Object o) { ISize isize = (ISize) o; return Objects.equals(this.x, isize.x) && Objects.equals(this.y, isize.y) && - Objects.equals(this.z, isize.z) && - Objects.equals(this.xYZ, isize.xYZ); + Objects.equals(this.z, isize.z); } @Override public int hashCode() { - return Objects.hash(x, y, z, xYZ); + return Objects.hash(x, y, z); } @Override @@ -184,7 +154,6 @@ public String toString() { sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" z: ").append(toIndentedString(z)).append("\n"); - sb.append(" xYZ: ").append(toIndentedString(xYZ)).append("\n"); sb.append("}"); return sb.toString(); } @@ -247,11 +216,6 @@ public String toUrlQueryString(String prefix) { joiner.add(String.format("%sz%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getZ()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); } - // add `xYZ` to the URL query string - if (getxYZ() != null) { - joiner.add(String.format("%sxYZ%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getxYZ()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); - } - return joiner.toString(); } } diff --git a/vcell-restclient/src/main/java/org/vcell/restclient/model/User.java b/vcell-restclient/src/main/java/org/vcell/restclient/model/User.java index 7b5db562a7..117c14584b 100644 --- a/vcell-restclient/src/main/java/org/vcell/restclient/model/User.java +++ b/vcell-restclient/src/main/java/org/vcell/restclient/model/User.java @@ -35,7 +35,6 @@ @JsonPropertyOrder({ User.JSON_PROPERTY_USER_NAME, User.JSON_PROPERTY_KEY, - User.JSON_PROPERTY_I_D, User.JSON_PROPERTY_NAME, User.JSON_PROPERTY_TEST_ACCOUNT }) @@ -47,9 +46,6 @@ public class User { public static final String JSON_PROPERTY_KEY = "key"; private KeyValue key; - public static final String JSON_PROPERTY_I_D = "iD"; - private KeyValue iD; - public static final String JSON_PROPERTY_NAME = "name"; private String name; @@ -109,31 +105,6 @@ public void setKey(KeyValue key) { } - public User iD(KeyValue iD) { - this.iD = iD; - return this; - } - - /** - * Get iD - * @return iD - **/ - @javax.annotation.Nullable - @JsonProperty(JSON_PROPERTY_I_D) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public KeyValue getiD() { - return iD; - } - - - @JsonProperty(JSON_PROPERTY_I_D) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setiD(KeyValue iD) { - this.iD = iD; - } - - public User name(String name) { this.name = name; return this; @@ -198,14 +169,13 @@ public boolean equals(Object o) { User user = (User) o; return Objects.equals(this.userName, user.userName) && Objects.equals(this.key, user.key) && - Objects.equals(this.iD, user.iD) && Objects.equals(this.name, user.name) && Objects.equals(this.testAccount, user.testAccount); } @Override public int hashCode() { - return Objects.hash(userName, key, iD, name, testAccount); + return Objects.hash(userName, key, name, testAccount); } @Override @@ -214,7 +184,6 @@ public String toString() { sb.append("class User {\n"); sb.append(" userName: ").append(toIndentedString(userName)).append("\n"); sb.append(" key: ").append(toIndentedString(key)).append("\n"); - sb.append(" iD: ").append(toIndentedString(iD)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" testAccount: ").append(toIndentedString(testAccount)).append("\n"); sb.append("}"); @@ -274,11 +243,6 @@ public String toUrlQueryString(String prefix) { joiner.add(getKey().toUrlQueryString(prefix + "key" + suffix)); } - // add `iD` to the URL query string - if (getiD() != null) { - joiner.add(getiD().toUrlQueryString(prefix + "iD" + suffix)); - } - // add `name` to the URL query string if (getName() != null) { joiner.add(String.format("%sname%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getName()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); diff --git a/vcell-restclient/src/test/java/org/vcell/restclient/api/FieldDataResourceApiTest.java b/vcell-restclient/src/test/java/org/vcell/restclient/api/FieldDataResourceApiTest.java index b041d8312d..eeded53913 100644 --- a/vcell-restclient/src/test/java/org/vcell/restclient/api/FieldDataResourceApiTest.java +++ b/vcell-restclient/src/test/java/org/vcell/restclient/api/FieldDataResourceApiTest.java @@ -15,12 +15,9 @@ import org.vcell.restclient.ApiException; import org.vcell.restclient.model.AnalyzedResultsFromFieldData; -import org.vcell.restclient.model.ExternalDataIdentifier; -import org.vcell.restclient.model.FieldDataDBOperationSpec; -import org.vcell.restclient.model.FieldDataFileOperationSpec; -import org.vcell.restclient.model.FieldDataNoCopyConflict; -import org.vcell.restclient.model.FieldDataReferences; +import org.vcell.restclient.model.FieldDataReference; import org.vcell.restclient.model.FieldDataSaveResults; +import org.vcell.restclient.model.FieldDataShape; import java.io.File; import org.junit.Test; import org.junit.Ignore; @@ -42,7 +39,7 @@ public class FieldDataResourceApiTest { /** - * Copy an existing field data entry. + * Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. * * * @@ -50,16 +47,17 @@ public class FieldDataResourceApiTest { * if the Api call fails */ @Test - public void copyFieldDataTest() throws ApiException { - FieldDataDBOperationSpec fieldDataDBOperationSpec = null; - FieldDataNoCopyConflict response = - api.copyFieldData(fieldDataDBOperationSpec); + public void analyzeFieldDataFileTest() throws ApiException { + File _file = null; + String fileName = null; + AnalyzedResultsFromFieldData response = + api.analyzeFieldDataFile(_file, fileName); // TODO: test validations } /** - * + * Take the analyzed results of the field data, modify it to your liking, then save it on the server. * * * @@ -67,27 +65,10 @@ public void copyFieldDataTest() throws ApiException { * if the Api call fails */ @Test - public void createNewFieldDataFromFileAlreadyAnalyzedTest() throws ApiException { + public void createFieldDataFromAnalyzedFileTest() throws ApiException { AnalyzedResultsFromFieldData analyzedResultsFromFieldData = null; FieldDataSaveResults response = - api.createNewFieldDataFromFileAlreadyAnalyzed(analyzedResultsFromFieldData); - - // TODO: test validations - } - - /** - * Create new field data from a simulation. - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createNewFieldDataFromSimulationTest() throws ApiException { - FieldDataDBOperationSpec fieldDataDBOperationSpec = null; - ExternalDataIdentifier response = - api.createNewFieldDataFromSimulation(fieldDataDBOperationSpec); + api.createFieldDataFromAnalyzedFile(analyzedResultsFromFieldData); // TODO: test validations } @@ -102,15 +83,15 @@ public void createNewFieldDataFromSimulationTest() throws ApiException { */ @Test public void deleteFieldDataTest() throws ApiException { - String body = null; + String fieldDataID = null; - api.deleteFieldData(body); + api.deleteFieldData(fieldDataID); // TODO: test validations } /** - * + * Get all of the ids used to identify, and retrieve field data. * * * @@ -118,17 +99,15 @@ public void deleteFieldDataTest() throws ApiException { * if the Api call fails */ @Test - public void generateFieldDataEstimateTest() throws ApiException { - File _file = null; - String fileName = null; - FieldDataFileOperationSpec response = - api.generateFieldDataEstimate(_file, fileName); + public void getAllFieldDataIDsTest() throws ApiException { + List response = + api.getAllFieldDataIDs(); // TODO: test validations } /** - * Get all of the ids used to identify, and retrieve field data. + * Get the shape of the field data. That is it's size, origin, extent, and data identifiers. * * * @@ -136,9 +115,10 @@ public void generateFieldDataEstimateTest() throws ApiException { * if the Api call fails */ @Test - public void getAllFieldDataIDsTest() throws ApiException { - FieldDataReferences response = - api.getAllFieldDataIDs(); + public void getFieldDataShapeFromIDTest() throws ApiException { + String fieldDataID = null; + FieldDataShape response = + api.getFieldDataShapeFromID(fieldDataID); // TODO: test validations } diff --git a/vcell-restclient/src/test/java/org/vcell/restclient/model/FieldDataReferenceTest.java b/vcell-restclient/src/test/java/org/vcell/restclient/model/FieldDataReferenceTest.java new file mode 100644 index 0000000000..42f1f106e9 --- /dev/null +++ b/vcell-restclient/src/test/java/org/vcell/restclient/model/FieldDataReferenceTest.java @@ -0,0 +1,68 @@ +/* + * VCell API + * VCell API + * + * The version of the OpenAPI document: 1.0.1 + * Contact: vcell_support@uchc.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.vcell.restclient.model; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import org.vcell.restclient.model.ExternalDataIdentifier; +import org.vcell.restclient.model.KeyValue; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + +/** + * Model tests for FieldDataReference + */ +public class FieldDataReferenceTest { + private final FieldDataReference model = new FieldDataReference(); + + /** + * Model tests for FieldDataReference + */ + @Test + public void testFieldDataReference() { + // TODO: test FieldDataReference + } + + /** + * Test the property 'externalDataIdentifier' + */ + @Test + public void externalDataIdentifierTest() { + // TODO: test externalDataIdentifier + } + + /** + * Test the property 'externalDataAnnotation' + */ + @Test + public void externalDataAnnotationTest() { + // TODO: test externalDataAnnotation + } + + /** + * Test the property 'externalDataIDSimRef' + */ + @Test + public void externalDataIDSimRefTest() { + // TODO: test externalDataIDSimRef + } + +} diff --git a/vcell-restclient/src/test/java/org/vcell/restclient/model/FieldDataShapeTest.java b/vcell-restclient/src/test/java/org/vcell/restclient/model/FieldDataShapeTest.java new file mode 100644 index 0000000000..576de83e27 --- /dev/null +++ b/vcell-restclient/src/test/java/org/vcell/restclient/model/FieldDataShapeTest.java @@ -0,0 +1,86 @@ +/* + * VCell API + * VCell API + * + * The version of the OpenAPI document: 1.0.1 + * Contact: vcell_support@uchc.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package org.vcell.restclient.model; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import org.vcell.restclient.model.DataIdentifier; +import org.vcell.restclient.model.Extent; +import org.vcell.restclient.model.ISize; +import org.vcell.restclient.model.Origin; +import org.junit.Assert; +import org.junit.Ignore; +import org.junit.Test; + +/** + * Model tests for FieldDataShape + */ +public class FieldDataShapeTest { + private final FieldDataShape model = new FieldDataShape(); + + /** + * Model tests for FieldDataShape + */ + @Test + public void testFieldDataShape() { + // TODO: test FieldDataShape + } + + /** + * Test the property 'extent' + */ + @Test + public void extentTest() { + // TODO: test extent + } + + /** + * Test the property 'origin' + */ + @Test + public void originTest() { + // TODO: test origin + } + + /** + * Test the property 'isize' + */ + @Test + public void isizeTest() { + // TODO: test isize + } + + /** + * Test the property 'dataIdentifier' + */ + @Test + public void dataIdentifierTest() { + // TODO: test dataIdentifier + } + + /** + * Test the property 'times' + */ + @Test + public void timesTest() { + // TODO: test times + } + +} diff --git a/webapp-ng/src/app/core/modules/openapi/.openapi-generator/FILES b/webapp-ng/src/app/core/modules/openapi/.openapi-generator/FILES index 0411468fd2..a9995085f5 100644 --- a/webapp-ng/src/app/core/modules/openapi/.openapi-generator/FILES +++ b/webapp-ng/src/app/core/modules/openapi/.openapi-generator/FILES @@ -25,20 +25,14 @@ model/analyzed-results-from-field-data.ts model/batch-system-type.ts model/bio-model.ts model/biomodel-ref.ts -model/cartesian-mesh.ts -model/coordinate.ts model/data-identifier.ts model/detailed-state.ts model/domain.ts model/extent.ts model/external-data-identifier.ts -model/field-data-db-operation-spec.ts -model/field-data-file-operation-spec.ts -model/field-data-info.ts -model/field-data-no-copy-conflict.ts -model/field-data-references.ts +model/field-data-reference.ts model/field-data-save-results.ts -model/group-access.ts +model/field-data-shape.ts model/hello-world-message.ts model/htc-job-id.ts model/i-size.ts @@ -57,7 +51,6 @@ model/simulation-queue-id.ts model/simulation-status-persistent-record.ts model/status-message.ts model/status.ts -model/ucd-info.ts model/user-identity-json-safe.ts model/user-login-info-for-mapping.ts model/user-registration-info.ts @@ -65,9 +58,5 @@ model/user.ts model/variable-domain.ts model/variable-type.ts model/vc-simulation-identifier.ts -model/version-flag.ts -model/version.ts -model/versionable-type-version.ts -model/versionable-type.ts param.ts variables.ts diff --git a/webapp-ng/src/app/core/modules/openapi/api/field-data-resource.service.ts b/webapp-ng/src/app/core/modules/openapi/api/field-data-resource.service.ts index 86a4ee3c99..d949fe63ce 100644 --- a/webapp-ng/src/app/core/modules/openapi/api/field-data-resource.service.ts +++ b/webapp-ng/src/app/core/modules/openapi/api/field-data-resource.service.ts @@ -21,19 +21,11 @@ import { Observable } from 'rxjs'; // @ts-ignore import { AnalyzedResultsFromFieldData } from '../model/analyzed-results-from-field-data'; // @ts-ignore -import { ExternalDataIdentifier } from '../model/external-data-identifier'; -// @ts-ignore -import { FieldDataDBOperationSpec } from '../model/field-data-db-operation-spec'; -// @ts-ignore -import { FieldDataFileOperationSpec } from '../model/field-data-file-operation-spec'; -// @ts-ignore -import { FieldDataInfo } from '../model/field-data-info'; -// @ts-ignore -import { FieldDataNoCopyConflict } from '../model/field-data-no-copy-conflict'; -// @ts-ignore -import { FieldDataReferences } from '../model/field-data-references'; +import { FieldDataReference } from '../model/field-data-reference'; // @ts-ignore import { FieldDataSaveResults } from '../model/field-data-save-results'; +// @ts-ignore +import { FieldDataShape } from '../model/field-data-shape'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS } from '../variables'; @@ -122,15 +114,16 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } /** - * Copy an existing field data entry. - * @param fieldDataDBOperationSpec + * Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. + * @param file + * @param fileName * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ - public copyFieldData(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; - public copyFieldData(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public copyFieldData(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public copyFieldData(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { + public analyzeFieldDataFile(file?: Blob, fileName?: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; + public analyzeFieldDataFile(file?: Blob, fileName?: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; + public analyzeFieldDataFile(file?: Blob, fileName?: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; + public analyzeFieldDataFile(file?: Blob, fileName?: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { let localVarHeaders = this.defaultHeaders; @@ -151,78 +144,30 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa localVarHttpContext = new HttpContext(); } - // to determine the Content-Type header const consumes: string[] = [ - 'application/json' + 'multipart/form-data' ]; - const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes); - if (httpContentTypeSelected !== undefined) { - localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected); - } - let responseType_: 'text' | 'json' | 'blob' = 'json'; - if (localVarHttpHeaderAcceptSelected) { - if (localVarHttpHeaderAcceptSelected.startsWith('text')) { - responseType_ = 'text'; - } else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) { - responseType_ = 'json'; - } else { - responseType_ = 'blob'; - } - } - - let localVarPath = `/api/v1/fieldData/copy`; - return this.httpClient.request('post', `${this.configuration.basePath}${localVarPath}`, - { - context: localVarHttpContext, - body: fieldDataDBOperationSpec, - responseType: responseType_, - withCredentials: this.configuration.withCredentials, - headers: localVarHeaders, - observe: observe, - reportProgress: reportProgress - } - ); - } - - /** - * @param analyzedResultsFromFieldData - * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. - * @param reportProgress flag to report request and response progress. - */ - public createNewFieldDataFromFileAlreadyAnalyzed(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; - public createNewFieldDataFromFileAlreadyAnalyzed(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public createNewFieldDataFromFileAlreadyAnalyzed(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public createNewFieldDataFromFileAlreadyAnalyzed(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { - - let localVarHeaders = this.defaultHeaders; + const canConsumeForm = this.canConsumeForm(consumes); - let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept; - if (localVarHttpHeaderAcceptSelected === undefined) { - // to determine the Accept header - const httpHeaderAccepts: string[] = [ - 'application/json' - ]; - localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts); - } - if (localVarHttpHeaderAcceptSelected !== undefined) { - localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected); + let localVarFormParams: { append(param: string, value: any): any; }; + let localVarUseForm = false; + let localVarConvertFormParamsToString = false; + // use FormData to transmit files using content-type "multipart/form-data" + // see https://stackoverflow.com/questions/4007969/application-x-www-form-urlencoded-or-multipart-form-data + localVarUseForm = canConsumeForm; + if (localVarUseForm) { + localVarFormParams = new FormData(); + } else { + localVarFormParams = new HttpParams({encoder: this.encoder}); } - let localVarHttpContext: HttpContext | undefined = options && options.context; - if (localVarHttpContext === undefined) { - localVarHttpContext = new HttpContext(); + if (file !== undefined) { + localVarFormParams = localVarFormParams.append('file', file) as any || localVarFormParams; } - - - // to determine the Content-Type header - const consumes: string[] = [ - 'application/json' - ]; - const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes); - if (httpContentTypeSelected !== undefined) { - localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected); + if (fileName !== undefined) { + localVarFormParams = localVarFormParams.append('fileName', fileName) as any || localVarFormParams; } let responseType_: 'text' | 'json' | 'blob' = 'json'; @@ -236,11 +181,11 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } } - let localVarPath = `/api/v1/fieldData/createFieldDataFromFileAlreadyAnalyzed`; - return this.httpClient.request('post', `${this.configuration.basePath}${localVarPath}`, + let localVarPath = `/api/v1/fieldData/analyzeFieldDataFile`; + return this.httpClient.request('post', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, - body: analyzedResultsFromFieldData, + body: localVarConvertFormParamsToString ? localVarFormParams.toString() : localVarFormParams, responseType: responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, @@ -251,15 +196,15 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } /** - * Create new field data from a simulation. - * @param fieldDataDBOperationSpec + * Take the analyzed results of the field data, modify it to your liking, then save it on the server. + * @param analyzedResultsFromFieldData * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ - public createNewFieldDataFromSimulation(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; - public createNewFieldDataFromSimulation(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public createNewFieldDataFromSimulation(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public createNewFieldDataFromSimulation(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { + public createFieldDataFromAnalyzedFile(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; + public createFieldDataFromAnalyzedFile(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; + public createFieldDataFromAnalyzedFile(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; + public createFieldDataFromAnalyzedFile(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { let localVarHeaders = this.defaultHeaders; @@ -301,11 +246,11 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } } - let localVarPath = `/api/v1/fieldData/createFieldDataFromSimulation`; - return this.httpClient.request('post', `${this.configuration.basePath}${localVarPath}`, + let localVarPath = `/api/v1/fieldData/createFieldDataFromAnalyzedFile`; + return this.httpClient.request('post', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, - body: fieldDataDBOperationSpec, + body: analyzedResultsFromFieldData, responseType: responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, @@ -317,86 +262,24 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa /** * Delete the selected field data. - * @param body + * @param fieldDataID * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ - public deleteFieldData(body?: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: undefined, context?: HttpContext}): Observable; - public deleteFieldData(body?: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: undefined, context?: HttpContext}): Observable>; - public deleteFieldData(body?: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: undefined, context?: HttpContext}): Observable>; - public deleteFieldData(body?: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: undefined, context?: HttpContext}): Observable { - - let localVarHeaders = this.defaultHeaders; - - let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept; - if (localVarHttpHeaderAcceptSelected === undefined) { - // to determine the Accept header - const httpHeaderAccepts: string[] = [ - ]; - localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts); - } - if (localVarHttpHeaderAcceptSelected !== undefined) { - localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected); - } - - let localVarHttpContext: HttpContext | undefined = options && options.context; - if (localVarHttpContext === undefined) { - localVarHttpContext = new HttpContext(); - } - - - // to determine the Content-Type header - const consumes: string[] = [ - 'text/plain' - ]; - const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes); - if (httpContentTypeSelected !== undefined) { - localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected); + public deleteFieldData(fieldDataID: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: undefined, context?: HttpContext}): Observable; + public deleteFieldData(fieldDataID: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: undefined, context?: HttpContext}): Observable>; + public deleteFieldData(fieldDataID: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: undefined, context?: HttpContext}): Observable>; + public deleteFieldData(fieldDataID: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: undefined, context?: HttpContext}): Observable { + if (fieldDataID === null || fieldDataID === undefined) { + throw new Error('Required parameter fieldDataID was null or undefined when calling deleteFieldData.'); } - let responseType_: 'text' | 'json' | 'blob' = 'json'; - if (localVarHttpHeaderAcceptSelected) { - if (localVarHttpHeaderAcceptSelected.startsWith('text')) { - responseType_ = 'text'; - } else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) { - responseType_ = 'json'; - } else { - responseType_ = 'blob'; - } - } - - let localVarPath = `/api/v1/fieldData`; - return this.httpClient.request('delete', `${this.configuration.basePath}${localVarPath}`, - { - context: localVarHttpContext, - body: body, - responseType: responseType_, - withCredentials: this.configuration.withCredentials, - headers: localVarHeaders, - observe: observe, - reportProgress: reportProgress - } - ); - } - - /** - * @param file - * @param fileName - * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. - * @param reportProgress flag to report request and response progress. - */ - public generateFieldDataEstimate(file?: Blob, fileName?: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; - public generateFieldDataEstimate(file?: Blob, fileName?: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public generateFieldDataEstimate(file?: Blob, fileName?: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public generateFieldDataEstimate(file?: Blob, fileName?: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { - let localVarHeaders = this.defaultHeaders; let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept; if (localVarHttpHeaderAcceptSelected === undefined) { // to determine the Accept header const httpHeaderAccepts: string[] = [ - 'application/json' ]; localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts); } @@ -409,31 +292,6 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa localVarHttpContext = new HttpContext(); } - // to determine the Content-Type header - const consumes: string[] = [ - 'multipart/form-data' - ]; - - const canConsumeForm = this.canConsumeForm(consumes); - - let localVarFormParams: { append(param: string, value: any): any; }; - let localVarUseForm = false; - let localVarConvertFormParamsToString = false; - // use FormData to transmit files using content-type "multipart/form-data" - // see https://stackoverflow.com/questions/4007969/application-x-www-form-urlencoded-or-multipart-form-data - localVarUseForm = canConsumeForm; - if (localVarUseForm) { - localVarFormParams = new FormData(); - } else { - localVarFormParams = new HttpParams({encoder: this.encoder}); - } - - if (file !== undefined) { - localVarFormParams = localVarFormParams.append('file', file) as any || localVarFormParams; - } - if (fileName !== undefined) { - localVarFormParams = localVarFormParams.append('fileName', fileName) as any || localVarFormParams; - } let responseType_: 'text' | 'json' | 'blob' = 'json'; if (localVarHttpHeaderAcceptSelected) { @@ -446,11 +304,10 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } } - let localVarPath = `/api/v1/fieldData/analyzeFieldDataFromFile`; - return this.httpClient.request('post', `${this.configuration.basePath}${localVarPath}`, + let localVarPath = `/api/v1/fieldData/delete/${this.configuration.encodeParam({name: "fieldDataID", value: fieldDataID, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}`; + return this.httpClient.request('delete', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, - body: localVarConvertFormParamsToString ? localVarFormParams.toString() : localVarFormParams, responseType: responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, @@ -465,9 +322,9 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ - public getAllFieldDataIDs(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; - public getAllFieldDataIDs(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public getAllFieldDataIDs(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; + public getAllFieldDataIDs(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; + public getAllFieldDataIDs(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>>; + public getAllFieldDataIDs(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>>; public getAllFieldDataIDs(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { let localVarHeaders = this.defaultHeaders; @@ -502,7 +359,7 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } let localVarPath = `/api/v1/fieldData/IDs`; - return this.httpClient.request('get', `${this.configuration.basePath}${localVarPath}`, + return this.httpClient.request>('get', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, responseType: responseType_, @@ -515,15 +372,18 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } /** - * Get the field data from the selected field data ID. - * @param body + * Get the shape of the field data. That is it\'s size, origin, extent, and data identifiers. + * @param fieldDataID * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ - public getFieldDataFromID(body?: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; - public getFieldDataFromID(body?: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public getFieldDataFromID(body?: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; - public getFieldDataFromID(body?: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { + public getFieldDataShapeFromID(fieldDataID: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable; + public getFieldDataShapeFromID(fieldDataID: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; + public getFieldDataShapeFromID(fieldDataID: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable>; + public getFieldDataShapeFromID(fieldDataID: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext}): Observable { + if (fieldDataID === null || fieldDataID === undefined) { + throw new Error('Required parameter fieldDataID was null or undefined when calling getFieldDataShapeFromID.'); + } let localVarHeaders = this.defaultHeaders; @@ -545,15 +405,6 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } - // to determine the Content-Type header - const consumes: string[] = [ - 'text/plain' - ]; - const httpContentTypeSelected: string | undefined = this.configuration.selectHeaderContentType(consumes); - if (httpContentTypeSelected !== undefined) { - localVarHeaders = localVarHeaders.set('Content-Type', httpContentTypeSelected); - } - let responseType_: 'text' | 'json' | 'blob' = 'json'; if (localVarHttpHeaderAcceptSelected) { if (localVarHttpHeaderAcceptSelected.startsWith('text')) { @@ -565,11 +416,10 @@ export class FieldDataResourceService implements FieldDataResourceServiceInterfa } } - let localVarPath = `/api/v1/fieldData`; - return this.httpClient.request('get', `${this.configuration.basePath}${localVarPath}`, + let localVarPath = `/api/v1/fieldData/fieldDataShape/${this.configuration.encodeParam({name: "fieldDataID", value: fieldDataID, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}`; + return this.httpClient.request('get', `${this.configuration.basePath}${localVarPath}`, { context: localVarHttpContext, - body: body, responseType: responseType_, withCredentials: this.configuration.withCredentials, headers: localVarHeaders, diff --git a/webapp-ng/src/app/core/modules/openapi/api/field-data-resource.serviceInterface.ts b/webapp-ng/src/app/core/modules/openapi/api/field-data-resource.serviceInterface.ts index 10e8d4734c..b613b85b23 100644 --- a/webapp-ng/src/app/core/modules/openapi/api/field-data-resource.serviceInterface.ts +++ b/webapp-ng/src/app/core/modules/openapi/api/field-data-resource.serviceInterface.ts @@ -14,13 +14,9 @@ import { HttpHeaders } from '@angular/comm import { Observable } from 'rxjs'; import { AnalyzedResultsFromFieldData } from '../model/models'; -import { ExternalDataIdentifier } from '../model/models'; -import { FieldDataDBOperationSpec } from '../model/models'; -import { FieldDataFileOperationSpec } from '../model/models'; -import { FieldDataInfo } from '../model/models'; -import { FieldDataNoCopyConflict } from '../model/models'; -import { FieldDataReferences } from '../model/models'; +import { FieldDataReference } from '../model/models'; import { FieldDataSaveResults } from '../model/models'; +import { FieldDataShape } from '../model/models'; import { Configuration } from '../configuration'; @@ -32,52 +28,38 @@ export interface FieldDataResourceServiceInterface { configuration: Configuration; /** - * Copy an existing field data entry. + * Analyze the field data from the uploaded file. Filenames must be lowercase alphanumeric, and can contain underscores. * - * @param fieldDataDBOperationSpec + * @param file + * @param fileName */ - copyFieldData(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, extraHttpRequestParams?: any): Observable; + analyzeFieldDataFile(file?: Blob, fileName?: string, extraHttpRequestParams?: any): Observable; /** - * + * Take the analyzed results of the field data, modify it to your liking, then save it on the server. * * @param analyzedResultsFromFieldData */ - createNewFieldDataFromFileAlreadyAnalyzed(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, extraHttpRequestParams?: any): Observable; - - /** - * Create new field data from a simulation. - * - * @param fieldDataDBOperationSpec - */ - createNewFieldDataFromSimulation(fieldDataDBOperationSpec?: FieldDataDBOperationSpec, extraHttpRequestParams?: any): Observable; + createFieldDataFromAnalyzedFile(analyzedResultsFromFieldData?: AnalyzedResultsFromFieldData, extraHttpRequestParams?: any): Observable; /** * Delete the selected field data. * - * @param body - */ - deleteFieldData(body?: string, extraHttpRequestParams?: any): Observable<{}>; - - /** - * - * - * @param file - * @param fileName + * @param fieldDataID */ - generateFieldDataEstimate(file?: Blob, fileName?: string, extraHttpRequestParams?: any): Observable; + deleteFieldData(fieldDataID: string, extraHttpRequestParams?: any): Observable<{}>; /** * Get all of the ids used to identify, and retrieve field data. * */ - getAllFieldDataIDs(extraHttpRequestParams?: any): Observable; + getAllFieldDataIDs(extraHttpRequestParams?: any): Observable>; /** - * Get the field data from the selected field data ID. + * Get the shape of the field data. That is it\'s size, origin, extent, and data identifiers. * - * @param body + * @param fieldDataID */ - getFieldDataFromID(body?: string, extraHttpRequestParams?: any): Observable; + getFieldDataShapeFromID(fieldDataID: string, extraHttpRequestParams?: any): Observable; } diff --git a/webapp-ng/src/app/core/modules/openapi/model/external-data-identifier.ts b/webapp-ng/src/app/core/modules/openapi/model/external-data-identifier.ts index bef0813fee..8cc2e19db5 100644 --- a/webapp-ng/src/app/core/modules/openapi/model/external-data-identifier.ts +++ b/webapp-ng/src/app/core/modules/openapi/model/external-data-identifier.ts @@ -17,7 +17,6 @@ export interface ExternalDataIdentifier { key?: KeyValue; owner?: User; name?: string; - iD?: string; jobIndex?: number; simulationKey?: KeyValue; parameterScanType?: boolean; diff --git a/webapp-ng/src/app/core/modules/openapi/model/field-data-reference.ts b/webapp-ng/src/app/core/modules/openapi/model/field-data-reference.ts new file mode 100644 index 0000000000..a761f15713 --- /dev/null +++ b/webapp-ng/src/app/core/modules/openapi/model/field-data-reference.ts @@ -0,0 +1,21 @@ +/** + * VCell API + * VCell API + * + * The version of the OpenAPI document: 1.0.1 + * Contact: vcell_support@uchc.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +import { KeyValue } from './key-value'; +import { ExternalDataIdentifier } from './external-data-identifier'; + + +export interface FieldDataReference { + externalDataIdentifier?: ExternalDataIdentifier; + externalDataAnnotation?: string; + externalDataIDSimRef?: Array; +} + diff --git a/webapp-ng/src/app/core/modules/openapi/model/field-data-shape.ts b/webapp-ng/src/app/core/modules/openapi/model/field-data-shape.ts new file mode 100644 index 0000000000..00b95546a1 --- /dev/null +++ b/webapp-ng/src/app/core/modules/openapi/model/field-data-shape.ts @@ -0,0 +1,25 @@ +/** + * VCell API + * VCell API + * + * The version of the OpenAPI document: 1.0.1 + * Contact: vcell_support@uchc.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +import { Origin } from './origin'; +import { DataIdentifier } from './data-identifier'; +import { Extent } from './extent'; +import { ISize } from './i-size'; + + +export interface FieldDataShape { + extent?: Extent; + origin?: Origin; + isize?: ISize; + dataIdentifier?: Array; + times?: Array; +} + diff --git a/webapp-ng/src/app/core/modules/openapi/model/i-size.ts b/webapp-ng/src/app/core/modules/openapi/model/i-size.ts index 5a9e9f1481..8a4749dd5a 100644 --- a/webapp-ng/src/app/core/modules/openapi/model/i-size.ts +++ b/webapp-ng/src/app/core/modules/openapi/model/i-size.ts @@ -15,6 +15,5 @@ export interface ISize { x?: number; y?: number; z?: number; - xYZ?: number; } diff --git a/webapp-ng/src/app/core/modules/openapi/model/models.ts b/webapp-ng/src/app/core/modules/openapi/model/models.ts index 24482e7a15..fb8ebc5c35 100644 --- a/webapp-ng/src/app/core/modules/openapi/model/models.ts +++ b/webapp-ng/src/app/core/modules/openapi/model/models.ts @@ -3,20 +3,14 @@ export * from './analyzed-results-from-field-data'; export * from './batch-system-type'; export * from './bio-model'; export * from './biomodel-ref'; -export * from './cartesian-mesh'; -export * from './coordinate'; export * from './data-identifier'; export * from './detailed-state'; export * from './domain'; export * from './extent'; export * from './external-data-identifier'; -export * from './field-data-db-operation-spec'; -export * from './field-data-file-operation-spec'; -export * from './field-data-info'; -export * from './field-data-no-copy-conflict'; -export * from './field-data-references'; +export * from './field-data-reference'; export * from './field-data-save-results'; -export * from './group-access'; +export * from './field-data-shape'; export * from './hello-world-message'; export * from './htc-job-id'; export * from './i-size'; @@ -34,7 +28,6 @@ export * from './simulation-queue-id'; export * from './simulation-status-persistent-record'; export * from './status'; export * from './status-message'; -export * from './ucd-info'; export * from './user'; export * from './user-identity-json-safe'; export * from './user-login-info-for-mapping'; @@ -42,7 +35,3 @@ export * from './user-registration-info'; export * from './vc-simulation-identifier'; export * from './variable-domain'; export * from './variable-type'; -export * from './version'; -export * from './version-flag'; -export * from './versionable-type'; -export * from './versionable-type-version'; diff --git a/webapp-ng/src/app/core/modules/openapi/model/user.ts b/webapp-ng/src/app/core/modules/openapi/model/user.ts index c15b7edcd6..eaf113a72d 100644 --- a/webapp-ng/src/app/core/modules/openapi/model/user.ts +++ b/webapp-ng/src/app/core/modules/openapi/model/user.ts @@ -15,7 +15,6 @@ import { KeyValue } from './key-value'; export interface User { userName?: string; key?: KeyValue; - iD?: KeyValue; name?: string; testAccount?: boolean; }