Skip to content

MalwareScanApi.md

Latest commit

 

History

History
223 lines (174 loc) · 8.03 KB

MalwareScanApi.md

File metadata and controls

223 lines (174 loc) · 8.03 KB

MalwareScanApi

All URIs are relative to http://localhost

Method HTTP request Description
getMalwareScanResults GET /documents/{documentId}/malwareScan Get Malware Scan results
setAntivirus PUT /documents/{documentId}/antivirus Antivirus document scan
setMalwareScan PUT /documents/{documentId}/malwareScan MalwareScan document scan

getMalwareScanResults

GetMalwareScanResponse getMalwareScanResults(documentId, siteId, next, limit)

Get Malware Scan results

Gets a Malware Scan results; available as an Add-On Module

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.MalwareScanApi;

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")
    
    MalwareScanApi apiInstance = new MalwareScanApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    String next = "next_example"; // String | Next page of results token
    String limit = "10"; // String | Limit Results
    try {
      GetMalwareScanResponse result = apiInstance.getMalwareScanResults(documentId, siteId, next, limit);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MalwareScanApi#getMalwareScanResults");
      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]
next String Next page of results token [optional]
limit String Limit Results [optional] [default to 10]

Return type

GetMalwareScanResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 CREATED * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 400 BAD REQUEST * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -

setAntivirus

SetResponse setAntivirus(documentId, siteId, shareKey, body)

Antivirus document scan

Perform an Anti-Malware / Antivirus scan on a document; available as an Add-On Module Deprecated. This endpoint is no longer recommended. Please use the `/documents/{document}/malwareScan` endpoint instead.

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.MalwareScanApi;

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")
    
    MalwareScanApi apiInstance = new MalwareScanApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    String shareKey = "shareKey_example"; // String | Share Identifier
    Object body = null; // Object | 
    try {
      SetResponse result = apiInstance.setAntivirus(documentId, siteId, shareKey, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MalwareScanApi#setAntivirus");
      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]
shareKey String Share Identifier [optional]
body Object [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 -

setMalwareScan

SetResponse setMalwareScan(documentId, siteId, body)

MalwareScan document scan

Perform an Anti-Malware / Antivirus scan on a document; available as an Add-On Module

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.MalwareScanApi;

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")
    
    MalwareScanApi apiInstance = new MalwareScanApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String siteId = "siteId_example"; // String | Site Identifier
    Object body = null; // Object | 
    try {
      SetResponse result = apiInstance.setMalwareScan(documentId, siteId, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MalwareScanApi#setMalwareScan");
      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]
body Object [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 -