Skip to content

RcsAgentMetadataApi.md

Latest commit

 

History

History
271 lines (188 loc) · 7.14 KB

RcsAgentMetadataApi.md

File metadata and controls

271 lines (188 loc) · 7.14 KB
Raw

RcsAgentMetadataApi

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

Method HTTP request Description
rcsAgentMetadataCreate POST /v4/api/rcs-agent-metadata
rcsAgentMetadataDelete DELETE /v4/api/rcs-agent-metadata/{id}
rcsAgentMetadataGet GET /v4/api/rcs-agent-metadata/{id}
rcsAgentMetadataSearch GET /v4/api/rcs-agent-metadata
rcsAgentMetadataUpdate PUT /v4/api/rcs-agent-metadata/{id}

rcsAgentMetadataCreate

RcsAgentMetadata rcsAgentMetadataCreate(body)

Create an rcs agent 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.RcsAgentMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


RcsAgentMetadataApi apiInstance = new RcsAgentMetadataApi();
RcsAgentMetadataCreate body = new RcsAgentMetadataCreate(); // RcsAgentMetadataCreate | 
try {
    RcsAgentMetadata result = apiInstance.rcsAgentMetadataCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RcsAgentMetadataApi#rcsAgentMetadataCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RcsAgentMetadataCreate [optional]

Return type

RcsAgentMetadata

Authorization

Bearer

HTTP request headers

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

rcsAgentMetadataDelete

rcsAgentMetadataDelete(id)

Remove an rcs agent 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.RcsAgentMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

rcsAgentMetadataGet

RcsAgentMetadata rcsAgentMetadataGet(id)

Retrieve an rcs agent 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.RcsAgentMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

RcsAgentMetadata

Authorization

Bearer

HTTP request headers

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

rcsAgentMetadataSearch

RcsAgentMetadataPaginationResponse rcsAgentMetadataSearch(filter, query, page, perPage, sort)

Search rcs agent 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.RcsAgentMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

RcsAgentMetadataPaginationResponse

Authorization

Bearer

HTTP request headers

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

rcsAgentMetadataUpdate

RcsAgentMetadata rcsAgentMetadataUpdate(id, body)

Update an rcs agent 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.RcsAgentMetadataApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


RcsAgentMetadataApi apiInstance = new RcsAgentMetadataApi();
String id = "id_example"; // String | 
RcsAgentMetadataUpdate body = new RcsAgentMetadataUpdate(); // RcsAgentMetadataUpdate | 
try {
    RcsAgentMetadata result = apiInstance.rcsAgentMetadataUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RcsAgentMetadataApi#rcsAgentMetadataUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body RcsAgentMetadataUpdate [optional]

Return type

RcsAgentMetadata

Authorization

Bearer

HTTP request headers

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