Formkiq API: Document Management Platform API using OAuth(JWT) Authentication
You can find out more about FormKiQ at https://formkiq.com.
FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform.
FormKiQ API was built on top of OpenAPI specification, so it is easy to use the API spec file with any application that supports the OpenAPI specification.
Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml
Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml
FormKiQ offers three forms of authentication:
- OAuth(JWT)
- AWS IAM
- API Key
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.15.1
- Package version: 1.0.0
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://formkiq.com
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
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 formkiq_client
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 formkiq_client
Execute pytest
to run the tests.
Please follow the installation procedure and then run the following:
import formkiq_client
from formkiq_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = formkiq_client.Configuration(
host = "https://localhost"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Enter a context with an instance of the API client
with formkiq_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = formkiq_client.AccessControlApi(api_client)
site_id = 'site_id_example' # str | Site Identifier
try:
# Delete OPA Access Policy Items
api_response = api_instance.delete_opa_access_policy_items(site_id)
print("The response of AccessControlApi->delete_opa_access_policy_items:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AccessControlApi->delete_opa_access_policy_items: %s\n" % e)
All URIs are relative to https://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
AccessControlApi | delete_opa_access_policy_items | DELETE /sites/{siteId}/opa/accessPolicy/policyItems | Delete OPA Access Policy Items |
AccessControlApi | get_opa_access_policies | GET /sites/opa/accessPolicies | Get OPAs Access Policies |
AccessControlApi | get_opa_access_policy | GET /sites/{siteId}/opa/accessPolicy | Get OPA Access Policy |
AccessControlApi | get_opa_access_policy_items | GET /sites/{siteId}/opa/accessPolicy/policyItems | Get OPA Access Policy Items |
AccessControlApi | set_opa_access_policy_items | PUT /sites/{siteId}/opa/accessPolicy/policyItems | Set opa access policy items, can only be requested with ADMIN privileges |
AdvancedDocumentSearchApi | add_document_fulltext | POST /documents/{documentId}/fulltext | Add document's full-text |
AdvancedDocumentSearchApi | delete_document_fulltext | DELETE /documents/{documentId}/fulltext | Delete document full-text |
AdvancedDocumentSearchApi | delete_document_fulltext_tag | DELETE /documents/{documentId}/fulltext/tags/{tagKey} | Delete document full-text tag |
AdvancedDocumentSearchApi | delete_document_fulltext_tag_and_value | DELETE /documents/{documentId}/fulltext/tags/{tagKey}/{tagValue} | Delete document full-text tag/value |
AdvancedDocumentSearchApi | get_document_fulltext | GET /documents/{documentId}/fulltext | Get document's full-text |
AdvancedDocumentSearchApi | query_fulltext | POST /queryFulltext | Direct opensearch search API |
AdvancedDocumentSearchApi | search_fulltext | POST /searchFulltext | Document full-text search |
AdvancedDocumentSearchApi | set_document_fulltext | PUT /documents/{documentId}/fulltext | Set document's full-text |
AdvancedDocumentSearchApi | update_document_fulltext | PATCH /documents/{documentId}/fulltext | Update document's full-text |
AntivirusApi | set_antivirus | PUT /documents/{documentId}/antivirus | Antivirus document scan |
AttributesApi | add_attribute | POST /attributes | Add new attribute |
AttributesApi | delete_attribute | DELETE /attributes/{key} | Delete attribute |
AttributesApi | get_attribute | GET /attributes/{key} | Get Attribute |
AttributesApi | get_attributes | GET /attributes | Get Attributes listing |
CaseManagementApi | add_case | POST /cases | Add New Case |
CaseManagementApi | add_nigo | POST /cases/{caseId}/nigos | Add New Nigo |
CaseManagementApi | add_task | POST /cases/{caseId}/tasks | Add New Task |
CaseManagementApi | delete_case | DELETE /cases/{caseId} | Delete Case |
CaseManagementApi | delete_case_document | DELETE /cases/{caseId}/documents/{documentId} | Delete Document from Case |
CaseManagementApi | delete_nigo | DELETE /cases/{caseId}/nigos/{nigoId} | Delete Nigo |
CaseManagementApi | delete_nigo_document | DELETE /cases/{caseId}/nigos/{nigoId}/documents/{documentId} | Delete Document from Nigo |
CaseManagementApi | delete_task | DELETE /cases/{caseId}/tasks/{taskId} | Delete Task |
CaseManagementApi | delete_task_document | DELETE /cases/{caseId}/tasks/{taskId}/documents/{documentId} | Delete Document from Task |
CaseManagementApi | get_case | GET /cases/{caseId} | Get Case details |
CaseManagementApi | get_case_documents | GET /cases/{caseId}/documents | Get list of document in a case |
CaseManagementApi | get_case_nigo | GET /cases/{caseId}/nigos/{nigoId} | Get nigo in a case |
CaseManagementApi | get_case_nigos | GET /cases/{caseId}/nigos | Get list of Nigos in a case |
CaseManagementApi | get_case_task | GET /cases/{caseId}/tasks/{taskId} | Get task in a case |
CaseManagementApi | get_case_tasks | GET /cases/{caseId}/tasks | Get list of tasks in a case |
CaseManagementApi | get_cases | GET /cases | Get Case listing |
CaseManagementApi | get_nigo_documents | GET /cases/{caseId}/nigos/{nigoId}/documents | Get list of document in a task |
CaseManagementApi | get_task_documents | GET /cases/{caseId}/tasks/{taskId}/documents | Get list of document in a task |
CaseManagementApi | update_case | PATCH /cases/{caseId} | Update existing Case |
CaseManagementApi | update_nigo | PATCH /cases/{caseId}/nigos/{nigoId} | Update existing Nigo |
CaseManagementApi | update_task | PATCH /cases/{caseId}/tasks/{taskId} | Update existing Task |
CustomIndexApi | delete_index | DELETE /indices/{indexType}/{indexKey} | |
CustomIndexApi | index_folder_move | POST /indices/{indexType}/move | |
CustomIndexApi | index_search | POST /indices/search | |
DocumentActionsApi | add_document_actions | POST /documents/{documentId}/actions | Add document action |
DocumentActionsApi | add_document_retry_action | POST /documents/{documentId}/actions/retry | Retries failed document action(s) |
DocumentActionsApi | get_document_actions | GET /documents/{documentId}/actions | Get document actions |
DocumentAttributesApi | add_document_attributes | POST /documents/{documentId}/attributes | Add attribute to document |
DocumentAttributesApi | delete_document_attribute | DELETE /documents/{documentId}/attributes/{attributeKey} | Delete document attribute |
DocumentAttributesApi | delete_document_attribute_and_value | DELETE /documents/{documentId}/attributes/{attributeKey}/{attributeValue} | Delete document's attribute value |
DocumentAttributesApi | get_document_attribute | GET /documents/{documentId}/attributes/{attributeKey} | Get document attribute by key |
DocumentAttributesApi | get_document_attribute_versions | GET /documents/{documentId}/attributes/{attributeKey}/versions | Get document attribute's versions |
DocumentAttributesApi | get_document_attributes | GET /documents/{documentId}/attributes | Get document's attributes |
DocumentAttributesApi | set_document_attribute_value | PUT /documents/{documentId}/attributes/{attributeKey} | Set document's attributes value |
DocumentAttributesApi | set_document_attributes | PUT /documents/{documentId}/attributes | Set document's attributes |
DocumentFoldersApi | add_folder | POST /folders | Add document folder |
DocumentFoldersApi | delete_folder | DELETE /folders/{indexKey} | Delete document folder |
DocumentFoldersApi | get_folder_documents | GET /folders | Get document folders |
DocumentOCRApi | add_document_ocr | POST /documents/{documentId}/ocr | Perform document ocr |
DocumentOCRApi | delete_document_ocr | DELETE /documents/{documentId}/ocr | Delete document ocr |
DocumentOCRApi | get_document_ocr | GET /documents/{documentId}/ocr | Get document ocr content |
DocumentOCRApi | set_document_ocr | PUT /documents/{documentId}/ocr | Set document ocr result |
DocumentSearchApi | document_search | POST /search | Document search |
DocumentSharesApi | add_folder_share | POST /shares/folders/{indexKey} | Add folder share |
DocumentSharesApi | delete_share | DELETE /shares/{shareKey} | Delete folder share |
DocumentSharesApi | get_user_shares | GET /shares | Get user shared folders |
DocumentTagsApi | add_document_tags | POST /documents/{documentId}/tags | Add tag to document |
DocumentTagsApi | delete_document_tag | DELETE /documents/{documentId}/tags/{tagKey} | Delete document tag |
DocumentTagsApi | delete_document_tag_and_value | DELETE /documents/{documentId}/tags/{tagKey}/{tagValue} | Delete document's tag value |
DocumentTagsApi | get_document_tag | GET /documents/{documentId}/tags/{tagKey} | Get document tag by key |
DocumentTagsApi | get_document_tags | GET /documents/{documentId}/tags | Get document's tags |
DocumentTagsApi | set_document_tag | PUT /documents/{documentId}/tags/{tagKey} | Update document tag value(s) |
DocumentTagsApi | set_document_tags | PUT /documents/{documentId}/tags | Set document's tags |
DocumentTagsApi | update_document_tags | PATCH /documents/{documentId}/tags | Update document tags |
DocumentTagsApi | update_matching_document_tags | PATCH /documents/tags | Mass Update document tag(s) |
DocumentVersionsApi | delete_document_version | DELETE /documents/{documentId}/versions/{versionKey} | Delete document version |
DocumentVersionsApi | get_document_versions | GET /documents/{documentId}/versions | Get document's versions |
DocumentVersionsApi | set_document_version | PUT /documents/{documentId}/versions | Set version of document |
DocumentWorkflowsApi | add_document_workflow | POST /documents/{documentId}/workflows | Add document workflow |
DocumentWorkflowsApi | add_document_workflow_decisions | POST /documents/{documentId}/workflow/{workflowId}/decisions | Approve/Reject document in approval queue |
DocumentWorkflowsApi | add_queue | POST /queues | Add queue |
DocumentWorkflowsApi | add_workflow | POST /workflows | Add workflow |
DocumentWorkflowsApi | delete_queue | DELETE /queues/{queueId} | Delete queue |
DocumentWorkflowsApi | delete_workflow | DELETE /workflows/{workflowId} | Delete workflow |
DocumentWorkflowsApi | get_document_workflow | GET /documents/{documentId}/workflows/{workflowId} | Get document workflow |
DocumentWorkflowsApi | get_document_workflows | GET /documents/{documentId}/workflows | Get document workflows |
DocumentWorkflowsApi | get_queue | GET /queues/{queueId} | Get queue |
DocumentWorkflowsApi | get_queues | GET /queues | Get queues |
DocumentWorkflowsApi | get_workflow | GET /workflows/{workflowId} | Get workflow |
DocumentWorkflowsApi | get_workflow_documents | GET /workflows/{workflowId}/documents | Get list of documents in workflow |
DocumentWorkflowsApi | get_workflow_queue_documents | GET /queues/{queueId}/documents | Get list of documents in queue |
DocumentWorkflowsApi | get_workflows | GET /workflows | Get workflows |
DocumentWorkflowsApi | set_workflow | PUT /workflows/{workflowId} | Set workflow |
DocumentWorkflowsApi | update_workflow | PATCH /workflows/{workflowId} | Update workflow |
DocumentsApi | add_document | POST /documents | Add new document |
DocumentsApi | add_document_upload | POST /documents/upload | Add large document |
DocumentsApi | compress_documents | POST /documents/compress | Compress multiple documents into a .zip file |
DocumentsApi | delete_document | DELETE /documents/{documentId} | Delete document |
DocumentsApi | delete_published_document_content | DELETE /publications/{documentId} | Delete published document's contents |
DocumentsApi | get_document | GET /documents/{documentId} | Get document |
DocumentsApi | get_document_content | GET /documents/{documentId}/content | Get document's contents |
DocumentsApi | get_document_id_upload | GET /documents/{documentId}/upload | Get url to update large document |
DocumentsApi | get_document_syncs | GET /documents/{documentId}/syncs | Get document syncs |
DocumentsApi | get_document_upload | GET /documents/upload | Get url to add large document |
DocumentsApi | get_document_url | GET /documents/{documentId}/url | Get document content url |
DocumentsApi | get_documents | GET /documents | Get Documents listing |
DocumentsApi | get_published_document_content | GET /publications/{documentId} | Get published document's contents |
DocumentsApi | set_document_restore | PUT /documents/{documentId}/restore | Restore soft deleted document |
DocumentsApi | update_document | PATCH /documents/{documentId} | Update document |
ESignatureApi | add_esignature_docusign | POST /esignature/docusign/{documentId} | Create E-signature request |
ESignatureApi | add_esignature_docusign_events | POST /esignature/docusign/events | Add E-signature event |
ESignatureApi | get_esignature_docusign_config | GET /esignature/docusign/config | Get E-signature config |
ESignatureApi | set_esignature_docusign_config | PUT /esignature/docusign/config | Set E-signature config |
ExamineObjectsApi | get_examine_pdf | GET /objects/examine/{id}/pdf | Add Examine Pdf |
ExamineObjectsApi | get_examine_pdf_url | GET /objects/examine/pdf | Add Examine Pdf |
MappingsApi | add_mapping | POST /mappings | Add New Mapping |
MappingsApi | delete_mapping | DELETE /mappings/{mappingId} | Delete Mapping |
MappingsApi | get_mapping | GET /mappings/{mappingId} | Get Mapping |
MappingsApi | get_mappings | GET /mappings | Get Mappings |
MappingsApi | set_mapping | PUT /mappings/{mappingId} | Set Mapping |
OnlyofficeApi | only_office_document_edit | POST /onlyoffice/{documentId}/edit | Edit onlyoffice document |
OnlyofficeApi | only_office_document_new | POST /onlyoffice/new | Create onlyoffice document |
OnlyofficeApi | only_office_document_save | POST /onlyoffice/{documentId}/save | Save onlyoffice document |
PublicApi | public_add_document | POST /public/documents | Public add document |
PublicApi | public_add_webhook | POST /public/webhooks/{webhooks+} | Public add webhook |
RulesetsApi | add_rule | POST /rulesets/{rulesetId}/rules | Add New Rule |
RulesetsApi | add_ruleset | POST /rulesets | Add New Ruleset |
RulesetsApi | delete_rule | DELETE /rulesets/{rulesetId}/rules/{ruleId} | Delete Rule |
RulesetsApi | delete_ruleset | DELETE /rulesets/{rulesetId} | Delete Ruleset |
RulesetsApi | get_rule | GET /rulesets/{rulesetId}/rules/{ruleId} | Get Rule |
RulesetsApi | get_rules | GET /rulesets/{rulesetId}/rules | Get Rules |
RulesetsApi | get_ruleset | GET /rulesets/{rulesetId} | Get Ruleset |
RulesetsApi | get_rulesets | GET /rulesets | Get Rulesets |
RulesetsApi | update_rule | PATCH /rulesets/{rulesetId}/rules/{ruleId} | Update Rule |
RulesetsApi | update_ruleset | PATCH /rulesets/{rulesetId} | Update Ruleset |
SchemasApi | add_classification | POST /sites/{siteId}/classifications | Add Classification |
SchemasApi | delete_classification | DELETE /sites/{siteId}/classifications/{classificationId} | Delete Classification |
SchemasApi | get_classification | GET /sites/{siteId}/classifications/{classificationId} | Get Classification |
SchemasApi | get_sites_classifications | GET /sites/{siteId}/classifications | Get Sites Classifications |
SchemasApi | get_sites_schema | GET /sites/{siteId}/schema/document | Get Sites Schema |
SchemasApi | set_classification | PUT /sites/{siteId}/classifications/{classificationId} | Set Classification |
SchemasApi | set_sites_schema | PUT /sites/{siteId}/schema/document | Set Sites Schema |
SystemManagementApi | add_api_key | POST /sites/{siteId}/apiKeys | Add API Key |
SystemManagementApi | delete_api_key | DELETE /sites/{siteId}/apiKeys/{apiKey} | Delete API Key |
SystemManagementApi | delete_opensearch_index | DELETE /sites/{siteId}/opensearch/index | Deletst site(s) OpenSearch index |
SystemManagementApi | get_api_keys | GET /sites/{siteId}/apiKeys | Get API Keys |
SystemManagementApi | get_configuration | GET /sites/{siteId}/configuration | Get site configuration |
SystemManagementApi | get_opensearch_index | GET /sites/{siteId}/opensearch/index | Get site(s) OpenSearch index settings |
SystemManagementApi | get_sites | GET /sites | Get site(s) access |
SystemManagementApi | get_version | GET /version | Get FormKiQ version |
SystemManagementApi | set_opensearch_index | PUT /sites/{siteId}/opensearch/index | Set site(s) OpenSearch index settings |
SystemManagementApi | update_configuration | PATCH /sites/{siteId}/configuration | Update site configuration |
TagIndexApi | index_search | POST /indices/search | |
TagSchemaApi | add_tag_schema | POST /tagSchemas | Add tag schemas |
TagSchemaApi | delete_tag_schema | DELETE /tagSchemas/{tagSchemaId} | Delete tag schema |
TagSchemaApi | get_tag_schema | GET /tagSchemas/{tagSchemaId} | Get tag schema |
TagSchemaApi | get_tag_schemas | GET /tagSchemas | Get tag schemas |
UserActivitiesApi | get_document_user_activities | GET /documents/{documentId}/userActivities | Get user activities |
UserActivitiesApi | get_user_activities | GET /userActivities | Get user activities |
UserManagementApi | add_group | POST /groups | Add a group |
UserManagementApi | add_user | POST /users | Add User |
UserManagementApi | add_user_to_group | POST /groups/{groupName}/users | Add User to a group |
UserManagementApi | delete_group | DELETE /groups/{groupName} | Delete Group |
UserManagementApi | delete_username | DELETE /users/{username} | Delete Username |
UserManagementApi | get_group | GET /groups/{groupName} | Get a user group |
UserManagementApi | get_groups | GET /groups | Get list of user group(s) |
UserManagementApi | get_list_of_user_groups | GET /users/{username}/groups | Returns a list of group user belongs to |
UserManagementApi | get_user | GET /users/{username} | Get a user |
UserManagementApi | get_users | GET /users | Get list of user(s) |
UserManagementApi | get_users_in_group | GET /groups/{groupName}/users | Get users in a group |
UserManagementApi | remove_username_from_group | DELETE /groups/{groupName}/users/{username} | Remove Username From Group |
UserManagementApi | set_user_operation | PUT /users/{username}/{userOperation} | Set User Operation |
WebhooksApi | add_webhook | POST /webhooks | Add webhook |
WebhooksApi | add_webhook_document | POST /private/webhooks/{webhooks+} | Add webhook |
WebhooksApi | add_webhook_tag | POST /webhooks/{webhookId}/tags | Add webhook tag |
WebhooksApi | delete_webhook | DELETE /webhooks/{webhookId} | Delete webhook |
WebhooksApi | get_webhook | GET /webhooks/{webhookId} | Get webhook |
WebhooksApi | get_webhook_tags | GET /webhooks/{webhookId}/tags | Get webhook tags |
WebhooksApi | get_webhooks | GET /webhooks | Get webhooks |
WebhooksApi | update_webhook | PATCH /webhooks/{webhookId} | Update webhook |
- AddAction
- AddActionParameters
- AddApiKeyRequest
- AddApiKeyResponse
- AddAttribute
- AddAttributeRequest
- AddAttributeResponse
- AddCase
- AddCaseRequest
- AddCaseResponse
- AddChildDocument
- AddChildDocumentResponse
- AddClassification
- AddClassificationRequest
- AddClassificationResponse
- AddDocumentActionsRequest
- AddDocumentActionsResponse
- AddDocumentActionsRetryResponse
- AddDocumentAttribute
- AddDocumentAttributeClassification
- AddDocumentAttributeStandard
- AddDocumentAttributeValue
- AddDocumentAttributesRequest
- AddDocumentFulltextRequest
- AddDocumentFulltextResponse
- AddDocumentMetadata
- AddDocumentOcrRequest
- AddDocumentOcrResponse
- AddDocumentRequest
- AddDocumentResponse
- AddDocumentTag
- AddDocumentTagsRequest
- AddDocumentUploadRequest
- AddDocumentWorkflowDecisionsRequest
- AddDocumentWorkflowDecisionsResponse
- AddDocumentWorkflowRequest
- AddDocumentWorkflowResponse
- AddEsignatureDocusignRequest
- AddEsignatureDocusignResponse
- AddFolderRequest
- AddFolderResponse
- AddFolderShareRequest
- AddFolderShareResponse
- AddGroup
- AddGroupRequest
- AddMapping
- AddMappingRequest
- AddMappingResponse
- AddNigo
- AddNigoRequest
- AddNigoResponse
- AddQueueRequest
- AddQueueResponse
- AddResponse
- AddRule
- AddRuleRequest
- AddRuleResponse
- AddRuleset
- AddRulesetRequest
- AddRulesetResponse
- AddShare
- AddTagSchemaRequest
- AddTagSchemaResponse
- AddTagSchemaTags
- AddTask
- AddTaskRequest
- AddTaskResponse
- AddUser
- AddUserRequest
- AddWebhookRequest
- AddWebhookResponse
- AddWebhookTagRequest
- AddWorkflowRequest
- AddWorkflowResponse
- AddWorkflowStep
- AddWorkflowStepDecision
- AddWorkflowStepQueue
- ApiKey
- Attribute
- AttributeDataType
- AttributeSchemaCompositeKey
- AttributeSchemaOptional
- AttributeSchemaRequired
- AttributeType
- AttributeValueType
- Case
- CaseStatus
- ChildDocument
- Classification
- ClassificationSummary
- DeleteApiKeyResponse
- DeleteCaseDocumentResponse
- DeleteCaseNigoDocumentResponse
- DeleteCaseNigoResponse
- DeleteCaseResponse
- DeleteCaseTaskDocumentResponse
- DeleteCaseTaskResponse
- DeleteFolderResponse
- DeleteFulltextResponse
- DeleteIndicesResponse
- DeleteQueueResponse
- DeleteResponse
- DeleteRuleResponse
- DeleteRulesetResponse
- DeleteShareResponse
- DeleteWorkflowResponse
- Document
- DocumentAction
- DocumentActionStatus
- DocumentActionType
- DocumentAttribute
- DocumentFulltextAttribute
- DocumentFulltextAttributeEq
- DocumentFulltextRequest
- DocumentFulltextResponse
- DocumentFulltextSearch
- DocumentFulltextTag
- DocumentId
- DocumentMetadata
- DocumentSearch
- DocumentSearchAttribute
- DocumentSearchMatchAttribute
- DocumentSearchMatchTag
- DocumentSearchMeta
- DocumentSearchRange
- DocumentSearchRequest
- DocumentSearchResponse
- DocumentSearchTag
- DocumentSearchTags
- DocumentSyncService
- DocumentSyncStatus
- DocumentSyncType
- DocumentTag
- DocumentVersion
- DocumentWorkflow
- DocumentWorkflowStatus
- DocumentsCompressRequest
- DocumentsCompressResponse
- Error
- ErrorsResponse
- EsignatureDocusignCarbonCopy
- EsignatureDocusignRecipientTab
- EsignatureDocusignSigner
- FulltextAttribute
- FulltextSearchItem
- GetApiKeysResponse
- GetAttributeResponse
- GetAttributesResponse
- GetCaseDocumentsResponse
- GetCaseNigoResponse
- GetCaseNigosResponse
- GetCaseResponse
- GetCaseTaskResponse
- GetCaseTasksResponse
- GetCasesResponse
- GetClassificationResponse
- GetClassificationsResponse
- GetConfigurationResponse
- GetDocumentActionsResponse
- GetDocumentAttributeResponse
- GetDocumentAttributeVersionsResponse
- GetDocumentAttributesResponse
- GetDocumentContentResponse
- GetDocumentFulltextResponse
- GetDocumentOcrResponse
- GetDocumentResponse
- GetDocumentSync
- GetDocumentSyncResponse
- GetDocumentTagResponse
- GetDocumentTagsResponse
- GetDocumentUrlResponse
- GetDocumentVersionsResponse
- GetDocumentWorkflowResponse
- GetDocumentWorkflowsResponse
- GetDocumentsResponse
- GetEsignatureDocusignConfigResponse
- GetExaminePdfResponse
- GetExaminePdfUrlResponse
- GetFoldersResponse
- GetGroupResponse
- GetGroupsResponse
- GetMappingResponse
- GetMappingsResponse
- GetOpaAccessPoliciesResponse
- GetOpaAccessPolicyItemsResponse
- GetOpaAccessPolicyResponse
- GetOpenSearchIndexResponse
- GetQueueResponse
- GetQueuesResponse
- GetRuleResponse
- GetRulesResponse
- GetRulesetResponse
- GetRulesetsResponse
- GetSitesResponse
- GetSitesSchemaResponse
- GetTagSchemaResponse
- GetTagSchemasResponse
- GetUserActivitesResponse
- GetUserGroupsResponse
- GetUserResponse
- GetUserSharesResponse
- GetUsersInGroupResponse
- GetUsersResponse
- GetVersionResponse
- GetWebhookResponse
- GetWebhookTagsResponse
- GetWebhooksResponse
- GetWorkflowDocumentsResponse
- GetWorkflowQueueDocumentsResponse
- GetWorkflowResponse
- GetWorkflowsResponse
- Group
- IndexFolderMoveRequest
- IndexFolderMoveResponse
- IndexSearch
- IndexSearchRequest
- IndexSearchResponse
- Mapping
- MappingAttribute
- MappingAttributeLabelMatchingType
- MappingAttributeMetadataField
- MappingAttributeSourceType
- MatchDocumentTag
- Nigo
- NigoStatus
- OcrEngine
- OcrKeyValues
- OcrOutputType
- OnlyOfficeConfig
- OnlyOfficeConfigDocument
- OnlyOfficeDocumentNewRequest
- OnlyOfficeDocumentResponse
- OnlyOfficeDocumentSaveResponse
- OnlyOfficeEditorConfig
- OpaPolicy
- OpaPolicyAttribute
- OpaPolicyAttributeEq
- OpaPolicyAttributeGt
- OpaPolicyAttributeGte
- OpaPolicyAttributeInput
- OpaPolicyAttributeLt
- OpaPolicyAttributeLte
- OpaPolicyAttributeNeq
- OpaPolicyItem
- OpaPolicyItemType
- OpenSearchIndex
- PdfDocument
- PdfDocumentField
- QueryFulltextResponse
- Queue
- Rule
- RuleCondition
- RuleConditionAttribute
- RuleConditionCriterion
- RuleConditionMust
- RuleConditionOperation
- Ruleset
- RulesetStatus
- SchemaAttributes
- SearchRangeDataType
- SearchResponseFields
- SearchResultDocument
- SearchResultDocumentAttribute
- SetAntivirusResponse
- SetClassificationRequest
- SetDocumentAttributeRequest
- SetDocumentAttributesRequest
- SetDocumentFulltextRequest
- SetDocumentFulltextResponse
- SetDocumentOcrRequest
- SetDocumentRestoreResponse
- SetDocumentTagKeyRequest
- SetDocumentVersionRequest
- SetDocumentVersionResponse
- SetEsignatureDocusignConfigRequest
- SetEsignatureDocusignConfigResponse
- SetMappingRequest
- SetOpaAccessPolicyItemsRequest
- SetOpenSearchIndexRequest
- SetOpenSearchIndexResponse
- SetResponse
- SetSitesSchemaRequest
- SetWorkflowRequest
- SetWorkflowResponse
- Site
- StringFormat
- StringGeneratorType
- TagSchema
- TagSchemaCompositeKey
- TagSchemaOptional
- TagSchemaRequired
- TagSchemaSummary
- TagSchemaTags
- Task
- TaskStatus
- UpdateCase
- UpdateCaseRequest
- UpdateCaseResponse
- UpdateConfigurationRequest
- UpdateConfigurationResponse
- UpdateDocumentFulltextRequest
- UpdateDocumentFulltextResponse
- UpdateDocumentRequest
- UpdateMatchingDocumentTagsRequest
- UpdateMatchingDocumentTagsRequestMatch
- UpdateMatchingDocumentTagsRequestUpdate
- UpdateMatchingDocumentTagsResponse
- UpdateNigo
- UpdateNigoRequest
- UpdateNigoResponse
- UpdateRule
- UpdateRuleRequest
- UpdateRuleResponse
- UpdateRuleset
- UpdateRulesetRequest
- UpdateRulesetResponse
- UpdateTask
- UpdateTaskRequest
- UpdateTaskResponse
- UpdateWorkflowRequest
- UpdateWorkflowResponse
- User
- UserActivity
- UserActivityType
- UserShare
- UserSharePermission
- UserSharePermissionType
- ValidationError
- ValidationErrorsResponse
- WebhookTag
- WorkflowDocument
- WorkflowQueue
- WorkflowStatus
- WorkflowStep
- WorkflowStepDecision
- WorkflowStepDecisionType
- WorkflowSummary
Endpoints do not require authorization.