All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
apiV2WebhooksDelete | DELETE /api/v2/webhooks | |
apiV2WebhooksGet | GET /api/v2/webhooks | Get all webhooks |
apiV2WebhooksIdDelete | DELETE /api/v2/webhooks/{id} | Delete webhook by ID |
apiV2WebhooksIdGet | GET /api/v2/webhooks/{id} | Get webhook by ID |
apiV2WebhooksIdPut | PUT /api/v2/webhooks/{id} | Edit webhook by ID |
apiV2WebhooksPost | POST /api/v2/webhooks | Create webhook |
apiV2WebhooksPut | PUT /api/v2/webhooks | |
apiV2WebhooksSearchPost | POST /api/v2/webhooks/search | Search for webhooks |
apiV2WebhooksSpecialVariablesGet | GET /api/v2/webhooks/specialVariables | Get special variables for webhook event type |
apiV2WebhooksTestPost | POST /api/v2/webhooks/test | Test webhook's url |
apiV2WebhooksDelete(apiV2WebhooksDeleteRequest)
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
ApiV2WebhooksDeleteRequest apiV2WebhooksDeleteRequest = new ApiV2WebhooksDeleteRequest(); // ApiV2WebhooksDeleteRequest |
try {
apiInstance.apiV2WebhooksDelete(apiV2WebhooksDeleteRequest);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
apiV2WebhooksDeleteRequest | ApiV2WebhooksDeleteRequest | [optional] |
null (empty response body)
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
List<WebHookModel> apiV2WebhooksGet(projectId)
Get all webhooks
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
UUID projectId = UUID.randomUUID(); // UUID | Project unique ID
try {
List<WebHookModel> result = apiInstance.apiV2WebhooksGet(projectId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
projectId | UUID | Project unique ID | [optional] |
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
404 | Not Found | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Read permission for requested project is required | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
0 | Error | - |
apiV2WebhooksIdDelete(id)
Delete webhook by ID
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Webhook unique ID
try {
apiInstance.apiV2WebhooksIdDelete(id);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksIdDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Webhook unique ID |
null (empty response body)
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
204 | No Content | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Delete permission for webhooks is required | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
WebHookModel apiV2WebhooksIdGet(id)
Get webhook by ID
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Webhook unique ID
try {
WebHookModel result = apiInstance.apiV2WebhooksIdGet(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksIdGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Webhook unique ID |
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Update permission for webhooks is required | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
WebHookModel apiV2WebhooksIdPut(id, apiV2WebhooksPostRequest)
Edit webhook by ID
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Webhook unique ID
ApiV2WebhooksPostRequest apiV2WebhooksPostRequest = new ApiV2WebhooksPostRequest(); // ApiV2WebhooksPostRequest |
try {
WebHookModel result = apiInstance.apiV2WebhooksIdPut(id, apiV2WebhooksPostRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksIdPut");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Webhook unique ID | |
apiV2WebhooksPostRequest | ApiV2WebhooksPostRequest | [optional] |
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Update permission for webhooks is required | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
WebHookModel apiV2WebhooksPost(apiV2WebhooksPostRequest)
Create webhook
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
ApiV2WebhooksPostRequest apiV2WebhooksPostRequest = new ApiV2WebhooksPostRequest(); // ApiV2WebhooksPostRequest |
try {
WebHookModel result = apiInstance.apiV2WebhooksPost(apiV2WebhooksPostRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
apiV2WebhooksPostRequest | ApiV2WebhooksPostRequest | [optional] |
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Update permission for webhooks is required | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
WebhooksUpdateResponse apiV2WebhooksPut(apiV2WebhooksPutRequest)
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
ApiV2WebhooksPutRequest apiV2WebhooksPutRequest = new ApiV2WebhooksPutRequest(); // ApiV2WebhooksPutRequest |
try {
WebhooksUpdateResponse result = apiInstance.apiV2WebhooksPut(apiV2WebhooksPutRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksPut");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
apiV2WebhooksPutRequest | ApiV2WebhooksPutRequest | [optional] |
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
List<WebHookModel> apiV2WebhooksSearchPost(skip, take, orderBy, searchField, searchValue, apiV2WebhooksSearchPostRequest)
Search for webhooks
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(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
ApiV2WebhooksSearchPostRequest apiV2WebhooksSearchPostRequest = new ApiV2WebhooksSearchPostRequest(); // ApiV2WebhooksSearchPostRequest |
try {
List<WebHookModel> result = apiInstance.apiV2WebhooksSearchPost(skip, take, orderBy, searchField, searchValue, apiV2WebhooksSearchPostRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksSearchPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
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] |
apiV2WebhooksSearchPostRequest | ApiV2WebhooksSearchPostRequest | [optional] |
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | * 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 | Read permission for all requested projects is required | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
List<String> apiV2WebhooksSpecialVariablesGet(eventType, variablesType)
Get special variables for webhook event type
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
WebHookEventType eventType = WebHookEventType.fromValue("AutomatedTestRunCreated"); // WebHookEventType | Webhook event type
WebhookVariablesType variablesType = WebhookVariablesType.fromValue("VariablesForUrl"); // WebhookVariablesType |
try {
List<String> result = apiInstance.apiV2WebhooksSpecialVariablesGet(eventType, variablesType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksSpecialVariablesGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
eventType | WebHookEventType | Webhook event type | [optional] [enum: AutomatedTestRunCreated, TestPlansStatusChanged, TestRunStopped, TestPointAssigned, TestResultJiraIssueCreated, AutoTestFinished, UserMentionedInComment, UserSelectedInWorkItemAttribute, AllTestPointsFinished, AllAutoTestsFinished, AutoTestChanged, WorkItemAutoTestRelationChanged, WorkItemAttributeChanged, WorkItemChanged, ConfigurationChanged, ProjectChanged, TestPlanChanged] |
variablesType | WebhookVariablesType | [optional] [default to VariablesForUrl] [enum: VariablesForUrl, VariablesForHeaders, VariablesForBody] |
List<String>
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |
WebhookResponse apiV2WebhooksTestPost(apiV2WebhooksTestPostRequest)
Test webhook's url
// 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.WebhooksApi;
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");
WebhooksApi apiInstance = new WebhooksApi(defaultClient);
ApiV2WebhooksTestPostRequest apiV2WebhooksTestPostRequest = new ApiV2WebhooksTestPostRequest(); // ApiV2WebhooksTestPostRequest |
try {
WebhookResponse result = apiInstance.apiV2WebhooksTestPost(apiV2WebhooksTestPostRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling WebhooksApi#apiV2WebhooksTestPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
apiV2WebhooksTestPostRequest | ApiV2WebhooksTestPostRequest | [optional] |
[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
400 | Bad Request | - |
401 | Unauthorized | - |
403 | Update permission for webhooks is required | - |
404 | Not Found | - |
409 | Conflict | - |
422 | Unprocessable Entity | - |