Package com.seeq.api

Class ContentApi

java.lang.Object
com.seeq.api.ContentApi

public class ContentApi extends Object
  • Constructor Details

    • ContentApi

      public ContentApi()
    • ContentApi

      public ContentApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • archiveAssetSelection

      public StatusMessageBase archiveAssetSelection(String id) throws ApiException
      Archive an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • archiveAssetSelectionWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveAssetSelectionWithHttpInfo(String id) throws ApiException
      Archive an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      Throws:
      ApiException - if fails to make API call
    • archiveAssetSelectionWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveAssetSelectionWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Archive an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • archiveContent

      public StatusMessageBase archiveContent(String id) throws ApiException
      Archive a content item
      Parameters:
      id - The Seeq ID for the content (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • archiveContentWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveContentWithHttpInfo(String id) throws ApiException
      Archive a content item
      Parameters:
      id - The Seeq ID for the content (required)
      Throws:
      ApiException - if fails to make API call
    • archiveContentWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveContentWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Archive a content item
      Parameters:
      id - The Seeq ID for the content (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • archiveDateRange

      public StatusMessageBase archiveDateRange(String id) throws ApiException
      Archive a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • archiveDateRangeWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveDateRangeWithHttpInfo(String id) throws ApiException
      Archive a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      Throws:
      ApiException - if fails to make API call
    • archiveDateRangeWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveDateRangeWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Archive a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • clearImageCache

      public void clearImageCache(String id) throws ApiException
      Clear the cached images for a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      Throws:
      ApiException - if fails to make API call
    • clearImageCacheWithHttpInfo

      public void clearImageCacheWithHttpInfo(String id) throws ApiException
      Clear the cached images for a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      Throws:
      ApiException - if fails to make API call
    • clearImageCacheWithHeadersAndHttpInfo

      public void clearImageCacheWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Clear the cached images for a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createAssetSelection

      public AssetSelectionOutputV1 createAssetSelection(AssetSelectionInputV1 body) throws ApiException
      Create new asset selection
      Parameters:
      body - (required)
      Returns:
      AssetSelectionOutputV1
      Throws:
      ApiException - if fails to make API call
    • createAssetSelectionWithHttpInfo

      public ApiClient.ApiResponse<AssetSelectionOutputV1> createAssetSelectionWithHttpInfo(AssetSelectionInputV1 body) throws ApiException
      Create new asset selection
      Parameters:
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • createAssetSelectionWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AssetSelectionOutputV1> createAssetSelectionWithHeadersAndHttpInfo(AssetSelectionInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create new asset selection
      Parameters:
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createContent

      public ContentOutputV1 createContent(ContentInputV1 body) throws ApiException
      Create a new content item
      Parameters:
      body - (required)
      Returns:
      ContentOutputV1
      Throws:
      ApiException - if fails to make API call
    • createContentWithHttpInfo

      public ApiClient.ApiResponse<ContentOutputV1> createContentWithHttpInfo(ContentInputV1 body) throws ApiException
      Create a new content item
      Parameters:
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • createContentWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContentOutputV1> createContentWithHeadersAndHttpInfo(ContentInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a new content item
      Parameters:
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createDateRange

      public DateRangeOutputV1 createDateRange(DateRangeInputV1 body) throws ApiException
      Create a new date range
      Parameters:
      body - (required)
      Returns:
      DateRangeOutputV1
      Throws:
      ApiException - if fails to make API call
    • createDateRangeWithHttpInfo

      public ApiClient.ApiResponse<DateRangeOutputV1> createDateRangeWithHttpInfo(DateRangeInputV1 body) throws ApiException
      Create a new date range
      Parameters:
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • createDateRangeWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DateRangeOutputV1> createDateRangeWithHeadersAndHttpInfo(DateRangeInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a new date range
      Parameters:
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getAssetSelection

      public AssetSelectionOutputV1 getAssetSelection(String id) throws ApiException
      Get an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      Returns:
      AssetSelectionOutputV1
      Throws:
      ApiException - if fails to make API call
    • getAssetSelectionWithHttpInfo

      public ApiClient.ApiResponse<AssetSelectionOutputV1> getAssetSelectionWithHttpInfo(String id) throws ApiException
      Get an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      Throws:
      ApiException - if fails to make API call
    • getAssetSelectionWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AssetSelectionOutputV1> getAssetSelectionWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getContent

      public ContentOutputV1 getContent(String id) throws ApiException
      Get a content item
      Parameters:
      id - The Seeq ID for the content (required)
      Returns:
      ContentOutputV1
      Throws:
      ApiException - if fails to make API call
    • getContentWithHttpInfo

      public ApiClient.ApiResponse<ContentOutputV1> getContentWithHttpInfo(String id) throws ApiException
      Get a content item
      Parameters:
      id - The Seeq ID for the content (required)
      Throws:
      ApiException - if fails to make API call
    • getContentWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContentOutputV1> getContentWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get a content item
      Parameters:
      id - The Seeq ID for the content (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getContentItems

      public GetContentItemsOutputV1 getContentItems(Integer offset, Integer limit) throws ApiException
      Get content items
      Parameters:
      offset - The pagination offset, the index of the first content item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of content items that will be returned in this page of results (optional, default to 40)
      Returns:
      GetContentItemsOutputV1
      Throws:
      ApiException - if fails to make API call
    • getContentItemsWithHttpInfo

      public ApiClient.ApiResponse<GetContentItemsOutputV1> getContentItemsWithHttpInfo(Integer offset, Integer limit) throws ApiException
      Get content items
      Parameters:
      offset - The pagination offset, the index of the first content item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of content items that will be returned in this page of results (optional, default to 40)
      Throws:
      ApiException - if fails to make API call
    • getContentItemsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<GetContentItemsOutputV1> getContentItemsWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get content items
      Parameters:
      offset - The pagination offset, the index of the first content item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of content items that will be returned in this page of results (optional, default to 40)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getContentItemsForDateRange

      public GetContentItemsOutputV1 getContentItemsForDateRange(String id, Integer offset, Integer limit) throws ApiException
      Get the content items that depend on a given date range
      Parameters:
      id - The Seeq ID for the content (required)
      offset - The pagination offset, the index of the first content item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of content items that will be returned in this page of results (optional, default to 40)
      Returns:
      GetContentItemsOutputV1
      Throws:
      ApiException - if fails to make API call
    • getContentItemsForDateRangeWithHttpInfo

      public ApiClient.ApiResponse<GetContentItemsOutputV1> getContentItemsForDateRangeWithHttpInfo(String id, Integer offset, Integer limit) throws ApiException
      Get the content items that depend on a given date range
      Parameters:
      id - The Seeq ID for the content (required)
      offset - The pagination offset, the index of the first content item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of content items that will be returned in this page of results (optional, default to 40)
      Throws:
      ApiException - if fails to make API call
    • getContentItemsForDateRangeWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<GetContentItemsOutputV1> getContentItemsForDateRangeWithHeadersAndHttpInfo(String id, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get the content items that depend on a given date range
      Parameters:
      id - The Seeq ID for the content (required)
      offset - The pagination offset, the index of the first content item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of content items that will be returned in this page of results (optional, default to 40)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getContentsWithAllMetadata

      public ContentWithMetadataListOutputV1 getContentsWithAllMetadata(String reportId) throws ApiException
      Retrieves all pieces of content and date ranges associated with the given report with extra metadata attached
      Parameters:
      reportId - Report to retrieve content and date ranges for (required)
      Returns:
      ContentWithMetadataListOutputV1
      Throws:
      ApiException - if fails to make API call
    • getContentsWithAllMetadataWithHttpInfo

      public ApiClient.ApiResponse<ContentWithMetadataListOutputV1> getContentsWithAllMetadataWithHttpInfo(String reportId) throws ApiException
      Retrieves all pieces of content and date ranges associated with the given report with extra metadata attached
      Parameters:
      reportId - Report to retrieve content and date ranges for (required)
      Throws:
      ApiException - if fails to make API call
    • getContentsWithAllMetadataWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContentWithMetadataListOutputV1> getContentsWithAllMetadataWithHeadersAndHttpInfo(String reportId, Map<String,String> customHeaders) throws ApiException
      Retrieves all pieces of content and date ranges associated with the given report with extra metadata attached
      Parameters:
      reportId - Report to retrieve content and date ranges for (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getDateRange

      public DateRangeOutputV1 getDateRange(String id) throws ApiException
      Get a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      Returns:
      DateRangeOutputV1
      Throws:
      ApiException - if fails to make API call
    • getDateRangeWithHttpInfo

      public ApiClient.ApiResponse<DateRangeOutputV1> getDateRangeWithHttpInfo(String id) throws ApiException
      Get a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      Throws:
      ApiException - if fails to make API call
    • getDateRangeWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DateRangeOutputV1> getDateRangeWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getDateRanges

      public GetDateRangesOutputV1 getDateRanges(Integer offset, Integer limit) throws ApiException
      Get date range items
      Parameters:
      offset - The pagination offset, the index of the first date range that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of date ranges that will be returned in this page of results (optional, default to 40)
      Returns:
      GetDateRangesOutputV1
      Throws:
      ApiException - if fails to make API call
    • getDateRangesWithHttpInfo

      public ApiClient.ApiResponse<GetDateRangesOutputV1> getDateRangesWithHttpInfo(Integer offset, Integer limit) throws ApiException
      Get date range items
      Parameters:
      offset - The pagination offset, the index of the first date range that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of date ranges that will be returned in this page of results (optional, default to 40)
      Throws:
      ApiException - if fails to make API call
    • getDateRangesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<GetDateRangesOutputV1> getDateRangesWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get date range items
      Parameters:
      offset - The pagination offset, the index of the first date range that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of date ranges that will be returned in this page of results (optional, default to 40)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getImage

      public void getImage(String id, Boolean useAsync) throws ApiException
      Get the image from a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      useAsync - When true, if the image is not cached a one pixel image will be returned from this call and a job will be started to generate the new image. Used to avoid blocking requests when called from a browser context. (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • getImageWithHttpInfo

      public void getImageWithHttpInfo(String id, Boolean useAsync) throws ApiException
      Get the image from a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      useAsync - When true, if the image is not cached a one pixel image will be returned from this call and a job will be started to generate the new image. Used to avoid blocking requests when called from a browser context. (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • getImageWithHeadersAndHttpInfo

      public void getImageWithHeadersAndHttpInfo(String id, Boolean useAsync, Map<String,String> customHeaders) throws ApiException
      Get the image from a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      useAsync - When true, if the image is not cached a one pixel image will be returned from this call and a job will be started to generate the new image. Used to avoid blocking requests when called from a browser context. (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getNotifiableReports

      public NotifiableReportOutputListV1 getNotifiableReports(List<String> ownerIds, String nameSearch, Integer offset, Integer limit, Boolean sortAsc) throws ApiException
      Retrieves all reports that have notifications configured
      Parameters:
      ownerIds - (optional)
      nameSearch - Filter the reports to those that are part of a topic document with the provided name (optional)
      offset - The pagination offset, the index of the first reports that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of reports that will be returned in this page of results (optional, default to 40)
      sortAsc - Sorts the document name in ascending order when true and descending when false (optional, default to true)
      Returns:
      NotifiableReportOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getNotifiableReportsWithHttpInfo

      public ApiClient.ApiResponse<NotifiableReportOutputListV1> getNotifiableReportsWithHttpInfo(List<String> ownerIds, String nameSearch, Integer offset, Integer limit, Boolean sortAsc) throws ApiException
      Retrieves all reports that have notifications configured
      Parameters:
      ownerIds - (optional)
      nameSearch - Filter the reports to those that are part of a topic document with the provided name (optional)
      offset - The pagination offset, the index of the first reports that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of reports that will be returned in this page of results (optional, default to 40)
      sortAsc - Sorts the document name in ascending order when true and descending when false (optional, default to true)
      Throws:
      ApiException - if fails to make API call
    • getNotifiableReportsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<NotifiableReportOutputListV1> getNotifiableReportsWithHeadersAndHttpInfo(List<String> ownerIds, String nameSearch, Integer offset, Integer limit, Boolean sortAsc, Map<String,String> customHeaders) throws ApiException
      Retrieves all reports that have notifications configured
      Parameters:
      ownerIds - (optional)
      nameSearch - Filter the reports to those that are part of a topic document with the provided name (optional)
      offset - The pagination offset, the index of the first reports that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of reports that will be returned in this page of results (optional, default to 40)
      sortAsc - Sorts the document name in ascending order when true and descending when false (optional, default to true)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getReactBlob

      public void getReactBlob(String id) throws ApiException
      Get the react json blob for a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      Throws:
      ApiException - if fails to make API call
    • getReactBlobWithHttpInfo

      public void getReactBlobWithHttpInfo(String id) throws ApiException
      Get the react json blob for a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      Throws:
      ApiException - if fails to make API call
    • getReactBlobWithHeadersAndHttpInfo

      public void getReactBlobWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get the react json blob for a piece of content
      Parameters:
      id - The Seeq ID for the content (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getSchedulableStatistics

      public SchedulableAdminListOutputV1 getSchedulableStatistics(List<String> types, Integer offset, Integer limit, String sortBy, Boolean sortAsc, Boolean isEnabled, String nameFilter, String ownerFilter, String scheduleFilter) throws ApiException
      Gets a collection of statistics for scheduled items
      Parameters:
      types - List of types to filter on (required)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      sortBy - A field by which to order the items'. Options: AverageRunTime, TotalRunTime, Name, Username, ContentCount, LastViewedAt, NextRunTime. Note: sorting by NextRunTime may be significantly slower than other options. (optional, default to AverageRunTime)
      sortAsc - If true or blank, sorts ascending. If false sorts descending. (optional, default to true)
      isEnabled - If true, includes only items with enabled schedules. If false, includes only items with disabled schedules. (optional, default to true)
      nameFilter - The topic/worksheet name to filter on. (optional)
      ownerFilter - The owner username to filter on. (optional)
      scheduleFilter - The schedule text to filter on. (optional)
      Returns:
      SchedulableAdminListOutputV1
      Throws:
      ApiException - if fails to make API call
    • getSchedulableStatisticsWithHttpInfo

      public ApiClient.ApiResponse<SchedulableAdminListOutputV1> getSchedulableStatisticsWithHttpInfo(List<String> types, Integer offset, Integer limit, String sortBy, Boolean sortAsc, Boolean isEnabled, String nameFilter, String ownerFilter, String scheduleFilter) throws ApiException
      Gets a collection of statistics for scheduled items
      Parameters:
      types - List of types to filter on (required)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      sortBy - A field by which to order the items'. Options: AverageRunTime, TotalRunTime, Name, Username, ContentCount, LastViewedAt, NextRunTime. Note: sorting by NextRunTime may be significantly slower than other options. (optional, default to AverageRunTime)
      sortAsc - If true or blank, sorts ascending. If false sorts descending. (optional, default to true)
      isEnabled - If true, includes only items with enabled schedules. If false, includes only items with disabled schedules. (optional, default to true)
      nameFilter - The topic/worksheet name to filter on. (optional)
      ownerFilter - The owner username to filter on. (optional)
      scheduleFilter - The schedule text to filter on. (optional)
      Throws:
      ApiException - if fails to make API call
    • getSchedulableStatisticsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<SchedulableAdminListOutputV1> getSchedulableStatisticsWithHeadersAndHttpInfo(List<String> types, Integer offset, Integer limit, String sortBy, Boolean sortAsc, Boolean isEnabled, String nameFilter, String ownerFilter, String scheduleFilter, Map<String,String> customHeaders) throws ApiException
      Gets a collection of statistics for scheduled items
      Parameters:
      types - List of types to filter on (required)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      sortBy - A field by which to order the items'. Options: AverageRunTime, TotalRunTime, Name, Username, ContentCount, LastViewedAt, NextRunTime. Note: sorting by NextRunTime may be significantly slower than other options. (optional, default to AverageRunTime)
      sortAsc - If true or blank, sorts ascending. If false sorts descending. (optional, default to true)
      isEnabled - If true, includes only items with enabled schedules. If false, includes only items with disabled schedules. (optional, default to true)
      nameFilter - The topic/worksheet name to filter on. (optional)
      ownerFilter - The owner username to filter on. (optional)
      scheduleFilter - The schedule text to filter on. (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getSchedulableSummary

      public SchedulableSummaryWeekOutputV1 getSchedulableSummary(String stat, String start, String ownerFilter) throws ApiException
      Gets a summary of statistics for scheduled items across a week, with each day being separated into 24 buckets
      Parameters:
      stat - The stat to summarize by (optional, default to AverageRunTime)
      start - The ISO Date string to start the summary from. The time must start at midnight on some day (required)
      ownerFilter - The owner username to filter on. (optional)
      Returns:
      SchedulableSummaryWeekOutputV1
      Throws:
      ApiException - if fails to make API call
    • getSchedulableSummaryWithHttpInfo

      public ApiClient.ApiResponse<SchedulableSummaryWeekOutputV1> getSchedulableSummaryWithHttpInfo(String stat, String start, String ownerFilter) throws ApiException
      Gets a summary of statistics for scheduled items across a week, with each day being separated into 24 buckets
      Parameters:
      stat - The stat to summarize by (optional, default to AverageRunTime)
      start - The ISO Date string to start the summary from. The time must start at midnight on some day (required)
      ownerFilter - The owner username to filter on. (optional)
      Throws:
      ApiException - if fails to make API call
    • getSchedulableSummaryWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<SchedulableSummaryWeekOutputV1> getSchedulableSummaryWithHeadersAndHttpInfo(String stat, String start, String ownerFilter, Map<String,String> customHeaders) throws ApiException
      Gets a summary of statistics for scheduled items across a week, with each day being separated into 24 buckets
      Parameters:
      stat - The stat to summarize by (optional, default to AverageRunTime)
      start - The ISO Date string to start the summary from. The time must start at midnight on some day (required)
      ownerFilter - The owner username to filter on. (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • previewContent

      public void previewContent(String worksheetId, String workstepId, Long height, Long width, Double scale, String timezone, String selector, String dateRangeId, String dateRangeFormula, String validityDuration, String reportId, String contentId, String summaryType, String summaryValue, String assetSelectionId, Boolean react) throws ApiException
      Preview an image for given content parameters
      Parameters:
      worksheetId - The content's source worksheet (required)
      workstepId - The content's source workstep (required)
      height - The content's desired height (required)
      width - The content's desired width (required)
      scale - The content's desired scale (optional, default to 1.0)
      timezone - The content's desired timezone (optional)
      selector - The content's desired selector (optional)
      dateRangeId - The content's date range; mutually exclusive with dateRangeFormula (optional)
      dateRangeFormula - Formula used as a temporary date range; mutually exclusive with dateRangeId (optional)
      validityDuration - A duration to use as the Expires header (optional)
      reportId - The content's report (optional)
      contentId - The content's ID (optional)
      summaryType - The content's desired summary type (optional)
      summaryValue - The content's desired summary value (optional)
      assetSelectionId - The content's asset selection id (optional)
      react - Whether the content is for a react component (optional)
      Throws:
      ApiException - if fails to make API call
    • previewContentWithHttpInfo

      public void previewContentWithHttpInfo(String worksheetId, String workstepId, Long height, Long width, Double scale, String timezone, String selector, String dateRangeId, String dateRangeFormula, String validityDuration, String reportId, String contentId, String summaryType, String summaryValue, String assetSelectionId, Boolean react) throws ApiException
      Preview an image for given content parameters
      Parameters:
      worksheetId - The content's source worksheet (required)
      workstepId - The content's source workstep (required)
      height - The content's desired height (required)
      width - The content's desired width (required)
      scale - The content's desired scale (optional, default to 1.0)
      timezone - The content's desired timezone (optional)
      selector - The content's desired selector (optional)
      dateRangeId - The content's date range; mutually exclusive with dateRangeFormula (optional)
      dateRangeFormula - Formula used as a temporary date range; mutually exclusive with dateRangeId (optional)
      validityDuration - A duration to use as the Expires header (optional)
      reportId - The content's report (optional)
      contentId - The content's ID (optional)
      summaryType - The content's desired summary type (optional)
      summaryValue - The content's desired summary value (optional)
      assetSelectionId - The content's asset selection id (optional)
      react - Whether the content is for a react component (optional)
      Throws:
      ApiException - if fails to make API call
    • previewContentWithHeadersAndHttpInfo

      public void previewContentWithHeadersAndHttpInfo(String worksheetId, String workstepId, Long height, Long width, Double scale, String timezone, String selector, String dateRangeId, String dateRangeFormula, String validityDuration, String reportId, String contentId, String summaryType, String summaryValue, String assetSelectionId, Boolean react, Map<String,String> customHeaders) throws ApiException
      Preview an image for given content parameters
      Parameters:
      worksheetId - The content's source worksheet (required)
      workstepId - The content's source workstep (required)
      height - The content's desired height (required)
      width - The content's desired width (required)
      scale - The content's desired scale (optional, default to 1.0)
      timezone - The content's desired timezone (optional)
      selector - The content's desired selector (optional)
      dateRangeId - The content's date range; mutually exclusive with dateRangeFormula (optional)
      dateRangeFormula - Formula used as a temporary date range; mutually exclusive with dateRangeId (optional)
      validityDuration - A duration to use as the Expires header (optional)
      reportId - The content's report (optional)
      contentId - The content's ID (optional)
      summaryType - The content's desired summary type (optional)
      summaryValue - The content's desired summary value (optional)
      assetSelectionId - The content's asset selection id (optional)
      react - Whether the content is for a react component (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • redirectToSourceWorksheet

      public void redirectToSourceWorksheet(String id, Boolean noRedirect) throws ApiException
      Redirect to the source worksheet for a given content image
      Parameters:
      id - The Seeq ID for the content (required)
      noRedirect - Set to true to receive the redirected URL as data rather than redirecting (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • redirectToSourceWorksheetWithHttpInfo

      public void redirectToSourceWorksheetWithHttpInfo(String id, Boolean noRedirect) throws ApiException
      Redirect to the source worksheet for a given content image
      Parameters:
      id - The Seeq ID for the content (required)
      noRedirect - Set to true to receive the redirected URL as data rather than redirecting (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • redirectToSourceWorksheetWithHeadersAndHttpInfo

      public void redirectToSourceWorksheetWithHeadersAndHttpInfo(String id, Boolean noRedirect, Map<String,String> customHeaders) throws ApiException
      Redirect to the source worksheet for a given content image
      Parameters:
      id - The Seeq ID for the content (required)
      noRedirect - Set to true to receive the redirected URL as data rather than redirecting (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateAssetSelection

      public AssetSelectionOutputV1 updateAssetSelection(String id, AssetSelectionInputV1 body) throws ApiException
      Update an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      body - (required)
      Returns:
      AssetSelectionOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateAssetSelectionWithHttpInfo

      public ApiClient.ApiResponse<AssetSelectionOutputV1> updateAssetSelectionWithHttpInfo(String id, AssetSelectionInputV1 body) throws ApiException
      Update an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • updateAssetSelectionWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AssetSelectionOutputV1> updateAssetSelectionWithHeadersAndHttpInfo(String id, AssetSelectionInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update an asset selection
      Parameters:
      id - The Seeq ID for the asset selection (required)
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateContent

      public ContentOutputV1 updateContent(String id, ContentInputV1 body, Boolean clearCache) throws ApiException
      Update a content item
      Parameters:
      id - The Seeq ID for the content (required)
      body - (required)
      clearCache - Whether the content's cache should be cleared. Useful to force regeneration of an image when content parameters have not changed (optional, default to false)
      Returns:
      ContentOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateContentWithHttpInfo

      public ApiClient.ApiResponse<ContentOutputV1> updateContentWithHttpInfo(String id, ContentInputV1 body, Boolean clearCache) throws ApiException
      Update a content item
      Parameters:
      id - The Seeq ID for the content (required)
      body - (required)
      clearCache - Whether the content's cache should be cleared. Useful to force regeneration of an image when content parameters have not changed (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • updateContentWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ContentOutputV1> updateContentWithHeadersAndHttpInfo(String id, ContentInputV1 body, Boolean clearCache, Map<String,String> customHeaders) throws ApiException
      Update a content item
      Parameters:
      id - The Seeq ID for the content (required)
      body - (required)
      clearCache - Whether the content's cache should be cleared. Useful to force regeneration of an image when content parameters have not changed (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateDateRange

      public DateRangeOutputV1 updateDateRange(String id, DateRangeInputV1 body) throws ApiException
      Update a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      body - (required)
      Returns:
      DateRangeOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateDateRangeWithHttpInfo

      public ApiClient.ApiResponse<DateRangeOutputV1> updateDateRangeWithHttpInfo(String id, DateRangeInputV1 body) throws ApiException
      Update a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • updateDateRangeWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DateRangeOutputV1> updateDateRangeWithHeadersAndHttpInfo(String id, DateRangeInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update a date range
      Parameters:
      id - The Seeq ID for the date range (required)
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call