python-rustici-engine-api

Rustici Engine API

This Python package is automatically generated by the Swagger Codegen project:

• API version: 2.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/Myagi/python-rustici-engine-api.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/Myagi/python-rustici-engine-api.git)

Then import the package:

import rustici_engine 

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 rustici_engine

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import rustici_engine
from rustici_engine.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = rustici_engine.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: oauth
configuration = rustici_engine.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = rustici_engine.AboutApi(rustici_engine.ApiClient(configuration))
engine_tenant_name = 'engine_tenant_name_example' # str | optional tenant for this request (optional)

try:
    # Get back the version and platform of the running instance of Engine
    api_response = api_instance.get_about(engine_tenant_name=engine_tenant_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AboutApi->get_about: %s\n" % e)
# Configure HTTP basic authorization: basic
configuration = rustici_engine.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: oauth
configuration = rustici_engine.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = rustici_engine.AboutApi(rustici_engine.ApiClient(configuration))
engine_tenant_name = 'engine_tenant_name_example' # str | optional tenant for this request (optional)
since = '2013-10-20T19:20:30+01:00' # datetime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. (optional)
until = '2013-10-20T19:20:30+01:00' # datetime | Only items updated up until the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. (optional)

try:
    # Gets the number of users for the specified tenant or across all tenants when none is specified
    api_response = api_instance.get_user_count(engine_tenant_name=engine_tenant_name, since=since, until=until)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AboutApi->get_user_count: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api/v2/

Class	Method	HTTP request	Description
AboutApi	get_about	GET /about	Get back the version and platform of the running instance of Engine
AboutApi	get_user_count	GET /about/userCount	Gets the number of users for the specified tenant or across all tenants when none is specified
AppManagementApi	create_credential	POST /appManagement/credentials	Create credential
AppManagementApi	create_or_update_tenant	PUT /appManagement/tenants/{tenantName}	Create or update tenant
AppManagementApi	create_token	POST /appManagement/token	Create token
AppManagementApi	delete_application_configuration_setting	DELETE /appManagement/configuration/{settingId}	Clears the `settingId` value for this level
AppManagementApi	delete_credential	DELETE /appManagement/credentials/{credentialId}	Removes `credentialId` credentials
AppManagementApi	delete_tenant	DELETE /appManagement/tenants/{tenantName}	Delete a tenant. Warning: If tenant data is not deleted first, this will leave orphaned rows that can only be deleted manually. Does not remove any data, but does remove mapping between name and key used to store data. Consider deactivating instead.
AppManagementApi	delete_tenant_data	DELETE /appManagement/tenants/{tenantName}/data	Delete all of a tenant's data.
AppManagementApi	get_application_configuration	GET /appManagement/configuration	Returns all configuration settings for this level
AppManagementApi	get_authenticated_credential	GET /appManagement/authenticatedCredential	Get information about the credential used to authenticate this request.
AppManagementApi	get_credential	GET /appManagement/credentials/{credentialId}	Get information on `credentialId` credential
AppManagementApi	get_credentials	GET /appManagement/credentials	List of credentials
AppManagementApi	get_pii_deletion_job	GET /appManagement/PII/deletionJob/{jobId}	Check the status of a PII deletion job with the provided job id.
AppManagementApi	get_tenant_list	GET /appManagement/tenants	Get list of all tenants
AppManagementApi	inspect_token	GET /appManagement/token	Inspect token
AppManagementApi	post_pii_deletion_job	POST /appManagement/PII/deletionJob	Initiate a job to delete a user's Personal Identifying Information from the system.
AppManagementApi	post_update_encrypted_setting	POST /appManagement/configuration/updateEncryptedSettings	Re-write settings, and statement pipe passwords using the current encryption settings. For password rotation.
AppManagementApi	reset_credential_secret	POST /appManagement/credentials/{credentialId}/resetSecret	Reset credential secret
AppManagementApi	set_application_configuration	POST /appManagement/configuration	Set configuration settings for this level.
AppManagementApi	update_credential	PUT /appManagement/credentials/{credentialId}	Update `credentialId` credentials
ContentConnectorsApi	create_connector	POST /contentConnectors	Create a connector
ContentConnectorsApi	get_connector_content_list	GET /contentConnectors/availableContent	Get list of available content
ContentConnectorsApi	get_connectors_list	GET /contentConnectors	Get content connectors
ContentConnectorsApi	get_refresh_job_status	GET /contentConnectors/availableContent/refreshJobs/{refreshJobId}	Check the status of a refresh job.
ContentConnectorsApi	refresh_connector_content_list_job	POST /contentConnectors/availableContent/refreshJobs	Start a job to refresh the list of available content
ContentConnectorsApi	search_remote_connector_content	POST /contentConnectors/remoteSearch	search remote content
ContentConnectorsApi	update_connector	PUT /contentConnectors/{connectorId}	Update a connector
CourseApi	build_course_preview_launch_link	POST /courses/{courseId}/preview	Returns the link to use to preview this course
CourseApi	build_course_preview_launch_link_with_version	POST /courses/{courseId}/versions/{versionId}/preview	Returns the link to use to preview this course
CourseApi	create_fetch_and_import_course_job	POST /courses/importJobs	Start a job to fetch and import a course.
CourseApi	create_upload_and_import_course_job	POST /courses/importJobs/upload	Upload a course and start an import job for it.
CourseApi	delete_course	DELETE /courses/{courseId}	Delete `courseId`
CourseApi	delete_course_configuration_setting	DELETE /courses/{courseId}/configuration/{settingId}	Clears the `settingId` value for this course
CourseApi	delete_course_version	DELETE /courses/{courseId}/versions/{versionId}	Delete version `versionId` of `courseId`
CourseApi	delete_course_version_configuration_setting	DELETE /courses/{courseId}/versions/{versionId}/configuration/{settingId}	Clears the `settingId` value for this course and version.
CourseApi	get_course	GET /courses/{courseId}	Get information about `courseId`
CourseApi	get_course_configuration	GET /courses/{courseId}/configuration	Returns all configuration settings for this course
CourseApi	get_course_statements	GET /courses/{courseId}/xAPIStatements	Get xAPI statements for `courseId`
CourseApi	get_course_version_configuration	GET /courses/{courseId}/versions/{versionId}/configuration	Returns all configuration settings for this course and version.
CourseApi	get_course_version_info	GET /courses/{courseId}/versions/{versionId}	Get version `versionId` of `courseId`
CourseApi	get_course_version_statements	GET /courses/{courseId}/versions/{versionId}/xAPIStatements	Get xAPI statements for version `versionId` of `courseId`
CourseApi	get_course_versions	GET /courses/{courseId}/versions	Get all versions of `courseId`
CourseApi	get_courses	GET /courses	Get a list of all courses for the specified tenant
CourseApi	get_import_job_status	GET /courses/importJobs/{importJobId}	Check the status of an import job.
CourseApi	import_course_without_upload	POST /courses	Create a course
CourseApi	set_course_configuration	POST /courses/{courseId}/configuration	Set configuration settings for this course.
CourseApi	set_course_title	PUT /courses/{courseId}/title	Sets the course title for `courseId`
CourseApi	set_course_version_configuration	POST /courses/{courseId}/versions/{versionId}/configuration	Set configuration settings for this course and version.
CourseApi	upload_and_import_course	POST /courses/upload	Upload a course to import
DispatchApi	create_destinations	POST /dispatch/destinations	Create multiple destinations
DispatchApi	create_dispatches	POST /dispatch/dispatches	Create multiple dispatches
DispatchApi	delete_destination	DELETE /dispatch/destinations/{destinationId}	Delete the destination with id `destinationId`
DispatchApi	delete_destination_dispatches	DELETE /dispatch/destinations/{destinationId}/dispatches	Delete all dispatches associated with this destination
DispatchApi	delete_dispatch	DELETE /dispatch/dispatches/{dispatchId}	Delete the dispatch with id `dispatchId`
DispatchApi	enable_registration_instancing	POST /dispatch/destinations/{destinationId}/dispatches/registrationInstancing	Enable or disable registration instancing
DispatchApi	get_destination	GET /dispatch/destinations/{destinationId}	Get the destination with id `destinationId`
DispatchApi	get_destination_dispatch_registration_count	GET /dispatch/destinations/{destinationId}/registrationCount	Get the registration count for all related dispatch registrations
DispatchApi	get_destination_dispatch_zip	GET /dispatch/destinations/{destinationId}/dispatches/zip	Get a ZIP file containing all dispatch packages related to a destination.
DispatchApi	get_destination_dispatches	GET /dispatch/destinations/{destinationId}/dispatches	Get a list of related dispatches
DispatchApi	get_destinations	GET /dispatch/destinations	Get a list of destinations
DispatchApi	get_dispatch	GET /dispatch/dispatches/{dispatchId}	Get the dispatch with id `dispatchId`
DispatchApi	get_dispatch_enabled	GET /dispatch/dispatches/{dispatchId}/enabled	Returns boolean indicating if dispatch with id `dispatchId` is enabled
DispatchApi	get_dispatch_registration_count	GET /dispatch/dispatches/{dispatchId}/registrationCount	Get the registration count for this dispatch, and the date and time of the last count reset, if any.
DispatchApi	get_dispatch_zip	GET /dispatch/dispatches/{dispatchId}/zip	Get the ZIP dispatch package.
DispatchApi	get_dispatches	GET /dispatch/dispatches	Get a list of dispatches
DispatchApi	get_lti_dispatch	GET /dispatch/dispatches/{dispatchId}/lti	Get the information necessary to launch this dispatch using the IMS LTI specification.
DispatchApi	post_dispatch_lti_reporters	POST /dispatch/ltiReporters	Set up a temporary LTI reporter; for use by products that use their own LTI entry points
DispatchApi	reset_destination_dispatch_registration_count	DELETE /dispatch/destinations/{destinationId}/registrationCount	Reset the registration count for related dispatches.
DispatchApi	reset_dispatch_registration_count	DELETE /dispatch/dispatches/{dispatchId}/registrationCount	Reset the registration count for this dispatch.
DispatchApi	set_destination	PUT /dispatch/destinations/{destinationId}	Create or update the destination with id `destinationId`
DispatchApi	set_destination_dispatch_enabled	POST /dispatch/destinations/{destinationId}/dispatches/enabled	Enable or disable all related dispatches
DispatchApi	set_dispatch_enabled	PUT /dispatch/dispatches/{dispatchId}/enabled	Enable or disable the dispatch
DispatchApi	update_dispatch	PUT /dispatch/dispatches/{dispatchId}	Update the dispatch with id `dispatchId`
PingApi	ping	GET /ping	Get back a message indicating that the API is working.
RegistrationApi	build_registration_launch_link	POST /registrations/{registrationId}/launchLink	Returns the link to use to launch this registration
RegistrationApi	create_new_registration_instance	POST /registrations/{registrationId}/instances	Create a new instance for this registration specified by the registration ID
RegistrationApi	create_registration	POST /registrations	Create a registration.
RegistrationApi	delete_registration	DELETE /registrations/{registrationId}	Delete `registrationId`
RegistrationApi	delete_registration_configuration_setting	DELETE /registrations/{registrationId}/configuration/{settingId}	Clears the `settingId` value for this registration
RegistrationApi	delete_registration_global_data	DELETE /registrations/{registrationId}/globalData	delete global data associated with `registrationId`
RegistrationApi	delete_registration_instance	DELETE /registrations/{registrationId}/instances/{instanceId}	Delete instance `instanceId` of `registrationId`
RegistrationApi	delete_registration_instance_configuration_setting	DELETE /registrations/{registrationId}/instances/{instanceId}/configuration/{settingId}	Clears the `settingId` value for this registration instance
RegistrationApi	delete_registration_progress	DELETE /registrations/{registrationId}/progress	delete registration progress (clear registration)
RegistrationApi	get_registration	HEAD /registrations/{registrationId}	Does this registration exist?
RegistrationApi	get_registration_configuration	GET /registrations/{registrationId}/configuration	Returns all configuration settings for this registration
RegistrationApi	get_registration_instance_configuration	GET /registrations/{registrationId}/instances/{instanceId}/configuration	Returns all configuration settings for this registration instance
RegistrationApi	get_registration_instance_launch_history	GET /registrations/{registrationId}/instances/{instanceId}/launchHistory	Returns history of this registration's launches
RegistrationApi	get_registration_instance_progress	GET /registrations/{registrationId}/instances/{instanceId}	Get registration progress for instance `instanceId` of `registrationId`
RegistrationApi	get_registration_instance_statements	GET /registrations/{registrationId}/instances/{instanceId}/xAPIStatements	Get xAPI statements for instance `instanceId` of `registrationId`
RegistrationApi	get_registration_instances	GET /registrations/{registrationId}/instances	Get all the instances of this the registration specified by the registration ID
RegistrationApi	get_registration_launch_history	GET /registrations/{registrationId}/launchHistory	Returns history of this registration's launches
RegistrationApi	get_registration_progress	GET /registrations/{registrationId}	Get registration progress for `registrationId`
RegistrationApi	get_registration_statements	GET /registrations/{registrationId}/xAPIStatements	Get xAPI statements for `registrationId`
RegistrationApi	get_registrations	GET /registrations	Gets a list of registrations including a summary of the status of each registration.
RegistrationApi	set_registration_configuration	POST /registrations/{registrationId}/configuration	Set configuration settings for this registration.
RegistrationApi	set_registration_instance_configuration	POST /registrations/{registrationId}/instances/{instanceId}/configuration	Set configuration settings for this registration instance.
XapiApi	create_statement_pipe	POST /xapi/statementPipes	Create an xAPI statement pipe.
XapiApi	create_xapi_credential	POST /xapi/credentials	Create an xAPI credential
XapiApi	delete_statement_pipe	DELETE /xapi/statementPipes/{statementPipeId}	Deletes the xAPI statement pipe specified with the id `statementPipeId`
XapiApi	delete_xapi_credential	DELETE /xapi/credentials/{xapiCredentialId}	Deletes the xAPI credential specified with the id `xapiCredentialId`
XapiApi	get_statement_pipe	GET /xapi/statementPipes/{statementPipeId}	Retrieves xAPI statement pipe specified by id `statementPipeId.`
XapiApi	get_statement_pipes	GET /xapi/statementPipes	Get a list of all xAPI statement pipes
XapiApi	get_xapi_credential	GET /xapi/credentials/{xapiCredentialId}	Retrieves the xAPI credential specified by id `xapiCredentialId`
XapiApi	get_xapi_credentials	GET /xapi/credentials	Get a list of all xAPI credentials
XapiApi	set_statement_pipe	PUT /xapi/statementPipes/{statementPipeId}	Either edits an existing xAPI statement pipe or creates a new one, specified by id `statementPipeId`
XapiApi	set_xapi_credential	PUT /xapi/credentials/{xapiCredentialId}	Either edits an existing xAPI credential or creates a new one, specified by id `xapiCredentialId`

Documentation For Models

• AboutSchema
• ActivityResultSchema
• CommentSchema
• CompletionAmountSchema
• ConnectorContentItemSchema
• ConnectorContentListEntrySchema
• ConnectorContentListSchema
• ConnectorContentSearchContextSchema
• ConnectorContentSearchSchema
• ConnectorListSchema
• ConnectorSchema
• ConnectorTypeSchema
• CourseActivitySchema
• CourseConnectorSchema
• CourseListNonPagedSchema
• CourseListSchema
• CourseReferenceSchema
• CourseSchema
• CreateConnectorSchema
• CreateDispatchIdSchema
• CreateDispatchListSchema
• CreateDispatchSchema
• CreateRegistrationSchema
• CredentialCreatedSchema
• CredentialListSchema
• CredentialRequestSchema
• CredentialSchema
• DestinationIdSchema
• DestinationListSchema
• DestinationSchema
• DispatchIdListSchema
• DispatchIdSchema
• DispatchListSchema
• DispatchLtiInfoSchema
• DispatchRegistrationCountSchema
• DispatchSchema
• EnabledSchema
• FormDataImportFile
• IdListSchema
• ImportAdHocReferenceRequestSchema
• ImportConnectorRequestSchema
• ImportFetchRequestSchema
• ImportJobResultSchema
• ImportMediaFileReferenceRequestSchema
• ImportReferenceRequestSchema
• ImportRequestSchema
• ImportResultSchema
• IntegerResultSchema
• ItemValuePairSchema
• LaunchHistoryListSchema
• LaunchHistorySchema
• LaunchLinkRequestSchema
• LaunchLinkSchema
• LaunchPageResponseSchema
• LearnerPreferenceSchema
• LearnerSchema
• LinkSchema
• LtiReporterIdSchema
• LtiReporterSchema
• MediaFileMetadataSchema
• MessageSchema
• MetadataSchema
• OAuthCredentialsSchema
• ObjectiveSchema
• PIIDeletionRequestResultSchema
• PIIDeletionRequestSchema
• PIIDeletionResultSchema
• PermissionsSchema
• PingSchema
• PluginVersionSchema
• PostBackSchema
• RefreshConnectorResultListSchema
• RefreshConnectorResultSchema
• RegistrationInstancingSchema
• RegistrationListSchema
• RegistrationSchema
• ReportingPluginSchema
• ResponseErrorSchema
• RuntimeInteractionSchema
• RuntimeObjectiveSchema
• RuntimeSchema
• ScoreSchema
• SettingListSchema
• SettingsIndividualSchema
• SettingsPostSchema
• SharedDataEntrySchema
• StaticPropertiesSchema
• StringResultSchema
• TenantListSchema
• TenantSchema
• TitleSchema
• TokenInfoSchema
• TokenRequestSchema
• UpdateConnectorSchema
• UpdateDispatchSchema
• UserCountDetailSchema
• UserCountSummarySchema
• XapiAccount
• XapiActivity
• XapiActivityDefinition
• XapiAgentGroup
• XapiAttachment
• XapiContext
• XapiContextActivity
• XapiCredentialAuthTypeSchema
• XapiCredentialPermissionsLevelSchema
• XapiCredentialPostSchema
• XapiCredentialPutSchema
• XapiCredentialSchema
• XapiCredentialsListSchema
• XapiEndpointSchema
• XapiInteractionComponent
• XapiResult
• XapiScore
• XapiSelfSourcedPipeSchema
• XapiStatement
• XapiStatementPipeListSchema
• XapiStatementPipePostSchema
• XapiStatementPipePutSchema
• XapiStatementPipeSchema
• XapiStatementReference
• XapiStatementResult
• XapiVerb

Documentation For Authorization

basic

• Type: HTTP basic authentication

oauth

• Type: OAuth
• Flow: implicit
• Authorization URL: /authorize
• Scopes:
• ****:

Author