Package org.camunda.community.rest.client.api

Class TaskCommentApi

java.lang.Object
org.camunda.community.rest.client.api.TaskCommentApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class TaskCommentApi extends Object

  • Constructor Details

    • TaskCommentApi

      public TaskCommentApi()

    • TaskCommentApi

      public TaskCommentApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createComment

      public CommentDto createComment(String id, CommentDto commentDto) throws ApiException
      Create Creates a comment for a task by id.
      Parameters:
      id - The id of the task to add the comment to. (required)
      commentDto - **Note:** Only the `message` and `processInstanceId` properties will be used. Every other property passed to this endpoint will be ignored. (optional)
      Returns:
      CommentDto
      Throws:
      ApiException - if fails to make API call

    • createComment

      public CommentDto createComment(String id, CommentDto commentDto, Map<String,String> additionalHeaders) throws ApiException
      Create Creates a comment for a task by id.
      Parameters:
      id - The id of the task to add the comment to. (required)
      commentDto - **Note:** Only the `message` and `processInstanceId` properties will be used. Every other property passed to this endpoint will be ignored. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CommentDto
      Throws:
      ApiException - if fails to make API call

    • getComment

      public CommentDto getComment(String id, String commentId) throws ApiException
      Get Retrieves a task comment by task id and comment id.
      Parameters:
      id - The id of the task. (required)
      commentId - The id of the comment to be retrieved. (required)
      Returns:
      CommentDto
      Throws:
      ApiException - if fails to make API call

    • getComment

      public CommentDto getComment(String id, String commentId, Map<String,String> additionalHeaders) throws ApiException
      Get Retrieves a task comment by task id and comment id.
      Parameters:
      id - The id of the task. (required)
      commentId - The id of the comment to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CommentDto
      Throws:
      ApiException - if fails to make API call

    • getComments

      public List<CommentDto> getComments(String id) throws ApiException
      Get List Gets the comments for a task by id.
      Parameters:
      id - The id of the task to retrieve the comments for. (required)
      Returns:
      List<CommentDto>
      Throws:
      ApiException - if fails to make API call

    • getComments

      public List<CommentDto> getComments(String id, Map<String,String> additionalHeaders) throws ApiException
      Get List Gets the comments for a task by id.
      Parameters:
      id - The id of the task to retrieve the comments for. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CommentDto>
      Throws:
      ApiException - if fails to make API call