Skip to content

Commit

Permalink
Retrieve Field Data IDs and Shape Information With Rest
Browse files Browse the repository at this point in the history
Have the DB operation of retrieving all field data IDs of a user, and the shape information of a field data entry be done through the REST endpoints.
  • Loading branch information
AvocadoMoon committed Dec 23, 2024
1 parent e7522a8 commit 5cb8b12
Show file tree
Hide file tree
Showing 113 changed files with 4,605 additions and 4,898 deletions.
31 changes: 8 additions & 23 deletions python-restclient/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@ 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/FieldDataExternalDataIDs.md
docs/FieldDataFileOperationSpec.md
docs/FieldDataInfo.md
docs/FieldDataNoCopyConflict.md
docs/FieldDataReferences.md
docs/FieldDataResourceApi.md
docs/FieldDataSaveResults.md
docs/GroupAccess.md
Expand Down Expand Up @@ -55,27 +58,6 @@ docs/VersionableType.md
docs/VersionableTypeVersion.md
pyproject.toml
test/__init__.py
test/test_analyzed_results_from_field_data.py
test/test_cartesian_mesh.py
test/test_coordinate.py
test/test_extent.py
test/test_external_data_identifier.py
test/test_field_data_db_operation_spec.py
test/test_field_data_external_data_ids.py
test/test_field_data_file_operation_spec.py
test/test_field_data_no_copy_conflict.py
test/test_field_data_resource_api.py
test/test_field_data_save_results.py
test/test_group_access.py
test/test_i_size.py
test/test_origin.py
test/test_ucd_info.py
test/test_variable_domain.py
test/test_variable_type.py
test/test_version.py
test/test_version_flag.py
test/test_versionable_type.py
test/test_versionable_type_version.py
tox.ini
vcell_client/__init__.py
vcell_client/api/__init__.py
Expand All @@ -98,13 +80,16 @@ 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_external_data_ids.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_save_results.py
vcell_client/models/group_access.py
vcell_client/models/hello_world_message.py
Expand Down
10 changes: 7 additions & 3 deletions python-restclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,9 @@ Class | Method | HTTP request | Description
*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/createFieldDataFromFile |
*FieldDataResourceApi* | [**get_all_field_data**](docs/FieldDataResourceApi.md#get_all_field_data) | **GET** /api/v1/fieldData | Get all of the field data for that user.
*FieldDataResourceApi* | [**generate_field_data_estimate**](docs/FieldDataResourceApi.md#generate_field_data_estimate) | **POST** /api/v1/fieldData/analyzeFieldDataFromFile |
*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.
*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
Expand Down Expand Up @@ -125,13 +126,16 @@ Class | Method | HTTP request | Description
- [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)
- [FieldDataExternalDataIDs](docs/FieldDataExternalDataIDs.md)
- [FieldDataFileOperationSpec](docs/FieldDataFileOperationSpec.md)
- [FieldDataInfo](docs/FieldDataInfo.md)
- [FieldDataNoCopyConflict](docs/FieldDataNoCopyConflict.md)
- [FieldDataReferences](docs/FieldDataReferences.md)
- [FieldDataSaveResults](docs/FieldDataSaveResults.md)
- [GroupAccess](docs/GroupAccess.md)
- [HelloWorldMessage](docs/HelloWorldMessage.md)
Expand Down
2 changes: 1 addition & 1 deletion python-restclient/docs/BioModelResourceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**401** | Not Authorized | - |
**403** | Not Allowed | - |
**401** | Not Authorized | - |

[[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)

34 changes: 34 additions & 0 deletions python-restclient/docs/DataIdentifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# DataIdentifier


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**display_name** | **str** | | [optional]
**variable_type** | [**VariableType**](VariableType.md) | | [optional]
**domain** | [**Domain**](Domain.md) | | [optional]
**b_function** | **bool** | | [optional]
**function** | **bool** | | [optional]
**visible** | **bool** | | [optional]

## Example

```python
from vcell_client.models.data_identifier import DataIdentifier

# TODO update the JSON string below
json = "{}"
# create an instance of DataIdentifier from a JSON string
data_identifier_instance = DataIdentifier.from_json(json)
# print the JSON string representation of the object
print DataIdentifier.to_json()

# convert the object into a dict
data_identifier_dict = data_identifier_instance.to_dict()
# create an instance of DataIdentifier from a dict
data_identifier_form_dict = data_identifier.from_dict(data_identifier_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)


28 changes: 28 additions & 0 deletions python-restclient/docs/Domain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Domain


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]

## Example

```python
from vcell_client.models.domain import Domain

# TODO update the JSON string below
json = "{}"
# create an instance of Domain from a JSON string
domain_instance = Domain.from_json(json)
# print the JSON string representation of the object
print Domain.to_json()

# convert the object into a dict
domain_dict = domain_instance.to_dict()
# create an instance of Domain from a dict
domain_form_dict = domain.from_dict(domain_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)


34 changes: 34 additions & 0 deletions python-restclient/docs/FieldDataFileOperationResults.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# FieldDataFileOperationResults


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data_identifier_arr** | [**List[DataIdentifier]**](DataIdentifier.md) | | [optional]
**external_data_identifier** | [**ExternalDataIdentifier**](ExternalDataIdentifier.md) | | [optional]
**i_size** | [**ISize**](ISize.md) | | [optional]
**origin** | [**Origin**](Origin.md) | | [optional]
**extent** | [**Extent**](Extent.md) | | [optional]
**times** | **List[float]** | | [optional]
**dependant_function_info** | [**List[FieldDataReferenceInfo]**](FieldDataReferenceInfo.md) | | [optional]

## Example

```python
from vcell_client.models.field_data_file_operation_results import FieldDataFileOperationResults

# TODO update the JSON string below
json = "{}"
# create an instance of FieldDataFileOperationResults from a JSON string
field_data_file_operation_results_instance = FieldDataFileOperationResults.from_json(json)
# print the JSON string representation of the object
print FieldDataFileOperationResults.to_json()

# convert the object into a dict
field_data_file_operation_results_dict = field_data_file_operation_results_instance.to_dict()
# create an instance of FieldDataFileOperationResults from a dict
field_data_file_operation_results_form_dict = field_data_file_operation_results.from_dict(field_data_file_operation_results_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)


32 changes: 32 additions & 0 deletions python-restclient/docs/FieldDataInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# FieldDataInfo


## 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_info import FieldDataInfo

# TODO update the JSON string below
json = "{}"
# create an instance of FieldDataInfo from a JSON string
field_data_info_instance = FieldDataInfo.from_json(json)
# print the JSON string representation of the object
print FieldDataInfo.to_json()

# convert the object into a dict
field_data_info_dict = field_data_info_instance.to_dict()
# create an instance of FieldDataInfo from a dict
field_data_info_form_dict = field_data_info.from_dict(field_data_info_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)


34 changes: 34 additions & 0 deletions python-restclient/docs/FieldDataReferenceInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# FieldDataReferenceInfo


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**reference_source_type** | **str** | | [optional]
**reference_source_name** | **str** | | [optional]
**application_name** | **str** | | [optional]
**simulation_name** | **str** | | [optional]
**ref_source_version_date** | **str** | | [optional]
**func_names** | **List[str]** | | [optional]
**ref_source_version_key** | [**KeyValue**](KeyValue.md) | | [optional]

## Example

```python
from vcell_client.models.field_data_reference_info import FieldDataReferenceInfo

# TODO update the JSON string below
json = "{}"
# create an instance of FieldDataReferenceInfo from a JSON string
field_data_reference_info_instance = FieldDataReferenceInfo.from_json(json)
# print the JSON string representation of the object
print FieldDataReferenceInfo.to_json()

# convert the object into a dict
field_data_reference_info_dict = field_data_reference_info_instance.to_dict()
# create an instance of FieldDataReferenceInfo from a dict
field_data_reference_info_form_dict = field_data_reference_info.from_dict(field_data_reference_info_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)


30 changes: 30 additions & 0 deletions python-restclient/docs/FieldDataReferences.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# FieldDataReferences


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**external_data_identifiers** | [**List[ExternalDataIdentifier]**](ExternalDataIdentifier.md) | | [optional]
**external_data_annotations** | **List[str]** | | [optional]
**external_data_id_sim_refs** | **Dict[str, List[KeyValue]]** | | [optional]

## Example

```python
from vcell_client.models.field_data_references import FieldDataReferences

# TODO update the JSON string below
json = "{}"
# create an instance of FieldDataReferences from a JSON string
field_data_references_instance = FieldDataReferences.from_json(json)
# print the JSON string representation of the object
print FieldDataReferences.to_json()

# convert the object into a dict
field_data_references_dict = field_data_references_instance.to_dict()
# create an instance of FieldDataReferences from a dict
field_data_references_form_dict = field_data_references.from_dict(field_data_references_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)


Loading

0 comments on commit 5cb8b12

Please sign in to comment.