AppsApi

All URIs are relative to /

Method	HTTP request	Description
deleteUsingDELETE	DELETE /users-web/api/v3/apps/{anyStateAppId}	delete
getAppTypesUsingGET	GET /users-web/api/v3/apps/types	Get all App types supported for the account identified with apiKey
getUsingGET	GET /users-web/api/v3/apps/{anyStateAppId}	Gets defails for one particular App
inviteAppGuestsUsingPOST1	POST /users-web/api/v3/apps/guests	Invite guests to an app
listAppsUsersUsingGET1	GET /users-web/api/v3/apps/users	Get all users of apps accessible to this account
listUsingGET	GET /users-web/api/v3/apps	Get all apps accessible by account identified with apiKey
updateDescriptionUsingPUT1	PUT /users-web/api/v3/apps/{anyStateAppId}/description	Update description of the app
updateUsingPUT3	PUT /users-web/api/v3/apps/{anyStateAppId}	Update app

deleteUsingDELETE

GenericMapBasedApiResponse deleteUsingDELETE(anyStateAppId)

delete

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.AppsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

AppsApi apiInstance = new AppsApi();
Long anyStateAppId = 789L; // Long | anyStateAppId
try {
    GenericMapBasedApiResponse result = apiInstance.deleteUsingDELETE(anyStateAppId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AppsApi#deleteUsingDELETE");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
anyStateAppId	Long	anyStateAppId

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

getAppTypesUsingGET

AppTypesResponse getAppTypesUsingGET()

Get all App types supported for the account identified with apiKey

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.AppsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

AppsApi apiInstance = new AppsApi();
try {
    AppTypesResponse result = apiInstance.getAppTypesUsingGET();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AppsApi#getAppTypesUsingGET");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

AppTypesResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

getUsingGET

AppResponse getUsingGET(anyStateAppId)

Gets defails for one particular App

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.AppsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

AppsApi apiInstance = new AppsApi();
Long anyStateAppId = 789L; // Long | anyStateAppId
try {
    AppResponse result = apiInstance.getUsingGET(anyStateAppId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AppsApi#getUsingGET");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
anyStateAppId	Long	anyStateAppId

Return type

AppResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

inviteAppGuestsUsingPOST1

GenericMapBasedApiResponse inviteAppGuestsUsingPOST1(body)

Invite guests to an app

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.AppsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

AppsApi apiInstance = new AppsApi();
Invitation body = new Invitation(); // Invitation | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values
try {
    GenericMapBasedApiResponse result = apiInstance.inviteAppGuestsUsingPOST1(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AppsApi#inviteAppGuestsUsingPOST1");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Invitation	For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

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

listAppsUsersUsingGET1

AppsResponse listAppsUsersUsingGET1()

Get all users of apps accessible to this account

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.AppsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

AppsApi apiInstance = new AppsApi();
try {
    AppsResponse result = apiInstance.listAppsUsersUsingGET1();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AppsApi#listAppsUsersUsingGET1");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

AppsResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

listUsingGET

AppsResponse listUsingGET()

Get all apps accessible by account identified with apiKey

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.AppsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

AppsApi apiInstance = new AppsApi();
try {
    AppsResponse result = apiInstance.listUsingGET();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AppsApi#listUsingGET");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

AppsResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateDescriptionUsingPUT1

AppResponse updateDescriptionUsingPUT1(anyStateAppId, body)

Update description of the app

App can be in any state

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.AppsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

AppsApi apiInstance = new AppsApi();
Long anyStateAppId = 789L; // Long | App Id
AppDescription body = new AppDescription(); // AppDescription | Update Details
try {
    AppResponse result = apiInstance.updateDescriptionUsingPUT1(anyStateAppId, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AppsApi#updateDescriptionUsingPUT1");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
anyStateAppId	Long	App Id
body	AppDescription	Update Details	[optional]

Return type

AppResponse

Authorization

api_key

HTTP request headers

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

updateUsingPUT3

AppResponse updateUsingPUT3(body, anyStateAppId)

Update app

App can be in any state

Example

// Import classes:
//import com.sematext.cloud.ApiClient;
//import com.sematext.cloud.ApiException;
//import com.sematext.cloud.Configuration;
//import com.sematext.cloud.auth.*;
//import com.sematext.cloud.client.AppsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

AppsApi apiInstance = new AppsApi();
UpdateAppInfo body = new UpdateAppInfo(); // UpdateAppInfo | dto
Long anyStateAppId = 789L; // Long | App Id
try {
    AppResponse result = apiInstance.updateUsingPUT3(body, anyStateAppId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AppsApi#updateUsingPUT3");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	UpdateAppInfo	dto
anyStateAppId	Long	App Id

Return type

AppResponse

Authorization

api_key

HTTP request headers

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

Files

AppsApi.md

Latest commit

History

AppsApi.md

File metadata and controls

AppsApi

deleteUsingDELETE

Example

Parameters

Return type

Authorization

HTTP request headers

getAppTypesUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

inviteAppGuestsUsingPOST1

Example

Parameters

Return type

Authorization

HTTP request headers

listAppsUsersUsingGET1

Example

Parameters

Return type

Authorization

HTTP request headers

listUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

updateDescriptionUsingPUT1

Example

Parameters

Return type

Authorization

HTTP request headers

updateUsingPUT3

Example

Parameters

Return type

Authorization

HTTP request headers