Package com.seeq.api

Class ItemsApi

java.lang.Object
com.seeq.api.ItemsApi

public class ItemsApi extends Object
  • Constructor Details

    • ItemsApi

      public ItemsApi()
    • ItemsApi

      public ItemsApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • addAccessControlEntry

      public AclOutputV1 addAccessControlEntry(String id, AceInputV1 body) throws ApiException
      Add an access control entry to an item
      Parameters:
      id - ID of the item to add access control entry to (required)
      body - The access control entry to add to the item (required)
      Returns:
      AclOutputV1
      Throws:
      ApiException - if fails to make API call
    • addAccessControlEntryWithHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> addAccessControlEntryWithHttpInfo(String id, AceInputV1 body) throws ApiException
      Add an access control entry to an item
      Parameters:
      id - ID of the item to add access control entry to (required)
      body - The access control entry to add to the item (required)
      Throws:
      ApiException - if fails to make API call
    • addAccessControlEntryWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> addAccessControlEntryWithHeadersAndHttpInfo(String id, AceInputV1 body, Map<String,String> customHeaders) throws ApiException
      Add an access control entry to an item
      Parameters:
      id - ID of the item to add access control entry to (required)
      body - The access control entry to add to the item (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • archiveItem

      public StatusMessageBase archiveItem(String id, Boolean delete, String archivedReason, String note) throws ApiException
      Archive or delete an item
      Parameters:
      id - ID of the item for which to retrieve properties (required)
      delete - Permanently and irretrievably delete the item (optional, default to false)
      archivedReason - The reason for archiving the item. Can be one of OBSOLETE_SQLV1, BY_USER, DATASOURCE_CLEANUP, BY_MIGRATION, BY_PARENT_ITEM, BY_AUTO_ARCHIVE, BY_SANDBOX_MODE, or NONE (optional, default to BY_USER)
      note - An optional note for why the item was archived (optional)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • archiveItemWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveItemWithHttpInfo(String id, Boolean delete, String archivedReason, String note) throws ApiException
      Archive or delete an item
      Parameters:
      id - ID of the item for which to retrieve properties (required)
      delete - Permanently and irretrievably delete the item (optional, default to false)
      archivedReason - The reason for archiving the item. Can be one of OBSOLETE_SQLV1, BY_USER, DATASOURCE_CLEANUP, BY_MIGRATION, BY_PARENT_ITEM, BY_AUTO_ARCHIVE, BY_SANDBOX_MODE, or NONE (optional, default to BY_USER)
      note - An optional note for why the item was archived (optional)
      Throws:
      ApiException - if fails to make API call
    • archiveItemWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> archiveItemWithHeadersAndHttpInfo(String id, Boolean delete, String archivedReason, String note, Map<String,String> customHeaders) throws ApiException
      Archive or delete an item
      Parameters:
      id - ID of the item for which to retrieve properties (required)
      delete - Permanently and irretrievably delete the item (optional, default to false)
      archivedReason - The reason for archiving the item. Can be one of OBSOLETE_SQLV1, BY_USER, DATASOURCE_CLEANUP, BY_MIGRATION, BY_PARENT_ITEM, BY_AUTO_ARCHIVE, BY_SANDBOX_MODE, or NONE (optional, default to BY_USER)
      note - An optional note for why the item was archived (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • archiveItemFinder

      public void archiveItemFinder(String id) throws ApiException
      Archive an item finder
      Parameters:
      id - ID of the item finder to archive. (required)
      Throws:
      ApiException - if fails to make API call
    • archiveItemFinderWithHttpInfo

      public void archiveItemFinderWithHttpInfo(String id) throws ApiException
      Archive an item finder
      Parameters:
      id - ID of the item finder to archive. (required)
      Throws:
      ApiException - if fails to make API call
    • archiveItemFinderWithHeadersAndHttpInfo

      public void archiveItemFinderWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Archive an item finder
      Parameters:
      id - ID of the item finder to archive. (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • changeOwner

      public StatusMessageBase changeOwner(String itemId, String newOwnerId) throws ApiException
      Change the owner of the specified item to the specified user. You need to be an administrator to be able to change the owner.
      Parameters:
      itemId - ID of the item to change owner for (required)
      newOwnerId - ID of the user to become the new owner (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • changeOwnerWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> changeOwnerWithHttpInfo(String itemId, String newOwnerId) throws ApiException
      Change the owner of the specified item to the specified user. You need to be an administrator to be able to change the owner.
      Parameters:
      itemId - ID of the item to change owner for (required)
      newOwnerId - ID of the user to become the new owner (required)
      Throws:
      ApiException - if fails to make API call
    • changeOwnerWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> changeOwnerWithHeadersAndHttpInfo(String itemId, String newOwnerId, Map<String,String> customHeaders) throws ApiException
      Change the owner of the specified item to the specified user. You need to be an administrator to be able to change the owner.
      Parameters:
      itemId - ID of the item to change owner for (required)
      newOwnerId - ID of the user to become the new owner (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • clearCache

      public CacheInfoV1 clearCache(String id, Boolean clearDependents) throws ApiException
      Clear the cache for an item.
      Parameters:
      id - ID of the item on which to clear cache (required)
      clearDependents - Whether dependent caches should be cleared. Should always be true if a cache is in error, but false may be valuable when merely trying to recover disk space. (optional, default to true)
      Returns:
      CacheInfoV1
      Throws:
      ApiException - if fails to make API call
    • clearCacheWithHttpInfo

      public ApiClient.ApiResponse<CacheInfoV1> clearCacheWithHttpInfo(String id, Boolean clearDependents) throws ApiException
      Clear the cache for an item.
      Parameters:
      id - ID of the item on which to clear cache (required)
      clearDependents - Whether dependent caches should be cleared. Should always be true if a cache is in error, but false may be valuable when merely trying to recover disk space. (optional, default to true)
      Throws:
      ApiException - if fails to make API call
    • clearCacheWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<CacheInfoV1> clearCacheWithHeadersAndHttpInfo(String id, Boolean clearDependents, Map<String,String> customHeaders) throws ApiException
      Clear the cache for an item.
      Parameters:
      id - ID of the item on which to clear cache (required)
      clearDependents - Whether dependent caches should be cleared. Should always be true if a cache is in error, but false may be valuable when merely trying to recover disk space. (optional, default to true)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createItemFinder

      public ItemFinderOutputV1 createItemFinder(ItemFinderInputV1 body) throws ApiException
      Create a new item finder
      Parameters:
      body - (required)
      Returns:
      ItemFinderOutputV1
      Throws:
      ApiException - if fails to make API call
    • createItemFinderWithHttpInfo

      public ApiClient.ApiResponse<ItemFinderOutputV1> createItemFinderWithHttpInfo(ItemFinderInputV1 body) throws ApiException
      Create a new item finder
      Parameters:
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • createItemFinderWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemFinderOutputV1> createItemFinderWithHeadersAndHttpInfo(ItemFinderInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a new item finder
      Parameters:
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • deleteProperty

      public StatusMessageBase deleteProperty(String id, String propertyName) throws ApiException
      Delete a property
      Parameters:
      id - ID of the item whose property is being deleted (required)
      propertyName - Name of the property to delete (required)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • deletePropertyWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> deletePropertyWithHttpInfo(String id, String propertyName) throws ApiException
      Delete a property
      Parameters:
      id - ID of the item whose property is being deleted (required)
      propertyName - Name of the property to delete (required)
      Throws:
      ApiException - if fails to make API call
    • deletePropertyWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> deletePropertyWithHeadersAndHttpInfo(String id, String propertyName, Map<String,String> customHeaders) throws ApiException
      Delete a property
      Parameters:
      id - ID of the item whose property is being deleted (required)
      propertyName - Name of the property to delete (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • findSwap

      public ItemPreviewV1 findSwap(String id, List<SwapInputV1> body) throws ApiException
      Create, or find, a variant of the item that is based on the specified asset. For example, given the ID for Temperature in Area A, find its equivalent for Area B. Or, for a formula that uses Area A Temperature as an input, create a variant that that is based off Area B.
      Parameters:
      id - ID of the item that is being updated (required)
      body - Asset swap information (required)
      Returns:
      ItemPreviewV1
      Throws:
      ApiException - if fails to make API call
    • findSwapWithHttpInfo

      public ApiClient.ApiResponse<ItemPreviewV1> findSwapWithHttpInfo(String id, List<SwapInputV1> body) throws ApiException
      Create, or find, a variant of the item that is based on the specified asset. For example, given the ID for Temperature in Area A, find its equivalent for Area B. Or, for a formula that uses Area A Temperature as an input, create a variant that that is based off Area B.
      Parameters:
      id - ID of the item that is being updated (required)
      body - Asset swap information (required)
      Throws:
      ApiException - if fails to make API call
    • findSwapWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemPreviewV1> findSwapWithHeadersAndHttpInfo(String id, List<SwapInputV1> body, Map<String,String> customHeaders) throws ApiException
      Create, or find, a variant of the item that is based on the specified asset. For example, given the ID for Temperature in Area A, find its equivalent for Area B. Or, for a formula that uses Area A Temperature as an input, create a variant that that is based off Area B.
      Parameters:
      id - ID of the item that is being updated (required)
      body - Asset swap information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getAccessControl

      public AclOutputV1 getAccessControl(String id) throws ApiException
      Get the current access control list for an item
      Parameters:
      id - ID of the item to get access control list for (required)
      Returns:
      AclOutputV1
      Throws:
      ApiException - if fails to make API call
    • getAccessControlWithHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> getAccessControlWithHttpInfo(String id) throws ApiException
      Get the current access control list for an item
      Parameters:
      id - ID of the item to get access control list for (required)
      Throws:
      ApiException - if fails to make API call
    • getAccessControlWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> getAccessControlWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get the current access control list for an item
      Parameters:
      id - ID of the item to get access control list for (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getAccessControlDetails

      public AclOutputV1 getAccessControlDetails(String id, Boolean forceAclInheritance) throws ApiException
      Get the current access control list for an item with details of inherited entries
      Parameters:
      id - ID of the item to get access control list for (required)
      forceAclInheritance - Show the ACL details as if access control inheritance would be enabled for the item (optional, default to false)
      Returns:
      AclOutputV1
      Throws:
      ApiException - if fails to make API call
    • getAccessControlDetailsWithHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> getAccessControlDetailsWithHttpInfo(String id, Boolean forceAclInheritance) throws ApiException
      Get the current access control list for an item with details of inherited entries
      Parameters:
      id - ID of the item to get access control list for (required)
      forceAclInheritance - Show the ACL details as if access control inheritance would be enabled for the item (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • getAccessControlDetailsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> getAccessControlDetailsWithHeadersAndHttpInfo(String id, Boolean forceAclInheritance, Map<String,String> customHeaders) throws ApiException
      Get the current access control list for an item with details of inherited entries
      Parameters:
      id - ID of the item to get access control list for (required)
      forceAclInheritance - Show the ACL details as if access control inheritance would be enabled for the item (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getFormulaDependencies

      public ItemDependencyOutputV1 getFormulaDependencies(String id) throws ApiException
      Get the formula dependencies of an Item.
      Parameters:
      id - ID of the item to find dependencies of (required)
      Returns:
      ItemDependencyOutputV1
      Throws:
      ApiException - if fails to make API call
    • getFormulaDependenciesWithHttpInfo

      public ApiClient.ApiResponse<ItemDependencyOutputV1> getFormulaDependenciesWithHttpInfo(String id) throws ApiException
      Get the formula dependencies of an Item.
      Parameters:
      id - ID of the item to find dependencies of (required)
      Throws:
      ApiException - if fails to make API call
    • getFormulaDependenciesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemDependencyOutputV1> getFormulaDependenciesWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get the formula dependencies of an Item.
      Parameters:
      id - ID of the item to find dependencies of (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getFormulaDependents

      public ItemPreviewListV1 getFormulaDependents(String id, Integer offset, Integer limit) throws ApiException
      Get a collection of items dependent on the item identified by the supplied ID.
      Parameters:
      id - ID of the item to find dependents of (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:
      ItemPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • getFormulaDependentsWithHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getFormulaDependentsWithHttpInfo(String id, Integer offset, Integer limit) throws ApiException
      Get a collection of items dependent on the item identified by the supplied ID.
      Parameters:
      id - ID of the item to find dependents of (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
    • getFormulaDependentsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getFormulaDependentsWithHeadersAndHttpInfo(String id, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a collection of items dependent on the item identified by the supplied ID.
      Parameters:
      id - ID of the item to find dependents of (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
    • getInterested

      public ItemPreviewListV1 getInterested(String id, Integer offset, Integer limit) throws ApiException
      Get a collection of items interested in the item identified by the supplied ID.
      Parameters:
      id - ID of the item to find all other items interested in the parameter (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:
      ItemPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • getInterestedWithHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getInterestedWithHttpInfo(String id, Integer offset, Integer limit) throws ApiException
      Get a collection of items interested in the item identified by the supplied ID.
      Parameters:
      id - ID of the item to find all other items interested in the parameter (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
    • getInterestedWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getInterestedWithHeadersAndHttpInfo(String id, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a collection of items interested in the item identified by the supplied ID.
      Parameters:
      id - ID of the item to find all other items interested in the parameter (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
    • getItemAndAllProperties

      public ItemOutputV1 getItemAndAllProperties(String id) throws ApiException
      Get all the properties for the item identified by the supplied ID
      Parameters:
      id - ID of the item for which to retrieve properties (required)
      Returns:
      ItemOutputV1
      Throws:
      ApiException - if fails to make API call
    • getItemAndAllPropertiesWithHttpInfo

      public ApiClient.ApiResponse<ItemOutputV1> getItemAndAllPropertiesWithHttpInfo(String id) throws ApiException
      Get all the properties for the item identified by the supplied ID
      Parameters:
      id - ID of the item for which to retrieve properties (required)
      Throws:
      ApiException - if fails to make API call
    • getItemAndAllPropertiesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemOutputV1> getItemAndAllPropertiesWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get all the properties for the item identified by the supplied ID
      Parameters:
      id - ID of the item for which to retrieve properties (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getItemFinder

      public ItemFinderOutputV1 getItemFinder(String id) throws ApiException
      Get an item finder
      Parameters:
      id - The Seeq ID for the item finder (required)
      Returns:
      ItemFinderOutputV1
      Throws:
      ApiException - if fails to make API call
    • getItemFinderWithHttpInfo

      public ApiClient.ApiResponse<ItemFinderOutputV1> getItemFinderWithHttpInfo(String id) throws ApiException
      Get an item finder
      Parameters:
      id - The Seeq ID for the item finder (required)
      Throws:
      ApiException - if fails to make API call
    • getItemFinderWithHeadersAndHttpInfo

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

      public ItemFinderOutputListV1 getItemFinders(Integer offset, Integer limit) throws ApiException
      Get a list of item finders
      Parameters:
      offset - (optional, default to 0)
      limit - The pagination limit, the total number of item finders that will be returned in this page of results (optional, default to 40)
      Returns:
      ItemFinderOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getItemFindersWithHttpInfo

      public ApiClient.ApiResponse<ItemFinderOutputListV1> getItemFindersWithHttpInfo(Integer offset, Integer limit) throws ApiException
      Get a list of item finders
      Parameters:
      offset - (optional, default to 0)
      limit - The pagination limit, the total number of item finders that will be returned in this page of results (optional, default to 40)
      Throws:
      ApiException - if fails to make API call
    • getItemFindersWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemFinderOutputListV1> getItemFindersWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a list of item finders
      Parameters:
      offset - (optional, default to 0)
      limit - The pagination limit, the total number of item finders 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
    • getItemUsages

      public ItemPreviewListV1 getItemUsages(String id, List<String> scope, Integer offset, Integer limit) throws ApiException
      Finds all Threshold Metrics and Formulas that are directly built off the specified item.
      Parameters:
      id - ID of the item to find usages (required)
      scope - IDs that limit the results to those which are in the global scope or are scoped to the items referenced by the IDs. <br>The following item types can act as a scope: <b>Workbook</b><br>If the scope is set to the Empty GUID then the scoped items are excluded (optional)
      offset - The pagination offset, the index of the first collection item that will be returned in this page (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page (optional, default to 500)
      Returns:
      ItemPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • getItemUsagesWithHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getItemUsagesWithHttpInfo(String id, List<String> scope, Integer offset, Integer limit) throws ApiException
      Finds all Threshold Metrics and Formulas that are directly built off the specified item.
      Parameters:
      id - ID of the item to find usages (required)
      scope - IDs that limit the results to those which are in the global scope or are scoped to the items referenced by the IDs. <br>The following item types can act as a scope: <b>Workbook</b><br>If the scope is set to the Empty GUID then the scoped items are excluded (optional)
      offset - The pagination offset, the index of the first collection item that will be returned in this page (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page (optional, default to 500)
      Throws:
      ApiException - if fails to make API call
    • getItemUsagesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemPreviewListV1> getItemUsagesWithHeadersAndHttpInfo(String id, List<String> scope, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Finds all Threshold Metrics and Formulas that are directly built off the specified item.
      Parameters:
      id - ID of the item to find usages (required)
      scope - IDs that limit the results to those which are in the global scope or are scoped to the items referenced by the IDs. <br>The following item types can act as a scope: <b>Workbook</b><br>If the scope is set to the Empty GUID then the scoped items are excluded (optional)
      offset - The pagination offset, the index of the first collection item that will be returned in this page (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page (optional, default to 500)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getItemUserAttributes

      public ItemUserAttributesOutputV1 getItemUserAttributes(String id) throws ApiException
      Get user-specific attributes of an item for the authenticated user.
      Parameters:
      id - ID of the item to get attributes for (required)
      Returns:
      ItemUserAttributesOutputV1
      Throws:
      ApiException - if fails to make API call
    • getItemUserAttributesWithHttpInfo

      public ApiClient.ApiResponse<ItemUserAttributesOutputV1> getItemUserAttributesWithHttpInfo(String id) throws ApiException
      Get user-specific attributes of an item for the authenticated user.
      Parameters:
      id - ID of the item to get attributes for (required)
      Throws:
      ApiException - if fails to make API call
    • getItemUserAttributesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemUserAttributesOutputV1> getItemUserAttributesWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get user-specific attributes of an item for the authenticated user.
      Parameters:
      id - ID of the item to get attributes for (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getPinnedItems

      public ItemSearchPreviewListV1 getPinnedItems(String sourceId) throws ApiException
      Get all pinned items for an item, ordered by the most recent first
      Parameters:
      sourceId - Id of the source item to get pinned items for. If not specified, the current user will be used. (optional)
      Returns:
      ItemSearchPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • getPinnedItemsWithHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> getPinnedItemsWithHttpInfo(String sourceId) throws ApiException
      Get all pinned items for an item, ordered by the most recent first
      Parameters:
      sourceId - Id of the source item to get pinned items for. If not specified, the current user will be used. (optional)
      Throws:
      ApiException - if fails to make API call
    • getPinnedItemsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> getPinnedItemsWithHeadersAndHttpInfo(String sourceId, Map<String,String> customHeaders) throws ApiException
      Get all pinned items for an item, ordered by the most recent first
      Parameters:
      sourceId - Id of the source item to get pinned items for. If not specified, the current user will be used. (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getProperty

      public PropertyOutputV1 getProperty(String id, String propertyName) throws ApiException
      Get a property
      Parameters:
      id - ID of the item for which to retrieve the specified property (required)
      propertyName - Name of the property to retrieve (required)
      Returns:
      PropertyOutputV1
      Throws:
      ApiException - if fails to make API call
    • getPropertyWithHttpInfo

      public ApiClient.ApiResponse<PropertyOutputV1> getPropertyWithHttpInfo(String id, String propertyName) throws ApiException
      Get a property
      Parameters:
      id - ID of the item for which to retrieve the specified property (required)
      propertyName - Name of the property to retrieve (required)
      Throws:
      ApiException - if fails to make API call
    • getPropertyWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<PropertyOutputV1> getPropertyWithHeadersAndHttpInfo(String id, String propertyName, Map<String,String> customHeaders) throws ApiException
      Get a property
      Parameters:
      id - ID of the item for which to retrieve the specified property (required)
      propertyName - Name of the property to retrieve (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getSwapOptions

      public SwapOptionListV1 getSwapOptions(String id, List<String> swapOutItemIds) throws ApiException
      For the Item to be swapped in, get a ranked list of potential swap-out Items from the paths of the Items whose IDs are passed as query parameters. The ranking is based on the number of matches found among the descendants of the swap-in Item when the listed Item is chosen as the swap-out Item, where matching is established by comparing relative paths.
      Parameters:
      id - ID of the root Item to be swapped in (required)
      swapOutItemIds - IDs of the items to be swapped out (required)
      Returns:
      SwapOptionListV1
      Throws:
      ApiException - if fails to make API call
    • getSwapOptionsWithHttpInfo

      public ApiClient.ApiResponse<SwapOptionListV1> getSwapOptionsWithHttpInfo(String id, List<String> swapOutItemIds) throws ApiException
      For the Item to be swapped in, get a ranked list of potential swap-out Items from the paths of the Items whose IDs are passed as query parameters. The ranking is based on the number of matches found among the descendants of the swap-in Item when the listed Item is chosen as the swap-out Item, where matching is established by comparing relative paths.
      Parameters:
      id - ID of the root Item to be swapped in (required)
      swapOutItemIds - IDs of the items to be swapped out (required)
      Throws:
      ApiException - if fails to make API call
    • getSwapOptionsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<SwapOptionListV1> getSwapOptionsWithHeadersAndHttpInfo(String id, List<String> swapOutItemIds, Map<String,String> customHeaders) throws ApiException
      For the Item to be swapped in, get a ranked list of potential swap-out Items from the paths of the Items whose IDs are passed as query parameters. The ranking is based on the number of matches found among the descendants of the swap-in Item when the listed Item is chosen as the swap-out Item, where matching is established by comparing relative paths.
      Parameters:
      id - ID of the root Item to be swapped in (required)
      swapOutItemIds - IDs of the items to be swapped out (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • pinItem

      public ItemSearchPreviewListV1 pinItem(String sourceId, String itemId) throws ApiException
      Pin an item
      Parameters:
      sourceId - Id of the source item. If not specified, the current user will be used. (optional)
      itemId - Id of the item to pin/mark as a favorite (required)
      Returns:
      ItemSearchPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • pinItemWithHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> pinItemWithHttpInfo(String sourceId, String itemId) throws ApiException
      Pin an item
      Parameters:
      sourceId - Id of the source item. If not specified, the current user will be used. (optional)
      itemId - Id of the item to pin/mark as a favorite (required)
      Throws:
      ApiException - if fails to make API call
    • pinItemWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> pinItemWithHeadersAndHttpInfo(String sourceId, String itemId, Map<String,String> customHeaders) throws ApiException
      Pin an item
      Parameters:
      sourceId - Id of the source item. If not specified, the current user will be used. (optional)
      itemId - Id of the item to pin/mark as a favorite (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • removeAccessControlEntry

      public AclOutputV1 removeAccessControlEntry(String id, String aceId) throws ApiException
      Remove an access control entry from an item
      Parameters:
      id - ID of the item to remove access control entry from (required)
      aceId - ID of the access control entry to remove (required)
      Returns:
      AclOutputV1
      Throws:
      ApiException - if fails to make API call
    • removeAccessControlEntryWithHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> removeAccessControlEntryWithHttpInfo(String id, String aceId) throws ApiException
      Remove an access control entry from an item
      Parameters:
      id - ID of the item to remove access control entry from (required)
      aceId - ID of the access control entry to remove (required)
      Throws:
      ApiException - if fails to make API call
    • removeAccessControlEntryWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> removeAccessControlEntryWithHeadersAndHttpInfo(String id, String aceId, Map<String,String> customHeaders) throws ApiException
      Remove an access control entry from an item
      Parameters:
      id - ID of the item to remove access control entry from (required)
      aceId - ID of the access control entry to remove (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • resetCdc

      public PropertyOutputV1 resetCdc(String itemId) throws ApiException
      Reset the Change Data Capture of an item.
      Parameters:
      itemId - Id of the item to update. (required)
      Returns:
      PropertyOutputV1
      Throws:
      ApiException - if fails to make API call
    • resetCdcWithHttpInfo

      public ApiClient.ApiResponse<PropertyOutputV1> resetCdcWithHttpInfo(String itemId) throws ApiException
      Reset the Change Data Capture of an item.
      Parameters:
      itemId - Id of the item to update. (required)
      Throws:
      ApiException - if fails to make API call
    • resetCdcWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<PropertyOutputV1> resetCdcWithHeadersAndHttpInfo(String itemId, Map<String,String> customHeaders) throws ApiException
      Reset the Change Data Capture of an item.
      Parameters:
      itemId - Id of the item to update. (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • searchItems

      public ItemSearchPreviewPaginatedListV1 searchItems(List<String> filters, List<String> scope, String asset, List<String> types, List<String> includeProperties, Integer offset, Integer limit, List<String> orderBy) throws ApiException
      Get a collection of items
      Parameters:
      filters - A list of item filters to reduce the result set. To logical AND multiple filters, use <b>\"filter1 && filter2</b>\" on a single line. To logical OR multiple filters, put each onto a new line. Filters can include any of the following options:<br><b>Empty</b>: returns the first ceiling number of items<br><b>\"value\"</b>: name or description of the item contains the case-insensitive value<br><b>\"field==value\"</b>: specified field exactly matches the case-sensitive value or regex<br><b>\"field~=value\"</b>: specified field contains the case-insensitive value or case-sensitive regex<br>To search for all items in the desired scope you may also use \"\\*\" character as filter.<br><b>Example:</b> Find items where (name or description contains case-insensitive \"bulb\" AND description contains case-insensitive \"area a\") OR (items hosted by datasource \"Example Data\" where name exactly matches the regex \".\\*[ABC]_Temperature\")<br><b>bulb && Description~=area a</b><br><b>Datasource ID==Example Data && Name==/.\\*[ABC]_Temperature/</b><br>To allow items with the 'unsearchable' property to be returned, include <b>\"@includeUnsearchable\"</b> on its own line<br>To exclude globally scoped items when using the \"scope\" filter include <b>\"@excludeGloballyScoped\"</b> on its own line (optional)
      scope - IDs that limit the results to those which are in the global scope or are scoped to the items referenced by the IDs. <br>The following item types can act as a scope: <b>Workbook</b><br>If the scope is set to the Empty GUID then the scoped items are excluded (optional)
      asset - An ID that limits the results to items which are in the tree below the Asset referenced by the ID. (optional)
      types - A list of one or more case-sensitive item types which will restrict results to only those items that exactly match, or are children of, one of the specified types. If no types are provided then items of any type are returned (optional)
      includeProperties - A list of one or more case-sensitive item properties to include in every item this search finds. Use a single entry set to <b>\"@allProperties\"</b> to specify that all item properties should be returned. Specified properties not present for an item are simply omitted and do not cause errors. (optional)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results. When using limit or offset values to query different item subsets it is important to sort the results using orderBy. Otherwise inconsistent results may be returned. (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results. When using limit or offset values to query different item subsets it is important to sort the results using orderBy. Otherwise inconsistent results may be returned. (optional, default to 40)
      orderBy - An optional list of one or more fields used to sort the results. (optional)
      Returns:
      ItemSearchPreviewPaginatedListV1
      Throws:
      ApiException - if fails to make API call
    • searchItemsWithHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewPaginatedListV1> searchItemsWithHttpInfo(List<String> filters, List<String> scope, String asset, List<String> types, List<String> includeProperties, Integer offset, Integer limit, List<String> orderBy) throws ApiException
      Get a collection of items
      Parameters:
      filters - A list of item filters to reduce the result set. To logical AND multiple filters, use <b>\"filter1 && filter2</b>\" on a single line. To logical OR multiple filters, put each onto a new line. Filters can include any of the following options:<br><b>Empty</b>: returns the first ceiling number of items<br><b>\"value\"</b>: name or description of the item contains the case-insensitive value<br><b>\"field==value\"</b>: specified field exactly matches the case-sensitive value or regex<br><b>\"field~=value\"</b>: specified field contains the case-insensitive value or case-sensitive regex<br>To search for all items in the desired scope you may also use \"\\*\" character as filter.<br><b>Example:</b> Find items where (name or description contains case-insensitive \"bulb\" AND description contains case-insensitive \"area a\") OR (items hosted by datasource \"Example Data\" where name exactly matches the regex \".\\*[ABC]_Temperature\")<br><b>bulb && Description~=area a</b><br><b>Datasource ID==Example Data && Name==/.\\*[ABC]_Temperature/</b><br>To allow items with the 'unsearchable' property to be returned, include <b>\"@includeUnsearchable\"</b> on its own line<br>To exclude globally scoped items when using the \"scope\" filter include <b>\"@excludeGloballyScoped\"</b> on its own line (optional)
      scope - IDs that limit the results to those which are in the global scope or are scoped to the items referenced by the IDs. <br>The following item types can act as a scope: <b>Workbook</b><br>If the scope is set to the Empty GUID then the scoped items are excluded (optional)
      asset - An ID that limits the results to items which are in the tree below the Asset referenced by the ID. (optional)
      types - A list of one or more case-sensitive item types which will restrict results to only those items that exactly match, or are children of, one of the specified types. If no types are provided then items of any type are returned (optional)
      includeProperties - A list of one or more case-sensitive item properties to include in every item this search finds. Use a single entry set to <b>\"@allProperties\"</b> to specify that all item properties should be returned. Specified properties not present for an item are simply omitted and do not cause errors. (optional)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results. When using limit or offset values to query different item subsets it is important to sort the results using orderBy. Otherwise inconsistent results may be returned. (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results. When using limit or offset values to query different item subsets it is important to sort the results using orderBy. Otherwise inconsistent results may be returned. (optional, default to 40)
      orderBy - An optional list of one or more fields used to sort the results. (optional)
      Throws:
      ApiException - if fails to make API call
    • searchItemsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewPaginatedListV1> searchItemsWithHeadersAndHttpInfo(List<String> filters, List<String> scope, String asset, List<String> types, List<String> includeProperties, Integer offset, Integer limit, List<String> orderBy, Map<String,String> customHeaders) throws ApiException
      Get a collection of items
      Parameters:
      filters - A list of item filters to reduce the result set. To logical AND multiple filters, use <b>\"filter1 && filter2</b>\" on a single line. To logical OR multiple filters, put each onto a new line. Filters can include any of the following options:<br><b>Empty</b>: returns the first ceiling number of items<br><b>\"value\"</b>: name or description of the item contains the case-insensitive value<br><b>\"field==value\"</b>: specified field exactly matches the case-sensitive value or regex<br><b>\"field~=value\"</b>: specified field contains the case-insensitive value or case-sensitive regex<br>To search for all items in the desired scope you may also use \"\\*\" character as filter.<br><b>Example:</b> Find items where (name or description contains case-insensitive \"bulb\" AND description contains case-insensitive \"area a\") OR (items hosted by datasource \"Example Data\" where name exactly matches the regex \".\\*[ABC]_Temperature\")<br><b>bulb && Description~=area a</b><br><b>Datasource ID==Example Data && Name==/.\\*[ABC]_Temperature/</b><br>To allow items with the 'unsearchable' property to be returned, include <b>\"@includeUnsearchable\"</b> on its own line<br>To exclude globally scoped items when using the \"scope\" filter include <b>\"@excludeGloballyScoped\"</b> on its own line (optional)
      scope - IDs that limit the results to those which are in the global scope or are scoped to the items referenced by the IDs. <br>The following item types can act as a scope: <b>Workbook</b><br>If the scope is set to the Empty GUID then the scoped items are excluded (optional)
      asset - An ID that limits the results to items which are in the tree below the Asset referenced by the ID. (optional)
      types - A list of one or more case-sensitive item types which will restrict results to only those items that exactly match, or are children of, one of the specified types. If no types are provided then items of any type are returned (optional)
      includeProperties - A list of one or more case-sensitive item properties to include in every item this search finds. Use a single entry set to <b>\"@allProperties\"</b> to specify that all item properties should be returned. Specified properties not present for an item are simply omitted and do not cause errors. (optional)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results. When using limit or offset values to query different item subsets it is important to sort the results using orderBy. Otherwise inconsistent results may be returned. (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results. When using limit or offset values to query different item subsets it is important to sort the results using orderBy. Otherwise inconsistent results may be returned. (optional, default to 40)
      orderBy - An optional list of one or more fields used to sort the results. (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setAcl

      public AclOutputV1 setAcl(String id, AclInputV1 body) throws ApiException
      Set the access control list (list of access control entries) for an item.
      Parameters:
      id - ID of the item to change access control list for (required)
      body - The access control list to set (required)
      Returns:
      AclOutputV1
      Throws:
      ApiException - if fails to make API call
    • setAclWithHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> setAclWithHttpInfo(String id, AclInputV1 body) throws ApiException
      Set the access control list (list of access control entries) for an item.
      Parameters:
      id - ID of the item to change access control list for (required)
      body - The access control list to set (required)
      Throws:
      ApiException - if fails to make API call
    • setAclWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> setAclWithHeadersAndHttpInfo(String id, AclInputV1 body, Map<String,String> customHeaders) throws ApiException
      Set the access control list (list of access control entries) for an item.
      Parameters:
      id - ID of the item to change access control list for (required)
      body - The access control list to set (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setAclInheritance

      public AclOutputV1 setAclInheritance(String id, Boolean inheritAcl) throws ApiException
      Turns on or off access control inheritance for the specified item
      Parameters:
      id - ID of the item to change access control inheritance for (required)
      inheritAcl - True if the item should inherit access control from its parent, false if it shouldn't. (required)
      Returns:
      AclOutputV1
      Throws:
      ApiException - if fails to make API call
    • setAclInheritanceWithHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> setAclInheritanceWithHttpInfo(String id, Boolean inheritAcl) throws ApiException
      Turns on or off access control inheritance for the specified item
      Parameters:
      id - ID of the item to change access control inheritance for (required)
      inheritAcl - True if the item should inherit access control from its parent, false if it shouldn't. (required)
      Throws:
      ApiException - if fails to make API call
    • setAclInheritanceWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<AclOutputV1> setAclInheritanceWithHeadersAndHttpInfo(String id, Boolean inheritAcl, Map<String,String> customHeaders) throws ApiException
      Turns on or off access control inheritance for the specified item
      Parameters:
      id - ID of the item to change access control inheritance for (required)
      inheritAcl - True if the item should inherit access control from its parent, false if it shouldn't. (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setFormula

      public CalculatedItemOutputV1 setFormula(String id, FormulaUpdateInputV1 body) throws ApiException
      Update the formula and formula parameters of an item
      Parameters:
      id - ID of the item that is being updated (required)
      body - The formula information (required)
      Returns:
      CalculatedItemOutputV1
      Throws:
      ApiException - if fails to make API call
    • setFormulaWithHttpInfo

      public ApiClient.ApiResponse<CalculatedItemOutputV1> setFormulaWithHttpInfo(String id, FormulaUpdateInputV1 body) throws ApiException
      Update the formula and formula parameters of an item
      Parameters:
      id - ID of the item that is being updated (required)
      body - The formula information (required)
      Throws:
      ApiException - if fails to make API call
    • setFormulaWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<CalculatedItemOutputV1> setFormulaWithHeadersAndHttpInfo(String id, FormulaUpdateInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update the formula and formula parameters of an item
      Parameters:
      id - ID of the item that is being updated (required)
      body - The formula information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setItemUserAttributes

      public ItemUserAttributesOutputV1 setItemUserAttributes(String id, ItemUserAttributesInputV1 body) throws ApiException
      Set user-specific attributes of an item for the authenticated user.
      Parameters:
      id - ID of the item to change owner for (required)
      body - Attributes to set (required)
      Returns:
      ItemUserAttributesOutputV1
      Throws:
      ApiException - if fails to make API call
    • setItemUserAttributesWithHttpInfo

      public ApiClient.ApiResponse<ItemUserAttributesOutputV1> setItemUserAttributesWithHttpInfo(String id, ItemUserAttributesInputV1 body) throws ApiException
      Set user-specific attributes of an item for the authenticated user.
      Parameters:
      id - ID of the item to change owner for (required)
      body - Attributes to set (required)
      Throws:
      ApiException - if fails to make API call
    • setItemUserAttributesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemUserAttributesOutputV1> setItemUserAttributesWithHeadersAndHttpInfo(String id, ItemUserAttributesInputV1 body, Map<String,String> customHeaders) throws ApiException
      Set user-specific attributes of an item for the authenticated user.
      Parameters:
      id - ID of the item to change owner for (required)
      body - Attributes to set (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setProperties

      public ItemOutputV1 setProperties(String id, List<ScalarPropertyV1> body) throws ApiException
      Set properties on the item identified by the supplied ID
      Parameters:
      id - ID of the item to set properties on (required)
      body - Property information (required)
      Returns:
      ItemOutputV1
      Throws:
      ApiException - if fails to make API call
    • setPropertiesWithHttpInfo

      public ApiClient.ApiResponse<ItemOutputV1> setPropertiesWithHttpInfo(String id, List<ScalarPropertyV1> body) throws ApiException
      Set properties on the item identified by the supplied ID
      Parameters:
      id - ID of the item to set properties on (required)
      body - Property information (required)
      Throws:
      ApiException - if fails to make API call
    • setPropertiesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemOutputV1> setPropertiesWithHeadersAndHttpInfo(String id, List<ScalarPropertyV1> body, Map<String,String> customHeaders) throws ApiException
      Set properties on the item identified by the supplied ID
      Parameters:
      id - ID of the item to set properties on (required)
      body - Property information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setProperty

      public PropertyHrefOutputV1 setProperty(String id, String propertyName, PropertyInputV1 body) throws ApiException
      Set a property
      Parameters:
      id - ID of the item to set the property on (required)
      propertyName - Name of the property to set (required)
      body - Property information (required)
      Returns:
      PropertyHrefOutputV1
      Throws:
      ApiException - if fails to make API call
    • setPropertyWithHttpInfo

      public ApiClient.ApiResponse<PropertyHrefOutputV1> setPropertyWithHttpInfo(String id, String propertyName, PropertyInputV1 body) throws ApiException
      Set a property
      Parameters:
      id - ID of the item to set the property on (required)
      propertyName - Name of the property to set (required)
      body - Property information (required)
      Throws:
      ApiException - if fails to make API call
    • setPropertyWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<PropertyHrefOutputV1> setPropertyWithHeadersAndHttpInfo(String id, String propertyName, PropertyInputV1 body, Map<String,String> customHeaders) throws ApiException
      Set a property
      Parameters:
      id - ID of the item to set the property on (required)
      propertyName - Name of the property to set (required)
      body - Property information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • setScope

      public ItemOutputV1 setScope(String id, String workbookId) throws ApiException
      Update the scope of an item
      Parameters:
      id - ID of the item that is having its scope updated (required)
      workbookId - ID of the Workbook to which the item is being scoped. If not provided the item will be moved to the global scope (optional)
      Returns:
      ItemOutputV1
      Throws:
      ApiException - if fails to make API call
    • setScopeWithHttpInfo

      public ApiClient.ApiResponse<ItemOutputV1> setScopeWithHttpInfo(String id, String workbookId) throws ApiException
      Update the scope of an item
      Parameters:
      id - ID of the item that is having its scope updated (required)
      workbookId - ID of the Workbook to which the item is being scoped. If not provided the item will be moved to the global scope (optional)
      Throws:
      ApiException - if fails to make API call
    • setScopeWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemOutputV1> setScopeWithHeadersAndHttpInfo(String id, String workbookId, Map<String,String> customHeaders) throws ApiException
      Update the scope of an item
      Parameters:
      id - ID of the item that is having its scope updated (required)
      workbookId - ID of the Workbook to which the item is being scoped. If not provided the item will be moved to the global scope (optional)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • unpinItem

      public ItemSearchPreviewListV1 unpinItem(String sourceId, String itemId) throws ApiException
      Unpin an item
      Parameters:
      sourceId - Id of the source item. If not specified, the current user will be used. (optional)
      itemId - Id of the item to unpin/unmark as a favorite (required)
      Returns:
      ItemSearchPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • unpinItemWithHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> unpinItemWithHttpInfo(String sourceId, String itemId) throws ApiException
      Unpin an item
      Parameters:
      sourceId - Id of the source item. If not specified, the current user will be used. (optional)
      itemId - Id of the item to unpin/unmark as a favorite (required)
      Throws:
      ApiException - if fails to make API call
    • unpinItemWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemSearchPreviewListV1> unpinItemWithHeadersAndHttpInfo(String sourceId, String itemId, Map<String,String> customHeaders) throws ApiException
      Unpin an item
      Parameters:
      sourceId - Id of the source item. If not specified, the current user will be used. (optional)
      itemId - Id of the item to unpin/unmark as a favorite (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateItemFinder

      public ItemFinderOutputV1 updateItemFinder(String id, ItemFinderInputV1 body) throws ApiException
      Update an item finder
      Parameters:
      id - The Seeq ID for the item finder (required)
      body - (required)
      Returns:
      ItemFinderOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateItemFinderWithHttpInfo

      public ApiClient.ApiResponse<ItemFinderOutputV1> updateItemFinderWithHttpInfo(String id, ItemFinderInputV1 body) throws ApiException
      Update an item finder
      Parameters:
      id - The Seeq ID for the item finder (required)
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • updateItemFinderWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<ItemFinderOutputV1> updateItemFinderWithHeadersAndHttpInfo(String id, ItemFinderInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update an item finder
      Parameters:
      id - The Seeq ID for the item finder (required)
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call