Skip to content

AnalysesCommentsApi.md

Latest commit

 

History

History
305 lines (237 loc) · 10.2 KB

AnalysesCommentsApi.md

File metadata and controls

305 lines (237 loc) · 10.2 KB

AnalysesCommentsApi

All URIs are relative to https://api.reveng.ai

Method HTTP request Description
createAnalysisComment POST /v2/analyses/{analysis_id}/comments Create a comment for this analysis
deleteAnalysisComment DELETE /v2/analyses/{analysis_id}/comments/{comment_id} Delete a comment
getAnalysisComments GET /v2/analyses/{analysis_id}/comments Get comments for this analysis
updateAnalysisComment PATCH /v2/analyses/{analysis_id}/comments/{comment_id} Update a comment

createAnalysisComment

BaseResponseCommentResponse createAnalysisComment(analysisId, commentBase)

Create a comment for this analysis

Creates a comment associated with a specified analysis).

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesCommentsApi;

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

    AnalysesCommentsApi apiInstance = new AnalysesCommentsApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    CommentBase commentBase = new CommentBase(); // CommentBase | 
    try {
      BaseResponseCommentResponse result = apiInstance.createAnalysisComment(analysisId, commentBase);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesCommentsApi#createAnalysisComment");
      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
analysisId Integer
commentBase CommentBase

Return type

BaseResponseCommentResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Successful Response -
422 Invalid request parameters -
400 Bad Request -

deleteAnalysisComment

BaseResponseBool deleteAnalysisComment(commentId, analysisId)

Delete a comment

Deletes an existing comment. Users can only delete their own comments.

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesCommentsApi;

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

    AnalysesCommentsApi apiInstance = new AnalysesCommentsApi(defaultClient);
    Integer commentId = 56; // Integer | 
    Integer analysisId = 56; // Integer | 
    try {
      BaseResponseBool result = apiInstance.deleteAnalysisComment(commentId, analysisId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesCommentsApi#deleteAnalysisComment");
      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
commentId Integer
analysisId Integer

Return type

BaseResponseBool

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -
403 You can only delete your own comments -
400 Bad Request -

getAnalysisComments

BaseResponseListCommentResponse getAnalysisComments(analysisId)

Get comments for this analysis

Retrieves all comments created for a specific analysis. Only returns comments for resources the requesting user has access to.

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesCommentsApi;

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

    AnalysesCommentsApi apiInstance = new AnalysesCommentsApi(defaultClient);
    Integer analysisId = 56; // Integer | 
    try {
      BaseResponseListCommentResponse result = apiInstance.getAnalysisComments(analysisId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesCommentsApi#getAnalysisComments");
      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
analysisId Integer

Return type

BaseResponseListCommentResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

updateAnalysisComment

BaseResponseCommentResponse updateAnalysisComment(commentId, analysisId, commentUpdateRequest)

Update a comment

Updates the content of an existing comment. Users can only update their own comments.

Example

// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysesCommentsApi;

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

    AnalysesCommentsApi apiInstance = new AnalysesCommentsApi(defaultClient);
    Integer commentId = 56; // Integer | 
    Integer analysisId = 56; // Integer | 
    CommentUpdateRequest commentUpdateRequest = new CommentUpdateRequest(); // CommentUpdateRequest | 
    try {
      BaseResponseCommentResponse result = apiInstance.updateAnalysisComment(commentId, analysisId, commentUpdateRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnalysesCommentsApi#updateAnalysisComment");
      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
commentId Integer
analysisId Integer
commentUpdateRequest CommentUpdateRequest

Return type

BaseResponseCommentResponse

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -
403 You can only update your own comments -
400 Bad Request -