PkgFoundry
Catalog PyPI
PACKAGE EXPLORERView in registry

AIForged

PyPI

AIForged API

aiforgedapiswagger
Versions collected1
Direct dependencies4From release 1.0.1
Last observed21 Oct, 10:43 UTC

README

Version 1.0.1 documentation

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

ClassMethodHTTP requestDescription
AccountApiaccount_activate_accountPOST /api/Account/ActivateAccountAllow new user to Activate user account
AccountApiaccount_activate_userPUT /api/Account/ActivateUserAllow admin to Activate another user account
AccountApiaccount_block_userPUT /api/Account/BlockUserUnblock a user
AccountApiaccount_createPOST /api/Account/CreateCreate a new user
AccountApiaccount_deleteDELETE /api/Account/DeleteDelete a user
AccountApiaccount_delete_user_login_providerDELETE /api/Account/DeleteUserLoginProviderGet list of current user login providers
AccountApiaccount_disable2_faDELETE /api/Account/Disable2FADisable 2FA
AccountApiaccount_enable2_faPOST /api/Account/Enable2FAEnable 2FA
AccountApiaccount_findGET /api/Account/FindFind users
AccountApiaccount_generate_authenticator_keyGET /api/Account/GenerateAuthenticatorEnabled and Generate Authenticator Key
AccountApiaccount_get2_fa_providersGET /api/Account/Get2FAProvidersGet 2FAProviders
AccountApiaccount_get_allGET /api/Account/GetAllGet all users
AccountApiaccount_get_api_keyGET /api/Account/GetAPIKeyGet the API key for a user
AccountApiaccount_get_authenticator_urlGET /api/Account/GetAuthenticatorUrlGet Authenticator Url
AccountApiaccount_get_by_idGET /api/Account/GetByIdGet user by Id
AccountApiaccount_get_by_user_nameGET /api/Account/GetByUserNameGet user info by username
AccountApiaccount_get_current_userGET /api/Account/GetCurrentUserGet the current logged in user
AccountApiaccount_get_pagedGET /api/Account/GetPagedGet users paged
AccountApiaccount_get_user_countGET /api/Account/GetUserCountGet count of users
AccountApiaccount_get_user_login_providersGET /api/Account/GetUserLoginProvidersGet list of current user login providers
AccountApiaccount_group_createPOST /api/Account/GroupCreateCreate a new user int a group
AccountApiaccount_logoutGET /api/Account/LogoutLog out the current user
AccountApiaccount_password_resetPOST /api/Account/PasswordResetReset a password request
AccountApiaccount_password_reset_requestPOST /api/Account/PasswordResetRequestRequest a reset a user account
AccountApiaccount_registerPOST /api/Account/RegisterRegister a new user account
AccountApiaccount_send_registration_mailPOST /api/Account/SendRegistrationMailSend a registration email
AccountApiaccount_unblock_userPUT /api/Account/UnblockUserUnblock a user
AccountApiaccount_updatePUT /api/Account/UpdateUpdate a different users
AccountApiaccount_verify2_fa_tokenPOST /api/Account/Verify2FATokenGet Verify 2FA Token
AccountApiaccount_verify_phone_noPOST /api/Account/VerifyPhoneNoVerify Phone number
AuditApiaudit_getGET /api/AuditGet audit info by Id
AuditApiaudit_get_allGET /api/Audit/GetAllGet audit by search criteria
BundlesApibundles_createPOST /api/Bundles/CreateCreate a new bundle
BundlesApibundles_deleteDELETE /api/Bundles/DeleteDelete a bundle
BundlesApibundles_get_allGET /api/Bundles/GetAllGet all bundles
BundlesApibundles_updatePUT /api/Bundles/UpdateUpdate a bundle
ClassesApiclasses_createPOST /api/Classes/CreateCreate a new category
ClassesApiclasses_deleteDELETE /api/Classes/DeleteDelete a category
ClassesApiclasses_delete_training_optionDELETE /api/Classes/DeleteTrainingOptionDelete a category training options
ClassesApiclasses_find_by_nameGET /api/Classes/FindByNameGet categories by project and name
ClassesApiclasses_getGET /api/Classes/GetGet category information
ClassesApiclasses_get_by_projectGET /api/Classes/GetByProjectGet all categories by project
ClassesApiclasses_get_by_userGET /api/Classes/GetByUserGet categories by user and project
ClassesApiclasses_get_training_optionGET /api/Classes/GetTrainingOptionGet a category training options
ClassesApiclasses_set_training_optionPUT /api/Classes/SetTrainingOptionSet a category training options
ClassesApiclasses_updatePUT /api/Classes/UpdateUpdate a category
CloningApicloning_configurePOST /api/Cloning/ConfigureClone a service to new project
CloningApicloning_get_data_set_optionsGET /api/Cloning/GetDataSetOptionsGet clone default options
CloningApicloning_get_default_optionsGET /api/Cloning/GetDefaultOptionsGet clone default options
CloningApicloning_get_destination_projectGET /api/Cloning/GetDestinationProjectGet Destination Project
CloningApicloning_get_destination_serviceGET /api/Cloning/GetDestinationServiceGet Destination Service
CloningApicloning_get_intervalGET /api/Cloning/GetIntervalGet Cloning interval
CloningApicloning_get_optionsGET /api/Cloning/GetOptionsGet current cloning options
CloningApicloning_get_training_optionsGET /api/Cloning/GetTrainingOptionsGet clone default options
CloningApicloning_set_optionsPOST /api/Cloning/SetOptionsSet Options
ContactApicontact_createPOST /api/Contact/CreateCreate contacts
ContactApicontact_deleteDELETE /api/Contact/DeleteDelete
ContactApicontact_getGET /api/Contact/GetGet Contacts
ContactApicontact_updatePUT /api/Contact/UpdateUpdate contacts
DataSetApidata_set_createPOST /api/DataSet/CreateCreate a new empty custom dataset
DataSetApidata_set_create_recordPOST /api/DataSet/CreateRecordCreate a custom dataset record
DataSetApidata_set_deleteDELETE /api/DataSet/DeleteDelete a custom dataset
DataSetApidata_set_delete_recordDELETE /api/DataSet/DeleteRecordDelete a custom dataset record by key ID
DataSetApidata_set_delete_record_by_key_valueDELETE /api/DataSet/DeleteByKeyValueDelete a custom dataset record by key value
DataSetApidata_set_delete_recordsDELETE /api/DataSet/DeleteRecordsDelete multiple custom dataset records by key IDs
DataSetApidata_set_getGET /api/DataSet/GetGet custom dataset and data
DataSetApidata_set_get_allGET /api/DataSet/GetAllGet all datasets for a service
DataSetApidata_set_get_by_defGET /api/DataSet/GetByDefGet custom dataset by definition
DataSetApidata_set_get_by_idGET /api/DataSet/GetByIdGet custom dataset by ID
DataSetApidata_set_get_by_nameGET /api/DataSet/GetByNameGet dataset by name
DataSetApidata_set_get_recordGET /api/DataSet/GetRecordGet a custom dataset record
DataSetApidata_set_get_record_by_key_valueGET /api/DataSet/GetRecordByKeyValueFind a custom dataset by key
DataSetApidata_set_savePOST /api/DataSet/SaveSave a custom dataset
DataSetApidata_set_syncPOST /api/DataSet/SyncSync custom dataset with service or categories
DataSetApidata_set_update_recordPUT /api/DataSet/UpdateRecordUpdate a custom dataset record
DocumentApidocument_bulk_class_changePOST /api/Document/BulkClassChangeBulk change document classes by status and usage
DocumentApidocument_bulk_copyPOST /api/Document/BulkCopyBulk Copy document by status and usage to another service
DocumentApidocument_bulk_movePOST /api/Document/BulkMoveBulk Mode document by status and usage to another service
DocumentApidocument_bulk_updatePOST /api/Document/BulkUpdateBulk update document by status and usage
DocumentApidocument_change_field_page_indexPUT /api/Document/ChangeFieldPageIndexMove fields to another page
DocumentApidocument_classifyPOST /api/Document/ClassifyUpload and classify a document
DocumentApidocument_clonePOST /api/Document/CloneClone a document
DocumentApidocument_clone_for_trainingPOST /api/Document/CloneForTrainingClone a processed document for training
DocumentApidocument_copyPOST /api/Document/CopyCopy a document to another project/service and supply a new status and usage
DocumentApidocument_deleteDELETE /api/Document/DeleteDelete a document by ID
DocumentApidocument_delete_blobDELETE /api/Document/DeleteBlobDelete a document blob
DocumentApidocument_delete_fields_on_pageDELETE /api/Document/DeleteFieldsOnPageDelete fields on a page
DocumentApidocument_delete_multiDELETE /api/Document/DeleteMultiDelete multiple documents
DocumentApidocument_delete_pagesDELETE /api/Document/DeletePagesDelete pages from a document
DocumentApidocument_extract_and_verifyPOST /api/Document/ExtractAndVerifyUpload and extract information for verification
DocumentApidocument_find_latest_childGET /api/Document/FindLatestChildFind latest child document to assist with verification
DocumentApidocument_fix_page_verification_indexPUT /api/Document/FixPageVerificationIndexFix page parameter index
DocumentApidocument_get_blobGET /api/Document/GetBlobGet the data blob for a document id by image type
DocumentApidocument_get_blob_by_idGET /api/Document/GetBlobByIdGet blob by blob ID
DocumentApidocument_get_classificationGET /api/Document/GetClassificationGet a document classification
DocumentApidocument_get_dataGET /api/Document/GetDataGet document images
DocumentApidocument_get_documentGET /api/Document/GetGet a document by ID
DocumentApidocument_get_ex_summaryGET /api/Document/GetExtendedSummaryGet a summary of documents for analytics
DocumentApidocument_get_extendedGET /api/Document/GetExtendedFind documnets by using structured search criteria. The results can be paged
DocumentApidocument_get_extended_countGET /api/Document/GetExtendedCountFind documnets count by using structured search criteria This is used to detemine paging
DocumentApidocument_get_hierarchyGET /api/Document/GetHierarchyGet a document and its related documents
DocumentApidocument_get_previewsGET /api/Document/GetPreviewsGet preview documents and images for a service
DocumentApidocument_get_rootGET /api/Document/GetRootGet a topmost root document by ID
DocumentApidocument_get_system_documentGET /api/Document/GetSystemDocumentGet system document
DocumentApidocument_get_system_documentsGET /api/Document/GetSystemDocumentsGet system documents
DocumentApidocument_get_training_reportGET /api/Document/GetTrainingReportGet Training Report
DocumentApidocument_merge_to_pdf_for_categoryPOST /api/Document/MergeToPdfForCategoryMerge the provided image documents into a single PDF document for the specified category
DocumentApidocument_movePOST /api/Document/MoveMove a document to another project and service
DocumentApidocument_set_field_page_verification_indexPUT /api/Document/SetFieldPageVerificationIndexChange field verification index
DocumentApidocument_storePOST /api/Document/StoreStore structured doument and containing data blob
DocumentApidocument_un_deleteDELETE /api/Document/UnDeleteUndelete a document by id
DocumentApidocument_updatePUT /api/Document/UpdateUpdate a document
DocumentApidocument_update_blobPUT /api/Document/UpdateBlobUpdate a blob
DocumentApidocument_uploadPOST /api/Document/UploadUpload multiple documents
DocumentApidocument_upload_filePOST /api/Document/UploadFileUpload a document
GroupApigroup_createPOST /api/Group/CreateCreate usergroup
GroupApigroup_create_rolePOST /api/Group/CreateRoleCreate group role
GroupApigroup_deleteDELETE /api/Group/DeleteDelete
GroupApigroup_delete_roleDELETE /api/Group/DeleteRoleCreate group role
GroupApigroup_getGET /api/Group/GetGet by id
GroupApigroup_get_by_userGET /api/Group/GetByUserGet by users
GroupApigroup_get_rolesGET /api/Group/GetRolesGet roles by group
GroupApigroup_get_users_by_roleGET /api/Group/GetUsersByRoleGet users by roles
GroupApigroup_updatePUT /api/Group/UpdateUpdate group
GroupApigroup_update_rolePUT /api/Group/UpdateRoleUpdate group role
LogApilog_addPOST /api/Log/AddAdd a log record
LogApilog_createPUT /api/Log/CreateCreate a log
LogApilog_getGET /api/LogGet Log info by Id
LogApilog_get_allGET /api/Log/GetAllGet logs by search criteria
MarketPlaceApimarket_place_approve_requestPUT /api/MarketPlace/ApproveRequestApprove a user request
MarketPlaceApimarket_place_getGET /api/MarketPlace/GetGet marketplace items by using a filter
MarketPlaceApimarket_place_get_by_userGET /api/MarketPlace/GetByUserGet by user
MarketPlaceApimarket_place_get_project_usersGET /api/MarketPlace/GetProjectUsers
MarketPlaceApimarket_place_get_ratingGET /api/MarketPlace/GetRatingGet service rating
MarketPlaceApimarket_place_get_ratingsGET /api/MarketPlace/GetRatingsGet service rating
MarketPlaceApimarket_place_get_usersGET /api/MarketPlace/GetUsersGet users of a marketplace service
MarketPlaceApimarket_place_invitePOST /api/MarketPlace/InviteInvite a user to a service
MarketPlaceApimarket_place_link_usersPUT /api/MarketPlace/LinkUsersLink / Shared users to project service group
MarketPlaceApimarket_place_rateGET /api/MarketPlace/RateRate a service
MarketPlaceApimarket_place_request_accessPUT /api/MarketPlace/RequestAccessRequest access to market place
MarketPlaceApimarket_place_resend_invitePOST /api/MarketPlace/ResendInviteInvite a user to a service
MarketPlaceApimarket_place_un_link_usersPUT /api/MarketPlace/UnLinkUsersUnlink users from a service
NotificationApinotification_bulk_flag_as_readPOST /api/Notification/BulkFlagAsReadFlag multiple notifications as read
NotificationApinotification_createPOST /api/Notification/CreateCreate Email Notifications for Support and Other
NotificationApinotification_deleteDELETE /api/Notification/DeleteDelete
NotificationApinotification_flag_as_readPUT /api/Notification/FlagAsReadFlag Notification as read
NotificationApinotification_getGET /api/Notification/GetGet Notifications
NotificationApinotification_get_attachmentGET /api/Notification/GetAttachmentGet Attachment
NotificationApinotification_get_countGET /api/Notification/GetCountGet Notifications Count
NotificationApinotification_get_preferencesGET /api/Notification/GetPreferencesGet the current user notification preferences
NotificationApinotification_get_unread_countGET /api/Notification/GetUnreadCountGet Notifications Count
NotificationApinotification_save_preferencesGET /api/Notification/SavePreferencesSave the current user notification preferences
NotificationApinotification_web_hook_getGET /api/Notification/WebHookWebhook for WhatApp
NotificationApinotification_web_hook_postPOST /api/Notification/WebHookWebhook for WhatApp
ParamDefApiparam_def_createPOST /api/ParamDef/CreateCreate a new parameter definition
ParamDefApiparam_def_create_settingPOST /api/ParamDef/CreateSettingCreate a new setting for a definition
ParamDefApiparam_def_deleteDELETE /api/ParamDef/DeleteDelete a parameter definition
ParamDefApiparam_def_delete_multiDELETE /api/ParamDef/DeleteMultiDelete multiple definitions
ParamDefApiparam_def_elevatePUT /api/ParamDef/ElevateElevate to parent level
ParamDefApiparam_def_getGET /api/ParamDef/GetGet parameter definition by ID
ParamDefApiparam_def_get_hierachyGET /api/ParamDef/GetHierachyGet hierarchy of fields for a service
ParamDefApiparam_def_get_last_settingGET /api/ParamDef/GetLastSettingGet the latest setting for a parameter definition
ParamDefApiparam_def_get_parent_serviceGET /api/ParamDef/GetParentServiceGet parent service for a parameter definition by Id
ParamDefApiparam_def_get_settingGET /api/ParamDef/GetSettingGet settings for a parameter definition by ID
ParamDefApiparam_def_get_settingsGET /api/ParamDef/GetSettingsGet all settings for a parameter definition
ParamDefApiparam_def_get_usage_countGET /api/ParamDef/GetUsageCountGet hierarchy of fields for a service
ParamDefApiparam_def_save_settingPOST /api/ParamDef/SaveSettingSave a setting for a parameter definition
ParamDefApiparam_def_updatePUT /api/ParamDef/UpdateUpdate a parameter definition
ParametersApiparameters_bulk_change_param_defPOST /api/Parameters/BulkChangeParamDefBulk change parameter definitions for parameters in all documents in a project
ParametersApiparameters_createPOST /api/Parameters/CreateCreate a new parameter on a document
ParametersApiparameters_deep_searchGET /api/Parameters/DeepSearchDeep Search for parameter values
ParametersApiparameters_deleteDELETE /api/Parameters/DeleteDelete a parameter
ParametersApiparameters_delete_by_param_defDELETE /api/Parameters/DeleteByParamDefDelete parameters by definitions from a document
ParametersApiparameters_delete_by_project_service_param_defDELETE /api/Parameters/DeleteByProjectServiceParamDefDelete parameters by definitions from a document
ParametersApiparameters_export_to_excelGET /api/Parameters/ExportToExcelExport results to Excel
ParametersApiparameters_extractGET /api/Parameters/ExtractExtract document parameters
ParametersApiparameters_getGET /api/Parameters/GetGet parameter value
ParametersApiparameters_get_by_verificationGET /api/Parameters/GetByVerificationGet parameter by verification id
ParametersApiparameters_get_hierarchyGET /api/Parameters/GetHierarchyGet document parameter hierarchy
ParametersApiparameters_get_summaryGET /api/Parameters/GetSummaryGet summary of project verifications
ParametersApiparameters_get_usageGET /api/Parameters/GetUsageGet parameter definition usage
ParametersApiparameters_multi_extractGET /api/Parameters/MultiExtractExtract multiple document parameters
ParametersApiparameters_updatePUT /api/Parameters/UpdateUpdate a parameter
ParametersApiparameters_update_multiPUT /api/Parameters/UpdateMultiUpdate multiple parameter values
PaymentApipayment_get_paymentsGET /api/Payment/GetPaymentsGet payments made by a user
PaymentApipayment_process_paymentPOST /api/Payment/ProcessPaymentProcess a payment and update status from payment provider
ProjectApiproject_cancel_creditPOST /api/Project/CancelCreditCancel a credit
ProjectApiproject_change_ownerPOST /api/Project/ChangeOwnerChange the owner of a project
ProjectApiproject_createPOST /api/Project/CreateCreate a new project
ProjectApiproject_create_creditPOST /api/Project/CreateCreditCreate a manual credit and link it to a project
ProjectApiproject_deleteDELETE /api/Project/DeleteDelete a project
ProjectApiproject_expire_creditsPOST /api/Project/ExpireCreditsExpire credits before a date
ProjectApiproject_get_auditGET /api/Project/GetAuditGet audit transaction for service usage
ProjectApiproject_get_available_creditsGET /api/Project/GetAvailableCreditsGet audit transaction for service usage
ProjectApiproject_get_balanceGET /api/Project/GetBalanceGet the balance for a specific project
ProjectApiproject_get_balancesGET /api/Project/GetBalancesGet balances for multiple projects linked to a user
ProjectApiproject_get_by_nameGET /api/Project/GetByNameFind a project by name for user
ProjectApiproject_get_by_userGET /api/Project/GetByUserGet projects and services for user
ProjectApiproject_get_hierachiesGET /api/Project/GetHierachiesGet hierarchy of fields for all services in a project
ProjectApiproject_get_servicesGET /api/Project/GetServicesGet services related to a project
ProjectApiproject_get_statementGET /api/Project/GetStatementGet statement for user
ProjectApiproject_get_transaction_auditGET /api/Project/GetTransactionAuditGet audit transaction for service usage
ProjectApiproject_get_user_projectGET /api/Project/GetUserProjectGet a specific project for user
ProjectApiproject_transfer_credit_amountPOST /api/Project/TransferCreditAmountTransfer credits by amount
ProjectApiproject_transfer_creditsPOST /api/Project/TransferCreditsTransfer credits and link it to a project
ProjectApiproject_updatePOST /api/Project/UpdateUpdate a project
ReportsApireports_export_requestPOST /api/Reports/RequestExportCreate a PowerBI report export request
ReportsApireports_get_configGET /api/Reports/GetConfigReports Config
ReportsApireports_get_exported_filePOST /api/Reports/GetExportGet the exported file
ReportsApireports_get_group_usersGET /api/Reports/GetGroupUsersGet goup users
ReportsApireports_get_groupsGET /api/Reports/GetGroupsGet groups
ReportsApireports_get_pagesGET /api/Reports/GetPagesGet pages by report id
ReportsApireports_get_reportGET /api/Reports/GetReportGet report by Id
ReportsApireports_get_reportsGET /api/Reports/GetReportsGet reports
ReportsApireports_poll_export_requestGET /api/Reports/PollExportPoll PowerBI report export request
ReportsApireports_power_biGET /api/Reports/PowerBIGo To PowerBI
RolesApiroles_createPOST /api/Roles/CreateCreate a role
RolesApiroles_deleteDELETE /api/Roles/DeleteDelete a role
RolesApiroles_getGET /api/Roles/GetGet role info by id.
RolesApiroles_get_allGET /api/Roles/GetAllGet all roles.
RolesApiroles_get_all_permissionsGET /api/Roles/permissionsGet permissions claims on the system
RolesApiroles_get_by_nameGET /api/Roles/GetByNameGet role info by name.
RolesApiroles_get_pagedGET /api/Roles/GetPagedGet roles by pages
RolesApiroles_updatePUT /api/Roles/UpdateUpdate a role
ServiceTypeApiservice_type_createPOST /api/ServiceType/CreateCreate a new service type
ServiceTypeApiservice_type_create_chargePOST /api/ServiceType/CreateCharge
ServiceTypeApiservice_type_deleteDELETE /api/ServiceType/DeleteDelete a service type
ServiceTypeApiservice_type_delete_chargeDELETE /api/ServiceType/DeleteChargeDelete service type charge.
ServiceTypeApiservice_type_get_allGET /api/ServiceType/GetAllGet all service types. You can use a serice interface filter
ServiceTypeApiservice_type_get_all_chargesGET /api/ServiceType/GetAllChargesGet all service types and charges.
ServiceTypeApiservice_type_get_chargesGET /api/ServiceType/GetChargesGet all service types. You can use a serice interface filter
ServiceTypeApiservice_type_updatePUT /api/ServiceType/UpdateUpdate a service type
ServiceTypeApiservice_type_update_chargePUT /api/ServiceType/UpdateChargeUpdate service type charge.
ServicesApiservices_changePOST /api/Services/ChangeChange a service
ServicesApiservices_createPOST /api/Services/CreateCreate a new service
ServicesApiservices_create_chargePOST /api/Services/CreateCharge
ServicesApiservices_create_definition_resultsPOST /api/Services/CreateDefinitionResultsBuild definition keys after training
ServicesApiservices_delete_chargeDELETE /api/Services/DeleteChargeDelete service type charge.
ServicesApiservices_delete_custom_trainingDELETE /api/Services/DeleteCustomTrainingDelete custom training parameters
ServicesApiservices_find_service_referencesGET /api/Services/FindServiceReferencesFind References to a Service
ServicesApiservices_getGET /api/Services/GetGet a service by id
ServicesApiservices_get_chargesGET /api/Services/GetChargesGet all service types. You can use a serice interface filter
ServicesApiservices_get_code_constantsGET /api/Services/GetCodeConstantsGet code constants
ServicesApiservices_get_custom_trainingGET /api/Services/GetCustomTrainingGet custom training parameters
ServicesApiservices_get_custom_training_fieldsGET /api/Services/GetCustomTrainingFieldsGet custom training fields
ServicesApiservices_get_eventsGET /api/Services/GetEventsGet events for a service
ServicesApiservices_get_related_usersGET /api/Services/GetRelatedUsersGet related users
ServicesApiservices_get_training_reportGET /api/Services/GetTrainingReportGet training report for service
ServicesApiservices_initializePATCH /api/Services/InitializeInitialize a service
ServicesApiservices_movePOST /api/Services/MoveMove a service to another project
ServicesApiservices_processPOST /api/Services/ProcessProcess service documents
ServicesApiservices_save_custom_trainingPOST /api/Services/SaveCustomTrainingSave custom training
ServicesApiservices_trainPOST /api/Services/TrainTrain service
ServicesApiservices_update_chargePUT /api/Services/UpdateChargeUpdate service type charge.
SystemApisystem_check_servicesGET /api/System/CheckServicesCheck services
SystemApisystem_create_data_typePOST /api/System/CreateDataTypeCreate a new data type
SystemApisystem_create_enum_dataPOST /api/System/CreateEnumDataCreate a new system enum
SystemApisystem_delete_data_typeDELETE /api/System/DeleteDataTypeDelete a datatype
SystemApisystem_delete_enum_dataDELETE /api/System/DeleteEnumDataDelete a system enum
SystemApisystem_get_background_worker_itemGET /api/System/GetBackgroundWorkerItemGet background worker item
SystemApisystem_get_category_trainingGET /api/System/GetCategoryTrainingGet category training options
SystemApisystem_get_data_type_infoGET /api/System/GetDataTypeInfoGet value types
SystemApisystem_get_data_typesGET /api/System/GetDataTypesGet data types
SystemApisystem_get_enum_dataGET /api/System/GetEnumDataGet system enum values
SystemApisystem_get_enum_optionsGET /api/System/GetEnumOptionsGet enumerator options
SystemApisystem_get_exceptionGET /api/System/GetExceptionTest an exception
SystemApisystem_get_logsGET /api/System/GetLogsGet event logs
SystemApisystem_get_system_dateGET /api/System/GetSystemDateGet the current server date and time
SystemApisystem_get_system_infoGET /api/System/GetSystemInfoGet system and application information
SystemApisystem_sync_enum_dataPUT /api/System/SyncEnumDataDelete a system enum
SystemApisystem_test_data_setGET /api/System/GetDataSetDummy to expose event logs
SystemApisystem_update_data_typePUT /api/System/UpdateDataTypeUpdate a datatype description
SystemApisystem_update_enum_dataPUT /api/System/UpdateEnumDataUpdate system enum
UserPreferencesApiuser_preferences_getGET /api/UserPreferences/GetGet the current user preferences
UserPreferencesApiuser_preferences_savePUT /api/UserPreferences/SaveSave current user preferences
UserSettingsApiuser_settings_createPOST /api/UserSettings/CreateSave a user settings
UserSettingsApiuser_settings_deleteDELETE /api/UserSettings/DeleteDelete a user settings
UserSettingsApiuser_settings_getGET /api/UserSettings/GetGet user setting by name
UserSettingsApiuser_settings_get_allGET /api/UserSettings/GetAllGet user settings
UserSettingsApiuser_settings_get_pictureGET /api/UserSettings/GetPictureGet user profile picture
UserSettingsApiuser_settings_set_picturePOST /api/UserSettings/SetPictureGet user profile picture
UserSettingsApiuser_settings_updatePUT /api/UserSettings/UpdateUpdate a user settings
VerificationApiverification_getGET /api/Verification/GetGet a verification by ID
VerificationApiverification_get_allGET /api/Verification/GetAllGet all verifications for a parameter
VerificationApiverification_get_extendedGET /api/Verification/GetExtendedGet extended verification info
VerificationApiverification_get_heatmapGET /api/Verification/GetHeatmapGet verification analytics for service
VerificationApiverification_get_latestGET /api/Verification/GetLatestGet latest verification for a parameter
VerificationApiverification_get_shredGET /api/Verification/GetShredGet a verification image shred
VerificationApiverification_get_summaryGET /api/Verification/GetSummaryGet a summary of verifications for service
VerificationApiverification_rerunPOST /api/Verification/RerunRerun verification on a parameter
VerificationApiverification_rerun_allPOST /api/Verification/RerunAllRerun verification on a document
VerificationApiverification_verifyPUT /api/Verification/VerifyCreate a list of verifications
WizardApiwizard_create_servicePOST /api/Wizard/CreateServiceBootstrap a new serice and get the wizard steps required
WizardApiwizard_get_allGET /api/Wizard/GetAllGet all wizards steps for a project and services
WizardApiwizard_savePOST /api/Wizard/SaveSave a wizard step
WizardApiwizard_validatePOST /api/Wizard/ValidateValidate a visard step
WizardApiwizard_validate_multiPOST /api/Wizard/ValidateMultiValidate miltiple wizard steps
WorkItemApiwork_item_createPOST /api/WorkItem/CreateCreate Workflow for Document / Shred for Backward compatibility
WorkItemApiwork_item_create_exPOST /api/WorkItem/CreateExCreateEx Workflow for Document / Shred
WorkItemApiwork_item_deleteDELETE /api/WorkItem/DeleteDelete work item
WorkItemApiwork_item_escelatePOST /api/WorkItem/EscelateEscelate to another user
WorkItemApiwork_item_expireDELETE /api/WorkItem/ExpireExpire WorkItems
WorkItemApiwork_item_finalizePOST /api/WorkItem/FinalizeFinalize Workflow for Document
WorkItemApiwork_item_getGET /api/WorkItem/GetGet WorkItems
WorkItemApiwork_item_get_by_idGET /api/WorkItem/GetByIdGet WorkItem By Id
WorkItemApiwork_item_get_countGET /api/WorkItem/GetCountGet WorkItems Count
WorkItemApiwork_item_get_heatmapGET /api/WorkItem/GetHeatmapGet WorkItems Heatmap
WorkItemApiwork_item_get_summaryGET /api/WorkItem/GetSummaryGet WorkItems Summary
WorkItemApiwork_item_get_work_queueGET /api/WorkItem/GetWorkQueueGet document work queue
WorkItemApiwork_item_rebuildPOST /api/WorkItem/RebuildRebuild workitems and execute custom code
WorkItemApiwork_item_rejectPOST /api/WorkItem/RejectReject work item
WorkItemApiwork_item_reject_shredPOST /api/WorkItem/RejectShredReject work items for a shred
WorkItemApiwork_item_set_statusPUT /api/WorkItem/SetStatusUpdate status
WorkItemApiwork_item_transferPOST /api/WorkItem/TransferEscelate to another user
WorkItemApiwork_item_transfer_openPOST /api/WorkItem/TransferOpenTransfer all open to another user

Documentation For Models

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

support@aiforged.com

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
1.0.12 Jul 20244
Sorted by available source dates · UTC

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 10:43 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:ee8793b8cb6ed98284dac969a4089746c4cc1f80465dfc56981e027ca5f13eb1