Skip to content

UserActivitiesApi.md

Latest commit

 

History

History
256 lines (207 loc) · 10.7 KB

UserActivitiesApi.md

File metadata and controls

256 lines (207 loc) · 10.7 KB

UserActivitiesApi

All URIs are relative to http://localhost

Method HTTP request Description
getDocumentUserActivities GET /documents/{documentId}/userActivities Get user activities for a document
getResourceActivities GET /activities Get resource activities
getUserActivities GET /userActivities Get user activities

getDocumentUserActivities

GetUserActivitesResponse getDocumentUserActivities(documentId, siteId, next, limit)

Get user activities for a document

Retrieve a user's activities for 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.UserActivitiesApi;

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")
    
    UserActivitiesApi apiInstance = new UserActivitiesApi(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 {
      GetUserActivitesResponse result = apiInstance.getDocumentUserActivities(documentId, siteId, next, limit);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserActivitiesApi#getDocumentUserActivities");
      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

GetUserActivitesResponse

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 -

getResourceActivities

GetActivitesResponse getResourceActivities(siteId, documentId, entityTypeId, namespace, entityId, rulesetId, ruleId, workflowId, attributeKey, schema, classificationId, mappingId, apiKey, controlPolicy, start, end, sort, next, limit, userId)

Get resource activities

Retrieve an resource activities

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

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")
    
    UserActivitiesApi apiInstance = new UserActivitiesApi(defaultClient);
    String siteId = "siteId_example"; // String | Site Identifier
    String documentId = "documentId_example"; // String | Document Identifier
    String entityTypeId = "entityTypeId_example"; // String | EntityType Identifier
    String namespace = "PRESET"; // String | Namespace Identifier
    String entityId = "entityId_example"; // String | Entity Identifier
    String rulesetId = "rulesetId_example"; // String | RulesetId Identifier
    String ruleId = "ruleId_example"; // String | RuleId Identifier
    String workflowId = "workflowId_example"; // String | Workflow Identifier
    String attributeKey = "attributeKey_example"; // String | Attribute Key
    String schema = "document"; // String | Schema Type
    String classificationId = "classificationId_example"; // String | Classification Id
    String mappingId = "mappingId_example"; // String | Mapping Id
    String apiKey = "apiKey_example"; // String | Api Key
    String controlPolicy = "opa"; // String | Control Policy
    OffsetDateTime start = OffsetDateTime.now(); // OffsetDateTime | Start of date-time range (UTC)
    OffsetDateTime end = OffsetDateTime.now(); // OffsetDateTime | End of date-time range (UTC)
    String sort = "ASC"; // String | Sort order (default DESC)
    String next = "next_example"; // String | Next page of results token
    String limit = "10"; // String | Limit Results
    String userId = "userId_example"; // String | Fetch specific user activities
    try {
      GetActivitesResponse result = apiInstance.getResourceActivities(siteId, documentId, entityTypeId, namespace, entityId, rulesetId, ruleId, workflowId, attributeKey, schema, classificationId, mappingId, apiKey, controlPolicy, start, end, sort, next, limit, userId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserActivitiesApi#getResourceActivities");
      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
siteId String Site Identifier [optional]
documentId String Document Identifier [optional]
entityTypeId String EntityType Identifier [optional]
namespace String Namespace Identifier [optional] [enum: PRESET, CUSTOM]
entityId String Entity Identifier [optional]
rulesetId String RulesetId Identifier [optional]
ruleId String RuleId Identifier [optional]
workflowId String Workflow Identifier [optional]
attributeKey String Attribute Key [optional]
schema String Schema Type [optional] [enum: document]
classificationId String Classification Id [optional]
mappingId String Mapping Id [optional]
apiKey String Api Key [optional]
controlPolicy String Control Policy [optional] [enum: opa]
start OffsetDateTime Start of date-time range (UTC) [optional]
end OffsetDateTime End of date-time range (UTC) [optional]
sort String Sort order (default DESC) [optional] [enum: ASC, DESC]
next String Next page of results token [optional]
limit String Limit Results [optional] [default to 10]
userId String Fetch specific user activities [optional]

Return type

GetActivitesResponse

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 -

getUserActivities

GetUserActivitesResponse getUserActivities(siteId, next, limit, userId)

Get user activities

Retrieve a user's activities

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

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")
    
    UserActivitiesApi apiInstance = new UserActivitiesApi(defaultClient);
    String siteId = "siteId_example"; // String | Site Identifier
    String next = "next_example"; // String | Next page of results token
    String limit = "10"; // String | Limit Results
    String userId = "userId_example"; // String | Fetch specific user activities
    try {
      GetUserActivitesResponse result = apiInstance.getUserActivities(siteId, next, limit, userId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserActivitiesApi#getUserActivities");
      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
siteId String Site Identifier [optional]
next String Next page of results token [optional]
limit String Limit Results [optional] [default to 10]
userId String Fetch specific user activities [optional]

Return type

GetUserActivitesResponse

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 -