swagger-client
Integration with AI Forged system
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 For more information, please visit https://www.aiforged.com
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 swagger_client
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 swagger_client
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.AIForgedViewModelsUserActivateViewModel() # AIForgedViewModelsUserActivateViewModel |
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Allow new user to Activate user account
api_response = api_instance.account_activate_account(body, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_activate_account: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | The user id (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Allow admin to Activate another user account
api_response = api_instance.account_activate_user(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_activate_user: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | The user id (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Unblock a user
api_response = api_instance.account_block_user(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_block_user: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.AIForgedViewModelsUserEditViewModel() # AIForgedViewModelsUserEditViewModel |
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Create a new user
api_response = api_instance.account_create(body, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_create: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | The user id (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Delete a user
api_response = api_instance.account_delete(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_delete: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.MicrosoftAspNetCoreIdentityUserLoginInfo() # MicrosoftAspNetCoreIdentityUserLoginInfo | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
user_id = 'user_id_example' # str | (optional)
try:
# Get list of current user login providers
api_response = api_instance.account_delete_user_login_provider(body=body, x_api_version=x_api_version, user_id=user_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_delete_user_login_provider: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Disable 2FA
api_response = api_instance.account_disable2_fa(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_disable2_fa: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | (optional)
provider = 'provider_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Enable 2FA
api_response = api_instance.account_enable2_fa(user_id=user_id, provider=provider, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_enable2_fa: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
filter = 'filter_example' # str | (optional)
group_id = 56 # int | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Find users
api_response = api_instance.account_find(filter=filter, group_id=group_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_find: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Enabled and Generate Authenticator Key
api_response = api_instance.account_generate_authenticator_key(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_generate_authenticator_key: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get 2FAProviders
api_response = api_instance.account_get2_fa_providers(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get2_fa_providers: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
group_id = 56 # int | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get all users
api_response = api_instance.account_get_all(group_id=group_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_all: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | The user API key (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get the API key for a user
api_response = api_instance.account_get_api_key(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_api_key: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get Authenticator Url
api_response = api_instance.account_get_authenticator_url(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_authenticator_url: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
userid = 'userid_example' # str | The user id (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get user by Id
api_response = api_instance.account_get_by_id(userid=userid, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_by_id: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_name = 'user_name_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get user info by username
api_response = api_instance.account_get_by_user_name(user_name=user_name, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_by_user_name: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get the current logged in user
api_response = api_instance.account_get_current_user(x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_current_user: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
filter = 'filter_example' # str | (optional)
page = -1 # int | (optional) (default to -1)
page_size = -1 # int | (optional) (default to -1)
group_id = 56 # int | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get users paged
api_response = api_instance.account_get_paged(filter=filter, page=page, page_size=page_size, group_id=group_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_paged: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
filter = 'filter_example' # str | (optional)
group_id = 56 # int | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get count of users
api_response = api_instance.account_get_user_count(filter=filter, group_id=group_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_user_count: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get list of current user login providers
api_response = api_instance.account_get_user_login_providers(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_get_user_login_providers: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.AIForgedViewModelsUserEditViewModel() # AIForgedViewModelsUserEditViewModel | New user info
x_api_version = 'x_api_version_example' # str | (optional)
user_id = 'user_id_example' # str | The user id (optional)
role_id = 56 # int | (optional)
try:
# Create a new user int a group
api_response = api_instance.account_group_create(body, x_api_version=x_api_version, user_id=user_id, role_id=role_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_group_create: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Log out the current user
api_response = api_instance.account_logout(x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_logout: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.AIForgedViewModelsUserPasswordResetViewModel() # AIForgedViewModelsUserPasswordResetViewModel |
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Reset a password request
api_response = api_instance.account_password_reset(body, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_password_reset: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.AIForgedViewModelsUserActivateViewModel() # AIForgedViewModelsUserActivateViewModel |
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Request a reset a user account
api_response = api_instance.account_password_reset_request(body, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_password_reset_request: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.AIForgedViewModelsUserEditViewModel() # AIForgedViewModelsUserEditViewModel |
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Register a new user account
api_response = api_instance.account_register(body, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_register: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.AIForgedViewModelsUserActivateViewModel() # AIForgedViewModelsUserActivateViewModel |
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Send a registration email
api_response = api_instance.account_send_registration_mail(body, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_send_registration_mail: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | The user id (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Unblock a user
api_response = api_instance.account_unblock_user(user_id=user_id, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_unblock_user: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
body = swagger_client.AIForgedViewModelsUserEditViewModel() # AIForgedViewModelsUserEditViewModel |
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Update a different users
api_response = api_instance.account_update(body, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_update: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | (optional)
provider = 'provider_example' # str | (optional)
token = 'token_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Get Verify 2FA Token
api_response = api_instance.account_verify2_fa_token(user_id=user_id, provider=provider, token=token, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_verify2_fa_token: %s\n" % e)
# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = swagger_client.AccountApi(swagger_client.ApiClient(configuration))
user_id = 'user_id_example' # str | (optional)
phone_no = 'phone_no_example' # str | (optional)
token = 'token_example' # str | (optional)
x_api_version = 'x_api_version_example' # str | (optional)
try:
# Verify Phone number
api_response = api_instance.account_verify_phone_no(user_id=user_id, phone_no=phone_no, token=token, x_api_version=x_api_version)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->account_verify_phone_no: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://portal.aiforged.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountApi | account_activate_account | POST /api/Account/ActivateAccount | Allow new user to Activate user account |
| AccountApi | account_activate_user | PUT /api/Account/ActivateUser | Allow admin to Activate another user account |
| AccountApi | account_block_user | PUT /api/Account/BlockUser | Unblock a user |
| AccountApi | account_create | POST /api/Account/Create | Create a new user |
| AccountApi | account_delete | DELETE /api/Account/Delete | Delete a user |
| AccountApi | account_delete_user_login_provider | DELETE /api/Account/DeleteUserLoginProvider | Get list of current user login providers |
| AccountApi | account_disable2_fa | DELETE /api/Account/Disable2FA | Disable 2FA |
| AccountApi | account_enable2_fa | POST /api/Account/Enable2FA | Enable 2FA |
| AccountApi | account_find | GET /api/Account/Find | Find users |
| AccountApi | account_generate_authenticator_key | GET /api/Account/GenerateAuthenticator | Enabled and Generate Authenticator Key |
| AccountApi | account_get2_fa_providers | GET /api/Account/Get2FAProviders | Get 2FAProviders |
| AccountApi | account_get_all | GET /api/Account/GetAll | Get all users |
| AccountApi | account_get_api_key | GET /api/Account/GetAPIKey | Get the API key for a user |
| AccountApi | account_get_authenticator_url | GET /api/Account/GetAuthenticatorUrl | Get Authenticator Url |
| AccountApi | account_get_by_id | GET /api/Account/GetById | Get user by Id |
| AccountApi | account_get_by_user_name | GET /api/Account/GetByUserName | Get user info by username |
| AccountApi | account_get_current_user | GET /api/Account/GetCurrentUser | Get the current logged in user |
| AccountApi | account_get_paged | GET /api/Account/GetPaged | Get users paged |
| AccountApi | account_get_user_count | GET /api/Account/GetUserCount | Get count of users |
| AccountApi | account_get_user_login_providers | GET /api/Account/GetUserLoginProviders | Get list of current user login providers |
| AccountApi | account_group_create | POST /api/Account/GroupCreate | Create a new user int a group |
| AccountApi | account_logout | GET /api/Account/Logout | Log out the current user |
| AccountApi | account_password_reset | POST /api/Account/PasswordReset | Reset a password request |
| AccountApi | account_password_reset_request | POST /api/Account/PasswordResetRequest | Request a reset a user account |
| AccountApi | account_register | POST /api/Account/Register | Register a new user account |
| AccountApi | account_send_registration_mail | POST /api/Account/SendRegistrationMail | Send a registration email |
| AccountApi | account_unblock_user | PUT /api/Account/UnblockUser | Unblock a user |
| AccountApi | account_update | PUT /api/Account/Update | Update a different users |
| AccountApi | account_verify2_fa_token | POST /api/Account/Verify2FAToken | Get Verify 2FA Token |
| AccountApi | account_verify_phone_no | POST /api/Account/VerifyPhoneNo | Verify Phone number |
| AuditApi | audit_get | GET /api/Audit | Get audit info by Id |
| AuditApi | audit_get_all | GET /api/Audit/GetAll | Get audit by search criteria |
| BundlesApi | bundles_create | POST /api/Bundles/Create | Create a new bundle |
| BundlesApi | bundles_delete | DELETE /api/Bundles/Delete | Delete a bundle |
| BundlesApi | bundles_get_all | GET /api/Bundles/GetAll | Get all bundles |
| BundlesApi | bundles_update | PUT /api/Bundles/Update | Update a bundle |
| ClassesApi | classes_create | POST /api/Classes/Create | Create a new category |
| ClassesApi | classes_delete | DELETE /api/Classes/Delete | Delete a category |
| ClassesApi | classes_delete_training_option | DELETE /api/Classes/DeleteTrainingOption | Delete a category training options |
| ClassesApi | classes_find_by_name | GET /api/Classes/FindByName | Get categories by project and name |
| ClassesApi | classes_get | GET /api/Classes/Get | Get category information |
| ClassesApi | classes_get_by_project | GET /api/Classes/GetByProject | Get all categories by project |
| ClassesApi | classes_get_by_user | GET /api/Classes/GetByUser | Get categories by user and project |
| ClassesApi | classes_get_training_option | GET /api/Classes/GetTrainingOption | Get a category training options |
| ClassesApi | classes_set_training_option | PUT /api/Classes/SetTrainingOption | Set a category training options |
| ClassesApi | classes_update | PUT /api/Classes/Update | Update a category |
| CloningApi | cloning_configure | POST /api/Cloning/Configure | Clone a service to new project |
| CloningApi | cloning_get_data_set_options | GET /api/Cloning/GetDataSetOptions | Get clone default options |
| CloningApi | cloning_get_default_options | GET /api/Cloning/GetDefaultOptions | Get clone default options |
| CloningApi | cloning_get_destination_project | GET /api/Cloning/GetDestinationProject | Get Destination Project |
| CloningApi | cloning_get_destination_service | GET /api/Cloning/GetDestinationService | Get Destination Service |
| CloningApi | cloning_get_interval | GET /api/Cloning/GetInterval | Get Cloning interval |
| CloningApi | cloning_get_options | GET /api/Cloning/GetOptions | Get current cloning options |
| CloningApi | cloning_get_training_options | GET /api/Cloning/GetTrainingOptions | Get clone default options |
| CloningApi | cloning_set_options | POST /api/Cloning/SetOptions | Set Options |
| ContactApi | contact_create | POST /api/Contact/Create | Create contacts |
| ContactApi | contact_delete | DELETE /api/Contact/Delete | Delete |
| ContactApi | contact_get | GET /api/Contact/Get | Get Contacts |
| ContactApi | contact_update | PUT /api/Contact/Update | Update contacts |
| DataSetApi | data_set_create | POST /api/DataSet/Create | Create a new empty custom dataset |
| DataSetApi | data_set_create_record | POST /api/DataSet/CreateRecord | Create a custom dataset record |
| DataSetApi | data_set_delete | DELETE /api/DataSet/Delete | Delete a custom dataset |
| DataSetApi | data_set_delete_record | DELETE /api/DataSet/DeleteRecord | Delete a custom dataset record by key ID |
| DataSetApi | data_set_delete_record_by_key_value | DELETE /api/DataSet/DeleteByKeyValue | Delete a custom dataset record by key value |
| DataSetApi | data_set_delete_records | DELETE /api/DataSet/DeleteRecords | Delete multiple custom dataset records by key IDs |
| DataSetApi | data_set_get | GET /api/DataSet/Get | Get custom dataset and data |
| DataSetApi | data_set_get_all | GET /api/DataSet/GetAll | Get all datasets for a service |
| DataSetApi | data_set_get_by_def | GET /api/DataSet/GetByDef | Get custom dataset by definition |
| DataSetApi | data_set_get_by_id | GET /api/DataSet/GetById | Get custom dataset by ID |
| DataSetApi | data_set_get_by_name | GET /api/DataSet/GetByName | Get dataset by name |
| DataSetApi | data_set_get_record | GET /api/DataSet/GetRecord | Get a custom dataset record |
| DataSetApi | data_set_get_record_by_key_value | GET /api/DataSet/GetRecordByKeyValue | Find a custom dataset by key |
| DataSetApi | data_set_save | POST /api/DataSet/Save | Save a custom dataset |
| DataSetApi | data_set_sync | POST /api/DataSet/Sync | Sync custom dataset with service or categories |
| DataSetApi | data_set_update_record | PUT /api/DataSet/UpdateRecord | Update a custom dataset record |
| DocumentApi | document_bulk_class_change | POST /api/Document/BulkClassChange | Bulk change document classes by status and usage |
| DocumentApi | document_bulk_copy | POST /api/Document/BulkCopy | Bulk Copy document by status and usage to another service |
| DocumentApi | document_bulk_move | POST /api/Document/BulkMove | Bulk Mode document by status and usage to another service |
| DocumentApi | document_bulk_update | POST /api/Document/BulkUpdate | Bulk update document by status and usage |
| DocumentApi | document_change_field_page_index | PUT /api/Document/ChangeFieldPageIndex | Move fields to another page |
| DocumentApi | document_classify | POST /api/Document/Classify | Upload and classify a document |
| DocumentApi | document_clone | POST /api/Document/Clone | Clone a document |
| DocumentApi | document_clone_for_training | POST /api/Document/CloneForTraining | Clone a processed document for training |
| DocumentApi | document_copy | POST /api/Document/Copy | Copy a document to another project/service and supply a new status and usage |
| DocumentApi | document_delete | DELETE /api/Document/Delete | Delete a document by ID |
| DocumentApi | document_delete_blob | DELETE /api/Document/DeleteBlob | Delete a document blob |
| DocumentApi | document_delete_fields_on_page | DELETE /api/Document/DeleteFieldsOnPage | Delete fields on a page |
| DocumentApi | document_delete_multi | DELETE /api/Document/DeleteMulti | Delete multiple documents |
| DocumentApi | document_delete_pages | DELETE /api/Document/DeletePages | Delete pages from a document |
| DocumentApi | document_extract_and_verify | POST /api/Document/ExtractAndVerify | Upload and extract information for verification |
| DocumentApi | document_find_latest_child | GET /api/Document/FindLatestChild | Find latest child document to assist with verification |
| DocumentApi | document_fix_page_verification_index | PUT /api/Document/FixPageVerificationIndex | Fix page parameter index |
| DocumentApi | document_get_blob | GET /api/Document/GetBlob | Get the data blob for a document id by image type |
| DocumentApi | document_get_blob_by_id | GET /api/Document/GetBlobById | Get blob by blob ID |
| DocumentApi | document_get_classification | GET /api/Document/GetClassification | Get a document classification |
| DocumentApi | document_get_data | GET /api/Document/GetData | Get document images |
| DocumentApi | document_get_document | GET /api/Document/Get | Get a document by ID |
| DocumentApi | document_get_ex_summary | GET /api/Document/GetExtendedSummary | Get a summary of documents for analytics |
| DocumentApi | document_get_extended | GET /api/Document/GetExtended | Find documnets by using structured search criteria. The results can be paged |
| DocumentApi | document_get_extended_count | GET /api/Document/GetExtendedCount | Find documnets count by using structured search criteria This is used to detemine paging |
| DocumentApi | document_get_hierarchy | GET /api/Document/GetHierarchy | Get a document and its related documents |
| DocumentApi | document_get_previews | GET /api/Document/GetPreviews | Get preview documents and images for a service |
| DocumentApi | document_get_root | GET /api/Document/GetRoot | Get a topmost root document by ID |
| DocumentApi | document_get_system_document | GET /api/Document/GetSystemDocument | Get system document |
| DocumentApi | document_get_system_documents | GET /api/Document/GetSystemDocuments | Get system documents |
| DocumentApi | document_get_training_report | GET /api/Document/GetTrainingReport | Get Training Report |
| DocumentApi | document_merge_to_pdf_for_category | POST /api/Document/MergeToPdfForCategory | Merge the provided image documents into a single PDF document for the specified category |
| DocumentApi | document_move | POST /api/Document/Move | Move a document to another project and service |
| DocumentApi | document_set_field_page_verification_index | PUT /api/Document/SetFieldPageVerificationIndex | Change field verification index |
| DocumentApi | document_store | POST /api/Document/Store | Store structured doument and containing data blob |
| DocumentApi | document_un_delete | DELETE /api/Document/UnDelete | Undelete a document by id |
| DocumentApi | document_update | PUT /api/Document/Update | Update a document |
| DocumentApi | document_update_blob | PUT /api/Document/UpdateBlob | Update a blob |
| DocumentApi | document_upload | POST /api/Document/Upload | Upload multiple documents |
| DocumentApi | document_upload_file | POST /api/Document/UploadFile | Upload a document |
| GroupApi | group_create | POST /api/Group/Create | Create usergroup |
| GroupApi | group_create_role | POST /api/Group/CreateRole | Create group role |
| GroupApi | group_delete | DELETE /api/Group/Delete | Delete |
| GroupApi | group_delete_role | DELETE /api/Group/DeleteRole | Create group role |
| GroupApi | group_get | GET /api/Group/Get | Get by id |
| GroupApi | group_get_by_user | GET /api/Group/GetByUser | Get by users |
| GroupApi | group_get_roles | GET /api/Group/GetRoles | Get roles by group |
| GroupApi | group_get_users_by_role | GET /api/Group/GetUsersByRole | Get users by roles |
| GroupApi | group_update | PUT /api/Group/Update | Update group |
| GroupApi | group_update_role | PUT /api/Group/UpdateRole | Update group role |
| LogApi | log_add | POST /api/Log/Add | Add a log record |
| LogApi | log_create | PUT /api/Log/Create | Create a log |
| LogApi | log_get | GET /api/Log | Get Log info by Id |
| LogApi | log_get_all | GET /api/Log/GetAll | Get logs by search criteria |
| MarketPlaceApi | market_place_approve_request | PUT /api/MarketPlace/ApproveRequest | Approve a user request |
| MarketPlaceApi | market_place_get | GET /api/MarketPlace/Get | Get marketplace items by using a filter |
| MarketPlaceApi | market_place_get_by_user | GET /api/MarketPlace/GetByUser | Get by user |
| MarketPlaceApi | market_place_get_project_users | GET /api/MarketPlace/GetProjectUsers | |
| MarketPlaceApi | market_place_get_rating | GET /api/MarketPlace/GetRating | Get service rating |
| MarketPlaceApi | market_place_get_ratings | GET /api/MarketPlace/GetRatings | Get service rating |
| MarketPlaceApi | market_place_get_users | GET /api/MarketPlace/GetUsers | Get users of a marketplace service |
| MarketPlaceApi | market_place_invite | POST /api/MarketPlace/Invite | Invite a user to a service |
| MarketPlaceApi | market_place_link_users | PUT /api/MarketPlace/LinkUsers | Link / Shared users to project service group |
| MarketPlaceApi | market_place_rate | GET /api/MarketPlace/Rate | Rate a service |
| MarketPlaceApi | market_place_request_access | PUT /api/MarketPlace/RequestAccess | Request access to market place |
| MarketPlaceApi | market_place_resend_invite | POST /api/MarketPlace/ResendInvite | Invite a user to a service |
| MarketPlaceApi | market_place_un_link_users | PUT /api/MarketPlace/UnLinkUsers | Unlink users from a service |
| NotificationApi | notification_bulk_flag_as_read | POST /api/Notification/BulkFlagAsRead | Flag multiple notifications as read |
| NotificationApi | notification_create | POST /api/Notification/Create | Create Email Notifications for Support and Other |
| NotificationApi | notification_delete | DELETE /api/Notification/Delete | Delete |
| NotificationApi | notification_flag_as_read | PUT /api/Notification/FlagAsRead | Flag Notification as read |
| NotificationApi | notification_get | GET /api/Notification/Get | Get Notifications |
| NotificationApi | notification_get_attachment | GET /api/Notification/GetAttachment | Get Attachment |
| NotificationApi | notification_get_count | GET /api/Notification/GetCount | Get Notifications Count |
| NotificationApi | notification_get_preferences | GET /api/Notification/GetPreferences | Get the current user notification preferences |
| NotificationApi | notification_get_unread_count | GET /api/Notification/GetUnreadCount | Get Notifications Count |
| NotificationApi | notification_save_preferences | GET /api/Notification/SavePreferences | Save the current user notification preferences |
| NotificationApi | notification_web_hook_get | GET /api/Notification/WebHook | Webhook for WhatApp |
| NotificationApi | notification_web_hook_post | POST /api/Notification/WebHook | Webhook for WhatApp |
| ParamDefApi | param_def_create | POST /api/ParamDef/Create | Create a new parameter definition |
| ParamDefApi | param_def_create_setting | POST /api/ParamDef/CreateSetting | Create a new setting for a definition |
| ParamDefApi | param_def_delete | DELETE /api/ParamDef/Delete | Delete a parameter definition |
| ParamDefApi | param_def_delete_multi | DELETE /api/ParamDef/DeleteMulti | Delete multiple definitions |
| ParamDefApi | param_def_elevate | PUT /api/ParamDef/Elevate | Elevate to parent level |
| ParamDefApi | param_def_get | GET /api/ParamDef/Get | Get parameter definition by ID |
| ParamDefApi | param_def_get_hierachy | GET /api/ParamDef/GetHierachy | Get hierarchy of fields for a service |
| ParamDefApi | param_def_get_last_setting | GET /api/ParamDef/GetLastSetting | Get the latest setting for a parameter definition |
| ParamDefApi | param_def_get_parent_service | GET /api/ParamDef/GetParentService | Get parent service for a parameter definition by Id |
| ParamDefApi | param_def_get_setting | GET /api/ParamDef/GetSetting | Get settings for a parameter definition by ID |
| ParamDefApi | param_def_get_settings | GET /api/ParamDef/GetSettings | Get all settings for a parameter definition |
| ParamDefApi | param_def_get_usage_count | GET /api/ParamDef/GetUsageCount | Get hierarchy of fields for a service |
| ParamDefApi | param_def_save_setting | POST /api/ParamDef/SaveSetting | Save a setting for a parameter definition |
| ParamDefApi | param_def_update | PUT /api/ParamDef/Update | Update a parameter definition |
| ParametersApi | parameters_bulk_change_param_def | POST /api/Parameters/BulkChangeParamDef | Bulk change parameter definitions for parameters in all documents in a project |
| ParametersApi | parameters_create | POST /api/Parameters/Create | Create a new parameter on a document |
| ParametersApi | parameters_deep_search | GET /api/Parameters/DeepSearch | Deep Search for parameter values |
| ParametersApi | parameters_delete | DELETE /api/Parameters/Delete | Delete a parameter |
| ParametersApi | parameters_delete_by_param_def | DELETE /api/Parameters/DeleteByParamDef | Delete parameters by definitions from a document |
| ParametersApi | parameters_delete_by_project_service_param_def | DELETE /api/Parameters/DeleteByProjectServiceParamDef | Delete parameters by definitions from a document |
| ParametersApi | parameters_export_to_excel | GET /api/Parameters/ExportToExcel | Export results to Excel |
| ParametersApi | parameters_extract | GET /api/Parameters/Extract | Extract document parameters |
| ParametersApi | parameters_get | GET /api/Parameters/Get | Get parameter value |
| ParametersApi | parameters_get_by_verification | GET /api/Parameters/GetByVerification | Get parameter by verification id |
| ParametersApi | parameters_get_hierarchy | GET /api/Parameters/GetHierarchy | Get document parameter hierarchy |
| ParametersApi | parameters_get_summary | GET /api/Parameters/GetSummary | Get summary of project verifications |
| ParametersApi | parameters_get_usage | GET /api/Parameters/GetUsage | Get parameter definition usage |
| ParametersApi | parameters_multi_extract | GET /api/Parameters/MultiExtract | Extract multiple document parameters |
| ParametersApi | parameters_update | PUT /api/Parameters/Update | Update a parameter |
| ParametersApi | parameters_update_multi | PUT /api/Parameters/UpdateMulti | Update multiple parameter values |
| PaymentApi | payment_get_payments | GET /api/Payment/GetPayments | Get payments made by a user |
| PaymentApi | payment_process_payment | POST /api/Payment/ProcessPayment | Process a payment and update status from payment provider |
| ProjectApi | project_cancel_credit | POST /api/Project/CancelCredit | Cancel a credit |
| ProjectApi | project_change_owner | POST /api/Project/ChangeOwner | Change the owner of a project |
| ProjectApi | project_create | POST /api/Project/Create | Create a new project |
| ProjectApi | project_create_credit | POST /api/Project/CreateCredit | Create a manual credit and link it to a project |
| ProjectApi | project_delete | DELETE /api/Project/Delete | Delete a project |
| ProjectApi | project_expire_credits | POST /api/Project/ExpireCredits | Expire credits before a date |
| ProjectApi | project_get_audit | GET /api/Project/GetAudit | Get audit transaction for service usage |
| ProjectApi | project_get_available_credits | GET /api/Project/GetAvailableCredits | Get audit transaction for service usage |
| ProjectApi | project_get_balance | GET /api/Project/GetBalance | Get the balance for a specific project |
| ProjectApi | project_get_balances | GET /api/Project/GetBalances | Get balances for multiple projects linked to a user |
| ProjectApi | project_get_by_name | GET /api/Project/GetByName | Find a project by name for user |
| ProjectApi | project_get_by_user | GET /api/Project/GetByUser | Get projects and services for user |
| ProjectApi | project_get_hierachies | GET /api/Project/GetHierachies | Get hierarchy of fields for all services in a project |
| ProjectApi | project_get_services | GET /api/Project/GetServices | Get services related to a project |
| ProjectApi | project_get_statement | GET /api/Project/GetStatement | Get statement for user |
| ProjectApi | project_get_transaction_audit | GET /api/Project/GetTransactionAudit | Get audit transaction for service usage |
| ProjectApi | project_get_user_project | GET /api/Project/GetUserProject | Get a specific project for user |
| ProjectApi | project_transfer_credit_amount | POST /api/Project/TransferCreditAmount | Transfer credits by amount |
| ProjectApi | project_transfer_credits | POST /api/Project/TransferCredits | Transfer credits and link it to a project |
| ProjectApi | project_update | POST /api/Project/Update | Update a project |
| ReportsApi | reports_export_request | POST /api/Reports/RequestExport | Create a PowerBI report export request |
| ReportsApi | reports_get_config | GET /api/Reports/GetConfig | Reports Config |
| ReportsApi | reports_get_exported_file | POST /api/Reports/GetExport | Get the exported file |
| ReportsApi | reports_get_group_users | GET /api/Reports/GetGroupUsers | Get goup users |
| ReportsApi | reports_get_groups | GET /api/Reports/GetGroups | Get groups |
| ReportsApi | reports_get_pages | GET /api/Reports/GetPages | Get pages by report id |
| ReportsApi | reports_get_report | GET /api/Reports/GetReport | Get report by Id |
| ReportsApi | reports_get_reports | GET /api/Reports/GetReports | Get reports |
| ReportsApi | reports_poll_export_request | GET /api/Reports/PollExport | Poll PowerBI report export request |
| ReportsApi | reports_power_bi | GET /api/Reports/PowerBI | Go To PowerBI |
| RolesApi | roles_create | POST /api/Roles/Create | Create a role |
| RolesApi | roles_delete | DELETE /api/Roles/Delete | Delete a role |
| RolesApi | roles_get | GET /api/Roles/Get | Get role info by id. |
| RolesApi | roles_get_all | GET /api/Roles/GetAll | Get all roles. |
| RolesApi | roles_get_all_permissions | GET /api/Roles/permissions | Get permissions claims on the system |
| RolesApi | roles_get_by_name | GET /api/Roles/GetByName | Get role info by name. |
| RolesApi | roles_get_paged | GET /api/Roles/GetPaged | Get roles by pages |
| RolesApi | roles_update | PUT /api/Roles/Update | Update a role |
| ServiceTypeApi | service_type_create | POST /api/ServiceType/Create | Create a new service type |
| ServiceTypeApi | service_type_create_charge | POST /api/ServiceType/CreateCharge | |
| ServiceTypeApi | service_type_delete | DELETE /api/ServiceType/Delete | Delete a service type |
| ServiceTypeApi | service_type_delete_charge | DELETE /api/ServiceType/DeleteCharge | Delete service type charge. |
| ServiceTypeApi | service_type_get_all | GET /api/ServiceType/GetAll | Get all service types. You can use a serice interface filter |
| ServiceTypeApi | service_type_get_all_charges | GET /api/ServiceType/GetAllCharges | Get all service types and charges. |
| ServiceTypeApi | service_type_get_charges | GET /api/ServiceType/GetCharges | Get all service types. You can use a serice interface filter |
| ServiceTypeApi | service_type_update | PUT /api/ServiceType/Update | Update a service type |
| ServiceTypeApi | service_type_update_charge | PUT /api/ServiceType/UpdateCharge | Update service type charge. |
| ServicesApi | services_change | POST /api/Services/Change | Change a service |
| ServicesApi | services_create | POST /api/Services/Create | Create a new service |
| ServicesApi | services_create_charge | POST /api/Services/CreateCharge | |
| ServicesApi | services_create_definition_results | POST /api/Services/CreateDefinitionResults | Build definition keys after training |
| ServicesApi | services_delete_charge | DELETE /api/Services/DeleteCharge | Delete service type charge. |
| ServicesApi | services_delete_custom_training | DELETE /api/Services/DeleteCustomTraining | Delete custom training parameters |
| ServicesApi | services_find_service_references | GET /api/Services/FindServiceReferences | Find References to a Service |
| ServicesApi | services_get | GET /api/Services/Get | Get a service by id |
| ServicesApi | services_get_charges | GET /api/Services/GetCharges | Get all service types. You can use a serice interface filter |
| ServicesApi | services_get_code_constants | GET /api/Services/GetCodeConstants | Get code constants |
| ServicesApi | services_get_custom_training | GET /api/Services/GetCustomTraining | Get custom training parameters |
| ServicesApi | services_get_custom_training_fields | GET /api/Services/GetCustomTrainingFields | Get custom training fields |
| ServicesApi | services_get_events | GET /api/Services/GetEvents | Get events for a service |
| ServicesApi | services_get_related_users | GET /api/Services/GetRelatedUsers | Get related users |
| ServicesApi | services_get_training_report | GET /api/Services/GetTrainingReport | Get training report for service |
| ServicesApi | services_initialize | PATCH /api/Services/Initialize | Initialize a service |
| ServicesApi | services_move | POST /api/Services/Move | Move a service to another project |
| ServicesApi | services_process | POST /api/Services/Process | Process service documents |
| ServicesApi | services_save_custom_training | POST /api/Services/SaveCustomTraining | Save custom training |
| ServicesApi | services_train | POST /api/Services/Train | Train service |
| ServicesApi | services_update_charge | PUT /api/Services/UpdateCharge | Update service type charge. |
| SystemApi | system_check_services | GET /api/System/CheckServices | Check services |
| SystemApi | system_create_data_type | POST /api/System/CreateDataType | Create a new data type |
| SystemApi | system_create_enum_data | POST /api/System/CreateEnumData | Create a new system enum |
| SystemApi | system_delete_data_type | DELETE /api/System/DeleteDataType | Delete a datatype |
| SystemApi | system_delete_enum_data | DELETE /api/System/DeleteEnumData | Delete a system enum |
| SystemApi | system_get_background_worker_item | GET /api/System/GetBackgroundWorkerItem | Get background worker item |
| SystemApi | system_get_category_training | GET /api/System/GetCategoryTraining | Get category training options |
| SystemApi | system_get_data_type_info | GET /api/System/GetDataTypeInfo | Get value types |
| SystemApi | system_get_data_types | GET /api/System/GetDataTypes | Get data types |
| SystemApi | system_get_enum_data | GET /api/System/GetEnumData | Get system enum values |
| SystemApi | system_get_enum_options | GET /api/System/GetEnumOptions | Get enumerator options |
| SystemApi | system_get_exception | GET /api/System/GetException | Test an exception |
| SystemApi | system_get_logs | GET /api/System/GetLogs | Get event logs |
| SystemApi | system_get_system_date | GET /api/System/GetSystemDate | Get the current server date and time |
| SystemApi | system_get_system_info | GET /api/System/GetSystemInfo | Get system and application information |
| SystemApi | system_sync_enum_data | PUT /api/System/SyncEnumData | Delete a system enum |
| SystemApi | system_test_data_set | GET /api/System/GetDataSet | Dummy to expose event logs |
| SystemApi | system_update_data_type | PUT /api/System/UpdateDataType | Update a datatype description |
| SystemApi | system_update_enum_data | PUT /api/System/UpdateEnumData | Update system enum |
| UserPreferencesApi | user_preferences_get | GET /api/UserPreferences/Get | Get the current user preferences |
| UserPreferencesApi | user_preferences_save | PUT /api/UserPreferences/Save | Save current user preferences |
| UserSettingsApi | user_settings_create | POST /api/UserSettings/Create | Save a user settings |
| UserSettingsApi | user_settings_delete | DELETE /api/UserSettings/Delete | Delete a user settings |
| UserSettingsApi | user_settings_get | GET /api/UserSettings/Get | Get user setting by name |
| UserSettingsApi | user_settings_get_all | GET /api/UserSettings/GetAll | Get user settings |
| UserSettingsApi | user_settings_get_picture | GET /api/UserSettings/GetPicture | Get user profile picture |
| UserSettingsApi | user_settings_set_picture | POST /api/UserSettings/SetPicture | Get user profile picture |
| UserSettingsApi | user_settings_update | PUT /api/UserSettings/Update | Update a user settings |
| VerificationApi | verification_get | GET /api/Verification/Get | Get a verification by ID |
| VerificationApi | verification_get_all | GET /api/Verification/GetAll | Get all verifications for a parameter |
| VerificationApi | verification_get_extended | GET /api/Verification/GetExtended | Get extended verification info |
| VerificationApi | verification_get_heatmap | GET /api/Verification/GetHeatmap | Get verification analytics for service |
| VerificationApi | verification_get_latest | GET /api/Verification/GetLatest | Get latest verification for a parameter |
| VerificationApi | verification_get_shred | GET /api/Verification/GetShred | Get a verification image shred |
| VerificationApi | verification_get_summary | GET /api/Verification/GetSummary | Get a summary of verifications for service |
| VerificationApi | verification_rerun | POST /api/Verification/Rerun | Rerun verification on a parameter |
| VerificationApi | verification_rerun_all | POST /api/Verification/RerunAll | Rerun verification on a document |
| VerificationApi | verification_verify | PUT /api/Verification/Verify | Create a list of verifications |
| WizardApi | wizard_create_service | POST /api/Wizard/CreateService | Bootstrap a new serice and get the wizard steps required |
| WizardApi | wizard_get_all | GET /api/Wizard/GetAll | Get all wizards steps for a project and services |
| WizardApi | wizard_save | POST /api/Wizard/Save | Save a wizard step |
| WizardApi | wizard_validate | POST /api/Wizard/Validate | Validate a visard step |
| WizardApi | wizard_validate_multi | POST /api/Wizard/ValidateMulti | Validate miltiple wizard steps |
| WorkItemApi | work_item_create | POST /api/WorkItem/Create | Create Workflow for Document / Shred for Backward compatibility |
| WorkItemApi | work_item_create_ex | POST /api/WorkItem/CreateEx | CreateEx Workflow for Document / Shred |
| WorkItemApi | work_item_delete | DELETE /api/WorkItem/Delete | Delete work item |
| WorkItemApi | work_item_escelate | POST /api/WorkItem/Escelate | Escelate to another user |
| WorkItemApi | work_item_expire | DELETE /api/WorkItem/Expire | Expire WorkItems |
| WorkItemApi | work_item_finalize | POST /api/WorkItem/Finalize | Finalize Workflow for Document |
| WorkItemApi | work_item_get | GET /api/WorkItem/Get | Get WorkItems |
| WorkItemApi | work_item_get_by_id | GET /api/WorkItem/GetById | Get WorkItem By Id |
| WorkItemApi | work_item_get_count | GET /api/WorkItem/GetCount | Get WorkItems Count |
| WorkItemApi | work_item_get_heatmap | GET /api/WorkItem/GetHeatmap | Get WorkItems Heatmap |
| WorkItemApi | work_item_get_summary | GET /api/WorkItem/GetSummary | Get WorkItems Summary |
| WorkItemApi | work_item_get_work_queue | GET /api/WorkItem/GetWorkQueue | Get document work queue |
| WorkItemApi | work_item_rebuild | POST /api/WorkItem/Rebuild | Rebuild workitems and execute custom code |
| WorkItemApi | work_item_reject | POST /api/WorkItem/Reject | Reject work item |
| WorkItemApi | work_item_reject_shred | POST /api/WorkItem/RejectShred | Reject work items for a shred |
| WorkItemApi | work_item_set_status | PUT /api/WorkItem/SetStatus | Update status |
| WorkItemApi | work_item_transfer | POST /api/WorkItem/Transfer | Escelate to another user |
| WorkItemApi | work_item_transfer_open | POST /api/WorkItem/TransferOpen | Transfer all open to another user |
Documentation For Models
- AIForgedCloneChecks
- AIForgedCloneOptions
- AIForgedDALAuditAccessType
- AIForgedDALAuditEntity
- AIForgedDALAvailability
- AIForgedDALBundleType
- AIForgedDALCategoryStatus
- AIForgedDALChargeStatus
- AIForgedDALClassType
- AIForgedDALContactStatus
- AIForgedDALDataTypeCategory
- AIForgedDALDocumentDataType
- AIForgedDALDocumentStatus
- AIForgedDALEnumType
- AIForgedDALGroupRoleStatus
- AIForgedDALGroupRoleType
- AIForgedDALGroupRoleUserStatus
- AIForgedDALGroupStatus
- AIForgedDALGroupType
- AIForgedDALGroupingType
- AIForgedDALLogType
- AIForgedDALMarkingType
- AIForgedDALModelsGroupRoleUserViewModel
- AIForgedDALModelsParameterDefSettingViewModel
- AIForgedDALModelsServiceEventViewModel
- AIForgedDALModelsTransactionsAuditViewModel
- AIForgedDALNotificationArea
- AIForgedDALNotificationEvent
- AIForgedDALNotificationLevel
- AIForgedDALNotificationStatus
- AIForgedDALNotificationType
- AIForgedDALOperationOption
- AIForgedDALOptionStatusFlags
- AIForgedDALOrientation
- AIForgedDALParameterDefinitionCategory
- AIForgedDALParameterDefinitionStatus
- AIForgedDALPaymentStatus
- AIForgedDALProjectStatus
- AIForgedDALRatingStatus
- AIForgedDALRatingType
- AIForgedDALReferenceType
- AIForgedDALRequiredOption
- AIForgedDALServiceEventStatus
- AIForgedDALServiceEventType
- AIForgedDALServiceOptions
- AIForgedDALServiceTypeStatus
- AIForgedDALSettingStatus
- AIForgedDALSettingType
- AIForgedDALSortDirection
- AIForgedDALSortField
- AIForgedDALTransactionStatus
- AIForgedDALUsageType
- AIForgedDALValueType
- AIForgedDALVerificationStatus
- AIForgedDALVerificationType
- AIForgedDALViewModelsNotificationOption
- AIForgedDALViewModelsNotificationPreferences
- AIForgedDALViewModelsNotificationSetting
- AIForgedDALWizardState
- AIForgedDALWizardType
- AIForgedDALWorkItemAction
- AIForgedDALWorkItemMethod
- AIForgedDALWorkItemReason
- AIForgedDALWorkItemStatus
- AIForgedDALWorkItemType
- AIForgedHelpersLogEvent
- AIForgedProcessorBackgoundWorkItem
- AIForgedReportsBackgroundType
- AIForgedReportsCustomLayout
- AIForgedReportsDisplayOption
- AIForgedReportsFilter
- AIForgedReportsFilterDisplaySettings
- AIForgedReportsFilterTarget
- AIForgedReportsFilterType
- AIForgedReportsLayoutType
- AIForgedReportsPageSizeType
- AIForgedReportsPageSizeTypes
- AIForgedReportsReportAlignment
- AIForgedReportsReportConfigViewModel
- AIForgedReportsSetting
- AIForgedReportsTokenType
- AIForgedViewModelsAccountBalanceItem
- AIForgedViewModelsAuditViewModel
- AIForgedViewModelsBundlesViewModel
- AIForgedViewModelsCategoryTrainingOptions
- AIForgedViewModelsCategoryTrainingType
- AIForgedViewModelsClassesViewModel
- AIForgedViewModelsContactViewModel
- AIForgedViewModelsCustomDataSet
- AIForgedViewModelsCustomDataSetRecord
- AIForgedViewModelsCustomDataSetValue
- AIForgedViewModelsDataTypeViewModel
- AIForgedViewModelsDocParamSummary
- AIForgedViewModelsDocumentDataViewModel
- AIForgedViewModelsDocumentExtraction
- AIForgedViewModelsDocumentParameterViewModel
- AIForgedViewModelsDocumentViewModel
- AIForgedViewModelsDocumentsSummary
- AIForgedViewModelsEnumDataViewModel
- AIForgedViewModelsGroupRoleViewModel
- AIForgedViewModelsGroupViewModel
- AIForgedViewModelsLogViewModel
- AIForgedViewModelsNotificationAttachmentViewModel
- AIForgedViewModelsNotificationViewModel
- AIForgedViewModelsParameterDefViewModel
- AIForgedViewModelsPaymentViewModel
- AIForgedViewModelsPermissionViewModel
- AIForgedViewModelsProjectViewModel
- AIForgedViewModelsRatingViewModel
- AIForgedViewModelsRoleViewModel
- AIForgedViewModelsServiceChargeViewModel
- AIForgedViewModelsServiceTypeChargeViewModel
- AIForgedViewModelsServiceTypeViewModel
- AIForgedViewModelsSettingViewModel
- AIForgedViewModelsUserActivateViewModel
- AIForgedViewModelsUserEditViewModel
- AIForgedViewModelsUserInviteViewModel
- AIForgedViewModelsUserPasswordResetViewModel
- AIForgedViewModelsUserViewModel
- AIForgedViewModelsVerificationSummary
- AIForgedViewModelsVerificationViewModel
- AIForgedViewModelsWizard
- AIForgedViewModelsWizardValidation
- AIForgedViewModelsWorkFlowSummary
- AIForgedViewModelsWorkItemViewModel
- Action
- Action1
- Action2
- Action3
- Action4
- Area
- Area1
- Area2
- Category
- DocStatus
- DocStatus1
- DocStatus2
- DocUsage
- DocumentClassifyBody
- DocumentExtractAndVerifyBody
- DocumentUploadBody
- DocumentUploadFileBody
- Entity
- Evnt
- Evnt1
- Evnt2
- Grouping
- LarcAIDictionaryLookupMethod
- LookupMethod
- MasterDocStatus
- Method
- Method1
- Method2
- Method3
- Method4
- MicrosoftAspNetCoreIdentityUserLoginInfo
- MicrosoftAspNetCoreMvcProblemDetails
- MicrosoftPowerBIApiModelsAzureResource
- MicrosoftPowerBIApiModelsExport
- MicrosoftPowerBIApiModelsExportState
- MicrosoftPowerBIApiModelsFileFormat
- MicrosoftPowerBIApiModelsGroup
- MicrosoftPowerBIApiModelsGroupUser
- MicrosoftPowerBIApiModelsGroupUserAccessRight
- MicrosoftPowerBIApiModelsPage
- MicrosoftPowerBIApiModelsPrincipalType
- MicrosoftPowerBIApiModelsReport
- MicrosoftPowerBIApiModelsReportUser
- MicrosoftPowerBIApiModelsReportUserAccessRight
- MicrosoftPowerBIApiModelsServicePrincipalProfile
- MicrosoftPowerBIApiModelsSubscription
- MicrosoftPowerBIApiModelsSubscriptionUser
- MicrosoftPowerBIApiModelsUser
- OneOfAIForgedCloneOptionsChecks
- OneOfAIForgedCloneOptionsParamDefCategoriesItems
- OneOfAIForgedDALModelsParameterDefSettingViewModelMarking
- OneOfAIForgedDALModelsParameterDefSettingViewModelOrientation
- OneOfAIForgedDALModelsServiceEventViewModelMaster
- OneOfAIForgedDALModelsServiceEventViewModelResultType
- OneOfAIForgedDALModelsServiceEventViewModelSourceType
- OneOfAIForgedReportsCustomLayoutPageSizeType
- OneOfAIForgedReportsCustomLayoutReportAlignment
- OneOfAIForgedReportsFilterDisplaySettings
- OneOfAIForgedReportsFilterTarget
- OneOfAIForgedReportsReportConfigViewModelSettings
- OneOfAIForgedReportsSettingBackground
- OneOfAIForgedReportsSettingCustomLayout
- OneOfAIForgedReportsSettingLayoutType
- OneOfAIForgedViewModelsAuditViewModelDef
- OneOfAIForgedViewModelsAuditViewModelDocument
- OneOfAIForgedViewModelsAuditViewModelEvent
- OneOfAIForgedViewModelsAuditViewModelGroup
- OneOfAIForgedViewModelsAuditViewModelParameter
- OneOfAIForgedViewModelsAuditViewModelProject
- OneOfAIForgedViewModelsAuditViewModelService
- OneOfAIForgedViewModelsAuditViewModelTransaction
- OneOfAIForgedViewModelsAuditViewModelVerification
- OneOfAIForgedViewModelsAuditViewModelWorkItem
- OneOfAIForgedViewModelsCategoryTrainingOptionsTrainingType
- OneOfAIForgedViewModelsClassesViewModelStatus
- OneOfAIForgedViewModelsClassesViewModelType
- OneOfAIForgedViewModelsCustomDataSetDocument
- OneOfAIForgedViewModelsCustomDataSetKeyDef
- OneOfAIForgedViewModelsCustomDataSetRecordAvailability
- OneOfAIForgedViewModelsCustomDataSetSortDirection
- OneOfAIForgedViewModelsCustomDataSetValueAvailability
- OneOfAIForgedViewModelsCustomDataSetValueStatus
- OneOfAIForgedViewModelsCustomDataSetValueType
- OneOfAIForgedViewModelsDataTypeViewModelCategory
- OneOfAIForgedViewModelsDocParamSummaryCategory
- OneOfAIForgedViewModelsDocParamSummaryGrouping
- OneOfAIForgedViewModelsDocumentDataViewModelAvailability
- OneOfAIForgedViewModelsDocumentDataViewModelType
- OneOfAIForgedViewModelsDocumentExtractionCategory
- OneOfAIForgedViewModelsDocumentExtractionGrouping
- OneOfAIForgedViewModelsDocumentExtractionStatus
- OneOfAIForgedViewModelsDocumentExtractionType
- OneOfAIForgedViewModelsDocumentParameterViewModelAvailability
- OneOfAIForgedViewModelsDocumentParameterViewModelParamDef
- OneOfAIForgedViewModelsDocumentViewModelAvailability
- OneOfAIForgedViewModelsDocumentViewModelLatestChildStatus
- OneOfAIForgedViewModelsGroupRoleViewModelGroup
- OneOfAIForgedViewModelsGroupRoleViewModelProject
- OneOfAIForgedViewModelsLogViewModelDef
- OneOfAIForgedViewModelsLogViewModelDocument
- OneOfAIForgedViewModelsLogViewModelEvent
- OneOfAIForgedViewModelsLogViewModelParameter
- OneOfAIForgedViewModelsLogViewModelProject
- OneOfAIForgedViewModelsLogViewModelService
- OneOfAIForgedViewModelsLogViewModelTransaction
- OneOfAIForgedViewModelsLogViewModelType
- OneOfAIForgedViewModelsLogViewModelVerification
- OneOfAIForgedViewModelsLogViewModelWorkItem
- OneOfAIForgedViewModelsNotificationViewModelContact
- OneOfAIForgedViewModelsParameterDefViewModelAvailability
- OneOfAIForgedViewModelsParameterDefViewModelCategory
- OneOfAIForgedViewModelsParameterDefViewModelGrouping
- OneOfAIForgedViewModelsPaymentViewModelBundle
- OneOfAIForgedViewModelsPaymentViewModelProject
- OneOfAIForgedViewModelsProjectViewModelBalance
- OneOfAIForgedViewModelsRatingViewModelStatus
- OneOfAIForgedViewModelsServiceTypeViewModelValueType
- OneOfAIForgedViewModelsVerificationSummaryDocStatus
- OneOfAIForgedViewModelsVerificationSummaryDocUsage
- OneOfAIForgedViewModelsWizardDependencyPd
- OneOfAIForgedViewModelsWizardPd
- OneOfAIForgedViewModelsWizardStpd
- OneOfAIForgedViewModelsWorkFlowSummaryDocStatus
- OneOfAIForgedViewModelsWorkFlowSummaryDocUsage
- OneOfAIForgedViewModelsWorkFlowSummaryMethod
- OneOfAIForgedViewModelsWorkItemViewModelDef
- OneOfAIForgedViewModelsWorkItemViewModelDocument
- OneOfAIForgedViewModelsWorkItemViewModelMethod
- OneOfAIForgedViewModelsWorkItemViewModelParent
- OneOfAIForgedViewModelsWorkItemViewModelProject
- OneOfAIForgedViewModelsWorkItemViewModelService
- OneOfAIForgedViewModelsWorkItemViewModelShred
- OneOfAIForgedViewModelsWorkItemViewModelUser
- OneOfAIForgedViewModelsWorkItemViewModelVerification
- OneOfMicrosoftPowerBIApiModelsExportStatus
- OneOfMicrosoftPowerBIApiModelsGroupLogAnalyticsWorkspace
- OneOfMicrosoftPowerBIApiModelsUserProfile
- Reason
- Reason1
- Reason10
- Reason2
- Reason3
- Reason4
- Reason5
- Reason6
- Reason7
- Reason8
- Reason9
- SortDirection
- SortDirection1
- SortDirection2
- SortDirection3
- SortDirection4
- SortDirection5
- SortDirection6
- SortDirection7
- SortDirection8
- SortField
- SortField1
- SortField2
- SortField3
- SortField4
- Status
- Status1
- Status2
- Status3
- Status4
- Status5
- SystemDayOfWeek
- Type
- Type1
- Type10
- Type2
- Type3
- Type4
- Type5
- Type6
- Type7
- Type8
- Type9
- Usage
- Usage1
- Usage2
- Usage3
- Usage4
- Usage5
- Usagefilter
- UserSettingsSetPictureBody
Documentation For Authorization
oauth2
- Type: OAuth
- Flow: password
- Authorization URL: https://portal.aiforged.com/connect/authorize
- Scopes:
- openid: Authentication Id
- email: User email
- phone: User phone number
- profile: User profile info
- roles: User roles
- aiforgedapi: Api Scope
Author
Release files for AIForged 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aiforged-1.0.1.tar.gz | 244.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| AIForged-1.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.6 MB
Release files / aiforged-1.0.1.tar.gz
| Download URL | aiforged-1.0.1.tar.gz |
|---|---|
| Size | 244.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f149e4873d8faabfc7f0620176017ac3518c375b1dfc3aec09d931b5dd418ace
|
|
BLAKE2b-256 checksum How to use checksums |
cbca479ec35ec54f2f97e1539059fcfdea64c91d2fb36a8fe672b450ac96f679
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.3
|
Release files / AIForged-1.0.1-py3-none-any.whl
| Download URL | AIForged-1.0.1-py3-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
886cca1ded6f4b5609b039f618a573bb36067b8e64013ec1b72c4ed78b6450f5
|
|
BLAKE2b-256 checksum How to use checksums |
ce425fdba33b17476cde1fd8572557b0dda050336a49d8c04cc9888a16bc73c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.3
|