Package com.seeq.api
Class ContentApi
java.lang.Object
com.seeq.api.ContentApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionArchive an asset selectionarchiveAssetSelectionWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive an asset selectionArchive an asset selectionarchiveContent
(String id) Archive a content itemarchiveContentWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a content itemArchive a content itemArchive a date rangearchiveDateRangeWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a date rangeArchive a date rangevoid
Clear the cached images for a piece of contentvoid
clearImageCacheWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Clear the cached images for a piece of contentvoid
Clear the cached images for a piece of contentCreate new asset selectioncreateAssetSelectionWithHeadersAndHttpInfo
(AssetSelectionInputV1 body, Map<String, String> customHeaders) Create new asset selectionCreate new asset selectioncreateContent
(ContentInputV1 body) Create a new content itemcreateContentWithHeadersAndHttpInfo
(ContentInputV1 body, Map<String, String> customHeaders) Create a new content itemCreate a new content itemCreate a new date rangecreateDateRangeWithHeadersAndHttpInfo
(DateRangeInputV1 body, Map<String, String> customHeaders) Create a new date rangeCreate a new date rangeGet an asset selectiongetAssetSelectionWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get an asset selectionGet an asset selectiongetContent
(String id) Get a content itemgetContentItems
(Integer offset, Integer limit) Get content itemsgetContentItemsForDateRange
(String id, Integer offset, Integer limit) Get the content items that depend on a given date rangegetContentItemsForDateRangeWithHeadersAndHttpInfo
(String id, Integer offset, Integer limit, Map<String, String> customHeaders) Get the content items that depend on a given date rangegetContentItemsForDateRangeWithHttpInfo
(String id, Integer offset, Integer limit) Get the content items that depend on a given date rangegetContentItemsWithHeadersAndHttpInfo
(Integer offset, Integer limit, Map<String, String> customHeaders) Get content itemsgetContentItemsWithHttpInfo
(Integer offset, Integer limit) Get content itemsgetContentsWithAllMetadata
(String reportId) Retrieves all pieces of content and date ranges associated with the given report with extra metadata attachedgetContentsWithAllMetadataWithHeadersAndHttpInfo
(String reportId, Map<String, String> customHeaders) Retrieves all pieces of content and date ranges associated with the given report with extra metadata attachedgetContentsWithAllMetadataWithHttpInfo
(String reportId) Retrieves all pieces of content and date ranges associated with the given report with extra metadata attachedgetContentWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a content itemGet a content itemgetDateRange
(String id) Get a date rangegetDateRanges
(Integer offset, Integer limit) Get date range itemsgetDateRangesWithHeadersAndHttpInfo
(Integer offset, Integer limit, Map<String, String> customHeaders) Get date range itemsgetDateRangesWithHttpInfo
(Integer offset, Integer limit) Get date range itemsgetDateRangeWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a date rangeGet a date rangevoid
Get the image from a piece of contentvoid
Get the image from a piece of contentvoid
getImageWithHttpInfo
(String id, Boolean useAsync) Get the image from a piece of contentgetNotifiableReports
(List<String> ownerIds, String nameSearch, Integer offset, Integer limit, Boolean sortAsc) Retrieves all reports that have notifications configuredgetNotifiableReportsWithHeadersAndHttpInfo
(List<String> ownerIds, String nameSearch, Integer offset, Integer limit, Boolean sortAsc, Map<String, String> customHeaders) Retrieves all reports that have notifications configuredgetNotifiableReportsWithHttpInfo
(List<String> ownerIds, String nameSearch, Integer offset, Integer limit, Boolean sortAsc) Retrieves all reports that have notifications configuredvoid
getReactBlob
(String id) Get the react json blob for a piece of contentvoid
getReactBlobWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get the react json blob for a piece of contentvoid
Get the react json blob for a piece of contentlong
getSchedulableStatistics
(List<String> types, Integer offset, Integer limit, String sortBy, Boolean sortAsc, Boolean isEnabled, String nameFilter, String ownerFilter, String scheduleFilter) Gets a collection of statistics for scheduled itemsgetSchedulableStatisticsWithHeadersAndHttpInfo
(List<String> types, Integer offset, Integer limit, String sortBy, Boolean sortAsc, Boolean isEnabled, String nameFilter, String ownerFilter, String scheduleFilter, Map<String, String> customHeaders) Gets a collection of statistics for scheduled itemsgetSchedulableStatisticsWithHttpInfo
(List<String> types, Integer offset, Integer limit, String sortBy, Boolean sortAsc, Boolean isEnabled, String nameFilter, String ownerFilter, String scheduleFilter) Gets a collection of statistics for scheduled itemsgetSchedulableSummary
(String stat, String start, String ownerFilter) Gets a summary of statistics for scheduled items across a week, with each day being separated into 24 bucketsgetSchedulableSummaryWithHeadersAndHttpInfo
(String stat, String start, String ownerFilter, Map<String, String> customHeaders) Gets a summary of statistics for scheduled items across a week, with each day being separated into 24 bucketsgetSchedulableSummaryWithHttpInfo
(String stat, String start, String ownerFilter) Gets a summary of statistics for scheduled items across a week, with each day being separated into 24 bucketsvoid
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) Preview an image for given content parametersvoid
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) Preview an image for given content parametersvoid
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) Preview an image for given content parametersvoid
redirectToSourceWorksheet
(String id, Boolean noRedirect) Redirect to the source worksheet for a given content imagevoid
redirectToSourceWorksheetWithHeadersAndHttpInfo
(String id, Boolean noRedirect, Map<String, String> customHeaders) Redirect to the source worksheet for a given content imagevoid
redirectToSourceWorksheetWithHttpInfo
(String id, Boolean noRedirect) Redirect to the source worksheet for a given content imagevoid
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) updateAssetSelection
(String id, AssetSelectionInputV1 body) Update an asset selectionupdateAssetSelectionWithHeadersAndHttpInfo
(String id, AssetSelectionInputV1 body, Map<String, String> customHeaders) Update an asset selectionUpdate an asset selectionupdateContent
(String id, ContentInputV1 body, Boolean clearCache) Update a content itemupdateContentWithHeadersAndHttpInfo
(String id, ContentInputV1 body, Boolean clearCache, Map<String, String> customHeaders) Update a content itemupdateContentWithHttpInfo
(String id, ContentInputV1 body, Boolean clearCache) Update a content itemupdateDateRange
(String id, DateRangeInputV1 body) Update a date rangeupdateDateRangeWithHeadersAndHttpInfo
(String id, DateRangeInputV1 body, Map<String, String> customHeaders) Update a date rangeUpdate a date range
-
Constructor Details
-
ContentApi
public ContentApi() -
ContentApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
archiveAssetSelection
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 ApiExceptionArchive 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
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 ApiExceptionArchive 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
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 ApiExceptionArchive 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
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
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 ApiExceptionClear 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
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 ApiExceptionCreate 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
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 ApiExceptionCreate 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
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 ApiExceptionCreate 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
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 ApiExceptionGet 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
Get a content item- Parameters:
id
- The Seeq ID for the content (required)- Returns:
- ContentOutputV1
- Throws:
ApiException
- if fails to make API call
-
getContentWithHttpInfo
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 ApiExceptionGet 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
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 ApiExceptionGet 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 ApiExceptionGet 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 ApiExceptionRetrieves 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
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 ApiExceptionGet 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
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 ApiExceptionGet 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
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
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 ApiExceptionGet 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 ApiExceptionRetrieves 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
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
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 ApiExceptionGet 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 ApiExceptionGets 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 ApiExceptionGets 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 ApiExceptionPreview 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
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 ApiExceptionRedirect 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 ApiExceptionUpdate 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 ApiExceptionUpdate 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
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 ApiExceptionUpdate 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
-