44This is the official supported Java library for the FormKiQ API.
55
66FormKiQ HTTP API
7- - API version: 1.16 .0
8- - Build date: 2024-11-13T21:59:20.801618-06 :00[ America/Winnipeg]
9- - Generator version: 7.9 .0
7+ - API version: 1.17 .0
8+ - Build date: 2025-03-12T17:17:25.165880-05 :00[ America/Winnipeg]
9+ - Generator version: 7.12 .0
1010
1111Formkiq API: Document Management Platform API using OAuth(JWT) Authentication
1212
@@ -63,7 +63,7 @@ Add this dependency to your project's POM:
6363<dependency >
6464 <groupId >com.formkiq</groupId >
6565 <artifactId >client</artifactId >
66- <version >1.16.1 </version >
66+ <version >1.17.0 </version >
6767 <scope >compile</scope >
6868</dependency >
6969```
@@ -79,7 +79,7 @@ Add this dependency to your project's build file:
7979 }
8080
8181 dependencies {
82- implementation "com.formkiq:client:1.16.1 "
82+ implementation "com.formkiq:client:1.17.0 "
8383 }
8484```
8585
@@ -93,7 +93,7 @@ mvn clean package
9393
9494Then manually install the following JARs:
9595
96- * ` target/client-1.16.1 .jar `
96+ * ` target/client-1.17.0 .jar `
9797* ` target/lib/*.jar `
9898
9999## Getting Started
@@ -113,7 +113,7 @@ import com.formkiq.client.api.AdvancedDocumentSearchApi;
113113public class Example {
114114 public static void main (String [] args ) {
115115 ApiClient defaultClient = Configuration . getDefaultApiClient();
116-
116+
117117 // Pick one of the following authorization methods (JWT / IAM / KEY)
118118 //
119119 // 1. For JWT authorization
@@ -284,6 +284,7 @@ Class | Method | HTTP request | Description
284284* DocumentsApi* | [ ** getDocumentUrl** ] ( docs/DocumentsApi.md#getDocumentUrl ) | ** GET** /documents/{documentId}/url | Get document content url
285285* DocumentsApi* | [ ** getDocuments** ] ( docs/DocumentsApi.md#getDocuments ) | ** GET** /documents | Get Documents listing
286286* DocumentsApi* | [ ** getPublishedDocumentContent** ] ( docs/DocumentsApi.md#getPublishedDocumentContent ) | ** GET** /publications/{documentId} | Get published document' ; s contents
287+ * DocumentsApi* | [ ** purgeDocument** ] ( docs/DocumentsApi.md#purgeDocument ) | ** DELETE** /documents/{documentId}/purge | Purge document
287288* DocumentsApi* | [ ** setDocumentRestore** ] ( docs/DocumentsApi.md#setDocumentRestore ) | ** PUT** /documents/{documentId}/restore | Restore soft deleted document
288289* DocumentsApi* | [ ** updateDocument** ] ( docs/DocumentsApi.md#updateDocument ) | ** PATCH** /documents/{documentId} | Update document
289290* ESignatureApi* | [ ** addDocusignEnvelopes** ] ( docs/ESignatureApi.md#addDocusignEnvelopes ) | ** POST** /esignature/docusign/{documentId}/envelopes | Create Docusign Envelope request
@@ -297,9 +298,6 @@ Class | Method | HTTP request | Description
297298* MappingsApi* | [ ** getMapping** ] ( docs/MappingsApi.md#getMapping ) | ** GET** /mappings/{mappingId} | Get Mapping
298299* MappingsApi* | [ ** getMappings** ] ( docs/MappingsApi.md#getMappings ) | ** GET** /mappings | Get Mappings
299300* MappingsApi* | [ ** setMapping** ] ( docs/MappingsApi.md#setMapping ) | ** PUT** /mappings/{mappingId} | Set Mapping
300- * OnlyofficeApi* | [ ** onlyOfficeDocumentEdit** ] ( docs/OnlyofficeApi.md#onlyOfficeDocumentEdit ) | ** POST** /onlyoffice/{documentId}/edit | Edit onlyoffice document
301- * OnlyofficeApi* | [ ** onlyOfficeDocumentNew** ] ( docs/OnlyofficeApi.md#onlyOfficeDocumentNew ) | ** POST** /onlyoffice/new | Create onlyoffice document
302- * OnlyofficeApi* | [ ** onlyOfficeDocumentSave** ] ( docs/OnlyofficeApi.md#onlyOfficeDocumentSave ) | ** POST** /onlyoffice/{documentId}/save | Save onlyoffice document
303301* PublicApi* | [ ** publicAddDocument** ] ( docs/PublicApi.md#publicAddDocument ) | ** POST** /public/documents | Public add document
304302* PublicApi* | [ ** publicAddWebhook** ] ( docs/PublicApi.md#publicAddWebhook ) | ** POST** /public/webhooks/{webhooks+} | Public add webhook
305303* ReindexApi* | [ ** addReindexDocument** ] ( docs/ReindexApi.md#addReindexDocument ) | ** POST** /reindex/documents/{documentId} | Reindex metadata on a document
@@ -323,17 +321,25 @@ Class | Method | HTTP request | Description
323321* SchemasApi* | [ ** setClassification** ] ( docs/SchemasApi.md#setClassification ) | ** PUT** /sites/{siteId}/classifications/{classificationId} | Set Classification
324322* SchemasApi* | [ ** setSitesSchema** ] ( docs/SchemasApi.md#setSitesSchema ) | ** PUT** /sites/{siteId}/schema/document | Set Sites Schema
325323* SystemManagementApi* | [ ** addApiKey** ] ( docs/SystemManagementApi.md#addApiKey ) | ** POST** /sites/{siteId}/apiKeys | Add API Key
324+ * SystemManagementApi* | [ ** addLocale** ] ( docs/SystemManagementApi.md#addLocale ) | ** POST** /sites/{siteId}/locales | Add Locale
325+ * SystemManagementApi* | [ ** addLocaleResourceItem** ] ( docs/SystemManagementApi.md#addLocaleResourceItem ) | ** POST** /sites/{siteId}/locales/{locale}/resourceItems | Add Locale Resource Item
326326* SystemManagementApi* | [ ** addSite** ] ( docs/SystemManagementApi.md#addSite ) | ** POST** /sites | Add Site
327327* SystemManagementApi* | [ ** deleteApiKey** ] ( docs/SystemManagementApi.md#deleteApiKey ) | ** DELETE** /sites/{siteId}/apiKeys/{apiKey} | Delete API Key
328+ * SystemManagementApi* | [ ** deleteLocale** ] ( docs/SystemManagementApi.md#deleteLocale ) | ** DELETE** /sites/{siteId}/locales/{locale} | Delete Locale
329+ * SystemManagementApi* | [ ** deleteLocaleResourceItem** ] ( docs/SystemManagementApi.md#deleteLocaleResourceItem ) | ** DELETE** /sites/{siteId}/locales/{locale}/resourceItems/{itemKey} | Delete Local Resource Item
328330* SystemManagementApi* | [ ** deleteOpensearchIndex** ] ( docs/SystemManagementApi.md#deleteOpensearchIndex ) | ** DELETE** /sites/{siteId}/opensearch/index | Deletes site(s) OpenSearch index
329331* SystemManagementApi* | [ ** deleteSiteGroup** ] ( docs/SystemManagementApi.md#deleteSiteGroup ) | ** DELETE** /sites/{siteId}/groups/{groupName} | Deletes Site Group and permissions
330332* SystemManagementApi* | [ ** getApiKeys** ] ( docs/SystemManagementApi.md#getApiKeys ) | ** GET** /sites/{siteId}/apiKeys | Get API Keys
331333* SystemManagementApi* | [ ** getConfiguration** ] ( docs/SystemManagementApi.md#getConfiguration ) | ** GET** /sites/{siteId}/configuration | Get site configuration
334+ * SystemManagementApi* | [ ** getLocaleResourceItem** ] ( docs/SystemManagementApi.md#getLocaleResourceItem ) | ** GET** /sites/{siteId}/locales/{locale}/resourceItems/{itemKey} | Get Resource Item by Locale
335+ * SystemManagementApi* | [ ** getLocaleResourceItems** ] ( docs/SystemManagementApi.md#getLocaleResourceItems ) | ** GET** /sites/{siteId}/locales/{locale}/resourceItems | Get Resource Items by Locale
336+ * SystemManagementApi* | [ ** getLocales** ] ( docs/SystemManagementApi.md#getLocales ) | ** GET** /sites/{siteId}/locales | Get Locales
332337* SystemManagementApi* | [ ** getOpensearchIndex** ] ( docs/SystemManagementApi.md#getOpensearchIndex ) | ** GET** /sites/{siteId}/opensearch/index | Get site(s) OpenSearch index settings
333338* SystemManagementApi* | [ ** getSiteGroup** ] ( docs/SystemManagementApi.md#getSiteGroup ) | ** GET** /sites/{siteId}/groups/{groupName} | Get group and permissions belonging to site
334339* SystemManagementApi* | [ ** getSiteGroups** ] ( docs/SystemManagementApi.md#getSiteGroups ) | ** GET** /sites/{siteId}/groups | Get group(s) and permissions belonging to site
335340* SystemManagementApi* | [ ** getSites** ] ( docs/SystemManagementApi.md#getSites ) | ** GET** /sites | Get site(s) access
336341* SystemManagementApi* | [ ** getVersion** ] ( docs/SystemManagementApi.md#getVersion ) | ** GET** /version | Get FormKiQ version
342+ * SystemManagementApi* | [ ** setLocaleResourceItem** ] ( docs/SystemManagementApi.md#setLocaleResourceItem ) | ** PUT** /sites/{siteId}/locales/{locale}/resourceItems/{itemKey} | Set Locale Resource Item
337343* SystemManagementApi* | [ ** setOpensearchIndex** ] ( docs/SystemManagementApi.md#setOpensearchIndex ) | ** PUT** /sites/{siteId}/opensearch/index | Set site(s) OpenSearch index settings
338344* SystemManagementApi* | [ ** setSiteGroupPermissions** ] ( docs/SystemManagementApi.md#setSiteGroupPermissions ) | ** PUT** /sites/{siteId}/groups/{groupName}/permissions | Set Site' ; s Group Permissions
339345* SystemManagementApi* | [ ** updateConfiguration** ] ( docs/SystemManagementApi.md#updateConfiguration ) | ** PATCH** /sites/{siteId}/configuration | Update site configuration
@@ -373,6 +379,8 @@ Class | Method | HTTP request | Description
373379 - [ AddAttribute] ( docs/AddAttribute.md )
374380 - [ AddAttributeRequest] ( docs/AddAttributeRequest.md )
375381 - [ AddAttributeResponse] ( docs/AddAttributeResponse.md )
382+ - [ AddAttributeSchemaOptional] ( docs/AddAttributeSchemaOptional.md )
383+ - [ AddAttributeSchemaRequired] ( docs/AddAttributeSchemaRequired.md )
376384 - [ AddCase] ( docs/AddCase.md )
377385 - [ AddCaseRequest] ( docs/AddCaseRequest.md )
378386 - [ AddCaseResponse] ( docs/AddCaseResponse.md )
@@ -418,6 +426,12 @@ Class | Method | HTTP request | Description
418426 - [ AddGoogleDocumentExportResponse] ( docs/AddGoogleDocumentExportResponse.md )
419427 - [ AddGroup] ( docs/AddGroup.md )
420428 - [ AddGroupRequest] ( docs/AddGroupRequest.md )
429+ - [ AddLocaleRequest] ( docs/AddLocaleRequest.md )
430+ - [ AddLocaleResourceClassificationItem] ( docs/AddLocaleResourceClassificationItem.md )
431+ - [ AddLocaleResourceInterfaceItem] ( docs/AddLocaleResourceInterfaceItem.md )
432+ - [ AddLocaleResourceItemRequest] ( docs/AddLocaleResourceItemRequest.md )
433+ - [ AddLocaleResourceItemResponse] ( docs/AddLocaleResourceItemResponse.md )
434+ - [ AddLocaleResourceSchemaItem] ( docs/AddLocaleResourceSchemaItem.md )
421435 - [ AddMapping] ( docs/AddMapping.md )
422436 - [ AddMappingRequest] ( docs/AddMappingRequest.md )
423437 - [ AddMappingResponse] ( docs/AddMappingResponse.md )
@@ -427,6 +441,7 @@ Class | Method | HTTP request | Description
427441 - [ AddQueueRequest] ( docs/AddQueueRequest.md )
428442 - [ AddQueueResponse] ( docs/AddQueueResponse.md )
429443 - [ AddReindexDocumentRequest] ( docs/AddReindexDocumentRequest.md )
444+ - [ AddResourceItem] ( docs/AddResourceItem.md )
430445 - [ AddResponse] ( docs/AddResponse.md )
431446 - [ AddRule] ( docs/AddRule.md )
432447 - [ AddRuleRequest] ( docs/AddRuleRequest.md )
@@ -507,6 +522,7 @@ Class | Method | HTTP request | Description
507522 - [ DocumentSearchResponse] ( docs/DocumentSearchResponse.md )
508523 - [ DocumentSearchTag] ( docs/DocumentSearchTag.md )
509524 - [ DocumentSearchTags] ( docs/DocumentSearchTags.md )
525+ - [ DocumentSync] ( docs/DocumentSync.md )
510526 - [ DocumentSyncService] ( docs/DocumentSyncService.md )
511527 - [ DocumentSyncStatus] ( docs/DocumentSyncStatus.md )
512528 - [ DocumentSyncType] ( docs/DocumentSyncType.md )
@@ -552,7 +568,6 @@ Class | Method | HTTP request | Description
552568 - [ GetDocumentFulltextResponse] ( docs/GetDocumentFulltextResponse.md )
553569 - [ GetDocumentOcrResponse] ( docs/GetDocumentOcrResponse.md )
554570 - [ GetDocumentResponse] ( docs/GetDocumentResponse.md )
555- - [ GetDocumentSync] ( docs/GetDocumentSync.md )
556571 - [ GetDocumentSyncResponse] ( docs/GetDocumentSyncResponse.md )
557572 - [ GetDocumentTagResponse] ( docs/GetDocumentTagResponse.md )
558573 - [ GetDocumentTagsResponse] ( docs/GetDocumentTagsResponse.md )
@@ -566,6 +581,9 @@ Class | Method | HTTP request | Description
566581 - [ GetFoldersResponse] ( docs/GetFoldersResponse.md )
567582 - [ GetGroupResponse] ( docs/GetGroupResponse.md )
568583 - [ GetGroupsResponse] ( docs/GetGroupsResponse.md )
584+ - [ GetLocaleResourceItemResponse] ( docs/GetLocaleResourceItemResponse.md )
585+ - [ GetLocaleResourceItemsResponse] ( docs/GetLocaleResourceItemsResponse.md )
586+ - [ GetLocalesResponse] ( docs/GetLocalesResponse.md )
569587 - [ GetMappingResponse] ( docs/GetMappingResponse.md )
570588 - [ GetMappingsResponse] ( docs/GetMappingsResponse.md )
571589 - [ GetOpaAccessPoliciesResponse] ( docs/GetOpaAccessPoliciesResponse.md )
@@ -605,6 +623,7 @@ Class | Method | HTTP request | Description
605623 - [ IndexSearchRequest] ( docs/IndexSearchRequest.md )
606624 - [ IndexSearchResponse] ( docs/IndexSearchResponse.md )
607625 - [ Locale] ( docs/Locale.md )
626+ - [ LocaleResourceType] ( docs/LocaleResourceType.md )
608627 - [ Mapping] ( docs/Mapping.md )
609628 - [ MappingAttribute] ( docs/MappingAttribute.md )
610629 - [ MappingAttributeLabelMatchingType] ( docs/MappingAttributeLabelMatchingType.md )
@@ -620,12 +639,6 @@ Class | Method | HTTP request | Description
620639 - [ OcrOutputType] ( docs/OcrOutputType.md )
621640 - [ OcrTable] ( docs/OcrTable.md )
622641 - [ OcrTableData] ( docs/OcrTableData.md )
623- - [ OnlyOfficeConfig] ( docs/OnlyOfficeConfig.md )
624- - [ OnlyOfficeConfigDocument] ( docs/OnlyOfficeConfigDocument.md )
625- - [ OnlyOfficeDocumentNewRequest] ( docs/OnlyOfficeDocumentNewRequest.md )
626- - [ OnlyOfficeDocumentResponse] ( docs/OnlyOfficeDocumentResponse.md )
627- - [ OnlyOfficeDocumentSaveResponse] ( docs/OnlyOfficeDocumentSaveResponse.md )
628- - [ OnlyOfficeEditorConfig] ( docs/OnlyOfficeEditorConfig.md )
629642 - [ OpaPolicy] ( docs/OpaPolicy.md )
630643 - [ OpaPolicyAttribute] ( docs/OpaPolicyAttribute.md )
631644 - [ OpaPolicyAttributeEq] ( docs/OpaPolicyAttributeEq.md )
@@ -643,6 +656,7 @@ Class | Method | HTTP request | Description
643656 - [ QueryFulltextResponse] ( docs/QueryFulltextResponse.md )
644657 - [ Queue] ( docs/Queue.md )
645658 - [ ReindexTarget] ( docs/ReindexTarget.md )
659+ - [ ResourceItem] ( docs/ResourceItem.md )
646660 - [ Rule] ( docs/Rule.md )
647661 - [ RuleCondition] ( docs/RuleCondition.md )
648662 - [ RuleConditionAttribute] ( docs/RuleConditionAttribute.md )
@@ -668,11 +682,13 @@ Class | Method | HTTP request | Description
668682 - [ SetDocumentVersionRequest] ( docs/SetDocumentVersionRequest.md )
669683 - [ SetDocumentVersionResponse] ( docs/SetDocumentVersionResponse.md )
670684 - [ SetGroupPermissionsRequest] ( docs/SetGroupPermissionsRequest.md )
685+ - [ SetLocaleResourceItemRequest] ( docs/SetLocaleResourceItemRequest.md )
671686 - [ SetMappingRequest] ( docs/SetMappingRequest.md )
672687 - [ SetOpaAccessPolicyItemsRequest] ( docs/SetOpaAccessPolicyItemsRequest.md )
673688 - [ SetOpenSearchIndexRequest] ( docs/SetOpenSearchIndexRequest.md )
674689 - [ SetOpenSearchIndexResponse] ( docs/SetOpenSearchIndexResponse.md )
675690 - [ SetResponse] ( docs/SetResponse.md )
691+ - [ SetSchemaAttributes] ( docs/SetSchemaAttributes.md )
676692 - [ SetSitesSchemaRequest] ( docs/SetSitesSchemaRequest.md )
677693 - [ SetWorkflowRequest] ( docs/SetWorkflowRequest.md )
678694 - [ SetWorkflowResponse] ( docs/SetWorkflowResponse.md )
@@ -725,6 +741,11 @@ Class | Method | HTTP request | Description
725741 - [ UserSharePermissionType] ( docs/UserSharePermissionType.md )
726742 - [ ValidationError] ( docs/ValidationError.md )
727743 - [ ValidationErrorsResponse] ( docs/ValidationErrorsResponse.md )
744+ - [ Watermark] ( docs/Watermark.md )
745+ - [ WatermarkPosition] ( docs/WatermarkPosition.md )
746+ - [ WatermarkPositionXAnchor] ( docs/WatermarkPositionXAnchor.md )
747+ - [ WatermarkPositionYAnchor] ( docs/WatermarkPositionYAnchor.md )
748+ - [ WatermarkScale] ( docs/WatermarkScale.md )
728749 - [ WebhookTag] ( docs/WebhookTag.md )
729750 - [ WorkflowDocument] ( docs/WorkflowDocument.md )
730751 - [ WorkflowQueue] ( docs/WorkflowQueue.md )
0 commit comments