Package: dda
ddaThe data API provides access to any database for which it is enabled. The API represents databases, views, view entries, and documents in JSON format.Important: This version of the OpenAPI spec (data.yaml) includes data API changes from the XPages Extension Library release 9.0.1.v09_02. This  includes new operations on attachments, agents and forms.  If you are using a version before 9.0.1.v09_02, consider using an earlier version of the spec.This Python package is automatically generated by theSwagger Codegenproject:API version: 9.0.1Package version: 1.0.0Build package: io.swagger.codegen.languages.PythonClientCodegenRequirements.Python 2.7 and 3.4+Installation & Usagepip installIf the python package is hosted on Github, you can install directly from Githubpipinstallgit+https://github.com//.git(you may need to runpipwith root permission:sudo pip install git+https://github.com//.git)Then import the package:importddaSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importddaGetting StartedPlease follow theinstallation procedureand then run the following:from__future__importprint_functionimporttimeimportddafromdda.restimportApiExceptionfrompprintimportpprint# Configure HTTP basic authorization: basicconfiguration=dda.Configuration()configuration.username='YOUR_USERNAME'configuration.password='YOUR_PASSWORD'# create an instance of the API classapi_instance=dda.AgentApi(dda.ApiClient(configuration))folder='folder_example'# str | Database folder name relative to the Domino data directory.  If the database is not in a folder, use `.` to specify the data directory itself.database='database_example'# str | Database file name.agent_job=dda.AgentJob()# AgentJob | The agent job to execute.try:# Executes an agent.api_instance.folder_database_api_data_agentjobs_post(folder,database,agent_job)exceptApiExceptionase:print("Exception when calling AgentApi->folder_database_api_data_agentjobs_post:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttps://localhostClassMethodHTTP requestDescriptionAgentApifolder_database_api_data_agentjobs_postPOST/{folder}/{database}/api/data/agentjobsExecutes an agent.AgentApifolder_database_api_data_agents_agent_name_getGET/{folder}/{database}/api/data/agents/{agentName}Reads a list of agents.AgentListApifolder_database_api_data_agents_getGET/{folder}/{database}/api/data/agentsReads a list of agents.AttachmentApifolder_database_api_data_documents_unid_doc_unid_item_name_file_name_deleteDELETE/{folder}/{database}/api/data/documents/unid/{docUnid}/{itemName}/{fileName}Deletes an attachment.AttachmentApifolder_database_api_data_documents_unid_doc_unid_item_name_file_name_getGET/{folder}/{database}/api/data/documents/unid/{docUnid}/{itemName}/{fileName}Reads an attachment.AttachmentApifolder_database_api_data_documents_unid_doc_unid_item_name_file_name_putPUT/{folder}/{database}/api/data/documents/unid/{docUnid}/{itemName}/{fileName}Updates an attachment.AttachmentApifolder_database_api_data_documents_unid_doc_unid_item_name_postPOST/{folder}/{database}/api/data/documents/unid/{docUnid}/{itemName}Adds an attachment to an item in a document.DatabaseListApiapi_data_getGET/api/dataGets a list of databases.DocumentApifolder_database_api_data_documents_postPOST/{folder}/{database}/api/data/documentsCreates a new document.DocumentApifolder_database_api_data_documents_unid_doc_unid_deleteDELETE/{folder}/{database}/api/data/documents/unid/{docUnid}Deletes a document.DocumentApifolder_database_api_data_documents_unid_doc_unid_getGET/{folder}/{database}/api/data/documents/unid/{docUnid}Reads a document.DocumentApifolder_database_api_data_documents_unid_doc_unid_patchPATCH/{folder}/{database}/api/data/documents/unid/{docUnid}Updates selected items in a document.DocumentApifolder_database_api_data_documents_unid_doc_unid_putPUT/{folder}/{database}/api/data/documents/unid/{docUnid}Replaces all items in a document.DocumentListApifolder_database_api_data_documents_getGET/{folder}/{database}/api/data/documentsGets a list of documents.FolderApifolder_database_api_data_collections_name_view_name_putPUT/{folder}/{database}/api/data/collections/name/{viewName}Updates the contents of a folder by folder name.FolderApifolder_database_api_data_collections_unid_view_unid_putPUT/{folder}/{database}/api/data/collections/unid/{viewUnid}Updates the contents of a folder by folder UNID.FormListApifolder_database_api_data_forms_getGET/{folder}/{database}/api/data/formsReads a list of forms.ViewDesignApifolder_database_api_data_collections_name_view_name_design_getGET/{folder}/{database}/api/data/collections/name/{viewName}/designGets information on the columns in a view or folder.ViewDesignApifolder_database_api_data_collections_unid_view_unid_design_getGET/{folder}/{database}/api/data/collections/unid/{viewUnid}/designGets information on the columns in a view or folder.ViewEntryListApifolder_database_api_data_collections_name_view_name_getGET/{folder}/{database}/api/data/collections/name/{viewName}Gets a list of view entries by view name.ViewEntryListApifolder_database_api_data_collections_unid_view_unid_getGET/{folder}/{database}/api/data/collections/unid/{viewUnid}Gets a list of view entries by view UNID.ViewListApifolder_database_api_data_collections_getGET/{folder}/{database}/api/data/collectionsGets a list of views and folders in a database.Documentation For ModelsAgentAgentJobAgentListResponseDatabaseDatabaseListResponseDocumentDocumentListEntryDocumentListResponseFolderOperationsFormFormListResponseLinkViewViewColumnDesignViewDesignResponseViewEntryViewEntryListResponseViewListResponseDocumentation For AuthorizationbasicType: HTTP basic authenticationAuthor