Skip to content

OPENAPI_README.md

Latest commit

 

History

History
559 lines (519 loc) · 59.8 KB

OPENAPI_README.md

File metadata and controls

559 lines (519 loc) · 59.8 KB

canopy.openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen

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 canopy.openapi

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 canopy.openapi

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import canopy.openapi
from canopy.openapi.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 = canopy.openapi.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 OAuth2 access token for authorization: Bearer
configuration = canopy.openapi.Configuration(
    host = "http://localhost"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Enter a context with an instance of the API client
with canopy.openapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = canopy.openapi.AccountSettingsApi(api_client)
    tenant_id = 'tenant_id_example' # str | The tenant ID of the user.
user_id = 'user_id_example' # str | The user ID of the user.

    try:
        # Gets the account settings for the specified user.  This contains information such as their username, their email, and whether their email address  has been confirmed.
        api_response = api_instance.account_settings_get(tenant_id, user_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountSettingsApi->account_settings_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccountSettingsApi account_settings_get GET /account-settings/{tenantId}/{userId} Gets the account settings for the specified user. This contains information such as their username, their email, and whether their email address has been confirmed.
AccountSettingsApi account_settings_put PUT /account-settings/{tenantId}/{userId} Updates the account settings for the specified user.
AvailabilityApi availability_get GET /availability Tests the availability of the API.
AvailabilityApi availability_head HEAD /availability This method performs a simple `ping` test of the API, where the API responding is considered a successful test.
ConfigApi config_decrypt POST /configs/decrypt Decrypts the provided data.
ConfigApi config_decrypt_with_metadata POST /configs/decryptWithMetadata Decrypts the provided data.
ConfigApi config_delete_config DELETE /configs/{tenantId}/{configId} Deletes an existing config.
ConfigApi config_delete_config_deprecated DELETE /configs/{tenantId}/{userId}/{configId} Deletes an existing config for the specified tenant and user.
ConfigApi config_encrypt POST /configs/encrypt Encrypts the provided data.
ConfigApi config_encrypt_with_metadata POST /configs/encryptWithMetadata Encrypted the provided data using the optional description and channel whitelist.
ConfigApi config_get_config GET /configs/{tenantId}/{configId} Gets an existing config.
ConfigApi config_get_config_deprecated GET /configs/{tenantId}/{userId}/{configId} Gets an existing config for the specified tenant and user.
ConfigApi config_get_config_names GET /configs/{tenantId}/names This method returns a list of config names for the specified config type, optionally along with the most recent config ID and user ID of each config name. It also returns the names of the default configs which are part of the specified sim version.
ConfigApi config_get_config_sub_paths GET /configs/{tenantId}/component-paths Gets all the unique component paths for the specified tenant and config type.
ConfigApi config_get_config_versions GET /configs/{tenantId}/{configId}/versions Gets the version history of an existing config. Note that we do not keep a complete version history, so the returned list of versions may not be exhaustive.
ConfigApi config_get_config_versions_deprecated GET /configs/{tenantId}/{userId}/{configId}/versions Gets the versions of an existing config for the specified tenant and user.
ConfigApi config_get_config_without_user_id_deprecated GET /configs/{tenantId}/auto/{configId} Gets an existing config for the specified tenant without specifying a user ID.
ConfigApi config_get_configs GET /configs/{tenantId} Given the provided filter information, this method returns: - a list of configs (metadata only) - a list of custom property groups ResultType can be used to specify which of the above lists to return. The list of configs may contain a continuation token of more results are available. The continuation token can be passed into a subsequent query as part of the filter to retrieve the next page of results. The list of custom property groups is not guaranteed to be complete. It is a best effort.
ConfigApi config_post_config POST /configs/{tenantId} Creates a new config for the specified tenant.
ConfigApi config_post_config_deprecated POST /configs/{tenantId}/{userId} Creates a new config for the specified tenant and user.
ConfigApi config_post_configs POST /configs/{tenantId}/batch Creates multiple new configs for the specified tenant.
ConfigApi config_post_configs_deprecated POST /configs/{tenantId}/{userId}/batch Creates multiple new configs for the specified tenant and user.
ConfigApi config_put_config PUT /configs/{tenantId}/{configId} Updates an existing config for the specified tenant.
ConfigApi config_put_config_deprecated PUT /configs/{tenantId}/{userId}/{configId} Updates an existing config for the specified tenant and user.
ConfigApi config_put_config_owner PUT /configs/{tenantId}/{configId}/owner Updates the owner of an existing config.
ConfigApi config_upgrade_config POST /configs/upgrade/{tenantId}/{targetSimVersion} Upgrades the config data to the specified target simulation version.
ConfigApi config_upgrade_config_deprecated POST /configs/upgrade/{targetSimVersion} Upgrades the config data to the specified target simulation version.
DeploymentsApi deployments_create_deployment POST /deployments Creates a new deployment.
DeploymentsApi deployments_get_account_features GET /deployments/features Gets a list of all account features.
DeploymentsApi deployments_get_deployment GET /deployments/{deploymentId} Gets metadata about the specified deployment.
DeploymentsApi deployments_get_deployments GET /deployments Gets a list of all deployments.
DeploymentsApi deployments_get_invoice_bot_deployments GET /deployments/invoicebot Gets a list of deployments for invoice bot processing.
DeploymentsApi deployments_get_subscription_level GET /deployments/subscription-levels/{subscriptionLevelId} Gets metadata about the specified subscription level.
DeploymentsApi deployments_get_subscription_levels GET /deployments/subscription-levels Gets a list of all subscription levels.
DeploymentsApi deployments_post_deployment_note POST /deployments/{deploymentId}/notes Adds a note to the specified deployment.
DeploymentsApi deployments_update_deployment PUT /deployments/{deploymentId} Updates the specified deployment.
DeploymentsApi deployments_update_invoice_bot_deployment PATCH /deployments/{deploymentId}/invoicebot Updates invoice bot fields for the specified deployment.
DeploymentsApi deployments_update_subscription_level PUT /deployments/subscription-levels/{id} Updates the specified subscription level.
EncryptionApi encryption_decrypt POST /encryption/decrypt Decrypts the specified data.
EncryptionApi encryption_delete_config_permission DELETE /encryption/config-permissions/{tenantId}/{encryptingTenantShortName}/{decryptingTenantShortName} Deletes an encryption key permission for the specified tenant. Config permissions represent which encryption keys are allowed to be used by which tenants to re-encrypt any encrypted configs you provide.
EncryptionApi encryption_delete_key_permission DELETE /encryption/key-permissions/{tenantId}/{encryptingTenantShortName} Deletes an encryption key permission for the specified tenant. Key permissions represent which tenants are allowed to use your tenant's encryption key.
EncryptionApi encryption_encrypt POST /encryption/encrypt Encrypts the specified data.
EncryptionApi encryption_get_config_permissions GET /encryption/config-permissions/{tenantId} Get the list of encryption config permissions for the specified tenant. Config permissions represent which encryption keys are allowed to be used by which tenants to re-encrypt any encrypted configs you provide.
EncryptionApi encryption_get_key_permissions GET /encryption/key-permissions/{tenantId} Get the list of encryption key permissions for the specified tenant. Key permissions represent which tenants are allowed to use your tenant's encryption key.
EncryptionApi encryption_put_config_permission PUT /encryption/config-permissions/{tenantId}/{encryptingTenantShortName}/{decryptingTenantShortName} Adds or replaces an encryption config permission for the specified tenant. Config permissions represent which encryption keys are allowed to be used by which tenants to re-encrypt any encrypted configs you provide.
EncryptionApi encryption_put_key_permission PUT /encryption/key-permissions/{tenantId}/{encryptingTenantShortName} Adds or replaces an encryption key permission for the specified tenant. Key permissions represent which tenants are allowed to use your tenant's encryption key.
EncryptionApi encryption_query POST /encryption/query/{tenantId} Queries the supplied data to determine what encryption keys can be used to re-encrypt it. Internally, the API will find all encrypted components in the car (including recursively encrypted ones) and note the tenant IDs which encrypted them. - For each of those encrypting tenant IDs it will search their permission lists to find any decrypting tenant IDs who have been granted permission by the encrypting tenant for their keys to be used by the config owner tenant. - For each decrypting tenant ID it will also search their permission list to ensure permission has also been granted by the decrypting tenant for their key to be used by the config owner.
EncryptionApi encryption_re_encrypt POST /encryption/re-encrypt/{tenantId} Re-encrypts the specified data. The data structure will be searched for encrypted nodes, and any found will be re-encrypted using the encryption key for the tenant / sim version combination specified in the request body. If either the decrypting tenant doesn't exist, or if the tenant ID parameter does not have the required permissions to use that encryption key, then the method will fail as a bad request.
EndToEndTestInboxApi end_to_end_test_inbox_get_latest_message_and_clear_mailbox GET /test-mailboxes/{mailboxName} Returns the latest message and clears the inbox.
ListFilterApi list_filter_upgrade_list_filter GET /list-filters/upgrade Upgrades a list filter from the old format to the new format. This is used to upgrade list filters that were created before the new format, supporting more complex queries, was introduced.
MembershipApi membership_delete_refresh_tokens DELETE /membership/refresh-tokens/{tenantId}/{userId} Clears all refresh tokens for the specified user. This forces all clients to re-authenticate.
MembershipApi membership_get_password_reset_token_validity GET /membership/password-reset-tokens/{userId} Checks the validity of a password reset token.
MembershipApi membership_get_user_roles GET /membership/roles/{tenantId}/{userId} Gets the specified user's roles.
MembershipApi membership_get_zendesk_token GET /membership/zendesk-token/{tenantId}/{userId} Gets the specified user's Zendesk token. This is used to provide SSO with Zendesk.
MembershipApi membership_post_email_confirmation POST /membership/email-confirmations Posts an email address confirmation. If successful, the user's email address will have been confirmed.
MembershipApi membership_post_email_confirmation_request POST /membership/email-confirmation-requests/{tenantId}/{userId} Request an email address confirmation for a user. This sends an email to the user which they can use to confirm their email address.
MembershipApi membership_post_initialize POST /membership/initialize This method performs some initialization tasks on a new instance of the platform, and does nothing on existing instances.
MembershipApi membership_post_password_reset_confirmation POST /membership/password-reset-confirmations Confirms a password reset for a user.
MembershipApi membership_post_password_reset_request POST /membership/password-reset-requests Requests a password reset for a user. If the user exists they will be send a password reset email containing a link they can click on to reset their password. If the user does not exist, nothing happens.
MembershipApi membership_post_registration POST /membership/registrations Registers a new user on the platform.
MembershipApi membership_put_user_role PUT /membership/roles/{tenantId}/{userId} Adds or removes a user role from the specified user.
MultiFactorAuthenticationApi multi_factor_authentication_get_multi_factor_authentication_code GET /mfa/{tenantId}/{userId}
MultiFactorAuthenticationApi multi_factor_authentication_post_multi_factor_authentication POST /mfa/{tenantId}/{userId}
PoolApi pool_get_pool_status GET /pools/{tenantId} Gets the status of a pool.
PoolApi pool_get_pools GET /pools Gets the status of all pools.
PoolApi pool_get_test_auto_scale_formula GET /pools/{tenantId}/autoscale/test Tests an auto-scale formula on a specific pool without applying it.
SimVersionApi sim_version_get_document GET /sim-versions/{simVersion}/documents/{documentPath} Gets a specific document associated with the specified sim version and tenant.
SimVersionApi sim_version_get_documents GET /sim-versions/{simVersion}/documents Gets the list of documents associated with the specified sim version and tenant.
SimVersionApi sim_version_get_downloads GET /sim-versions/{simVersion}/downloads Gets the downloads for the specified sim version and tenant. Downloads could include DiL models, or SimLauncherLocal.
SimVersionApi sim_version_get_sim_version GET /sim-versions/current Gets the sim version for a specific tenant. This will be the global sim version if the tenant doesn't have a specific sim version set, otherwise it will be the tenant specific sim version. Note that user sim versions are implemented purely as a front-end feature, so this method will always return the tenant sim version.
SimVersionApi sim_version_get_wiki_document GET /sim-versions/{wikiVersion}/wiki/{documentPath} Gets a document from the wiki associated with the specified sim version and tenant. Note that the wiki used to contain all our documentation, but now only contains sim version descriptions. The documentation has been moved to the new support platform.
SimVersionApi sim_version_post_sim_version POST /sim-versions/current Updates the global sim version for the platform. This is the default sim version which will be used if a user hasn't got a specific tenant or user sim version set.
StudyApi study_delete_study DELETE /studies/{tenantId}/{studyId} Deletes a study. If the study is in progress it will be aborted, although this may not immediately free up the nodes.
StudyApi study_delete_study_deprecated DELETE /studies/{tenantId}/{userId}/{studyId}
StudyApi study_get_all_tenants_study_statistics GET /studies/statistics Returns study statistics for all tenants.
StudyApi study_get_job_full_download GET /studies/{tenantId}/{studyId}/jobs/{jobId}/download/full Downloads complete job data as a ZIP file. This includes all inputs and results for a specific job.
StudyApi study_get_job_vector_download GET /studies/{tenantId}/{studyId}/jobs/{jobId}/download/vector/{simType} Downloads job vector results for a specific simulation type as CSV. This provides time-series data for the specified sim type.
StudyApi study_get_sim_type GET /studies/types/sims/{simType} Gets information about a specific sim type for a tenant. This returns a subset of the data from the GetStudyTypes method.
StudyApi study_get_studies GET /studies/{tenantId} Gets the list of studies for a tenant. The results will be paged.
StudyApi study_get_study GET /studies/{tenantId}/{studyId} Gets the specified study data. Note that this does not return the study results, but it returns the access signatures necessary to download the results. It also returns mapping from relevant tenant and user IDs to their names.
StudyApi study_get_study_deprecated GET /studies/{tenantId}/{userId}/{studyId}
StudyApi study_get_study_download GET /studies/{tenantId}/{studyId}/download Downloads a ZIP file containing the requested study data. It primarily exists for use by web browsers, which can't provide the authentication headers and so must pass in an access signature instead. If you are using this API method outside of the web browser, there is probably a better way to download the required data. Note: For the fastest and most reliable way to download studies, look in the documentation for "Download Tokens". This method, while more convenient than Download Tokens, can be unreliable for large studies as any connection issues can result in a truncated download. The URL containing the required access signature can be obtained using the GetStudyDownloadUrlAsync (`download-url`) method. When downloading study results programmatically it is faster and more efficient to read the required data directly from blob storage.
StudyApi study_get_study_download_deprecated GET /studies/{tenantId}/{userId}/{studyId}/download
StudyApi study_get_study_download_url GET /studies/{tenantId}/{studyId}/download-url Gets the access signature and expiry to enable the browser to download a study. This works around the fact that browsers can't provide authentication headers when downloading.
StudyApi study_get_study_download_url_deprecated GET /studies/{tenantId}/{userId}/{studyId}/download-url
StudyApi study_get_study_full_download GET /studies/{tenantId}/{studyId}/download/full Downloads the complete study including all jobs and results as a ZIP file. This is the recommended endpoint for downloading everything in a study.
StudyApi study_get_study_job GET /studies/{tenantId}/{studyId}/jobs/{jobId} Gets a study job, including the inputs and a mapping of relevant tenant and user IDs to their names.
StudyApi study_get_study_job_count POST /studies/{tenantId}/jobs-count Gets the Variations Count for a study without scheduling it.
StudyApi study_get_study_job_deprecated GET /studies/{tenantId}/{userId}/{studyId}/jobs/{jobId}
StudyApi study_get_study_job_download GET /studies/{tenantId}/{studyId}/jobs/{jobId}/download Downloads a ZIP file containing the requested study data. This method primarily exists for use by web browsers, which can't provide the authentication headers and so must pass in an access signature instead. If you are using this API method outside of the web browser, there is probably a better way to download the required data. Note: For the fastest and most reliable way to download studies, look in the documentation for "Download Tokens". This method, while more convenient than Download Tokens, can be unreliable for large studies as any connection issues can result in a truncated download. The URL containing the required access signature can be obtained using the GetStudyDownloadUrlAsync (`download-url`) method. When downloading study results programmatically it is faster and more efficient to read the required data directly from blob storage.
StudyApi study_get_study_job_download_deprecated GET /studies/{tenantId}/{userId}/{studyId}/jobs/{jobId}/download
StudyApi study_get_study_job_metadata GET /studies/{tenantId}/{studyId}/jobs/{jobId}/metadata Gets the metadata for a study job, which excludes certain information such as the job inputs to keep the data smaller.
StudyApi study_get_study_job_metadata_deprecated GET /studies/{tenantId}/{userId}/{studyId}/jobs/{jobId}/metadata
StudyApi study_get_study_jobs GET /studies/{tenantId}/{studyId}/jobs Gets the list of study jobs for a study. The results may be paged.
StudyApi study_get_study_jobs_deprecated GET /studies/{tenantId}/{userId}/{studyId}/jobs
StudyApi study_get_study_merged_scalar_download GET /studies/{tenantId}/{studyId}/download/scalar/merged Downloads merged scalar results as a single CSV file. This contains all scalar results merged into one file by the post-processor.
StudyApi study_get_study_metadata GET /studies/{tenantId}/{studyId}/metadata Gets the metadata for a study, which excludes certain information such as the study definition to keep the data smaller.
StudyApi study_get_study_metadata_deprecated GET /studies/{tenantId}/{userId}/{studyId}/metadata
StudyApi study_get_study_metadata_without_user_id_deprecated GET /studies/{tenantId}/auto/{studyId}/metadata
StudyApi study_get_study_scalar_download GET /studies/{tenantId}/{studyId}/download/scalar Downloads study scalar results as a ZIP file containing individual job results. Use /download/scalar/merged for a single merged CSV file.
StudyApi study_get_study_type GET /studies/types/{studyType} Gets a study type definition for a tenant.
StudyApi study_get_study_types GET /studies/types Gets the study type information for a specific tenant. This method also returns information about the simulations and config types which are indirectly available to the tenant through their set of study types.
StudyApi study_get_study_without_user_id_deprecated GET /studies/{tenantId}/auto/{studyId}
StudyApi study_get_tenant_access_information GET /studies/{tenantId}/access Gets the URL and shared access signature for a tenant's primary blob storage container.
StudyApi study_get_tenant_billable_stored_simulation_count GET /studies/statistics/stored/{tenantId} Gets the number of billable stored simulations for a tenant.
StudyApi study_get_tenant_study_statistics GET /studies/statistics/{tenantId} Returns the study statistics for a tenant.
StudyApi study_merge_study PATCH /studies/{tenantId}/{studyId}/merge Merges a study baseline definition into the main study document. This is used by Canopy personnel only.
StudyApi study_merge_study_deprecated PATCH /studies/{tenantId}/{userId}/{studyId}/merge
StudyApi study_post_study POST /studies/{tenantId} Creates a new study which will be scheduled to run on the platform. The study will not be complete when this method returns, but you can use the returned Study ID to poll the status of the study.
StudyApi study_post_study_deprecated POST /studies/{tenantId}/{userId}
StudyApi study_put_study PUT /studies/{tenantId}/{studyId} Updates a previously created study. This can be used to rename a study, or to add custom properties or notes. If any data isn't provided then it will be removed from the study.
StudyApi study_put_study_deprecated PUT /studies/{tenantId}/{userId}/{studyId}
StudyApi study_put_study_owner PUT /studies/{tenantId}/{studyId}/owner Changes the owner of a study. This can be called while the study is still in progress.
StudyApi study_put_study_priority PUT /studies/{tenantId}/{studyId}/priority Set the highest priority for a running study.
SupportSessionApi support_session_get_all_support_sessions GET /support-sessions/all Returns all the open support sessions on the platform.
SupportSessionApi support_session_get_support_session GET /support-sessions/{tenantId}/{documentId} Gets the support session for the specified document (config, study or worksheet).
SupportSessionApi support_session_get_support_session_deprecated GET /support-sessions/{tenantId}/{userId}/{documentId}
SupportSessionApi support_session_put_support_session PUT /support-sessions/{tenantId}/{documentId} Updates the support session for the specified document (config, study or worksheet). Note that messages are now handled by Zendesk, and this method is now only used to open or close a support session.
SupportSessionApi support_session_put_support_session_deprecated PUT /support-sessions/{tenantId}/{userId}/{documentId}
TenancyApi tenancy_delete_tenant DELETE /tenants/{tenantId} Deletes the specified tenant. This is irreversible. This will delete the tenant's document database, then all their blob storage containers, and finally it will remove the tenant from the authentication database. The data will not be recoverable. This method can only be called once all the tenant's users have been deleted.
TenancyApi tenancy_get_tenant GET /tenants/{tenantId} Gets metadata about the specified tenant.
TenancyApi tenancy_get_tenant_users GET /tenants/{tenantId}/users Gets the list of users for the specified tenant.
TenancyApi tenancy_get_tenants GET /tenants Gets metadata about all tenants.
TenancyApi tenancy_post_tenant POST /tenants Creates a new tenant in the specified region, including a new database if necessary.
TenancyApi tenancy_put_tenant PUT /tenants/{tenantId} Updates the specified tenant.
TenantSettingsApi tenant_settings_get_admin_tenant_settings GET /tenant-settings/admin/{tenantId} Gets the administrative tenant settings. These are only available to Canopy personnel.
TenantSettingsApi tenant_settings_get_tenant_channel_import_mappings GET /tenant-settings/channel-import-mappings/{tenantId} Gets the tenant channel import mappings, which specify how to map channels when importing telemetry.
TenantSettingsApi tenant_settings_get_tenant_channel_whitelists GET /tenant-settings/channel-whitelists/{tenantId} Gets the channel whitelists for the specified tenant. The tenant channel whitelist specifies which channels are always whitelisted when using that tenant's encrypted components.
TenantSettingsApi tenant_settings_get_tenant_default_custom_property_names GET /tenant-settings/default-custom-property-names/{tenantId} Gets the default custom property names for the specified tenant. The default custom property names will be shown by default when using the specified config.
TenantSettingsApi tenant_settings_get_tenant_settings_sim_version GET /tenant-settings/sim-version/{tenantId} Gets the tenant sim version. This is the default sim version for the tenant, unless overridden in an API call. If no sim version is specified, then the platform default sim version is used.
TenantSettingsApi tenant_settings_get_tenant_worksheet_label_definitions GET /tenant-settings/worksheet-label-definitions/{tenantId} Gets the tenant's worksheet label definitions. These specify what worksheet labels to show for all users in the tenant.
TenantSettingsApi tenant_settings_put_admin_tenant_settings PUT /tenant-settings/admin/{tenantId} Updates the administrative tenant settings. The provided ETag ensures that the settings have not been updated since they were last retrieved.
TenantSettingsApi tenant_settings_put_tenant_channel_import_mappings PUT /tenant-settings/channel-import-mappings/{tenantId} Updates the tenant channel import mappings, which specify how to map channels when importing telemetry.
TenantSettingsApi tenant_settings_put_tenant_channel_whitelists PUT /tenant-settings/channel-whitelists/{tenantId} Update the whitelist of channels for the specified tenant. The tenant channel whitelist specifies which channels are always whitelisted when using that tenant's encrypted components.
TenantSettingsApi tenant_settings_put_tenant_default_custom_property_names PUT /tenant-settings/default-custom-property-names/{tenantId} Updates the default custom property names for the specified tenant. The default custom property names will be shown by default when using the specified config.
TenantSettingsApi tenant_settings_put_tenant_settings_sim_version PUT /tenant-settings/sim-version/{tenantId} Updates the tenant sim version. This is the default sim version for the tenant, unless overridden in an API call. If no sim version is specified, then the platform default sim version is used.
TenantSettingsApi tenant_settings_put_tenant_worksheet_label_definitions PUT /tenant-settings/worksheet-label-definitions/{tenantId} Updates the tenant's worksheet label definitions. These specify what worksheet labels to show for all users in the tenant.
TokenApi token_post_token POST /token Gets a token for the specified user.
UserSettingsApi user_settings_get_user_settings GET /user-settings/{tenantId}/{userId} Gets the specified user settings.
UserSettingsApi user_settings_put_user_settings PUT /user-settings/{tenantId}/{userId} Updates the specified user settings.
WorksheetApi worksheet_get_worksheet GET /worksheets/{tenantId}/{worksheetId} Gets a worksheet, including all resolved references and labels.
WorksheetApi worksheet_post_duplicate_configs POST /worksheets/{tenantId}/{worksheetId}/duplicate Duplicates the specified set of configs from the (optional) source worksheet to the target worksheet.
WorksheetApi worksheet_post_worksheet POST /worksheets/{tenantId} Creates a new worksheet.
WorksheetApi worksheet_put_worksheet PUT /worksheets/{tenantId}/{worksheetId} Updates a worksheet.

Documentation For Models

Documentation For Authorization

Bearer

Author