# incqueryserver-api-python-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.19.0
- Package version: 0.19.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import iqs_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import iqs_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import iqs_client
from iqs_client.rest import ApiException
from pprint import pprint
configuration = iqs_client.Configuration()
# Configure HTTP basic authorization: basicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Defining host is optional and default to http://localhost/api
configuration.host = "http://localhost/api"
# Enter a context with an instance of the API client
with iqs_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = iqs_client.AcquisitionApi(api_client)
linked_data_acquisition_request_multipart = iqs_client.LinkedDataAcquisitionRequestMultipart() # LinkedDataAcquisitionRequestMultipart | Upload a linked data file.
try:
# Acquire a linked data document as a model compartment.
api_response = api_instance.acquire_linked_data(linked_data_acquisition_request_multipart)
pprint(api_response)
except ApiException as e:
print("Exception when calling AcquisitionApi->acquire_linked_data: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost/api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AcquisitionApi* | [**acquire_linked_data**](docs/AcquisitionApi.md#acquire_linked_data) | **POST** /demo.acquireLinkedData | Acquire a linked data document as a model compartment.
*AcquisitionApi* | [**close_acquisition**](docs/AcquisitionApi.md#close_acquisition) | **POST** /acquisition.close | End the acquistion of a compartment, either by finalizing or discarding
*AcquisitionApi* | [**start_acquisition**](docs/AcquisitionApi.md#start_acquisition) | **POST** /acquisition.start | Start the acquistion of a compartment
*AcquisitionApi* | [**upload_acquisition_chunk**](docs/AcquisitionApi.md#upload_acquisition_chunk) | **POST** /acquisition.uploadChunk | Uploads a chunk of content as part of an open acquisition
*AnalysisApi* | [**delete_model_analysis_configuration**](docs/AnalysisApi.md#delete_model_analysis_configuration) | **POST** /analysis.delete | Delete analysis configuration
*AnalysisApi* | [**list_model_analysis_configurations**](docs/AnalysisApi.md#list_model_analysis_configurations) | **GET** /analysis.list | List of registered analysis configurations
*AnalysisApi* | [**model_analysis_configuration_details**](docs/AnalysisApi.md#model_analysis_configuration_details) | **GET** /analysis.details | Retrieve the details of the given analysis configuration
*AnalysisApi* | [**register_model_analysis_configuration**](docs/AnalysisApi.md#register_model_analysis_configuration) | **POST** /analysis.register | Register new analysis configuration
*AnalysisApi* | [**run_model_analysis**](docs/AnalysisApi.md#run_model_analysis) | **POST** /analysis.run | Execute model analysis on given model compartment
*AsyncApi* | [**async_index_model_compartment**](docs/AsyncApi.md#async_index_model_compartment) | **POST** /async.indexModelCompartment | Store modelCompartment in selected indexes asynchronously.
*DemoApi* | [**acquire_linked_data**](docs/DemoApi.md#acquire_linked_data) | **POST** /demo.acquireLinkedData | Acquire a linked data document as a model compartment.
*DemoApi* | [**delete_model_compartment_from_index**](docs/DemoApi.md#delete_model_compartment_from_index) | **POST** /demo.deleteModelCompartment | Delete modelCompartment from selected indexes.
*DemoApi* | [**execute_query_one_off**](docs/DemoApi.md#execute_query_one_off) | **POST** /demo.executeQueryOneOff | Execute a query just once, without the need for registering it first.
*DemoApi* | [**get_compartment_index_status**](docs/DemoApi.md#get_compartment_index_status) | **POST** /demo.compartmentIndexStatus | Tells which indices the compartment is loaded in.
*DemoApi* | [**get_repository_structure**](docs/DemoApi.md#get_repository_structure) | **GET** /demo.completeStructure | Get repository structure separated by repository types
*DemoApi* | [**list_indexed_model_compartments**](docs/DemoApi.md#list_indexed_model_compartments) | **GET** /demo.indexStatus | List model compartment stored by the index
*DemoApi* | [**list_persisted_model_compartments_with_path**](docs/DemoApi.md#list_persisted_model_compartments_with_path) | **GET** /demo.listModelCompartmentsWithPath | List model compartments with path stored by persistent index.
*DemoApi* | [**repository_structure_compartment_details**](docs/DemoApi.md#repository_structure_compartment_details) | **POST** /demo.compartmentDetails | Returns detailed information about the given model compartment.
*DemoApi* | [**update_model_compartment_index**](docs/DemoApi.md#update_model_compartment_index) | **POST** /demo.indexCompartment | Store modelCompartment in selected indexes.
*DemoApi* | [**update_repository_structure**](docs/DemoApi.md#update_repository_structure) | **POST** /demo.updateStructure | Update complete repository structure
*ImpactAnalysisApi* | [**list_compartments_with_dependent_elements**](docs/ImpactAnalysisApi.md#list_compartments_with_dependent_elements) | **POST** /impact-analysis.listCompartments | Calculates the impact of given Elements, listing model compartments with elements referring to each
*ImpactAnalysisApi* | [**list_dependencies**](docs/ImpactAnalysisApi.md#list_dependencies) | **POST** /impact-analysis.listDependencies | Calculates the impact of given Elements, listing elements referring to each
*ImpactAnalysisApi* | [**list_revisions_with_dependencies**](docs/ImpactAnalysisApi.md#list_revisions_with_dependencies) | **POST** /impact-analysis.listRevisionsWithDependencies | Calculates the impact of given Elements, listing revisions with elements referring to each
*ImpactAnalysisApi* | [**register_md_object_i_ds**](docs/ImpactAnalysisApi.md#register_md_object_i_ds) | **POST** /impact-analysis.register | Registers a list of Elements that should have their dependency information preloaded
*ImpactAnalysisApi* | [**run_impact_analysis_query**](docs/ImpactAnalysisApi.md#run_impact_analysis_query) | **POST** /impact-analysis.run | Calculates the impact of given Elements, listing elements from any model compartment referring to each
*ImpactAnalysisApi* | [**unregister_md_object_i_ds**](docs/ImpactAnalysisApi.md#unregister_md_object_i_ds) | **POST** /impact-analysis.unregister | Unregisters a list of Elements that were previously registered
*InMemoryIndexApi* | [**delete_all_inmemory_model_compartments**](docs/InMemoryIndexApi.md#delete_all_inmemory_model_compartments) | **POST** /inmemory-index.deleteAllModelCompartments | Delete all loaded model compartments from the in-memory index
*InMemoryIndexApi* | [**delete_all_inmemory_revisions**](docs/InMemoryIndexApi.md#delete_all_inmemory_revision