Skip to content

WidgetMetadataApi.md

Latest commit

 

History

History
271 lines (188 loc) · 6.94 KB

WidgetMetadataApi.md

File metadata and controls

271 lines (188 loc) · 6.94 KB

WidgetMetadataApi

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

Method HTTP request Description
widgetMetadataCreate POST /v4/api/widget-metadata
widgetMetadataDelete DELETE /v4/api/widget-metadata/{id}
widgetMetadataGet GET /v4/api/widget-metadata/{id}
widgetMetadataSearch GET /v4/api/widget-metadata
widgetMetadataUpdate PUT /v4/api/widget-metadata/{id}

widgetMetadataCreate

WidgetMetadata widgetMetadataCreate(body)

Create a widget metadata.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


WidgetMetadataApi apiInstance = new WidgetMetadataApi();
WidgetMetadataCreate body = new WidgetMetadataCreate(); // WidgetMetadataCreate | 
try {
    WidgetMetadata result = apiInstance.widgetMetadataCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WidgetMetadataApi#widgetMetadataCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body WidgetMetadataCreate [optional]

Return type

WidgetMetadata

Authorization

Bearer

HTTP request headers

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

widgetMetadataDelete

widgetMetadataDelete(id)

Remove a widget metadata.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

widgetMetadataGet

WidgetMetadata widgetMetadataGet(id)

Retrieve a widget metadata.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

WidgetMetadata

Authorization

Bearer

HTTP request headers

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

widgetMetadataSearch

WidgetMetadataPaginationResponse widgetMetadataSearch(filter, query, page, perPage, sort)

Search widget metadata.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

WidgetMetadataPaginationResponse

Authorization

Bearer

HTTP request headers

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

widgetMetadataUpdate

WidgetMetadata widgetMetadataUpdate(id, body)

Update a widget metadata.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


WidgetMetadataApi apiInstance = new WidgetMetadataApi();
String id = "id_example"; // String | 
WidgetMetadataUpdate body = new WidgetMetadataUpdate(); // WidgetMetadataUpdate | 
try {
    WidgetMetadata result = apiInstance.widgetMetadataUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WidgetMetadataApi#widgetMetadataUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body WidgetMetadataUpdate [optional]

Return type

WidgetMetadata

Authorization

Bearer

HTTP request headers

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