Terradue Core API v2
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 2
- Package version: 1.0.0
- Generator version: 7.6.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
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:
import openapi_clientInstall via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import openapi_clientExecute pytest to run the tests.
Please follow the installation procedure and then run the following:
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.bios-dev.terradue.com/core
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "https://api.bios-dev.terradue.com/core"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.ControlApi(api_client)
job_id = 'job_id_example' # str |
try:
# Get the status of a job
api_response = api_instance.get_job_status(job_id)
print("The response of ControlApi->get_job_status:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ControlApi->get_job_status: %s\n" % e)All URIs are relative to https://api.bios-dev.terradue.com/core
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ControlApi | get_job_status | GET /v2/jobs/{jobId} | Get the status of a job |
| InventoryApi | claim_catalogue | POST /v2/inventory/catalogues/{catalogueId}/claim | Claim a catalogue |
| InventoryApi | get_catalogue_by_id | GET /v2/inventory/catalogues/{catalogueId} | Get the catalogue information for a specific id |
| InventoryApi | get_catalogue_publication_status | GET /v2/inventory/catalogues/publication/{publicationId} | Get Status of an import |
| InventoryApi | get_catalogues | GET /v2/inventory/catalogues | Get all the catalogues information related to an authenticated user |
| InventoryApi | get_inventory_sts | GET /v2/inventory/token | Get Credentials for specific inventory point (e.g catalog, collection) |
| InventoryApi | get_supported_formats | GET /v2/inventory/formats | Get the supported formats for the inventory point |
| InventoryApi | publish | POST /v2/inventory/catalogues/publish | Submit a catalog publication request |
| ServicesApi | cast_time_series | POST /v2/services/timeseries/cast | Request casting for a time series. |
| ServicesApi | get_data_casting_status_async | GET /v2/services/datacast/casts/{castId} | Get the status of a casting request |
| ServicesApi | post_data_casting | POST /v2/services/datacast/cast | Request casting for a generic data resource |
| StorageApi | claim_workspace | POST /v2/storage/workspaces/{workspaceId}/claim | Claim a workspace |
| StorageApi | delete_shared_folder_by_id | DELETE /v2/storage/sharedfolders/{sharedFolderId} | |
| StorageApi | download | POST /v2/storage/download | Request a download URL for a given resource |
| StorageApi | get_shared_folder_by_id | GET /v2/storage/sharedfolders/{sharedFolderId} | Get the shared folder information for a specific id |
| StorageApi | get_shared_folders | GET /v2/storage/sharedfolders | Get all the workspaces information related to an authenticated user |
| StorageApi | get_storage_sts | GET /v2/storage/token | Get Credentials for specific storage point (e.g workspace, shared folder...) |
| StorageApi | get_workspace_by_id | GET /v2/storage/workspaces/{workspaceId} | Get the workspace information for a specific id |
| StorageApi | get_workspace_import_status | GET /v2/storage/workspaces/imports/{importId} | Get Status of an import |
| StorageApi | get_workspaces | GET /v2/storage/workspaces | Get all the workspaces information related to an authenticated user |
| StorageApi | import_from_url | POST /v2/storage/workspaces/{workspaceId}/import-catalog | Import resources from exisiting catalog |
| StorageApi | share_folder | POST /v2/storage/workspaces/{workspaceId}/share | Share a folder from a workspace with users |
| UserApi | v2_user_info_get | GET /v2/user/info | Get the principal user identities from the identity management system |
| UserApi | v2_user_platforms_get | GET /v2/user/platforms | Get the principal user identities from the identity management system |
- AccessToken
- AuthResourceType
- BackgroundJobRequestStatus
- CatalogPublicationRequest
- ClaimLite
- ContentDisposition
- ContentType
- DataCastingEnum
- DataCastingRequest
- GetJobStatus401Response
- HttpValidationProblemDetails
- IInventoryCatalog
- IInventoryPoint
- IInventorySTS
- IPublicationRequest
- IResourceStatus
- ISharedFolder
- IStoragePoint
- IStorageSTS
- ISubject
- ITranslator
- IWorkspace
- ImportRequest
- ImportStatus
- InventoryType
- Link
- PrincipalContext
- ProblemDetails
- PublicationRequest
- PublicationStatus
- RequestStatus
- RequestStatusCode
- ResourceDeletionTask
- ResourceStatusCode
- ResourceType
- SelfInfo
- ShareFolderRequest
- StorageType
- StsInventory
- StsStorage
- Subject
Authentication schemes defined for the API:
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://iam-dev.terradue.com/realms/master/protocol/openid-connect/auth
- Scopes:
- openid: openid
- profile: profile
- bios-dev: bios-dev
- offline_access: offline_access