DocumentAttributesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
addDocumentAttributes	POST /documents/{documentId}/attributes	Add attribute to document
deleteDocumentAttribute	DELETE /documents/{documentId}/attributes/{attributeKey}	Delete document attribute
deleteDocumentAttributeAndValue	DELETE /documents/{documentId}/attributes/{attributeKey}/{attributeValue}	Delete document's attribute value
getDocumentAttribute	GET /documents/{documentId}/attributes/{attributeKey}	Get document attribute by key
getDocumentAttributes	GET /documents/{documentId}/attributes	Get document's attributes
setDocumentAttributeValue	PUT /documents/{documentId}/attributes/{attributeKey}	Set document's attributes value
setDocumentAttributes	PUT /documents/{documentId}/attributes	Set document's attributes

addDocumentAttributes

AddResponse addDocumentAttributes(documentId, addDocumentAttributesRequest, siteId)

Add attribute to document

Add multiple attributes to a document; this endpoint also accepts a different body parameter for adding a single attribute

Example

// 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.DocumentAttributesApi;

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")
    
    DocumentAttributesApi apiInstance = new DocumentAttributesApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    AddDocumentAttributesRequest addDocumentAttributesRequest = new AddDocumentAttributesRequest(); // AddDocumentAttributesRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      AddResponse result = apiInstance.addDocumentAttributes(documentId, addDocumentAttributesRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentAttributesApi#addDocumentAttributes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
addDocumentAttributesRequest	AddDocumentAttributesRequest
siteId	String	Site Identifier	[optional]

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

deleteDocumentAttribute

DeleteResponse deleteDocumentAttribute(documentId, attributeKey, siteId)

Delete document attribute

Delete a document attribute by using its key

Example

// 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.DocumentAttributesApi;

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")
    
    DocumentAttributesApi apiInstance = new DocumentAttributesApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String attributeKey = "attributeKey_example"; // String | Attribute Key
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      DeleteResponse result = apiInstance.deleteDocumentAttribute(documentId, attributeKey, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentAttributesApi#deleteDocumentAttribute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
attributeKey	String	Attribute Key
siteId	String	Site Identifier	[optional]

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

deleteDocumentAttributeAndValue

DeleteResponse deleteDocumentAttributeAndValue(documentId, attributeKey, attributeValue, siteId)

Delete document's attribute value

Delete a specific document attribute key/value combination; the request will be ignored if there is no valid key/value combination found

Example

// 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.DocumentAttributesApi;

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")
    
    DocumentAttributesApi apiInstance = new DocumentAttributesApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String attributeKey = "attributeKey_example"; // String | Attribute Key
    String attributeValue = "attributeValue_example"; // String | Attribute Value
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      DeleteResponse result = apiInstance.deleteDocumentAttributeAndValue(documentId, attributeKey, attributeValue, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentAttributesApi#deleteDocumentAttributeAndValue");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
attributeKey	String	Attribute Key
attributeValue	String	Attribute Value
siteId	String	Site Identifier	[optional]

Return type

DeleteResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

getDocumentAttribute

GetDocumentAttributeResponse getDocumentAttribute(documentId, attributeKey, siteId)

Get document attribute by key

Get a document attribute by using its key

Example

// 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.DocumentAttributesApi;

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")
    
    DocumentAttributesApi apiInstance = new DocumentAttributesApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String attributeKey = "attributeKey_example"; // String | Attribute Key
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      GetDocumentAttributeResponse result = apiInstance.getDocumentAttribute(documentId, attributeKey, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentAttributesApi#getDocumentAttribute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
attributeKey	String	Attribute Key
siteId	String	Site Identifier	[optional]

Return type

GetDocumentAttributeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

getDocumentAttributes

GetDocumentAttributesResponse getDocumentAttributes(documentId, siteId, limit, next)

Get document's attributes

Get a listing of a document's attributes

Example

// 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.DocumentAttributesApi;

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")
    
    DocumentAttributesApi apiInstance = new DocumentAttributesApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    String limit = "10"; // String | Limit Results
    String next = "next_example"; // String | Next page of results token
    try {
      GetDocumentAttributesResponse result = apiInstance.getDocumentAttributes(documentId, siteId, limit, next);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentAttributesApi#getDocumentAttributes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
siteId	String	Site Identifier	[optional]
limit	String	Limit Results	[optional] [default to 10]
next	String	Next page of results token	[optional]

Return type

GetDocumentAttributesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

setDocumentAttributeValue

SetResponse setDocumentAttributeValue(documentId, attributeKey, setDocumentAttributeRequest, siteId)

Set document's attributes value

Set attributes value to a document

Example

// 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.DocumentAttributesApi;

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")
    
    DocumentAttributesApi apiInstance = new DocumentAttributesApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String attributeKey = "attributeKey_example"; // String | Attribute Key
    SetDocumentAttributeRequest setDocumentAttributeRequest = new SetDocumentAttributeRequest(); // SetDocumentAttributeRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      SetResponse result = apiInstance.setDocumentAttributeValue(documentId, attributeKey, setDocumentAttributeRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentAttributesApi#setDocumentAttributeValue");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
attributeKey	String	Attribute Key
setDocumentAttributeRequest	SetDocumentAttributeRequest
siteId	String	Site Identifier	[optional]

Return type

SetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

setDocumentAttributes

SetResponse setDocumentAttributes(documentId, setDocumentAttributesRequest, siteId)

Set document's attributes

Set multiple attributes to a document; this endpoint also accepts a different body parameter for setting a single attribute Note: - attributes in the request will overwrite existing attributes.

Example

// 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.DocumentAttributesApi;

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")
    
    DocumentAttributesApi apiInstance = new DocumentAttributesApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    SetDocumentAttributesRequest setDocumentAttributesRequest = new SetDocumentAttributesRequest(); // SetDocumentAttributesRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      SetResponse result = apiInstance.setDocumentAttributes(documentId, setDocumentAttributesRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DocumentAttributesApi#setDocumentAttributes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
documentId	String	Document Identifier
setDocumentAttributesRequest	SetDocumentAttributesRequest
siteId	String	Site Identifier	[optional]

Return type

SetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	200 OK	* Access-Control-Allow-Origin - * Access-Control-Allow-Methods - * Access-Control-Allow-Headers -

FilesExpand file tree

DocumentAttributesApi.md

Latest commit

History

DocumentAttributesApi.md

File metadata and controls

DocumentAttributesApi

addDocumentAttributes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteDocumentAttribute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteDocumentAttributeAndValue

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDocumentAttribute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getDocumentAttributes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

setDocumentAttributeValue

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

setDocumentAttributes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details