NotificationsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
apiV2NotificationsCountGet	GET /api/v2/notifications/count	Get unread Notifications total in last 7 days
apiV2NotificationsGet	GET /api/v2/notifications	Get all Notifications for current User
apiV2NotificationsIdReadPost	POST /api/v2/notifications/{id}/read	Set Notification as read
apiV2NotificationsReadPost	POST /api/v2/notifications/read	Set all Notifications as read
apiV2NotificationsSearchPost	POST /api/v2/notifications/search	Search Notifications for current User

apiV2NotificationsCountGet

Integer apiV2NotificationsCountGet(isRead)

Get unread Notifications total in last 7 days

Use case User runs method execution System returns unread notifications total (listed in the response example)

Example

// Import classes:
import ru.testit.client.invoker.ApiClient;
import ru.testit.client.invoker.ApiException;
import ru.testit.client.invoker.Configuration;
import ru.testit.client.invoker.auth.*;
import ru.testit.client.invoker.models.*;
import ru.testit.client.api.NotificationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    NotificationsApi apiInstance = new NotificationsApi(defaultClient);
    Boolean isRead = true; // Boolean | 
    try {
      Integer result = apiInstance.apiV2NotificationsCountGet(isRead);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotificationsApi#apiV2NotificationsCountGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
isRead	Boolean		[optional]

Return type

Integer

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-

apiV2NotificationsGet

List<NotificationModel> apiV2NotificationsGet(notificationType, skip, take, orderBy, searchField, searchValue)

Get all Notifications for current User

Use case User runs method execution System returns notifications (listed in the response example)

Example

// Import classes:
import ru.testit.client.invoker.ApiClient;
import ru.testit.client.invoker.ApiException;
import ru.testit.client.invoker.Configuration;
import ru.testit.client.invoker.auth.*;
import ru.testit.client.invoker.models.*;
import ru.testit.client.api.NotificationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    NotificationsApi apiInstance = new NotificationsApi(defaultClient);
    NotificationTypeModel notificationType = NotificationTypeModel.fromValue("MentionInComment"); // NotificationTypeModel | 
    Integer skip = 56; // Integer | Amount of items to be skipped (offset)
    Integer take = 56; // Integer | Amount of items to be taken (limit)
    String orderBy = "orderBy_example"; // String | SQL-like  ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)
    String searchField = "searchField_example"; // String | Property name for searching
    String searchValue = "searchValue_example"; // String | Value for searching
    try {
      List<NotificationModel> result = apiInstance.apiV2NotificationsGet(notificationType, skip, take, orderBy, searchField, searchValue);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotificationsApi#apiV2NotificationsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
notificationType	NotificationTypeModel		[optional] [enum: MentionInComment, TestPointIsSetInTestPlan, MentionInCustomAttribute, TestPlanUnlockRequest]
skip	Integer	Amount of items to be skipped (offset)	[optional]
take	Integer	Amount of items to be taken (limit)	[optional]
orderBy	String	SQL-like ORDER BY statement (column1 ASC	DESC , column2 ASC
searchField	String	Property name for searching	[optional]
searchValue	String	Value for searching	[optional]

Return type

List<NotificationModel>

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	* Pagination-Skip - Skipped amount of items * Pagination-Take - Taken items * Pagination-Pages - Expected number of pages * Pagination-Total-Items - Total count of items
400	orderByStatement must have one '.' and no ',' symbols orderByStatement has invalid length orderByStatement must have uuid as attribute key Search field not found	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-

apiV2NotificationsIdReadPost

apiV2NotificationsIdReadPost(id)

Set Notification as read

Use case User sets notification internal (guid format) identifier User runs method execution System set notification as read

Example

// Import classes:
import ru.testit.client.invoker.ApiClient;
import ru.testit.client.invoker.ApiException;
import ru.testit.client.invoker.Configuration;
import ru.testit.client.invoker.auth.*;
import ru.testit.client.invoker.models.*;
import ru.testit.client.api.NotificationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    NotificationsApi apiInstance = new NotificationsApi(defaultClient);
    UUID id = UUID.randomUUID(); // UUID | 
    try {
      apiInstance.apiV2NotificationsIdReadPost(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotificationsApi#apiV2NotificationsIdReadPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	UUID

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Can't find notification with notificationId	-
409	Conflict	-
422	Unprocessable Entity	-
204	Successful operation	-

apiV2NotificationsReadPost

apiV2NotificationsReadPost()

Set all Notifications as read

Use case User runs method execution System set all notifications as read

Example

// Import classes:
import ru.testit.client.invoker.ApiClient;
import ru.testit.client.invoker.ApiException;
import ru.testit.client.invoker.Configuration;
import ru.testit.client.invoker.auth.*;
import ru.testit.client.invoker.models.*;
import ru.testit.client.api.NotificationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    NotificationsApi apiInstance = new NotificationsApi(defaultClient);
    try {
      apiInstance.apiV2NotificationsReadPost();
    } catch (ApiException e) {
      System.err.println("Exception when calling NotificationsApi#apiV2NotificationsReadPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-
204	Successful operation	-

apiV2NotificationsSearchPost

List<NotificationModel> apiV2NotificationsSearchPost(skip, take, orderBy, searchField, searchValue, apiV2NotificationsSearchPostRequest)

Search Notifications for current User

Use case User set filter and runs method execution System returns notifications (listed in the response example)

Example

// Import classes:
import ru.testit.client.invoker.ApiClient;
import ru.testit.client.invoker.ApiException;
import ru.testit.client.invoker.Configuration;
import ru.testit.client.invoker.auth.*;
import ru.testit.client.invoker.models.*;
import ru.testit.client.api.NotificationsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    NotificationsApi apiInstance = new NotificationsApi(defaultClient);
    Integer skip = 56; // Integer | Amount of items to be skipped (offset)
    Integer take = 56; // Integer | Amount of items to be taken (limit)
    String orderBy = "orderBy_example"; // String | SQL-like  ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)
    String searchField = "searchField_example"; // String | Property name for searching
    String searchValue = "searchValue_example"; // String | Value for searching
    ApiV2NotificationsSearchPostRequest apiV2NotificationsSearchPostRequest = new ApiV2NotificationsSearchPostRequest(); // ApiV2NotificationsSearchPostRequest | 
    try {
      List<NotificationModel> result = apiInstance.apiV2NotificationsSearchPost(skip, take, orderBy, searchField, searchValue, apiV2NotificationsSearchPostRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling NotificationsApi#apiV2NotificationsSearchPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
skip	Integer	Amount of items to be skipped (offset)	[optional]
take	Integer	Amount of items to be taken (limit)	[optional]
orderBy	String	SQL-like ORDER BY statement (column1 ASC	DESC , column2 ASC
searchField	String	Property name for searching	[optional]
searchValue	String	Value for searching	[optional]
apiV2NotificationsSearchPostRequest	ApiV2NotificationsSearchPostRequest		[optional]

Return type

List<NotificationModel>

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful operation	* Pagination-Skip - Skipped amount of items * Pagination-Take - Taken items * Pagination-Pages - Expected number of pages * Pagination-Total-Items - Total count of items
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-

Files

NotificationsApi.md

Latest commit

History

NotificationsApi.md

File metadata and controls

NotificationsApi

apiV2NotificationsCountGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiV2NotificationsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiV2NotificationsIdReadPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiV2NotificationsReadPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiV2NotificationsSearchPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details