deep-lynx 0.1.3

Deep Lynx Python SDK

This is an autogenerated file
Please see the official README for information on contributing, testing, installing, uploading to PyPi, as well as correctly formatted examples.

deep_lynx

The construction of megaprojects has consistently demonstrated challenges for project managers in regard to meeting cost, schedule, and performance requirements. Megaproject construction challenges are common place within megaprojects with many active projects in the United States failing to meet cost and schedule efforts by significant margins. Currently, engineering teams operate in siloed tools and disparate teams where connections across design, procurement, and construction systems are translated manually or over brittle point-to-point integrations. The manual nature of data exchange increases the risk of silent errors in the reactor design, with each silent error cascading across the design. These cascading errors lead to uncontrollable risk during construction, resulting in significant delays and cost overruns. Deep Lynx allows for an integrated platform during design and operations of mega projects. The Deep Lynx Core API delivers a few main features. 1. Provides a set of methods and endpoints for manipulating data in an object oriented database. This allows us to store complex datatypes as records and then to compile them into actual, modifiable objects at run-time. Users can store taxonomies or ontologies in a readable format. 2. Provides methods for storing and retrieving data in a graph database. This data is structured and validated against the aformentioned object oriented database before storage.

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

• API version: 1.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/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 deep_lynx 

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 deep_lynx

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import deep_lynx
from deep_lynx.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = deep_lynx.AuthenticationApi(deep_lynx.ApiClient(configuration))
body = deep_lynx.TokenExchangeRequest() # TokenExchangeRequest |  (optional)

try:
    # Exchange OAuth Token
    api_response = api_instance.exchange_o_auth_token(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->exchange_o_auth_token: %s\n" % e)


# create an instance of the API class
api_instance = deep_lynx.AuthenticationApi(deep_lynx.ApiClient(configuration))
x_api_key = 'x_api_key_example' # str | The API key
x_api_secret = 'x_api_secret_example' # str | The API secret
x_api_expiry = 'x_api_expiry_example' # str | The API expiry date (optional)

try:
    # Retrieve OAuth Token
    api_response = api_instance.retrieve_o_auth_token(x_api_key, x_api_secret, x_api_expiry=x_api_expiry)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->retrieve_o_auth_token: %s\n" % e)


# create an instance of the API class
api_instance = deep_lynx.AuthenticationApi(deep_lynx.ApiClient(configuration))
body = deep_lynx.RSACancelRequest() # RSACancelRequest |  (optional)

try:
    # RSA Cancel
    api_response = api_instance.rsa_cancel(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->rsa_cancel: %s\n" % e)


# create an instance of the API class
api_instance = deep_lynx.AuthenticationApi(deep_lynx.ApiClient(configuration))
body = deep_lynx.RSAInitRequest() # RSAInitRequest |  (optional)

try:
    # RSA Initialize
    api_response = api_instance.rsa_initialize(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->rsa_initialize: %s\n" % e)


# create an instance of the API class
api_instance = deep_lynx.AuthenticationApi(deep_lynx.ApiClient(configuration))
body = deep_lynx.RSAStatusRequest() # RSAStatusRequest |  (optional)

try:
    # RSA Status
    api_response = api_instance.rsa_status(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->rsa_status: %s\n" % e)


# create an instance of the API class
api_instance = deep_lynx.AuthenticationApi(deep_lynx.ApiClient(configuration))
body = deep_lynx.RSAVerifyRequest() # RSAVerifyRequest |  (optional)

try:
    # RSA Verify
    api_response = api_instance.rsa_verify(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->rsa_verify: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8090

Class	Method	HTTP request	Description
AuthenticationApi	exchange_o_auth_token	POST /oauth/exchange	Exchange OAuth Token
AuthenticationApi	retrieve_o_auth_token	GET /oauth/token	Retrieve OAuth Token
AuthenticationApi	rsa_cancel	POST /rsa/cancel	RSA Cancel
AuthenticationApi	rsa_initialize	POST /rsa/initialize	RSA Initialize
AuthenticationApi	rsa_status	POST /rsa/status	RSA Status
AuthenticationApi	rsa_verify	POST /rsa/verify	RSA Verify
ContainersApi	archive_container	DELETE /containers/{container_id}	Archive Container
ContainersApi	container_batch_update	PUT /containers	Container Batch Update
ContainersApi	create_container	POST /containers	Create Container
ContainersApi	import_container	POST /containers/import	Import Container
ContainersApi	list_containers	GET /containers	List Containers
ContainersApi	repair_container_permissions	POST /containers/{container_id}/permissions	Repair Container Permissions
ContainersApi	retrieve_container	GET /containers/{container_id}	Retrieve Container
ContainersApi	set_container_active	POST /containers/{container_id}/active	Set Container Active
ContainersApi	update_container	PUT /containers/{container_id}	Update Container
ContainersApi	update_container_import	PUT /containers/import/{container_id}	Update Container Import
DataExportApi	create_data_export	POST /containers/{container_id}/data/export	Create Data Export
DataExportApi	delete_data_export	DELETE /containers/{container_id}/data/export/{export_id}	Delete Data Export
DataExportApi	list_data_exports	GET /containers/{container_id}/data/export	List Data Exports
DataExportApi	retrieve_data_export	GET /containers/{container_id}/data/export/{export_id}	Retrieve Data Export
DataExportApi	start_data_export	POST /containers/{container_id}/data/export/{export_id}	Start Data Export
DataExportApi	stop_data_export	PUT /containers/{container_id}/data/export/{export_id}	Stop Data Export
DataQueryApi	query_graph	POST /containers/{container_id}/query	Query Graph
DataSourcesApi	archive_data_source	DELETE /containers/{container_id}/import/datasources/{data_source_id}	Archive Data Source
DataSourcesApi	create_data_source	POST /containers/{container_id}/import/datasources	Create Data Source
DataSourcesApi	create_manual_import	POST /containers/{container_id}/import/datasources/{data_source_id}/imports	Create Manual Import
DataSourcesApi	download_file	GET /containers/{container_id}/files/{file_id}/download	Download File
DataSourcesApi	list_data_sources	GET /containers/{container_id}/import/datasources	List Data Sources
DataSourcesApi	list_imports_for_data_source	GET /containers/{container_id}/import/datasources/{data_source_id}/imports	List Imports for Data Source
DataSourcesApi	retrieve_data_source	GET /containers/{container_id}/import/datasources/{data_source_id}	Retrieve Data Source
DataSourcesApi	retrieve_file	GET /containers/{container_id}/files/{file_id}	Retrieve File
DataSourcesApi	set_data_source_active	POST /containers/{container_id}/import/datasources/{data_source_id}/active	Set Data Source Active
DataSourcesApi	set_data_source_configuration	PUT /containers/{container_id}/import/datasources/{data_source_id}	Set Data Source Configuration
DataSourcesApi	set_data_source_inactive	DELETE /containers/{container_id}/import/datasources/{data_source_id}/active	Set Data Source Inactive
DataSourcesApi	upload_file	POST /containers/{container_id}/import/datasources/{data_source_id}/files	Upload File
DataTypeMappingsApi	create_transformation	POST /containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}/transformations	Create Data Type Mapping's Transformations
DataTypeMappingsApi	delete_data_type_mapping	DELETE /containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}	Delete Data Type Mapping
DataTypeMappingsApi	delete_transformation	DELETE /containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}/transformations/{transformation_id}	Delete Data Type Mapping's Transformations
DataTypeMappingsApi	export_type_mappings	POST /containers/{container_id}/import/datasources/{data_source_id}/mappings/export	Export Type Mappings
DataTypeMappingsApi	import_data_type_mappings	POST /containers/{container_id}/import/datasources/{data_source_id}/mappings/import	Import Data Type Mappings
DataTypeMappingsApi	list_data_type_mappings	GET /containers/{container_id}/import/datasources/{data_source_id}/mappings	List Data Type Mappings
DataTypeMappingsApi	list_transformations	GET /containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}/transformations	List Data Type Mapping's Transformations
DataTypeMappingsApi	retrieve_data_type_mapping	GET /containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}	Retrieve Data Type Mapping
DataTypeMappingsApi	update_data_type_mapping	PUT /containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}	Update Data Type Mapping
DataTypeMappingsApi	update_transformation	PUT /containers/{container_id}/import/datasources/{data_source_id}/mappings/{mapping_id}/transformations/{transformation_id}	Update Data Type Mapping's Transformations
EventsApi	create_event	POST /events	Create Event
EventsApi	create_event_action	POST /event_actions	Create Event Action
EventsApi	delete_event_action	DELETE /event_actions/{action_id}	Delete Event Action
EventsApi	list_event_action_statuses	GET /event_action_status	List Event Action Statuses
EventsApi	list_event_actions	GET /event_actions	List Event Actions
EventsApi	list_events	GET /events	List Events
EventsApi	retrieve_event	GET /events/{event_id}	Retrieve Event
EventsApi	retrieve_event_action	GET /event_actions/{action_id}	Retrieve Event Action
EventsApi	retrieve_event_action_status	GET /event_action_status/{status_id}	Retrieve Event Action Status
EventsApi	update_event_action	PUT /event_actions/{action_id}	Update Event Action
EventsApi	update_event_action_status	PUT /event_action_status/{status_id}	Update Event Action Status
GraphApi	archive_edge	DELETE /containers/{container_id}/graphs/edges/{edge_id}	Archive Edge
GraphApi	archive_node	DELETE /containers/{container_id}/graphs/nodes/{node_id}	Archive Node
GraphApi	attach_edge_file	PUT /containers/{container_id}/graphs/edges/{edge_id}/files/{file_id}	Attach Edge File
GraphApi	attach_node_file	PUT /containers/{container_id}/graphs/nodes/{node_id}/files/{file_id}	Attach Node File
GraphApi	create_or_update_edges	POST /containers/{container_id}/graphs/edges	Create or Update Edges
GraphApi	create_or_update_nodes	POST /containers/{container_id}/graphs/nodes	Create Or Update Nodes
GraphApi	delete_node_file	DELETE /containers/{container_id}/graphs/nodes/{node_id}/files/{file_id}	Detach Node File
GraphApi	detach_node_file	DELETE /containers/{container_id}/graphs/edges/{edge_id}/files/{file_id}	Detach Node File
GraphApi	list_edge_files	GET /containers/{container_id}/graphs/edges/{edge_id}/files	List Edge Files
GraphApi	list_edges	GET /containers/{container_id}/graphs/edges	List Edges
GraphApi	list_node_files	GET /containers/{container_id}/graphs/nodes/{node_id}/files	List Node Files
GraphApi	list_nodes	GET /containers/{container_id}/graphs/nodes	List Nodes
GraphApi	list_nodes_by_metatype_id	GET /containers/{container_id}/graphs/nodes/metatype/{metatype_id}	List Nodes By Metatype ID
GraphApi	retrieve_edge	GET /containers/{container_id}/graphs/edges/{edge_id}	Retrieve Edge
GraphApi	retrieve_node	GET /containers/{container_id}/graphs/nodes/{node_id}	Retrieve Node
ImportsApi	add_data_to_import	POST /containers/{container_id}/datasources/{data_source_id}/imports/{import_id}/data	Add Data to Import
ImportsApi	create_import	POST /containers/{container_id}/datasources/{data_source_id}/imports	Create Import
ImportsApi	delete_import	DELETE /containers/{container_id}/import/imports/{import_id}	Delete Import
ImportsApi	delete_import_data	DELETE /containers/{container_id}/import/imports/{import_id}/data/{data_id}	Delete Import Data
ImportsApi	list_imports_data	GET /containers/{container_id}/import/imports/{import_id}/data	List Import's Data
ImportsApi	retrieve_import_data	GET /containers/{container_id}/import/imports/{import_id}/data/{data_id}	Retrieve Import Data
ImportsApi	update_import_data	PUT /containers/{container_id}/import/imports/{import_id}/data/{data_id}	Update Import Data
MetatypeKeysApi	archive_metatype_key	DELETE /containers/{container_id}/metatypes/{metatype_id}/keys/{key_id}	Archive Metatype Key
MetatypeKeysApi	create_metatype_key	POST /containers/{container_id}/metatypes/{metatype_id}/keys	Create Metatype Key
MetatypeKeysApi	list_metatypes_keys	GET /containers/{container_id}/metatypes/{metatype_id}/keys	List Metatype's Keys
MetatypeKeysApi	retrieve_metatype_key	GET /containers/{container_id}/metatypes/{metatype_id}/keys/{key_id}	Retrieve Metatype Key
MetatypeKeysApi	update_metatype_key	PUT /containers/{container_id}/metatypes/{metatype_id}/keys/{key_id}	Update Metatype Key
MetatypeRelationshipKeysApi	archive_metatype_relationship_key	DELETE /containers/{container_id}/metatype_relationships/{relationship_id}/keys/{key_id}	Archive Metatype Relationship Key
MetatypeRelationshipKeysApi	create_metatype_relationship_key	POST /containers/{container_id}/metatype_relationships/{relationship_id}/keys	Create Metatype Relationship Key
MetatypeRelationshipKeysApi	list_metatype_relationship_keys	GET /containers/{container_id}/metatype_relationships/{relationship_id}/keys	List Metatype Relationship Keys
MetatypeRelationshipKeysApi	retrieve_metatype_relationship_key	GET /containers/{container_id}/metatype_relationships/{relationship_id}/keys/{key_id}	Retrieve Metatype Relationship Key
MetatypeRelationshipKeysApi	update_metatype_relationship_key	PUT /containers/{container_id}/metatype_relationships/{relationship_id}/keys/{key_id}	Update Metaype Relationship Key
MetatypeRelationshipPairsApi	archive_metatype_relationship_pair	DELETE /containers/{container_id}/metatype_relationship_pairs/{pair_id}	Archive Metatype Relationship Pair
MetatypeRelationshipPairsApi	create_metatype_relationship_pair	POST /containers/{container_id}/metatype_relationship_pairs	Create Metatype Relationship Pair
MetatypeRelationshipPairsApi	list_metatype_relationship_pairs	GET /containers/{container_id}/metatype_relationship_pairs	List Metatype Relationship Pairs
MetatypeRelationshipPairsApi	retrieve_metatype_relationship_pair	GET /containers/{container_id}/metatype_relationship_pairs/{pair_id}	Retrieve Metatype Relationship Pair
MetatypeRelationshipPairsApi	update_metatype_relationship_pair	PUT /containers/{container_id}/metatype_relationship_pairs/{pair_id}	Update Metaype Relationship Pair
MetatypeRelationshipsApi	archive_metatype_relationship	DELETE /containers/{container_id}/metatype_relationships/{relationship_id}	Archive Metatype Relationship
MetatypeRelationshipsApi	create_metatype_relationship	POST /containers/{container_id}/metatype_relationships	Create Metatype Relationship
MetatypeRelationshipsApi	list_metatype_relationships	GET /containers/{container_id}/metatype_relationships	List Metatype Relationships
MetatypeRelationshipsApi	retrieve_metatype_relationship	GET /containers/{container_id}/metatype_relationships/{relationship_id}	Retrieve Metatype Relationship
MetatypeRelationshipsApi	update_metatype_relationship	PUT /containers/{container_id}/metatype_relationships/{relationship_id}	Update Metatype Relationship
MetatypesApi	archive_metatype	DELETE /containers/{container_id}/metatypes/{metatype_id}	Archive Metatype
MetatypesApi	create_metatype	POST /containers/{container_id}/metatypes	Create Metatype
MetatypesApi	list_metatypes	GET /containers/{container_id}/metatypes	List Metatypes
MetatypesApi	retrieve_metaype	GET /containers/{container_id}/metatypes/{metatype_id}	Retrieve Metatype
MetatypesApi	update_metatype	PUT /containers/{container_id}/metatypes/{metatype_id}	Update Metatype
MetatypesApi	validate_metatype_properties	POST /containers/{container_id}/metatypes/{metatype_id}	Validate Metatype Properties
MiscApi	health	GET /health	Health
TasksApi	create_task	POST /containers/{container_id}/task	Create Task
TasksApi	get_task	GET /containers/{container_id}/task/{task_id}	Get Task
TasksApi	list_tasks	GET /containers/{container_id}/task	List Tasks
TasksApi	update_task	PUT /containers/{container_id}/task/{task_id}	Update Task
UsersApi	accept_container_invite	GET /users/invite	Accept Container Invite
UsersApi	assign_user_role	POST /containers/{container_id}/users/roles	Assign User Role
UsersApi	delete_user	DELETE /users/{user_id}	Delete User
UsersApi	invite_user_to_container	POST /containers/{container_id}/users/invite	Invite User to Container
UsersApi	list_invited_users_for_container	GET /containers/{container_id}/users/invite	List Invited Users for Container
UsersApi	list_outstanding_invites	GET /users/invites	List Outstanding Invites
UsersApi	list_user_permissions	GET /users/permissions	List User Permissions
UsersApi	list_users	GET /users	List Users
UsersApi	list_users_for_container	GET /containers/{container_id}/users	List Users for Container
UsersApi	list_users_roles	GET /containers/{container_id}/users/{user_id}/roles	List User's Roles
UsersApi	retrieve_user	GET /containers/{container_id}/users/{user_id}	Retrieve User
UsersApi	update_user	PUT /users/{user_id}	Update User

Documentation For Models

• AddDataToImportResponse
• AssignRoleRequest
• BatchContainerUpdateRequest
• BatchContainerUpdateRequestInner
• BatchUpdateContainerResponse
• Container
• ContainerConfig
• ContainerImportRequest
• ContainerImportResponse
• ContainerImportUpdateResponse
• ContainerInvite
• CreateContainerRequest
• CreateContainerResponse
• CreateDataExportRequest
• CreateDataSourceConfig
• CreateDataSourceRequest
• CreateDataSourcesResponse
• CreateEventActionRequest
• CreateEventActionResponse
• CreateEventRequest
• CreateEventResponse
• CreateImportResponse
• CreateManualImport
• CreateManualImportResponse
• CreateMetatypeKeyRequest
• CreateMetatypeKeysResponse
• CreateMetatypeRelationshipKeyRequest
• CreateMetatypeRelationshipKeysResponse
• CreateMetatypeRelationshipPairRequest
• CreateMetatypeRelationshipPairsResponse
• CreateMetatypeRelationshipRequest
• CreateMetatypeRelationshipsResponse
• CreateMetatypeRequest
• CreateMetatypesResponse
• CreateOrUpdateEdgesRequest
• CreateOrUpdateNodesRequest
• CreateTaskResponse
• CreateTransformationResponse
• CreateTypeMappingTransformationsRequest
• DataExportConfig
• DataSource
• DataSourceConfig
• DataSourceIdFilesBody
• DataSourceIdImportsBody
• DataSourceImport
• DataStaging
• Edge
• ErrorModel
• ErrorResponse
• Event
• EventAction
• EventActionStatus
• Exporter
• ExporterConfig
• FileInfo
• FileModel
• Generic200Response
• GetContainerResponse
• GetDataExportResponse
• GetDataSourceResponse
• GetDataTypeMappingResponse
• GetEdgeResponse
• GetEventActionResponse
• GetEventActionStatusResponse
• GetEventResponse
• GetFileInfoResponse
• GetImportDataResponse
• GetMetatypeKeyResponse
• GetMetatypeRelationshipKeyResponse
• GetMetatypeRelationshipPairResponse
• GetMetatypeRelationshipResponse
• GetMetatypeResponse
• GetNodeResponse
• GetTaskResponse
• GetUserResponse
• ImportDataTypeMappingResponse
• ImportDataTypeMappingResponseInner
• ImportIdDataBody
• ImportModel
• InlineResponse200
• KeyValidation
• ListContainerInvitesResponse
• ListContainerResponse
• ListDataExportsResponse
• ListDataSourceImportsResponse
• ListDataSourcesResponse
• ListDataTypeMappingResponse
• ListEdgeFiles
• ListEdgesResponse
• ListEventActionResponse
• ListEventActionStatusResponse
• ListEventsResponse
• ListImportDataResponse
• ListMetatypeKeysResponse
• ListMetatypeRelationshipKeysResponse
• ListMetatypeRelationshipPairsResponse
• ListMetatypeRelationshipsResponse
• ListMetatypesResponse
• ListNodeFiles
• ListNodesByMetatypeResponse
• ListNodesResponse
• ListTasksResponse
• ListTransformationResponse
• ListUserInvitesResponse
• ListUserPermissionsResponse
• ListUserRoles
• ListUsersForContainerResponse
• ListUsersResponse
• MappingsImportBody
• Metatype
• MetatypeKey
• MetatypeRelationship
• Node
• NodeMetatypeBody
• NotFound404
• OneOfUploadFileResponse
• RSACancelRequest
• RSAInitRequest
• RSAResponse
• RSAResponseValue
• RSAResponseValueChallengeMethods
• RSAResponseValueChallengeMethodsChallenges
• RSAResponseValueChallengeMethodsPrompt
• RSAResponseValueChallengeMethodsRequiredMethods
• RSAResponseValueChallengeMethodsVersions
• RSAResponseValueContext
• RSAResponseValueCredentialValidationResults
• RSAStatusRequest
• RSAStatusResponse
• RSAVerifyRequest
• RelationshipKey
• RelationshipPair
• RelationshipPairDestinationMetatype
• Task
• TaskConfig
• TokenExchangeRequest
• Transformation
• TransformationCondition
• TransformationKey
• TypeMapping
• TypeMappingExportPayload
• UpdateContainerRequest
• UpdateContainerRequestConfig
• UpdateContainerResponse
• UpdateDataSourceResponse
• UpdateDataTypeMappingResponse
• UpdateEventActionResponse
• UpdateEventActionStatusRequest
• UpdateEventActionStatusResponse
• UpdateImportDataResponse
• UpdateMetatypeKeyResponse
• UpdateMetatypeRelationshipKeyResponse
• UpdateMetatypeRelationshipPairResponse
• UpdateMetatypeRelationshipRequest
• UpdateMetatypeRelationshipResponse
• UpdateMetatypeRequest
• UpdateMetatypeResponse
• UpdateTaskResponse
• UpdateTransformationResponse
• UploadFileResponse
• User
• UserKey
• ValidateMetatypePropertiesResponse

Documentation For Authorization

BearerAuth

Author