Package com.seeq.api

Class WorkbooksApi

java.lang.Object
com.seeq.api.WorkbooksApi

public class WorkbooksApi extends Object
  • Constructor Details

    • WorkbooksApi

      public WorkbooksApi()
    • WorkbooksApi

      public WorkbooksApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • addRecentlyAccessed

      public ItemSearchPreviewListV1 addRecentlyAccessed(String workbookId, String itemId) throws ApiException
      Put the specified item at the top of the recently accessed list for the workbook
      Parameters:
      workbookId - ID of the workbook (required)
      itemId - Item to be added (required)
      Returns:
      ItemSearchPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • addRecentlyAccessedWithHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> addRecentlyAccessedWithHttpInfo(String workbookId, String itemId) throws ApiException
      Put the specified item at the top of the recently accessed list for the workbook
      Parameters:
      workbookId - ID of the workbook (required)
      itemId - Item to be added (required)
      Throws:
      ApiException - if fails to make API call
    • addRecentlyAccessedWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> addRecentlyAccessedWithHeadersAndHttpInfo(String workbookId, String itemId, Map<String,String> customHeaders) throws ApiException
      Put the specified item at the top of the recently accessed list for the workbook
      Parameters:
      workbookId - ID of the workbook (required)
      itemId - Item to be added (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • archiveWorkbook

      public ArchiveOutputV1 archiveWorkbook(String id) throws ApiException
      Archive a workbook by id
      Parameters:
      id - ID of the workbook to archive (required)
      Returns:
      ArchiveOutputV1
      Throws:
      ApiException - if fails to make API call
    • archiveWorkbookWithHttpInfo

      public ApiClient.ApiResponse<ArchiveOutputV1> archiveWorkbookWithHttpInfo(String id) throws ApiException
      Archive a workbook by id
      Parameters:
      id - ID of the workbook to archive (required)
      Throws:
      ApiException - if fails to make API call
    • archiveWorkbookWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ArchiveOutputV1> archiveWorkbookWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Archive a workbook by id
      Parameters:
      id - ID of the workbook to archive (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • archiveWorksheet

      public ArchiveOutputV1 archiveWorksheet(String workbookId, String worksheetId) throws ApiException
      Archive a worksheet
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet to archive (required)
      Returns:
      ArchiveOutputV1
      Throws:
      ApiException - if fails to make API call
    • archiveWorksheetWithHttpInfo

      public ApiClient.ApiResponse<ArchiveOutputV1> archiveWorksheetWithHttpInfo(String workbookId, String worksheetId) throws ApiException
      Archive a worksheet
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet to archive (required)
      Throws:
      ApiException - if fails to make API call
    • archiveWorksheetWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ArchiveOutputV1> archiveWorksheetWithHeadersAndHttpInfo(String workbookId, String worksheetId, Map<String,String> customHeaders) throws ApiException
      Archive a worksheet
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet to archive (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createWorkbook

      public WorkbookOutputV1 createWorkbook(WorkbookInputV1 body) throws ApiException
      Create a workbook
      Parameters:
      body - Workbook information (required)
      Returns:
      WorkbookOutputV1
      Throws:
      ApiException - if fails to make API call
    • createWorkbookWithHttpInfo

      public ApiClient.ApiResponse<WorkbookOutputV1> createWorkbookWithHttpInfo(WorkbookInputV1 body) throws ApiException
      Create a workbook
      Parameters:
      body - Workbook information (required)
      Throws:
      ApiException - if fails to make API call
    • createWorkbookWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorkbookOutputV1> createWorkbookWithHeadersAndHttpInfo(WorkbookInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a workbook
      Parameters:
      body - Workbook information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createWorksheet

      public WorksheetOutputV1 createWorksheet(String workbookId, WorksheetInputV1 body) throws ApiException
      Create a worksheet
      Parameters:
      workbookId - ID of the workbook on which to create the worksheet (required)
      body - Worksheet information (required)
      Returns:
      WorksheetOutputV1
      Throws:
      ApiException - if fails to make API call
    • createWorksheetWithHttpInfo

      public ApiClient.ApiResponse<WorksheetOutputV1> createWorksheetWithHttpInfo(String workbookId, WorksheetInputV1 body) throws ApiException
      Create a worksheet
      Parameters:
      workbookId - ID of the workbook on which to create the worksheet (required)
      body - Worksheet information (required)
      Throws:
      ApiException - if fails to make API call
    • createWorksheetWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorksheetOutputV1> createWorksheetWithHeadersAndHttpInfo(String workbookId, WorksheetInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a worksheet
      Parameters:
      workbookId - ID of the workbook on which to create the worksheet (required)
      body - Worksheet information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createWorkstep

      public WorkstepOutputV1 createWorkstep(String workbookId, String worksheetId, WorkstepInputV1 body, Boolean noWorkstepMessage) throws ApiException
      Append a new workstep to the worksheet
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which to append the new workstep (required)
      body - Workstep information (required)
      noWorkstepMessage - Option to not send a workstep message notifying clients that the current workstep of the worksheet has been updated. Should only be used when multiple worksteps are being pushed in quick succession and a subsequent call will be made to set the current workstep. (optional, default to false)
      Returns:
      WorkstepOutputV1
      Throws:
      ApiException - if fails to make API call
    • createWorkstepWithHttpInfo

      public ApiClient.ApiResponse<WorkstepOutputV1> createWorkstepWithHttpInfo(String workbookId, String worksheetId, WorkstepInputV1 body, Boolean noWorkstepMessage) throws ApiException
      Append a new workstep to the worksheet
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which to append the new workstep (required)
      body - Workstep information (required)
      noWorkstepMessage - Option to not send a workstep message notifying clients that the current workstep of the worksheet has been updated. Should only be used when multiple worksteps are being pushed in quick succession and a subsequent call will be made to set the current workstep. (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • createWorkstepWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorkstepOutputV1> createWorkstepWithHeadersAndHttpInfo(String workbookId, String worksheetId, WorkstepInputV1 body, Boolean noWorkstepMessage, Map<String,String> customHeaders) throws ApiException
      Append a new workstep to the worksheet
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which to append the new workstep (required)
      body - Workstep information (required)
      noWorkstepMessage - Option to not send a workstep message notifying clients that the current workstep of the worksheet has been updated. Should only be used when multiple worksteps are being pushed in quick succession and a subsequent call will be made to set the current workstep. (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getRecentlyAccessed

      public ItemSearchPreviewListV1 getRecentlyAccessed(String workbookId) throws ApiException
      Get the recently accessed list for the workbook
      Parameters:
      workbookId - ID of the workbook (required)
      Returns:
      ItemSearchPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • getRecentlyAccessedWithHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> getRecentlyAccessedWithHttpInfo(String workbookId) throws ApiException
      Get the recently accessed list for the workbook
      Parameters:
      workbookId - ID of the workbook (required)
      Throws:
      ApiException - if fails to make API call
    • getRecentlyAccessedWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> getRecentlyAccessedWithHeadersAndHttpInfo(String workbookId, Map<String,String> customHeaders) throws ApiException
      Get the recently accessed list for the workbook
      Parameters:
      workbookId - ID of the workbook (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getReferencedItems

      public ReferencedItemsOutputV1 getReferencedItems(String worksheetId, String workstepId) throws ApiException
      Get items referenced by workstep or a journal
      Parameters:
      worksheetId - ID of the worksheet associated with journal that references items to return (required)
      workstepId - ID of the workstep that references items to return (required)
      Returns:
      ReferencedItemsOutputV1
      Throws:
      ApiException - if fails to make API call
    • getReferencedItemsWithHttpInfo

      public ApiClient.ApiResponse<ReferencedItemsOutputV1> getReferencedItemsWithHttpInfo(String worksheetId, String workstepId) throws ApiException
      Get items referenced by workstep or a journal
      Parameters:
      worksheetId - ID of the worksheet associated with journal that references items to return (required)
      workstepId - ID of the workstep that references items to return (required)
      Throws:
      ApiException - if fails to make API call
    • getReferencedItemsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ReferencedItemsOutputV1> getReferencedItemsWithHeadersAndHttpInfo(String worksheetId, String workstepId, Map<String,String> customHeaders) throws ApiException
      Get items referenced by workstep or a journal
      Parameters:
      worksheetId - ID of the worksheet associated with journal that references items to return (required)
      workstepId - ID of the workstep that references items to return (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getWorkbook

      public WorkbookOutputV1 getWorkbook(String id) throws ApiException
      Get a workbook
      Parameters:
      id - ID of the workbook to retrieve (required)
      Returns:
      WorkbookOutputV1
      Throws:
      ApiException - if fails to make API call
    • getWorkbookWithHttpInfo

      public ApiClient.ApiResponse<WorkbookOutputV1> getWorkbookWithHttpInfo(String id) throws ApiException
      Get a workbook
      Parameters:
      id - ID of the workbook to retrieve (required)
      Throws:
      ApiException - if fails to make API call
    • getWorkbookWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorkbookOutputV1> getWorkbookWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get a workbook
      Parameters:
      id - ID of the workbook to retrieve (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getWorkbooks

      public WorkbookOutputListV1 getWorkbooks(String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit) throws ApiException
      Get a collection of workbooks
      Parameters:
      userId - The user ID to return workbooks for, defaults to the current user if not specified. Only an admin user is allowed to specify a user ID. (optional)
      isArchived - True to filter results to only workbooks that have been archived, false to filter results to workbooks that are not archived. (optional, default to false)
      sortOrder - A field by which to order the workbooks followed by a space and 'asc' or 'desc'. Field name can be one of: createdAt, updatedAt, name (optional, default to createdAt asc)
      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)
      Returns:
      WorkbookOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getWorkbooksWithHttpInfo

      public ApiClient.ApiResponse<WorkbookOutputListV1> getWorkbooksWithHttpInfo(String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit) throws ApiException
      Get a collection of workbooks
      Parameters:
      userId - The user ID to return workbooks for, defaults to the current user if not specified. Only an admin user is allowed to specify a user ID. (optional)
      isArchived - True to filter results to only workbooks that have been archived, false to filter results to workbooks that are not archived. (optional, default to false)
      sortOrder - A field by which to order the workbooks followed by a space and 'asc' or 'desc'. Field name can be one of: createdAt, updatedAt, name (optional, default to createdAt asc)
      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)
      Throws:
      ApiException - if fails to make API call
    • getWorkbooksWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorkbookOutputListV1> getWorkbooksWithHeadersAndHttpInfo(String userId, Boolean isArchived, String sortOrder, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a collection of workbooks
      Parameters:
      userId - The user ID to return workbooks for, defaults to the current user if not specified. Only an admin user is allowed to specify a user ID. (optional)
      isArchived - True to filter results to only workbooks that have been archived, false to filter results to workbooks that are not archived. (optional, default to false)
      sortOrder - A field by which to order the workbooks followed by a space and 'asc' or 'desc'. Field name can be one of: createdAt, updatedAt, name (optional, default to createdAt asc)
      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)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getWorksheet

      public WorksheetOutputV1 getWorksheet(String workbookId, String worksheetId) throws ApiException
      Get a worksheet
      Parameters:
      workbookId - ID of the workbook for which to retrieve the worksheets (required)
      worksheetId - ID of the worksheet to retrieve (required)
      Returns:
      WorksheetOutputV1
      Throws:
      ApiException - if fails to make API call
    • getWorksheetWithHttpInfo

      public ApiClient.ApiResponse<WorksheetOutputV1> getWorksheetWithHttpInfo(String workbookId, String worksheetId) throws ApiException
      Get a worksheet
      Parameters:
      workbookId - ID of the workbook for which to retrieve the worksheets (required)
      worksheetId - ID of the worksheet to retrieve (required)
      Throws:
      ApiException - if fails to make API call
    • getWorksheetWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorksheetOutputV1> getWorksheetWithHeadersAndHttpInfo(String workbookId, String worksheetId, Map<String,String> customHeaders) throws ApiException
      Get a worksheet
      Parameters:
      workbookId - ID of the workbook for which to retrieve the worksheets (required)
      worksheetId - ID of the worksheet to retrieve (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getWorksheetUsages

      public AnnotationListOutputV1 getWorksheetUsages(String workbookId, String worksheetId, Integer offset, Integer limit) throws ApiException
      Get a list of reports that reference a given worksheet
      Parameters:
      workbookId - The ID of the workbook for containing the worksheet (required)
      worksheetId - The ID of the worksheet (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)
      Returns:
      AnnotationListOutputV1
      Throws:
      ApiException - if fails to make API call
    • getWorksheetUsagesWithHttpInfo

      public ApiClient.ApiResponse<AnnotationListOutputV1> getWorksheetUsagesWithHttpInfo(String workbookId, String worksheetId, Integer offset, Integer limit) throws ApiException
      Get a list of reports that reference a given worksheet
      Parameters:
      workbookId - The ID of the workbook for containing the worksheet (required)
      worksheetId - The ID of the worksheet (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)
      Throws:
      ApiException - if fails to make API call
    • getWorksheetUsagesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AnnotationListOutputV1> getWorksheetUsagesWithHeadersAndHttpInfo(String workbookId, String worksheetId, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a list of reports that reference a given worksheet
      Parameters:
      workbookId - The ID of the workbook for containing the worksheet (required)
      worksheetId - The ID of the worksheet (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)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getWorksheets

      public WorksheetOutputListV1 getWorksheets(String workbookId, Integer offset, Integer limit, Boolean isArchived) throws ApiException
      Get a collection of worksheets
      Parameters:
      workbookId - The ID of the workbook for which to retrieve the worksheets (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)
      isArchived - Whether to return archived worksheets (optional, default to false)
      Returns:
      WorksheetOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getWorksheetsWithHttpInfo

      public ApiClient.ApiResponse<WorksheetOutputListV1> getWorksheetsWithHttpInfo(String workbookId, Integer offset, Integer limit, Boolean isArchived) throws ApiException
      Get a collection of worksheets
      Parameters:
      workbookId - The ID of the workbook for which to retrieve the worksheets (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)
      isArchived - Whether to return archived worksheets (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • getWorksheetsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorksheetOutputListV1> getWorksheetsWithHeadersAndHttpInfo(String workbookId, Integer offset, Integer limit, Boolean isArchived, Map<String,String> customHeaders) throws ApiException
      Get a collection of worksheets
      Parameters:
      workbookId - The ID of the workbook for which to retrieve the worksheets (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)
      isArchived - Whether to return archived worksheets (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getWorkstep

      public WorkstepOutputV1 getWorkstep(String workbookId, String worksheetId, String workstepId) throws ApiException
      Get a workstep
      Parameters:
      workbookId - ID of the workbook for which to retrieve the worksteps (required)
      worksheetId - ID of the worksheet for which to retrieve the worksteps (required)
      workstepId - ID of the workstep to retrieve (required)
      Returns:
      WorkstepOutputV1
      Throws:
      ApiException - if fails to make API call
    • getWorkstepWithHttpInfo

      public ApiClient.ApiResponse<WorkstepOutputV1> getWorkstepWithHttpInfo(String workbookId, String worksheetId, String workstepId) throws ApiException
      Get a workstep
      Parameters:
      workbookId - ID of the workbook for which to retrieve the worksteps (required)
      worksheetId - ID of the worksheet for which to retrieve the worksteps (required)
      workstepId - ID of the workstep to retrieve (required)
      Throws:
      ApiException - if fails to make API call
    • getWorkstepWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorkstepOutputV1> getWorkstepWithHeadersAndHttpInfo(String workbookId, String worksheetId, String workstepId, Map<String,String> customHeaders) throws ApiException
      Get a workstep
      Parameters:
      workbookId - ID of the workbook for which to retrieve the worksteps (required)
      worksheetId - ID of the worksheet for which to retrieve the worksteps (required)
      workstepId - ID of the workstep to retrieve (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • moveWorksheet

      public WorksheetOutputV1 moveWorksheet(String workbookId, String worksheetId, String nextWorksheetId) throws ApiException
      Move a Worksheet to a new location in the same Workbook
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which the workstep exists (required)
      nextWorksheetId - ID of the worksheet that the specified worksheet should precede. If not supplied then the worksheet will be moved to be the last worksheet in the workbook. (optional)
      Returns:
      WorksheetOutputV1
      Throws:
      ApiException - if fails to make API call
    • moveWorksheetWithHttpInfo

      public ApiClient.ApiResponse<WorksheetOutputV1> moveWorksheetWithHttpInfo(String workbookId, String worksheetId, String nextWorksheetId) throws ApiException
      Move a Worksheet to a new location in the same Workbook
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which the workstep exists (required)
      nextWorksheetId - ID of the worksheet that the specified worksheet should precede. If not supplied then the worksheet will be moved to be the last worksheet in the workbook. (optional)
      Throws:
      ApiException - if fails to make API call
    • moveWorksheetWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorksheetOutputV1> moveWorksheetWithHeadersAndHttpInfo(String workbookId, String worksheetId, String nextWorksheetId, Map<String,String> customHeaders) throws ApiException
      Move a Worksheet to a new location in the same Workbook
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which the workstep exists (required)
      nextWorksheetId - ID of the worksheet that the specified worksheet should precede. If not supplied then the worksheet will be moved to be the last worksheet in the workbook. (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setCurrentWorkstep

      public WorkstepOutputV1 setCurrentWorkstep(String workbookId, String worksheetId, String workstepId) throws ApiException
      Set the current workstep
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which the workstep exists (required)
      workstepId - ID of the workstep to set as the current one (required)
      Returns:
      WorkstepOutputV1
      Throws:
      ApiException - if fails to make API call
    • setCurrentWorkstepWithHttpInfo

      public ApiClient.ApiResponse<WorkstepOutputV1> setCurrentWorkstepWithHttpInfo(String workbookId, String worksheetId, String workstepId) throws ApiException
      Set the current workstep
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which the workstep exists (required)
      workstepId - ID of the workstep to set as the current one (required)
      Throws:
      ApiException - if fails to make API call
    • setCurrentWorkstepWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<WorkstepOutputV1> setCurrentWorkstepWithHeadersAndHttpInfo(String workbookId, String worksheetId, String workstepId, Map<String,String> customHeaders) throws ApiException
      Set the current workstep
      Parameters:
      workbookId - ID of the workbook on which the worksheet exists (required)
      worksheetId - ID of the worksheet on which the workstep exists (required)
      workstepId - ID of the workstep to set as the current one (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setRenderer

      public StatusMessageBase setRenderer(UUID id, UUID userId) throws ApiException
      Set the topic's renderer.
      Parameters:
      id - ID of the topic to change the renderer of (required)
      userId - The user to make the topic's renderer (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • setRendererWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> setRendererWithHttpInfo(UUID id, UUID userId) throws ApiException
      Set the topic's renderer.
      Parameters:
      id - ID of the topic to change the renderer of (required)
      userId - The user to make the topic's renderer (required)
      Throws:
      ApiException - if fails to make API call
    • setRendererWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> setRendererWithHeadersAndHttpInfo(UUID id, UUID userId, Map<String,String> customHeaders) throws ApiException
      Set the topic's renderer.
      Parameters:
      id - ID of the topic to change the renderer of (required)
      userId - The user to make the topic's renderer (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call