All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
addDocument | POST /documents | Add new document |
addDocumentUpload | POST /documents/upload | Add large document |
compressDocuments | POST /documents/compress | Compress multiple documents into a .zip file |
deleteDocument | DELETE /documents/{documentId} | Delete document |
deletePublishedDocumentContent | DELETE /publications/{documentId} | Delete published document's contents |
getDocument | GET /documents/{documentId} | Get document |
getDocumentContent | GET /documents/{documentId}/content | Get document's contents |
getDocumentIdUpload | GET /documents/{documentId}/upload | Get url to update large document |
getDocumentSyncs | GET /documents/{documentId}/syncs | Get document syncs |
getDocumentUpload | GET /documents/upload | Get url to add large document |
getDocumentUrl | GET /documents/{documentId}/url | Get document content url |
getDocuments | GET /documents | Get Documents listing |
getPublishedDocumentContent | GET /publications/{documentId} | Get published document's contents |
setDocumentRestore | PUT /documents/{documentId}/restore | Restore soft deleted document |
updateDocument | PATCH /documents/{documentId} | Update document |
AddDocumentResponse addDocument(addDocumentRequest, siteId, shareKey)
Add new document
Creates a new document; body may include document content if less than 5 MB See POST /documents/{documentId}/tags for adding tags to document schema See POST /documents/{documentId}/actions for adding actions to document schema
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
AddDocumentRequest addDocumentRequest = new AddDocumentRequest(); // AddDocumentRequest |
String siteId = "siteId_example"; // String | Site Identifier
String shareKey = "shareKey_example"; // String | Share Identifier
try {
AddDocumentResponse result = apiInstance.addDocument(addDocumentRequest, siteId, shareKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#addDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
addDocumentRequest | AddDocumentRequest | ||
siteId | String | Site Identifier | [optional] |
shareKey | String | Share Identifier | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | 201 CREATED | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
400 | 400 OK | - |
GetDocumentUrlResponse addDocumentUpload(addDocumentUploadRequest, siteId, contentLength, duration, shareKey)
Add large document
Returns a URL that can be used to upload document content and create a new document, while allowing metadata to also be sent; this endpoint (whether GET or POST) is required in order to add content that is larger than 5 MB
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
AddDocumentUploadRequest addDocumentUploadRequest = new AddDocumentUploadRequest(); // AddDocumentUploadRequest |
String siteId = "siteId_example"; // String | Site Identifier
Integer contentLength = 56; // Integer | Indicates the size of the entity-body
Integer duration = 56; // Integer | Indicates the number of hours request is valid for
String shareKey = "shareKey_example"; // String | Share Identifier
try {
GetDocumentUrlResponse result = apiInstance.addDocumentUpload(addDocumentUploadRequest, siteId, contentLength, duration, shareKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#addDocumentUpload");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
addDocumentUploadRequest | AddDocumentUploadRequest | ||
siteId | String | Site Identifier | [optional] |
contentLength | Integer | Indicates the size of the entity-body | [optional] |
duration | Integer | Indicates the number of hours request is valid for | [optional] |
shareKey | String | Share Identifier | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | 201 CREATED | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
DocumentsCompressResponse compressDocuments(documentsCompressRequest, siteId)
Compress multiple documents into a .zip file
Compress documents into an .ZIP archive file, and returns a S3 presigned url for the location of the archive file. The operation is async and processing time depends on the number and size of documents included; a 404 status code is returned until the file is ready.
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
DocumentsCompressRequest documentsCompressRequest = new DocumentsCompressRequest(); // DocumentsCompressRequest |
String siteId = "siteId_example"; // String | Site Identifier
try {
DocumentsCompressResponse result = apiInstance.compressDocuments(documentsCompressRequest, siteId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#compressDocuments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentsCompressRequest | DocumentsCompressRequest | ||
siteId | String | Site Identifier | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | 201 CREATED | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
DeleteResponse deleteDocument(documentId, siteId, softDelete)
Delete document
Delete a document
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
Boolean softDelete = true; // Boolean | Whether to soft delete document
try {
DeleteResponse result = apiInstance.deleteDocument(documentId, siteId, softDelete);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#deleteDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
softDelete | Boolean | Whether to soft delete document | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
DeleteResponse deletePublishedDocumentContent(documentId, siteId)
Delete published document's contents
Delete a published document's contents. Certain content types, text/_*, application/json, and application/x-www-form-urlencoded. return the "content" field, while all other content types return a 'contentUrl' for retrieving the content.
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
try {
DeleteResponse result = apiInstance.deletePublishedDocumentContent(documentId, siteId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#deletePublishedDocumentContent");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
GetDocumentResponse getDocument(documentId, siteId, shareKey)
Get document
Retrieves a document's details, i.e., metadata
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
String shareKey = "shareKey_example"; // String | Share Identifier
try {
GetDocumentResponse result = apiInstance.getDocument(documentId, siteId, shareKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
shareKey | String | Share Identifier | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
GetDocumentContentResponse getDocumentContent(documentId, siteId, versionKey, shareKey)
Get document's contents
Get a document's contents. Certain content types, text/_*, application/json, and application/x-www-form-urlencoded. return the "content" field, while all other content types return a 'contentUrl' for retrieving the content.
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
String versionKey = "versionKey_example"; // String | Version Key
String shareKey = "shareKey_example"; // String | Share Identifier
try {
GetDocumentContentResponse result = apiInstance.getDocumentContent(documentId, siteId, versionKey, shareKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getDocumentContent");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
versionKey | String | Version Key | [optional] |
shareKey | String | Share Identifier | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - * Location - |
GetDocumentUrlResponse getDocumentIdUpload(documentId, siteId, contentLength, duration, shareKey)
Get url to update large document
Returns a URL that can be used to upload documents for a specific documentId; this endpoint is required in order to add content that is larger than 5 MB. If versions are enabled, this will create a new version of the document.
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
Integer contentLength = 56; // Integer | Indicates the size of the entity-body
Integer duration = 56; // Integer | Indicates the number of hours request is valid for
String shareKey = "shareKey_example"; // String | Share Identifier
try {
GetDocumentUrlResponse result = apiInstance.getDocumentIdUpload(documentId, siteId, contentLength, duration, shareKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getDocumentIdUpload");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
contentLength | Integer | Indicates the size of the entity-body | [optional] |
duration | Integer | Indicates the number of hours request is valid for | [optional] |
shareKey | String | Share Identifier | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
GetDocumentSyncResponse getDocumentSyncs(documentId, siteId, limit, shareKey)
Get document syncs
Retrieve the document syncs with external services status
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
String limit = "10"; // String | Limit Results
String shareKey = "shareKey_example"; // String | Share Identifier
try {
GetDocumentSyncResponse result = apiInstance.getDocumentSyncs(documentId, siteId, limit, shareKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getDocumentSyncs");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
limit | String | Limit Results | [optional] [default to 10] |
shareKey | String | Share Identifier | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
GetDocumentUrlResponse getDocumentUpload(path, siteId, contentLength, duration, shareKey)
Get url to add large document
Returns a URL that can be used to upload document content and create a new document; this endpoint (whether GET or POST) is required in order to add content that is larger than 5 MB
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String path = "path_example"; // String | The upload file's path
String siteId = "siteId_example"; // String | Site Identifier
Integer contentLength = 56; // Integer | Indicates the size of the entity-body
Integer duration = 56; // Integer | Indicates the number of hours request is valid for
String shareKey = "shareKey_example"; // String | Share Identifier
try {
GetDocumentUrlResponse result = apiInstance.getDocumentUpload(path, siteId, contentLength, duration, shareKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getDocumentUpload");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
path | String | The upload file's path | [optional] |
siteId | String | Site Identifier | [optional] |
contentLength | Integer | Indicates the size of the entity-body | [optional] |
duration | Integer | Indicates the number of hours request is valid for | [optional] |
shareKey | String | Share Identifier | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
GetDocumentUrlResponse getDocumentUrl(documentId, siteId, versionKey, duration, shareKey, inline)
Get document content url
Returns a URL for the document's contents; this URL will expire (the default is 48 hours)
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
String versionKey = "versionKey_example"; // String | Version Key
Integer duration = 56; // Integer | Indicates the number of hours request is valid for
String shareKey = "shareKey_example"; // String | Share Identifier
Boolean inline = false; // Boolean | Set the Content-Disposition to inline
try {
GetDocumentUrlResponse result = apiInstance.getDocumentUrl(documentId, siteId, versionKey, duration, shareKey, inline);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getDocumentUrl");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
versionKey | String | Version Key | [optional] |
duration | Integer | Indicates the number of hours request is valid for | [optional] |
shareKey | String | Share Identifier | [optional] |
inline | Boolean | Set the Content-Disposition to inline | [optional] [default to false] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
GetDocumentsResponse getDocuments(siteId, actionStatus, deleted, date, tz, next, previous, limit)
Get Documents listing
Returns a list of the most recent documents added, ordered by inserted, descending
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String siteId = "siteId_example"; // String | Site Identifier
String actionStatus = "FAILED"; // String | Fetch documents with an action status
Boolean deleted = true; // Boolean | Fetch soft deleted documents
String date = "date_example"; // String | Fetch documents inserted on a certain date (yyyy-MM-dd)
String tz = "tz_example"; // String | UTC offset to apply to date parameter (IE: -0600)
String next = "next_example"; // String | Next page of results token
String previous = "previous_example"; // String | Previous page of results token
String limit = "10"; // String | Limit Results
try {
GetDocumentsResponse result = apiInstance.getDocuments(siteId, actionStatus, deleted, date, tz, next, previous, limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getDocuments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
siteId | String | Site Identifier | [optional] |
actionStatus | String | Fetch documents with an action status | [optional] [enum: FAILED, IN_QUEUE, PENDING, RUNNING, SKIPPED, FAILED_RETRY] |
deleted | Boolean | Fetch soft deleted documents | [optional] |
date | String | Fetch documents inserted on a certain date (yyyy-MM-dd) | [optional] |
tz | String | UTC offset to apply to date parameter (IE: -0600) | [optional] |
next | String | Next page of results token | [optional] |
previous | String | Previous page of results token | [optional] |
limit | String | Limit Results | [optional] [default to 10] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
getPublishedDocumentContent(documentId, siteId)
Get published document's contents
Get a published document's contents. Certain content types, text/_*, application/json, and application/x-www-form-urlencoded. return the "content" field, while all other content types return a 'contentUrl' for retrieving the content.
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
try {
apiInstance.getPublishedDocumentContent(documentId, siteId);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#getPublishedDocumentContent");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
null (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
307 | Temporary Redirect | * Location - |
SetDocumentRestoreResponse setDocumentRestore(documentId, siteId)
Restore soft deleted document
Restores a soft deleted document
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
String siteId = "siteId_example"; // String | Site Identifier
try {
SetDocumentRestoreResponse result = apiInstance.setDocumentRestore(documentId, siteId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#setDocumentRestore");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
siteId | String | Site Identifier | [optional] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
AddDocumentResponse updateDocument(documentId, updateDocumentRequest, siteId, shareKey)
Update document
Update a document's details, i.e., metadata
// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.DocumentsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
DocumentsApi apiInstance = new DocumentsApi(defaultClient);
String documentId = "documentId_example"; // String | Document Identifier
UpdateDocumentRequest updateDocumentRequest = new UpdateDocumentRequest(); // UpdateDocumentRequest |
String siteId = "siteId_example"; // String | Site Identifier
String shareKey = "shareKey_example"; // String | Share Identifier
try {
AddDocumentResponse result = apiInstance.updateDocument(documentId, updateDocumentRequest, siteId, shareKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DocumentsApi#updateDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
documentId | String | Document Identifier | |
updateDocumentRequest | UpdateDocumentRequest | ||
siteId | String | Site Identifier | [optional] |
shareKey | String | Share Identifier | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | 200 OK | * Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers - |
400 | 400 OK | - |