Skip to content
/ python_epic_api Public

Python API autogenerated from Epic's swagger API definition

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

zenotech/python_epic_api

BranchesTags

Repository files navigation

epiccore

REST API for interacting with EPIC (https://epic.zenotech.com) services.
Please note this API is in BETA and does not yet contain all EPIC functionality.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v2
  • Package version: 1.0.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:

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 epiccore

Setuptools

Install 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 epiccore

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import epiccore
from epiccore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://epic.zenotech.com/api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = epiccore.Configuration(
    host = "https://epic.zenotech.com/api/v2",
    api_key = {
        'Bearer': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'


# Enter a context with an instance of the API client
with epiccore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = epiccore.BillingApi(api_client)
    
    try:
        api_response = api_instance.billing_limits_list()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BillingApi->billing_limits_list: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://epic.zenotech.com/api/v2

Class Method HTTP request Description
BillingApi billing_limits_list GET /billing/limits/
BillingApi billing_limits_partial_update PATCH /billing/limits/
CatalogApi catalog_applications_list GET /catalog/applications/
CatalogApi catalog_applications_read GET /catalog/applications/{application}/
CatalogApi catalog_clusters_list GET /catalog/clusters/
CatalogApi catalog_clusters_read GET /catalog/clusters/{queue_code}/
CatalogApi catalog_desktop_list GET /catalog/desktop/
CatalogApi catalog_desktop_read GET /catalog/desktop/{node_code}/
ConfigApi config_read GET /config/{app_code}/{queue_code}/
DataApi data_file_list GET /data/file/
DataApi data_file_read GET /data/file/{id}/
DataApi data_folder_list GET /data/folder/
DataApi data_folder_read GET /data/folder/{id}/
DataApi data_session_list GET /data/session/
DesktopApi desktop_create POST /desktop/
DesktopApi desktop_list GET /desktop/
DesktopApi desktop_quote POST /desktop/quote/
DesktopApi desktop_read GET /desktop/{id}/
DesktopApi desktop_terminate POST /desktop/{id}/terminate/
JobApi job_auth_read GET /job/{id}/auth/
JobApi job_auth_update PUT /job/{id}/auth/
JobApi job_cancel POST /job/{id}/cancel/
JobApi job_create POST /job/
JobApi job_list GET /job/
JobApi job_partial_update PATCH /job/{id}/
JobApi job_quote POST /job/quote/
JobApi job_read GET /job/{id}/
JobApi job_residuals_read GET /job/{id}/residuals/
JobauthApi jobauth_list GET /jobauth/
JobauthApi jobauth_read GET /jobauth/{job}/
JobauthApi jobauth_update PUT /jobauth/{job}/
JobrefreshApi jobrefresh_create POST /jobrefresh/
JobrefreshApi jobrefresh_read GET /jobrefresh/{id}/
JobstepApi jobstep_cancel POST /jobstep/{id}/cancel/
JobstepApi jobstep_list GET /jobstep/
JobstepApi jobstep_logs_read GET /jobstep/{id}/logs/
JobstepApi jobstep_read GET /jobstep/{id}/
LicensesApi licenses_ansys POST /licenses/ansys/
LicensesApi licenses_create POST /licenses/
LicensesApi licenses_list GET /licenses/
LicensesApi licenses_read GET /licenses/{id}/
LicensesApi licenses_update PUT /licenses/{id}/
LicensesApi licenses_zcad POST /licenses/zcad/
LicensesApi licenses_zcfd POST /licenses/zcfd/
ProfileApi profile_settings_list GET /profile/settings/
ProjectsApi projects_list GET /projects/
ProjectsApi projects_partial_update PATCH /projects/{id}/
ProjectsApi projects_read GET /projects/{id}/
TeamsApi teams_list GET /teams/
TeamsApi teams_read GET /teams/{id}/

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

support@zenotech.com

About

Python API autogenerated from Epic's swagger API definition

Topics

python pypi epic

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

6 watching

Forks

0 forks
Report repository

Releases 28

0.0.28 Latest
Jul 18, 2023
+ 27 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages