Package com.seeq.api

Class ContextApi

java.lang.Object
com.seeq.api.ContextApi

public class ContextApi extends Object
  • Constructor Details

    • ContextApi

      public ContextApi()
    • ContextApi

      public ContextApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • createContextComment

      public ContextCommentOutputV1 createContextComment(String itemId, ContextCommentInputV1 body) throws ApiException
      Create a new comment associated with an Item
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      body - Context comment information (required)
      Returns:
      ContextCommentOutputV1
      Throws:
      ApiException - if fails to make API call
    • createContextCommentWithHttpInfo

      public ApiClient.ApiResponse<ContextCommentOutputV1> createContextCommentWithHttpInfo(String itemId, ContextCommentInputV1 body) throws ApiException
      Create a new comment associated with an Item
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      body - Context comment information (required)
      Throws:
      ApiException - if fails to make API call
    • createContextCommentWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContextCommentOutputV1> createContextCommentWithHeadersAndHttpInfo(String itemId, ContextCommentInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a new comment associated with an Item
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      body - Context comment information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createContextLabel

      public ContextLabelOutputV1 createContextLabel(String itemId, ContextLabelInputV1 body) throws ApiException
      Create a new label associated with an item
      Parameters:
      itemId - ID of the item that the label is associated with (required)
      body - Context label information (required)
      Returns:
      ContextLabelOutputV1
      Throws:
      ApiException - if fails to make API call
    • createContextLabelWithHttpInfo

      public ApiClient.ApiResponse<ContextLabelOutputV1> createContextLabelWithHttpInfo(String itemId, ContextLabelInputV1 body) throws ApiException
      Create a new label associated with an item
      Parameters:
      itemId - ID of the item that the label is associated with (required)
      body - Context label information (required)
      Throws:
      ApiException - if fails to make API call
    • createContextLabelWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContextLabelOutputV1> createContextLabelWithHeadersAndHttpInfo(String itemId, ContextLabelInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a new label associated with an item
      Parameters:
      itemId - ID of the item that the label is associated with (required)
      body - Context label information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createContextOpaque

      public ContextOpaqueOutputV1 createContextOpaque(String itemId, ContextOpaqueInputV1 body) throws ApiException
      Create new opaque context associated with an item
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      body - Context opaque information (required)
      Returns:
      ContextOpaqueOutputV1
      Throws:
      ApiException - if fails to make API call
    • createContextOpaqueWithHttpInfo

      public ApiClient.ApiResponse<ContextOpaqueOutputV1> createContextOpaqueWithHttpInfo(String itemId, ContextOpaqueInputV1 body) throws ApiException
      Create new opaque context associated with an item
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      body - Context opaque information (required)
      Throws:
      ApiException - if fails to make API call
    • createContextOpaqueWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContextOpaqueOutputV1> createContextOpaqueWithHeadersAndHttpInfo(String itemId, ContextOpaqueInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create new opaque context associated with an item
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      body - Context opaque information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createLabel

      public LabelOutputV1 createLabel(LabelInputV1 body) throws ApiException
      Create a new label
      Parameters:
      body - Label information (required)
      Returns:
      LabelOutputV1
      Throws:
      ApiException - if fails to make API call
    • createLabelWithHttpInfo

      public ApiClient.ApiResponse<LabelOutputV1> createLabelWithHttpInfo(LabelInputV1 body) throws ApiException
      Create a new label
      Parameters:
      body - Label information (required)
      Throws:
      ApiException - if fails to make API call
    • createLabelWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<LabelOutputV1> createLabelWithHeadersAndHttpInfo(LabelInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a new label
      Parameters:
      body - Label information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createLabelCategory

      public LabelCategoryOutputV1 createLabelCategory(LabelCategoryInputV1 body) throws ApiException
      Create a new label category
      Parameters:
      body - Label category information (required)
      Returns:
      LabelCategoryOutputV1
      Throws:
      ApiException - if fails to make API call
    • createLabelCategoryWithHttpInfo

      public ApiClient.ApiResponse<LabelCategoryOutputV1> createLabelCategoryWithHttpInfo(LabelCategoryInputV1 body) throws ApiException
      Create a new label category
      Parameters:
      body - Label category information (required)
      Throws:
      ApiException - if fails to make API call
    • createLabelCategoryWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<LabelCategoryOutputV1> createLabelCategoryWithHeadersAndHttpInfo(LabelCategoryInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a new label category
      Parameters:
      body - Label category information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • deleteContextComment

      public void deleteContextComment(String itemId, String commentId, Boolean delete) throws ApiException
      Delete or archive a comment
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      commentId - The comment ID to be deleted (required)
      delete - Permanently and irretrievably delete the comment (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • deleteContextCommentWithHttpInfo

      public void deleteContextCommentWithHttpInfo(String itemId, String commentId, Boolean delete) throws ApiException
      Delete or archive a comment
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      commentId - The comment ID to be deleted (required)
      delete - Permanently and irretrievably delete the comment (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • deleteContextCommentWithHeadersAndHttpInfo

      public void deleteContextCommentWithHeadersAndHttpInfo(String itemId, String commentId, Boolean delete, Map<String,String> customHeaders) throws ApiException
      Delete or archive a comment
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      commentId - The comment ID to be deleted (required)
      delete - Permanently and irretrievably delete the comment (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • deleteContextLabel

      public void deleteContextLabel(String itemId, String labelId) throws ApiException
      Delete or archive a label
      Parameters:
      itemId - ID of the item that the label is associated with (required)
      labelId - The context label ID to be deleted (required)
      Throws:
      ApiException - if fails to make API call
    • deleteContextLabelWithHttpInfo

      public void deleteContextLabelWithHttpInfo(String itemId, String labelId) throws ApiException
      Delete or archive a label
      Parameters:
      itemId - ID of the item that the label is associated with (required)
      labelId - The context label ID to be deleted (required)
      Throws:
      ApiException - if fails to make API call
    • deleteContextLabelWithHeadersAndHttpInfo

      public void deleteContextLabelWithHeadersAndHttpInfo(String itemId, String labelId, Map<String,String> customHeaders) throws ApiException
      Delete or archive a label
      Parameters:
      itemId - ID of the item that the label is associated with (required)
      labelId - The context label ID to be deleted (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • deleteContextOpaque

      public void deleteContextOpaque(String itemId, String opaqueId, Boolean delete) throws ApiException
      Delete or archive opaque context
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      opaqueId - The opaque ID to be deleted (required)
      delete - Permanently and irretrievably delete the opaque context (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • deleteContextOpaqueWithHttpInfo

      public void deleteContextOpaqueWithHttpInfo(String itemId, String opaqueId, Boolean delete) throws ApiException
      Delete or archive opaque context
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      opaqueId - The opaque ID to be deleted (required)
      delete - Permanently and irretrievably delete the opaque context (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • deleteContextOpaqueWithHeadersAndHttpInfo

      public void deleteContextOpaqueWithHeadersAndHttpInfo(String itemId, String opaqueId, Boolean delete, Map<String,String> customHeaders) throws ApiException
      Delete or archive opaque context
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      opaqueId - The opaque ID to be deleted (required)
      delete - Permanently and irretrievably delete the opaque context (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • deleteLabel

      public void deleteLabel(String labelId) throws ApiException
      Delete a specific label.
      Parameters:
      labelId - ID of the label (required)
      Throws:
      ApiException - if fails to make API call
    • deleteLabelWithHttpInfo

      public void deleteLabelWithHttpInfo(String labelId) throws ApiException
      Delete a specific label.
      Parameters:
      labelId - ID of the label (required)
      Throws:
      ApiException - if fails to make API call
    • deleteLabelWithHeadersAndHttpInfo

      public void deleteLabelWithHeadersAndHttpInfo(String labelId, Map<String,String> customHeaders) throws ApiException
      Delete a specific label.
      Parameters:
      labelId - ID of the label (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • deleteLabelCategory

      public void deleteLabelCategory(String categoryId) throws ApiException
      Delete a specific label category.
      Parameters:
      categoryId - ID of the category (required)
      Throws:
      ApiException - if fails to make API call
    • deleteLabelCategoryWithHttpInfo

      public void deleteLabelCategoryWithHttpInfo(String categoryId) throws ApiException
      Delete a specific label category.
      Parameters:
      categoryId - ID of the category (required)
      Throws:
      ApiException - if fails to make API call
    • deleteLabelCategoryWithHeadersAndHttpInfo

      public void deleteLabelCategoryWithHeadersAndHttpInfo(String categoryId, Map<String,String> customHeaders) throws ApiException
      Delete a specific label category.
      Parameters:
      categoryId - ID of the category (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • findLabelCategories

      public LabelCategoryOutputListV1 findLabelCategories() throws ApiException
      Get all label categories
      Returns:
      LabelCategoryOutputListV1
      Throws:
      ApiException - if fails to make API call
    • findLabelCategoriesWithHttpInfo

      public ApiClient.ApiResponse<LabelCategoryOutputListV1> findLabelCategoriesWithHttpInfo() throws ApiException
      Get all label categories
      Throws:
      ApiException - if fails to make API call
    • findLabelCategoriesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<LabelCategoryOutputListV1> findLabelCategoriesWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Get all label categories
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • findLabels

      public LabelOutputListV1 findLabels(String categoryId, String query, String parentId) throws ApiException
      Get all labels for a given category
      Parameters:
      categoryId - ID of the category of labels to return (required)
      query - Search for labels that contain this string in a case-insensitive manner. This is especially useful for autocomplete categories. Note that if this is specified only the first 20 results will be returned, ordered by name (optional)
      parentId - If set to the ID of a parent label then the child labels will be returned, if set to the empty GUID (00000000-0000-0000-0000-000000000000) only top level labels will be returned, if not specified all labels will be returned (optional)
      Returns:
      LabelOutputListV1
      Throws:
      ApiException - if fails to make API call
    • findLabelsWithHttpInfo

      public ApiClient.ApiResponse<LabelOutputListV1> findLabelsWithHttpInfo(String categoryId, String query, String parentId) throws ApiException
      Get all labels for a given category
      Parameters:
      categoryId - ID of the category of labels to return (required)
      query - Search for labels that contain this string in a case-insensitive manner. This is especially useful for autocomplete categories. Note that if this is specified only the first 20 results will be returned, ordered by name (optional)
      parentId - If set to the ID of a parent label then the child labels will be returned, if set to the empty GUID (00000000-0000-0000-0000-000000000000) only top level labels will be returned, if not specified all labels will be returned (optional)
      Throws:
      ApiException - if fails to make API call
    • findLabelsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<LabelOutputListV1> findLabelsWithHeadersAndHttpInfo(String categoryId, String query, String parentId, Map<String,String> customHeaders) throws ApiException
      Get all labels for a given category
      Parameters:
      categoryId - ID of the category of labels to return (required)
      query - Search for labels that contain this string in a case-insensitive manner. This is especially useful for autocomplete categories. Note that if this is specified only the first 20 results will be returned, ordered by name (optional)
      parentId - If set to the ID of a parent label then the child labels will be returned, if set to the empty GUID (00000000-0000-0000-0000-000000000000) only top level labels will be returned, if not specified all labels will be returned (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getContext

      public ContextOutputListV1 getContext(String itemId, List<String> datumId, Boolean archived) throws ApiException
      Get all context associated with an Item or with a specific datum of that Item
      Parameters:
      itemId - Returns context associated with this Item ID (required)
      datumId - If specified, only context that are also associated with this specific datumId will be returned (optional)
      archived - If true, returns only archived context. If false, returns non-archived comments. (optional)
      Returns:
      ContextOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getContextWithHttpInfo

      public ApiClient.ApiResponse<ContextOutputListV1> getContextWithHttpInfo(String itemId, List<String> datumId, Boolean archived) throws ApiException
      Get all context associated with an Item or with a specific datum of that Item
      Parameters:
      itemId - Returns context associated with this Item ID (required)
      datumId - If specified, only context that are also associated with this specific datumId will be returned (optional)
      archived - If true, returns only archived context. If false, returns non-archived comments. (optional)
      Throws:
      ApiException - if fails to make API call
    • getContextWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContextOutputListV1> getContextWithHeadersAndHttpInfo(String itemId, List<String> datumId, Boolean archived, Map<String,String> customHeaders) throws ApiException
      Get all context associated with an Item or with a specific datum of that Item
      Parameters:
      itemId - Returns context associated with this Item ID (required)
      datumId - If specified, only context that are also associated with this specific datumId will be returned (optional)
      archived - If true, returns only archived context. If false, returns non-archived comments. (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateContextComment

      public ContextCommentOutputV1 updateContextComment(String itemId, String commentId, ContextCommentInputV1 body) throws ApiException
      Update a comment
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      commentId - ID of the comment to update (required)
      body - Updated comment information (required)
      Returns:
      ContextCommentOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateContextCommentWithHttpInfo

      public ApiClient.ApiResponse<ContextCommentOutputV1> updateContextCommentWithHttpInfo(String itemId, String commentId, ContextCommentInputV1 body) throws ApiException
      Update a comment
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      commentId - ID of the comment to update (required)
      body - Updated comment information (required)
      Throws:
      ApiException - if fails to make API call
    • updateContextCommentWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContextCommentOutputV1> updateContextCommentWithHeadersAndHttpInfo(String itemId, String commentId, ContextCommentInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update a comment
      Parameters:
      itemId - ID of the item that the comment is associated with (required)
      commentId - ID of the comment to update (required)
      body - Updated comment information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateContextOpaque

      public ContextOpaqueOutputV1 updateContextOpaque(String itemId, String opaqueId, ContextOpaqueInputV1 body) throws ApiException
      Update opaque context
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      opaqueId - ID of the opaque context to update (required)
      body - Updated opaque context information (required)
      Returns:
      ContextOpaqueOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateContextOpaqueWithHttpInfo

      public ApiClient.ApiResponse<ContextOpaqueOutputV1> updateContextOpaqueWithHttpInfo(String itemId, String opaqueId, ContextOpaqueInputV1 body) throws ApiException
      Update opaque context
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      opaqueId - ID of the opaque context to update (required)
      body - Updated opaque context information (required)
      Throws:
      ApiException - if fails to make API call
    • updateContextOpaqueWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContextOpaqueOutputV1> updateContextOpaqueWithHeadersAndHttpInfo(String itemId, String opaqueId, ContextOpaqueInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update opaque context
      Parameters:
      itemId - ID of the item that the opaque context is associated with (required)
      opaqueId - ID of the opaque context to update (required)
      body - Updated opaque context information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateLabel

      public LabelOutputV1 updateLabel(String labelId, LabelInputV1 body) throws ApiException
      Update a label
      Parameters:
      labelId - (required)
      body - New name for the label (required)
      Returns:
      LabelOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateLabelWithHttpInfo

      public ApiClient.ApiResponse<LabelOutputV1> updateLabelWithHttpInfo(String labelId, LabelInputV1 body) throws ApiException
      Update a label
      Parameters:
      labelId - (required)
      body - New name for the label (required)
      Throws:
      ApiException - if fails to make API call
    • updateLabelWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<LabelOutputV1> updateLabelWithHeadersAndHttpInfo(String labelId, LabelInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update a label
      Parameters:
      labelId - (required)
      body - New name for the label (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateLabelCategory

      public LabelCategoryOutputV1 updateLabelCategory(String categoryId, LabelCategoryInputV1 body) throws ApiException
      Update a label category
      Parameters:
      categoryId - (required)
      body - Label category information (required)
      Returns:
      LabelCategoryOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateLabelCategoryWithHttpInfo

      public ApiClient.ApiResponse<LabelCategoryOutputV1> updateLabelCategoryWithHttpInfo(String categoryId, LabelCategoryInputV1 body) throws ApiException
      Update a label category
      Parameters:
      categoryId - (required)
      body - Label category information (required)
      Throws:
      ApiException - if fails to make API call
    • updateLabelCategoryWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<LabelCategoryOutputV1> updateLabelCategoryWithHeadersAndHttpInfo(String categoryId, LabelCategoryInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update a label category
      Parameters:
      categoryId - (required)
      body - Label category information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call