SYSNET DDA Client

The 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 the Swagger Codegen project:

• API version: 9.0.1
• Package version: 1.0.1
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

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

pip install sysnet-dda

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

Then import the package:

import dda

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 dda

Getting Started

Please follow the installation procedure and then run the following:

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

# Configure HTTP basic authorization: basic
configuration = dda.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
configuration.host = 'https://domino.example.com'

# create an instance of the API class
api_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)
except ApiException as e:
    print("Exception when calling AgentApi->folder_database_api_data_agentjobs_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost

Documentation For Models

• Agent
• AgentJob
• AgentListResponse
• Database
• DatabaseListResponse
• Document
• DocumentListEntry
• DocumentListResponse
• FolderOperations
• Form
• FormListResponse
• Link
• View
• ViewColumnDesign
• ViewDesignResponse
• ViewEntry
• ViewEntryListResponse
• ViewListResponse

Documentation For Authorization

basic

• Type: HTTP basic authentication

Author