Skip to content

Latest commit

 

History

History
221 lines (154 loc) · 5.24 KB

NotepadsApi.md

File metadata and controls

221 lines (154 loc) · 5.24 KB

NotepadsApi

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

Method HTTP request Description
notepadCreate POST /v4/api/notepad
notepadGet GET /v4/api/notepad/{id}
notepadSearch GET /v4/api/notepad
notepadUpdate PUT /v4/api/notepad/{id}

notepadCreate

Notepad notepadCreate(body)

Create a notepad.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


NotepadsApi apiInstance = new NotepadsApi();
NotepadCreate body = new NotepadCreate(); // NotepadCreate | 
try {
    Notepad result = apiInstance.notepadCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NotepadsApi#notepadCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body NotepadCreate [optional]

Return type

Notepad

Authorization

Bearer

HTTP request headers

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

notepadGet

Notepad notepadGet(id)

Retrieve a notepad.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

Notepad

Authorization

Bearer

HTTP request headers

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

notepadSearch

NotepadPaginationResponse notepadSearch(filter, query, page, perPage, sort)

Search notepads.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

NotepadPaginationResponse

Authorization

Bearer

HTTP request headers

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

notepadUpdate

Notepad notepadUpdate(id, body)

Update a notepad.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


NotepadsApi apiInstance = new NotepadsApi();
String id = "id_example"; // String | 
NotepadUpdate body = new NotepadUpdate(); // NotepadUpdate | 
try {
    Notepad result = apiInstance.notepadUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NotepadsApi#notepadUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body NotepadUpdate [optional]

Return type

Notepad

Authorization

Bearer

HTTP request headers

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