Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 6 KB

TasksApi.md

File metadata and controls

271 lines (188 loc) · 6 KB

TasksApi

All URIs are relative to https://app.statflo.com

Method HTTP request Description
taskCreate POST /v4/api/task
taskDelete DELETE /v4/api/task/{id}
taskGet GET /v4/api/task/{id}
taskSearch GET /v4/api/task
taskUpdate PUT /v4/api/task/{id}

taskCreate

Task taskCreate(body)

Create a task.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.TasksApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


TasksApi apiInstance = new TasksApi();
TaskCreate body = new TaskCreate(); // TaskCreate | 
try {
    Task result = apiInstance.taskCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TasksApi#taskCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body TaskCreate [optional]

Return type

Task

Authorization

Bearer

HTTP request headers

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

taskDelete

taskDelete(id)

Remove a task.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.TasksApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


TasksApi apiInstance = new TasksApi();
String id = "id_example"; // String | 
try {
    apiInstance.taskDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling TasksApi#taskDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

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

taskGet

Task taskGet(id)

Retrieve a task.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.TasksApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


TasksApi apiInstance = new TasksApi();
String id = "id_example"; // String | 
try {
    Task result = apiInstance.taskGet(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TasksApi#taskGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

Task

Authorization

Bearer

HTTP request headers

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

taskSearch

TaskPaginationResponse taskSearch(filter, query, page, perPage, sort)

Search tasks.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.TasksApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


TasksApi apiInstance = new TasksApi();
java.util.HashMap filter = new java.util.HashMap(); // java.util.HashMap | 
String query = "query_example"; // String | 
Integer page = 56; // Integer | 
Integer perPage = 56; // Integer | 
String sort = "sort_example"; // String | 
try {
    TaskPaginationResponse result = apiInstance.taskSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TasksApi#taskSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter java.util.HashMap [optional]
query String [optional]
page Integer [optional]
perPage Integer [optional]
sort String [optional]

Return type

TaskPaginationResponse

Authorization

Bearer

HTTP request headers

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

taskUpdate

Task taskUpdate(id, body)

Update a task.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.TasksApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


TasksApi apiInstance = new TasksApi();
String id = "id_example"; // String | 
TaskUpdate body = new TaskUpdate(); // TaskUpdate | 
try {
    Task result = apiInstance.taskUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TasksApi#taskUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body TaskUpdate [optional]

Return type

Task

Authorization

Bearer

HTTP request headers

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