Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 6.39 KB

TimelinesApi.md

File metadata and controls

271 lines (188 loc) · 6.39 KB

TimelinesApi

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

Method HTTP request Description
timelineCreate POST /v4/api/timeline
timelineDelete DELETE /v4/api/timeline/{id}
timelineGet GET /v4/api/timeline/{id}
timelineSearch GET /v4/api/timeline
timelineUpdate PUT /v4/api/timeline/{id}

timelineCreate

Timeline timelineCreate(body)

Create an timeline.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


TimelinesApi apiInstance = new TimelinesApi();
TimelineCreate body = new TimelineCreate(); // TimelineCreate | 
try {
    Timeline result = apiInstance.timelineCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TimelinesApi#timelineCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body TimelineCreate [optional]

Return type

Timeline

Authorization

Bearer

HTTP request headers

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

timelineDelete

timelineDelete(id)

Remove an timeline.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


TimelinesApi apiInstance = new TimelinesApi();
String id = "id_example"; // String | 
try {
    apiInstance.timelineDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling TimelinesApi#timelineDelete");
    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

timelineGet

Timeline timelineGet(id)

Retrieve an timeline.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

Timeline

Authorization

Bearer

HTTP request headers

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

timelineSearch

TimelinePaginationResponse timelineSearch(filter, query, page, perPage, sort)

Search timelines.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


TimelinesApi apiInstance = new TimelinesApi();
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 {
    TimelinePaginationResponse result = apiInstance.timelineSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TimelinesApi#timelineSearch");
    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

TimelinePaginationResponse

Authorization

Bearer

HTTP request headers

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

timelineUpdate

Timeline timelineUpdate(id, body)

Update an timeline.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


TimelinesApi apiInstance = new TimelinesApi();
String id = "id_example"; // String | 
TimelineUpdate body = new TimelineUpdate(); // TimelineUpdate | 
try {
    Timeline result = apiInstance.timelineUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TimelinesApi#timelineUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body TimelineUpdate [optional]

Return type

Timeline

Authorization

Bearer

HTTP request headers

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