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

Class TaskAttachmentApi

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

  • Constructor Details

    • TaskAttachmentApi

      public TaskAttachmentApi()

    • TaskAttachmentApi

      public TaskAttachmentApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • addAttachment

      public AttachmentDto addAttachment(String id, String attachmentName, String attachmentDescription, String attachmentType, String url, File content) throws ApiException
      Create Creates an attachment for a task.
      Parameters:
      id - The id of the task to add the attachment to. (required)
      attachmentName - The name of the attachment. (optional)
      attachmentDescription - The description of the attachment. (optional)
      attachmentType - The type of the attachment. (optional)
      url - The url to the remote content of the attachment. (optional)
      content - The content of the attachment. (optional)
      Returns:
      AttachmentDto
      Throws:
      ApiException - if fails to make API call

    • addAttachment

      public AttachmentDto addAttachment(String id, String attachmentName, String attachmentDescription, String attachmentType, String url, File content, Map<String,String> additionalHeaders) throws ApiException
      Create Creates an attachment for a task.
      Parameters:
      id - The id of the task to add the attachment to. (required)
      attachmentName - The name of the attachment. (optional)
      attachmentDescription - The description of the attachment. (optional)
      attachmentType - The type of the attachment. (optional)
      url - The url to the remote content of the attachment. (optional)
      content - The content of the attachment. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      AttachmentDto
      Throws:
      ApiException - if fails to make API call

    • deleteAttachment

      public void deleteAttachment(String id, String attachmentId) throws ApiException
      Delete Removes an attachment from a task by id.
      Parameters:
      id - The id of the task. (required)
      attachmentId - The id of the attachment to be removed. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteAttachment

      public void deleteAttachment(String id, String attachmentId, Map<String,String> additionalHeaders) throws ApiException
      Delete Removes an attachment from a task by id.
      Parameters:
      id - The id of the task. (required)
      attachmentId - The id of the attachment to be removed. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getAttachment

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

    • getAttachment

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

    • getAttachmentData

      public File getAttachmentData(String id, String attachmentId) throws ApiException
      Get (Binary) Retrieves the binary content of a task attachment by task id and attachment id.
      Parameters:
      id - The id of the task. (required)
      attachmentId - The id of the attachment to be retrieved. (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getAttachmentData

      public File getAttachmentData(String id, String attachmentId, Map<String,String> additionalHeaders) throws ApiException
      Get (Binary) Retrieves the binary content of a task attachment by task id and attachment id.
      Parameters:
      id - The id of the task. (required)
      attachmentId - The id of the attachment to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getAttachments

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

    • getAttachments

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