Catalog PyPI
PACKAGE EXPLORERView in registry

aiochris-oag

PyPI

ChRIS Research Integration System: Ultron BackEnd (CUBE) API

(cube)apibackendchrisintegrationopenapiopenapi-generatorresearchsystem:ultron
Versions collected1
Direct dependencies5From release 0.0.3
Last observed21 Oct, 11:43 UTC

README

Version 0.0.3 documentation

aiochris-oag

The ChRIS Ultron BackEnd (CUBE) is the core backend API of ChRIS. It manages ChRIS users, plugins, pipelines, and the provenance of data analyses as ChRIS feeds.

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

  • API version: 7.0.0-a2
  • Package version: 0.0.3
  • Generator version: 7.21.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://chrisproject.org

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/FNNDSC/openapi-clients.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/FNNDSC/openapi-clients.git)

Then import the package:

import aiochris_oag

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 aiochris_oag

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import aiochris_oag
from aiochris_oag.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = aiochris_oag.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: basicAuth
configuration = aiochris_oag.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'


# Enter a context with an instance of the API client
async with aiochris_oag.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = aiochris_oag.AuthTokenApi(api_client)
    username = 'username_example' # str | 
    password = 'password_example' # str | 

    try:
        api_response = await api_instance.auth_token_create(username, password)
        print("The response of AuthTokenApi->auth_token_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthTokenApi->auth_token_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AuthTokenApiauth_token_createPOST /api/v1/auth-token/
ChrisAdminApichris_admin_api_v1_computeresources_createPOST /chris-admin/api/v1/computeresources/
ChrisAdminApichris_admin_api_v1_computeresources_destroyDELETE /chris-admin/api/v1/computeresources/{id}/
ChrisAdminApichris_admin_api_v1_computeresources_listGET /chris-admin/api/v1/computeresources/
ChrisAdminApichris_admin_api_v1_computeresources_retrieveGET /chris-admin/api/v1/computeresources/{id}/
ChrisAdminApichris_admin_api_v1_createPOST /chris-admin/api/v1/
ChrisAdminApichris_admin_api_v1_destroyDELETE /chris-admin/api/v1/{id}/
ChrisAdminApichris_admin_api_v1_listGET /chris-admin/api/v1/
ChrisAdminApichris_admin_api_v1_retrieveGET /chris-admin/api/v1/{id}/
ChrisAdminApichris_admin_api_v1_updatePUT /chris-admin/api/v1/{id}/
ChrisinstanceApichrisinstance_retrieveGET /api/v1/chrisinstance/{id}/
CommentsApicomments_createPOST /api/v1/{id}/comments/
CommentsApicomments_destroyDELETE /api/v1/comments/{id}/
CommentsApicomments_listGET /api/v1/{id}/comments/
CommentsApicomments_retrieveGET /api/v1/comments/{id}/
CommentsApicomments_search_listGET /api/v1/{id}/comments/search/
CommentsApicomments_updatePUT /api/v1/comments/{id}/
ComputeresourcesApicomputeresources_listGET /api/v1/computeresources/
ComputeresourcesApicomputeresources_retrieveGET /api/v1/computeresources/{id}/
ComputeresourcesApicomputeresources_search_listGET /api/v1/computeresources/search/
DefaultApiroot_destroyDELETE /api/v1/{id}/
DefaultApiroot_listGET /api/v1/
DefaultApiroot_retrieveGET /api/v1/{id}/
DefaultApiroot_updatePUT /api/v1/{id}/
DownloadtokensApidownloadtokens_createPOST /api/v1/downloadtokens/
DownloadtokensApidownloadtokens_listGET /api/v1/downloadtokens/
DownloadtokensApidownloadtokens_retrieveGET /api/v1/downloadtokens/{id}/
DownloadtokensApidownloadtokens_search_listGET /api/v1/downloadtokens/search/
FilebrowserApifilebrowser_children_listGET /api/v1/filebrowser/{id}/children/
FilebrowserApifilebrowser_createPOST /api/v1/filebrowser/
FilebrowserApifilebrowser_destroyDELETE /api/v1/filebrowser/{id}/
FilebrowserApifilebrowser_files_destroyDELETE /api/v1/filebrowser/files/{id}/
FilebrowserApifilebrowser_files_grouppermissions_createPOST /api/v1/filebrowser/files/{id}/grouppermissions/
FilebrowserApifilebrowser_files_grouppermissions_destroyDELETE /api/v1/filebrowser/files/grouppermissions/{id}/
FilebrowserApifilebrowser_files_grouppermissions_listGET /api/v1/filebrowser/files/{id}/grouppermissions/
FilebrowserApifilebrowser_files_grouppermissions_retrieveGET /api/v1/filebrowser/files/grouppermissions/{id}/
FilebrowserApifilebrowser_files_grouppermissions_search_listGET /api/v1/filebrowser/files/{id}/grouppermissions/search/
FilebrowserApifilebrowser_files_grouppermissions_updatePUT /api/v1/filebrowser/files/grouppermissions/{id}/
FilebrowserApifilebrowser_files_listGET /api/v1/filebrowser/{id}/files/
FilebrowserApifilebrowser_files_retrieveGET /api/v1/filebrowser/files/{id}/
FilebrowserApifilebrowser_files_retrieve_0GET /api/v1/filebrowser/files/{id}/.
FilebrowserApifilebrowser_files_updatePUT /api/v1/filebrowser/files/{id}/
FilebrowserApifilebrowser_files_userpermissions_createPOST /api/v1/filebrowser/files/{id}/userpermissions/
FilebrowserApifilebrowser_files_userpermissions_destroyDELETE /api/v1/filebrowser/files/userpermissions/{id}/
FilebrowserApifilebrowser_files_userpermissions_listGET /api/v1/filebrowser/files/{id}/userpermissions/
FilebrowserApifilebrowser_files_userpermissions_retrieveGET /api/v1/filebrowser/files/userpermissions/{id}/
FilebrowserApifilebrowser_files_userpermissions_search_listGET /api/v1/filebrowser/files/{id}/userpermissions/search/
FilebrowserApifilebrowser_files_userpermissions_updatePUT /api/v1/filebrowser/files/userpermissions/{id}/
FilebrowserApifilebrowser_grouppermissions_createPOST /api/v1/filebrowser/{id}/grouppermissions/
FilebrowserApifilebrowser_grouppermissions_destroyDELETE /api/v1/filebrowser/grouppermissions/{id}/
FilebrowserApifilebrowser_grouppermissions_listGET /api/v1/filebrowser/{id}/grouppermissions/
FilebrowserApifilebrowser_grouppermissions_retrieveGET /api/v1/filebrowser/grouppermissions/{id}/
FilebrowserApifilebrowser_grouppermissions_search_listGET /api/v1/filebrowser/{id}/grouppermissions/search/
FilebrowserApifilebrowser_grouppermissions_updatePUT /api/v1/filebrowser/grouppermissions/{id}/
FilebrowserApifilebrowser_linkfiles_destroyDELETE /api/v1/filebrowser/linkfiles/{id}/
FilebrowserApifilebrowser_linkfiles_grouppermissions_createPOST /api/v1/filebrowser/linkfiles/{id}/grouppermissions/
FilebrowserApifilebrowser_linkfiles_grouppermissions_destroyDELETE /api/v1/filebrowser/linkfiles/grouppermissions/{id}/
FilebrowserApifilebrowser_linkfiles_grouppermissions_listGET /api/v1/filebrowser/linkfiles/{id}/grouppermissions/
FilebrowserApifilebrowser_linkfiles_grouppermissions_retrieveGET /api/v1/filebrowser/linkfiles/grouppermissions/{id}/
FilebrowserApifilebrowser_linkfiles_grouppermissions_search_listGET /api/v1/filebrowser/linkfiles/{id}/grouppermissions/search/
FilebrowserApifilebrowser_linkfiles_grouppermissions_updatePUT /api/v1/filebrowser/linkfiles/grouppermissions/{id}/
FilebrowserApifilebrowser_linkfiles_listGET /api/v1/filebrowser/{id}/linkfiles/
FilebrowserApifilebrowser_linkfiles_retrieveGET /api/v1/filebrowser/linkfiles/{id}/
FilebrowserApifilebrowser_linkfiles_retrieve_0GET /api/v1/filebrowser/linkfiles/{id}/.
FilebrowserApifilebrowser_linkfiles_updatePUT /api/v1/filebrowser/linkfiles/{id}/
FilebrowserApifilebrowser_linkfiles_userpermissions_createPOST /api/v1/filebrowser/linkfiles/{id}/userpermissions/
FilebrowserApifilebrowser_linkfiles_userpermissions_destroyDELETE /api/v1/filebrowser/linkfiles/userpermissions/{id}/
FilebrowserApifilebrowser_linkfiles_userpermissions_listGET /api/v1/filebrowser/linkfiles/{id}/userpermissions/
FilebrowserApifilebrowser_linkfiles_userpermissions_retrieveGET /api/v1/filebrowser/linkfiles/userpermissions/{id}/
FilebrowserApifilebrowser_linkfiles_userpermissions_search_listGET /api/v1/filebrowser/linkfiles/{id}/userpermissions/search/
FilebrowserApifilebrowser_linkfiles_userpermissions_updatePUT /api/v1/filebrowser/linkfiles/userpermissions/{id}/
FilebrowserApifilebrowser_listGET /api/v1/filebrowser/
FilebrowserApifilebrowser_retrieveGET /api/v1/filebrowser/{id}/
FilebrowserApifilebrowser_search_listGET /api/v1/filebrowser/search/
FilebrowserApifilebrowser_updatePUT /api/v1/filebrowser/{id}/
FilebrowserApifilebrowser_userpermissions_createPOST /api/v1/filebrowser/{id}/userpermissions/
FilebrowserApifilebrowser_userpermissions_destroyDELETE /api/v1/filebrowser/userpermissions/{id}/
FilebrowserApifilebrowser_userpermissions_listGET /api/v1/filebrowser/{id}/userpermissions/
FilebrowserApifilebrowser_userpermissions_retrieveGET /api/v1/filebrowser/userpermissions/{id}/
FilebrowserApifilebrowser_userpermissions_search_listGET /api/v1/filebrowser/{id}/userpermissions/search/
FilebrowserApifilebrowser_userpermissions_updatePUT /api/v1/filebrowser/userpermissions/{id}/
GrouppermissionsApigrouppermissions_createPOST /api/v1/{id}/grouppermissions/
GrouppermissionsApigrouppermissions_destroyDELETE /api/v1/grouppermissions/{id}/
GrouppermissionsApigrouppermissions_listGET /api/v1/{id}/grouppermissions/
GrouppermissionsApigrouppermissions_retrieveGET /api/v1/grouppermissions/{id}/
GrouppermissionsApigrouppermissions_search_listGET /api/v1/{id}/grouppermissions/search/
GroupsApigroups_createPOST /api/v1/groups/
GroupsApigroups_destroyDELETE /api/v1/groups/{id}/
GroupsApigroups_listGET /api/v1/groups/
GroupsApigroups_retrieveGET /api/v1/groups/{id}/
GroupsApigroups_search_listGET /api/v1/groups/search/
GroupsApigroups_users_createPOST /api/v1/groups/{id}/users/
GroupsApigroups_users_destroyDELETE /api/v1/groups/users/{id}/
GroupsApigroups_users_listGET /api/v1/groups/{id}/users/
GroupsApigroups_users_retrieveGET /api/v1/groups/users/{id}/
GroupsApigroups_users_search_listGET /api/v1/groups/{id}/users/search/
NoteApinote_retrieveGET /api/v1/note{id}/
NoteApinote_updatePUT /api/v1/note{id}/
PacsApiall_pacs_query_listGET /api/v1/pacs/queries/
PacsApiall_pacs_series_listGET /api/v1/pacs/series/
PacsApipacs_files_listGET /api/v1/pacs/files/
PacsApipacs_files_retrieveGET /api/v1/pacs/files/{id}/
PacsApipacs_files_retrieve_0GET /api/v1/pacs/files/{id}/.
PacsApipacs_files_search_listGET /api/v1/pacs/files/search/
PacsApipacs_listGET /api/v1/pacs/
PacsApipacs_queries_createPOST /api/v1/pacs/{id}/queries/
PacsApipacs_queries_destroyDELETE /api/v1/pacs/queries/{id}/
PacsApipacs_queries_retrieveGET /api/v1/pacs/queries/{id}/
PacsApipacs_queries_retrieves_createPOST /api/v1/pacs/queries/{id}/retrieves/
PacsApipacs_queries_retrieves_destroyDELETE /api/v1/pacs/queries/retrieves/{id}/
PacsApipacs_queries_retrieves_listGET /api/v1/pacs/queries/{id}/retrieves/
PacsApipacs_queries_retrieves_retrieveGET /api/v1/pacs/queries/retrieves/{id}/
PacsApipacs_queries_retrieves_search_listGET /api/v1/pacs/queries/{id}/retrieves/search/
PacsApipacs_queries_search_listGET /api/v1/pacs/queries/search/
PacsApipacs_queries_updatePUT /api/v1/pacs/queries/{id}/
PacsApipacs_query_listGET /api/v1/pacs/{id}/queries/
PacsApipacs_retrieveGET /api/v1/pacs/{id}/
PacsApipacs_search_listGET /api/v1/pacs/search/
PacsApipacs_series_createPOST /api/v1/pacs/series/
PacsApipacs_series_destroyDELETE /api/v1/pacs/series/{id}/
PacsApipacs_series_listGET /api/v1/pacs/{id}/series/
PacsApipacs_series_retrieveGET /api/v1/pacs/series/{id}/
PacsApipacs_series_search_listGET /api/v1/pacs/series/search/
PipelinesApiall_workflows_listGET /api/v1/pipelines/workflows/
PipelinesApipipelines_boolean_parameter_retrieveGET /api/v1/pipelines/boolean-parameter/{id}/
PipelinesApipipelines_boolean_parameter_updatePUT /api/v1/pipelines/boolean-parameter/{id}/
PipelinesApipipelines_createPOST /api/v1/pipelines/
PipelinesApipipelines_destroyDELETE /api/v1/pipelines/{id}/
PipelinesApipipelines_float_parameter_retrieveGET /api/v1/pipelines/float-parameter/{id}/
PipelinesApipipelines_float_parameter_updatePUT /api/v1/pipelines/float-parameter/{id}/
PipelinesApipipelines_integer_parameter_retrieveGET /api/v1/pipelines/integer-parameter/{id}/
PipelinesApipipelines_integer_parameter_updatePUT /api/v1/pipelines/integer-parameter/{id}/
PipelinesApipipelines_json_retrieveGET /api/v1/pipelines/{id}/json/
PipelinesApipipelines_listGET /api/v1/pipelines/
PipelinesApipipelines_parameters_listGET /api/v1/pipelines/{id}/parameters/
PipelinesApipipelines_pipings_listGET /api/v1/pipelines/{id}/pipings/
PipelinesApipipelines_pipings_retrieveGET /api/v1/pipelines/pipings/{id}/
PipelinesApipipelines_plugins_listGET /api/v1/pipelines/{id}/plugins/
PipelinesApipipelines_retrieveGET /api/v1/pipelines/{id}/
PipelinesApipipelines_search_listGET /api/v1/pipelines/search/
PipelinesApipipelines_sourcefiles_createPOST /api/v1/pipelines/sourcefiles/
PipelinesApipipelines_sourcefiles_listGET /api/v1/pipelines/sourcefiles/
PipelinesApipipelines_sourcefiles_retrieveGET /api/v1/pipelines/sourcefiles/{id}/
PipelinesApipipelines_sourcefiles_retrieve_0GET /api/v1/pipelines/sourcefiles/{id}/.
PipelinesApipipelines_sourcefiles_search_listGET /api/v1/pipelines/sourcefiles/search/
PipelinesApipipelines_string_parameter_retrieveGET /api/v1/pipelines/string-parameter/{id}/
PipelinesApipipelines_string_parameter_updatePUT /api/v1/pipelines/string-parameter/{id}/
PipelinesApipipelines_updatePUT /api/v1/pipelines/{id}/
PipelinesApipipelines_workflows_createPOST /api/v1/pipelines/{id}/workflows/
PipelinesApipipelines_workflows_destroyDELETE /api/v1/pipelines/workflows/{id}/
PipelinesApipipelines_workflows_plugininstances_listGET /api/v1/pipelines/workflows/{id}/plugininstances/
PipelinesApipipelines_workflows_retrieveGET /api/v1/pipelines/workflows/{id}/
PipelinesApipipelines_workflows_search_listGET /api/v1/pipelines/workflows/search/
PipelinesApipipelines_workflows_updatePUT /api/v1/pipelines/workflows/{id}/
PipelinesApiworkflows_listGET /api/v1/pipelines/{id}/workflows/
PlugininstancesApiplugininstances_listGET /api/v1/{id}/plugininstances/
PluginsApiall_plugins_instances_listGET /api/v1/plugins/instances/
PluginsApiplugins_boolean_parameter_retrieveGET /api/v1/plugins/boolean-parameter/{id}/
PluginsApiplugins_computeresources_listGET /api/v1/plugins/{id}/computeresources/
PluginsApiplugins_float_parameter_retrieveGET /api/v1/plugins/float-parameter/{id}/
PluginsApiplugins_instances_createPOST /api/v1/plugins/{id}/instances/
PluginsApiplugins_instances_descendants_listGET /api/v1/plugins/instances/{id}/descendants/
PluginsApiplugins_instances_destroyDELETE /api/v1/plugins/instances/{id}/
PluginsApiplugins_instances_listGET /api/v1/plugins/{id}/instances/
PluginsApiplugins_instances_parameters_listGET /api/v1/plugins/instances/{id}/parameters/
PluginsApiplugins_instances_retrieveGET /api/v1/plugins/instances/{id}/
PluginsApiplugins_instances_search_listGET /api/v1/plugins/instances/search/
PluginsApiplugins_instances_splits_createPOST /api/v1/plugins/instances/{id}/splits/
PluginsApiplugins_instances_splits_listGET /api/v1/plugins/instances/{id}/splits/
PluginsApiplugins_instances_splits_retrieveGET /api/v1/plugins/instances/splits/{id}/
PluginsApiplugins_instances_updatePUT /api/v1/plugins/instances/{id}/
PluginsApiplugins_integer_parameter_retrieveGET /api/v1/plugins/integer-parameter/{id}/
PluginsApiplugins_listGET /api/v1/plugins/
PluginsApiplugins_metas_listGET /api/v1/plugins/metas/
PluginsApiplugins_metas_plugins_listGET /api/v1/plugins/metas/{id}/plugins/
PluginsApiplugins_metas_retrieveGET /api/v1/plugins/metas/{id}/
PluginsApiplugins_metas_search_listGET /api/v1/plugins/metas/search/
PluginsApiplugins_parameters_listGET /api/v1/plugins/{id}/parameters/
PluginsApiplugins_parameters_retrieveGET /api/v1/plugins/parameters/{id}/
PluginsApiplugins_path_parameter_retrieveGET /api/v1/plugins/path-parameter/{id}/
PluginsApiplugins_retrieveGET /api/v1/plugins/{id}/
PluginsApiplugins_search_listGET /api/v1/plugins/search/
PluginsApiplugins_string_parameter_retrieveGET /api/v1/plugins/string-parameter/{id}/
PluginsApiplugins_unextpath_parameter_retrieveGET /api/v1/plugins/unextpath-parameter/{id}/
PublicfeedsApipublicfeeds_listGET /api/v1/publicfeeds/
PublicfeedsApipublicfeeds_search_listGET /api/v1/publicfeeds/search/
SchemaApischema_retrieveGET /schema/
SearchApisearch_listGET /api/v1/search/
TaggingsApitaggings_createPOST /api/v1/{id}/taggings/
TaggingsApitaggings_destroyDELETE /api/v1/taggings/{id}/
TaggingsApitaggings_listGET /api/v1/{id}/taggings/
TaggingsApitaggings_retrieveGET /api/v1/taggings/{id}/
TagsApifeed_tags_listGET /api/v1/{id}/tags/
TagsApitags_createPOST /api/v1/tags/
TagsApitags_destroyDELETE /api/v1/tags/{id}/
TagsApitags_feeds_listGET /api/v1/tags/{id}/feeds/
TagsApitags_listGET /api/v1/tags/
TagsApitags_retrieveGET /api/v1/tags/{id}/
TagsApitags_search_listGET /api/v1/tags/search/
TagsApitags_taggings_createPOST /api/v1/tags/{id}/taggings/
TagsApitags_taggings_listGET /api/v1/tags/{id}/taggings/
TagsApitags_updatePUT /api/v1/tags/{id}/
UserfilesApiuserfiles_createPOST /api/v1/userfiles/
UserfilesApiuserfiles_destroyDELETE /api/v1/userfiles/{id}/
UserfilesApiuserfiles_listGET /api/v1/userfiles/
UserfilesApiuserfiles_retrieveGET /api/v1/userfiles/{id}/
UserfilesApiuserfiles_retrieve_0GET /api/v1/userfiles/{id}/.
UserfilesApiuserfiles_search_listGET /api/v1/userfiles/search/
UserfilesApiuserfiles_updatePUT /api/v1/userfiles/{id}/
UserpermissionsApiuserpermissions_createPOST /api/v1/{id}/userpermissions/
UserpermissionsApiuserpermissions_destroyDELETE /api/v1/userpermissions/{id}/
UserpermissionsApiuserpermissions_listGET /api/v1/{id}/userpermissions/
UserpermissionsApiuserpermissions_retrieveGET /api/v1/userpermissions/{id}/
UserpermissionsApiuserpermissions_search_listGET /api/v1/{id}/userpermissions/search/
UsersApiusers_createPOST /api/v1/users/
UsersApiusers_groups_listGET /api/v1/users/{id}/groups/
UsersApiusers_listGET /api/v1/users/
UsersApiusers_retrieveGET /api/v1/users/{id}/
UsersApiusers_updatePUT /api/v1/users/{id}/

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

DownloadTokenInQueryString

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

basicAuth

  • Type: HTTP basic authentication

cookieAuth

  • Type: API key
  • API key parameter name: sessionid
  • Location:

tokenAuth

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

Author

dev@babymri.org

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
0.0.313 Apr 20265

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
fnndsc/openapi-clients

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 11:43 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:1e85436345c082f51daf5b70546acf0b84a0d93fa7ae926aa78afb1272e61268