Package com.mypurecloud.sdk.v2.api

Class ContentManagementApi

java.lang.Object
com.mypurecloud.sdk.v2.api.ContentManagementApi
public class ContentManagementApi extends Object

  • Constructor Details

    • ContentManagementApi

      public ContentManagementApi()

    • ContentManagementApi

      public ContentManagementApi(ApiClient apiClient)

  • Method Details

    • deleteContentmanagementDocument

      public void deleteContentmanagementDocument(String documentId, Boolean override) throws IOException, ApiException
      Delete a document.
      Parameters:
      documentId - Document ID (required)
      override - Override any lock on the document (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementDocumentWithHttpInfo

      public ApiResponse<Void> deleteContentmanagementDocumentWithHttpInfo(String documentId, Boolean override) throws IOException
      Delete a document.
      Parameters:
      documentId - Document ID (required)
      override - Override any lock on the document (optional)
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementDocument

      public void deleteContentmanagementDocument(DeleteContentmanagementDocumentRequest request) throws IOException, ApiException
      Delete a document.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementDocument

      public ApiResponse<Void> deleteContentmanagementDocument(ApiRequest<Void> request) throws IOException
      Delete a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementShare

      public void deleteContentmanagementShare(String shareId) throws IOException, ApiException
      Deletes an existing share. This revokes sharing rights specified in the share record
      Parameters:
      shareId - Share ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementShareWithHttpInfo

      public ApiResponse<Void> deleteContentmanagementShareWithHttpInfo(String shareId) throws IOException
      Deletes an existing share. This revokes sharing rights specified in the share record
      Parameters:
      shareId - Share ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementShare

      public void deleteContentmanagementShare(DeleteContentmanagementShareRequest request) throws IOException, ApiException
      Deletes an existing share. This revokes sharing rights specified in the share record
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementShare

      public ApiResponse<Void> deleteContentmanagementShare(ApiRequest<Void> request) throws IOException
      Deletes an existing share. This revokes sharing rights specified in the share record
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementStatusStatusId

      public void deleteContentmanagementStatusStatusId(String statusId) throws IOException, ApiException
      Cancel the command for this status
      Parameters:
      statusId - Status ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementStatusStatusIdWithHttpInfo

      public ApiResponse<Void> deleteContentmanagementStatusStatusIdWithHttpInfo(String statusId) throws IOException
      Cancel the command for this status
      Parameters:
      statusId - Status ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementStatusStatusId

      public void deleteContentmanagementStatusStatusId(DeleteContentmanagementStatusStatusIdRequest request) throws IOException, ApiException
      Cancel the command for this status
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementStatusStatusId

      public ApiResponse<Void> deleteContentmanagementStatusStatusId(ApiRequest<Void> request) throws IOException
      Cancel the command for this status
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspace

      public void deleteContentmanagementWorkspace(String workspaceId, String moveChildrenToWorkspaceId) throws IOException, ApiException
      Delete a workspace
      Parameters:
      workspaceId - Workspace ID (required)
      moveChildrenToWorkspaceId - New location for objects in deleted workspace. (optional)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceWithHttpInfo

      public ApiResponse<Void> deleteContentmanagementWorkspaceWithHttpInfo(String workspaceId, String moveChildrenToWorkspaceId) throws IOException
      Delete a workspace
      Parameters:
      workspaceId - Workspace ID (required)
      moveChildrenToWorkspaceId - New location for objects in deleted workspace. (optional)
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspace

      public void deleteContentmanagementWorkspace(DeleteContentmanagementWorkspaceRequest request) throws IOException, ApiException
      Delete a workspace
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspace

      public ApiResponse<Void> deleteContentmanagementWorkspace(ApiRequest<Void> request) throws IOException
      Delete a workspace
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceMember

      public void deleteContentmanagementWorkspaceMember(String workspaceId, String memberId) throws IOException, ApiException
      Delete a member from a workspace
      Parameters:
      workspaceId - Workspace ID (required)
      memberId - Member ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceMemberWithHttpInfo

      public ApiResponse<Void> deleteContentmanagementWorkspaceMemberWithHttpInfo(String workspaceId, String memberId) throws IOException
      Delete a member from a workspace
      Parameters:
      workspaceId - Workspace ID (required)
      memberId - Member ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceMember

      public void deleteContentmanagementWorkspaceMember(DeleteContentmanagementWorkspaceMemberRequest request) throws IOException, ApiException
      Delete a member from a workspace
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceMember

      public ApiResponse<Void> deleteContentmanagementWorkspaceMember(ApiRequest<Void> request) throws IOException
      Delete a member from a workspace
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceTagvalue

      public void deleteContentmanagementWorkspaceTagvalue(String workspaceId, String tagId) throws IOException, ApiException
      Delete workspace tag Delete a tag from a workspace. Will remove this tag from all documents.
      Parameters:
      workspaceId - Workspace ID (required)
      tagId - Tag ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceTagvalueWithHttpInfo

      public ApiResponse<Void> deleteContentmanagementWorkspaceTagvalueWithHttpInfo(String workspaceId, String tagId) throws IOException
      Delete workspace tag Delete a tag from a workspace. Will remove this tag from all documents.
      Parameters:
      workspaceId - Workspace ID (required)
      tagId - Tag ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceTagvalue

      public void deleteContentmanagementWorkspaceTagvalue(DeleteContentmanagementWorkspaceTagvalueRequest request) throws IOException, ApiException
      Delete workspace tag Delete a tag from a workspace. Will remove this tag from all documents.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteContentmanagementWorkspaceTagvalue

      public ApiResponse<Void> deleteContentmanagementWorkspaceTagvalue(ApiRequest<Void> request) throws IOException
      Delete workspace tag Delete a tag from a workspace. Will remove this tag from all documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementDocument

      public Document getContentmanagementDocument(String documentId, List<String> expand) throws IOException, ApiException
      Get a document.
      Parameters:
      documentId - Document ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      Document
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementDocumentWithHttpInfo

      public ApiResponse<Document> getContentmanagementDocumentWithHttpInfo(String documentId, List<String> expand) throws IOException
      Get a document.
      Parameters:
      documentId - Document ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      Document
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementDocument

      public Document getContentmanagementDocument(GetContentmanagementDocumentRequest request) throws IOException, ApiException
      Get a document.
      Parameters:
      request - The request object
      Returns:
      Document
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementDocument

      public ApiResponse<Document> getContentmanagementDocument(ApiRequest<Void> request) throws IOException
      Get a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementDocumentContent

      public DownloadResponse getContentmanagementDocumentContent(String documentId, String disposition, String contentType) throws IOException, ApiException
      Download a document.
      Parameters:
      documentId - Document ID (required)
      disposition - Request how the content will be downloaded: a file attachment or inline. Default is attachment. (optional)
      contentType - The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav (optional)
      Returns:
      DownloadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementDocumentContentWithHttpInfo

      public ApiResponse<DownloadResponse> getContentmanagementDocumentContentWithHttpInfo(String documentId, String disposition, String contentType) throws IOException
      Download a document.
      Parameters:
      documentId - Document ID (required)
      disposition - Request how the content will be downloaded: a file attachment or inline. Default is attachment. (optional)
      contentType - The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav (optional)
      Returns:
      DownloadResponse
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementDocumentContent

      public DownloadResponse getContentmanagementDocumentContent(GetContentmanagementDocumentContentRequest request) throws IOException, ApiException
      Download a document.
      Parameters:
      request - The request object
      Returns:
      DownloadResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementDocumentContent

      public ApiResponse<DownloadResponse> getContentmanagementDocumentContent(ApiRequest<Void> request) throws IOException
      Download a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementDocuments

      public DocumentEntityListing getContentmanagementDocuments(String workspaceId, String name, List<String> expand, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder) throws IOException, ApiException
      Deprecated.
      Get a list of documents.
      Parameters:
      workspaceId - Workspace ID (required)
      name - Name (optional)
      expand - Which fields, if any, to expand. (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - name or dateCreated (optional)
      sortOrder - ascending or descending (optional, default to ascending)
      Returns:
      DocumentEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementDocumentsWithHttpInfo

      public ApiResponse<DocumentEntityListing> getContentmanagementDocumentsWithHttpInfo(String workspaceId, String name, List<String> expand, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder) throws IOException
      Deprecated.
      Get a list of documents.
      Parameters:
      workspaceId - Workspace ID (required)
      name - Name (optional)
      expand - Which fields, if any, to expand. (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - name or dateCreated (optional)
      sortOrder - ascending or descending (optional, default to ascending)
      Returns:
      DocumentEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementDocuments

      public DocumentEntityListing getContentmanagementDocuments(GetContentmanagementDocumentsRequest request) throws IOException, ApiException
      Deprecated.
      Get a list of documents.
      Parameters:
      request - The request object
      Returns:
      DocumentEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementDocuments

      public ApiResponse<DocumentEntityListing> getContentmanagementDocuments(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get a list of documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementQuery

      public QueryResults getContentmanagementQuery(String queryPhrase, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, List<String> expand) throws IOException, ApiException
      Query content
      Parameters:
      queryPhrase - Phrase tokens are ANDed together over all searchable fields (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - name or dateCreated (optional, default to name)
      sortOrder - ascending or descending (optional, default to ascending)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      QueryResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementQueryWithHttpInfo

      public ApiResponse<QueryResults> getContentmanagementQueryWithHttpInfo(String queryPhrase, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder, List<String> expand) throws IOException
      Query content
      Parameters:
      queryPhrase - Phrase tokens are ANDed together over all searchable fields (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - name or dateCreated (optional, default to name)
      sortOrder - ascending or descending (optional, default to ascending)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      QueryResults
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementQuery

      public QueryResults getContentmanagementQuery(GetContentmanagementQueryRequest request) throws IOException, ApiException
      Query content
      Parameters:
      request - The request object
      Returns:
      QueryResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementQuery

      public ApiResponse<QueryResults> getContentmanagementQuery(ApiRequest<Void> request) throws IOException
      Query content
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementSecurityprofile

      public SecurityProfile getContentmanagementSecurityprofile(String securityProfileId) throws IOException, ApiException
      Get a Security Profile
      Parameters:
      securityProfileId - Security Profile Id (required)
      Returns:
      SecurityProfile
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementSecurityprofileWithHttpInfo

      public ApiResponse<SecurityProfile> getContentmanagementSecurityprofileWithHttpInfo(String securityProfileId) throws IOException
      Get a Security Profile
      Parameters:
      securityProfileId - Security Profile Id (required)
      Returns:
      SecurityProfile
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementSecurityprofile

      public SecurityProfile getContentmanagementSecurityprofile(GetContentmanagementSecurityprofileRequest request) throws IOException, ApiException
      Get a Security Profile
      Parameters:
      request - The request object
      Returns:
      SecurityProfile
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementSecurityprofile

      public ApiResponse<SecurityProfile> getContentmanagementSecurityprofile(ApiRequest<Void> request) throws IOException
      Get a Security Profile
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementSecurityprofiles

      public SecurityProfileEntityListing getContentmanagementSecurityprofiles() throws IOException, ApiException
      Get a List of Security Profiles
      Returns:
      SecurityProfileEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementSecurityprofilesWithHttpInfo

      public ApiResponse<SecurityProfileEntityListing> getContentmanagementSecurityprofilesWithHttpInfo() throws IOException
      Get a List of Security Profiles
      Returns:
      SecurityProfileEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementSecurityprofiles

      public SecurityProfileEntityListing getContentmanagementSecurityprofiles(GetContentmanagementSecurityprofilesRequest request) throws IOException, ApiException
      Get a List of Security Profiles
      Parameters:
      request - The request object
      Returns:
      SecurityProfileEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementSecurityprofiles

      public ApiResponse<SecurityProfileEntityListing> getContentmanagementSecurityprofiles(ApiRequest<Void> request) throws IOException
      Get a List of Security Profiles
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementShare

      public Share getContentmanagementShare(String shareId, List<String> expand) throws IOException, ApiException
      Retrieve details about an existing share.
      Parameters:
      shareId - Share ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      Share
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementShareWithHttpInfo

      public ApiResponse<Share> getContentmanagementShareWithHttpInfo(String shareId, List<String> expand) throws IOException
      Retrieve details about an existing share.
      Parameters:
      shareId - Share ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      Share
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementShare

      public Share getContentmanagementShare(GetContentmanagementShareRequest request) throws IOException, ApiException
      Retrieve details about an existing share.
      Parameters:
      request - The request object
      Returns:
      Share
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementShare

      public ApiResponse<Share> getContentmanagementShare(ApiRequest<Void> request) throws IOException
      Retrieve details about an existing share.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementSharedSharedId

      public SharedResponse getContentmanagementSharedSharedId(String sharedId, String disposition, String contentType, String expand) throws IOException, ApiException
      Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
      Parameters:
      sharedId - Shared ID (required)
      disposition - Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (optional, default to attachment)
      contentType - The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav (optional)
      expand - Expand some document fields (optional)
      Returns:
      SharedResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementSharedSharedIdWithHttpInfo

      public ApiResponse<SharedResponse> getContentmanagementSharedSharedIdWithHttpInfo(String sharedId, String disposition, String contentType, String expand) throws IOException
      Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
      Parameters:
      sharedId - Shared ID (required)
      disposition - Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (optional, default to attachment)
      contentType - The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav (optional)
      expand - Expand some document fields (optional)
      Returns:
      SharedResponse
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementSharedSharedId

      public SharedResponse getContentmanagementSharedSharedId(GetContentmanagementSharedSharedIdRequest request) throws IOException, ApiException
      Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
      Parameters:
      request - The request object
      Returns:
      SharedResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementSharedSharedId

      public ApiResponse<SharedResponse> getContentmanagementSharedSharedId(ApiRequest<Void> request) throws IOException
      Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementShares

      public ShareEntityListing getContentmanagementShares(String entityId, List<String> expand, Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400.
      Parameters:
      entityId - Filters the shares returned to only the entity specified by the value of this parameter. (optional)
      expand - Which fields, if any, to expand. (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      ShareEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementSharesWithHttpInfo

      public ApiResponse<ShareEntityListing> getContentmanagementSharesWithHttpInfo(String entityId, List<String> expand, Integer pageSize, Integer pageNumber) throws IOException
      Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400.
      Parameters:
      entityId - Filters the shares returned to only the entity specified by the value of this parameter. (optional)
      expand - Which fields, if any, to expand. (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      ShareEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementShares

      public ShareEntityListing getContentmanagementShares(GetContentmanagementSharesRequest request) throws IOException, ApiException
      Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400.
      Parameters:
      request - The request object
      Returns:
      ShareEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementShares

      public ApiResponse<ShareEntityListing> getContentmanagementShares(ApiRequest<Void> request) throws IOException
      Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementStatus

      public CommandStatusEntityListing getContentmanagementStatus(Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get a list of statuses for pending operations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      CommandStatusEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementStatusWithHttpInfo

      public ApiResponse<CommandStatusEntityListing> getContentmanagementStatusWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException
      Get a list of statuses for pending operations
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      CommandStatusEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementStatus

      public CommandStatusEntityListing getContentmanagementStatus(GetContentmanagementStatusRequest request) throws IOException, ApiException
      Get a list of statuses for pending operations
      Parameters:
      request - The request object
      Returns:
      CommandStatusEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementStatus

      public ApiResponse<CommandStatusEntityListing> getContentmanagementStatus(ApiRequest<Void> request) throws IOException
      Get a list of statuses for pending operations
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementStatusStatusId

      public CommandStatus getContentmanagementStatusStatusId(String statusId) throws IOException, ApiException
      Get a status.
      Parameters:
      statusId - Status ID (required)
      Returns:
      CommandStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementStatusStatusIdWithHttpInfo

      public ApiResponse<CommandStatus> getContentmanagementStatusStatusIdWithHttpInfo(String statusId) throws IOException
      Get a status.
      Parameters:
      statusId - Status ID (required)
      Returns:
      CommandStatus
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementStatusStatusId

      public CommandStatus getContentmanagementStatusStatusId(GetContentmanagementStatusStatusIdRequest request) throws IOException, ApiException
      Get a status.
      Parameters:
      request - The request object
      Returns:
      CommandStatus
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementStatusStatusId

      public ApiResponse<CommandStatus> getContentmanagementStatusStatusId(ApiRequest<Void> request) throws IOException
      Get a status.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementUsage

      public Usage getContentmanagementUsage() throws IOException, ApiException
      Get usage details.
      Returns:
      Usage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementUsageWithHttpInfo

      public ApiResponse<Usage> getContentmanagementUsageWithHttpInfo() throws IOException
      Get usage details.
      Returns:
      Usage
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementUsage

      public Usage getContentmanagementUsage(GetContentmanagementUsageRequest request) throws IOException, ApiException
      Get usage details.
      Parameters:
      request - The request object
      Returns:
      Usage
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementUsage

      public ApiResponse<Usage> getContentmanagementUsage(ApiRequest<Void> request) throws IOException
      Get usage details.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspace

      public Workspace getContentmanagementWorkspace(String workspaceId, List<String> expand) throws IOException, ApiException
      Get a workspace.
      Parameters:
      workspaceId - Workspace ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      Workspace
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceWithHttpInfo

      public ApiResponse<Workspace> getContentmanagementWorkspaceWithHttpInfo(String workspaceId, List<String> expand) throws IOException
      Get a workspace.
      Parameters:
      workspaceId - Workspace ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      Workspace
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspace

      public Workspace getContentmanagementWorkspace(GetContentmanagementWorkspaceRequest request) throws IOException, ApiException
      Get a workspace.
      Parameters:
      request - The request object
      Returns:
      Workspace
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspace

      public ApiResponse<Workspace> getContentmanagementWorkspace(ApiRequest<Void> request) throws IOException
      Get a workspace.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceDocuments

      public DocumentEntityListing getContentmanagementWorkspaceDocuments(String workspaceId, List<String> expand, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder) throws IOException, ApiException
      Get a list of documents.
      Parameters:
      workspaceId - Workspace ID (required)
      expand - Which fields, if any, to expand. (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - name or dateCreated (optional)
      sortOrder - ascending or descending (optional, default to ascending)
      Returns:
      DocumentEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceDocumentsWithHttpInfo

      public ApiResponse<DocumentEntityListing> getContentmanagementWorkspaceDocumentsWithHttpInfo(String workspaceId, List<String> expand, Integer pageSize, Integer pageNumber, String sortBy, String sortOrder) throws IOException
      Get a list of documents.
      Parameters:
      workspaceId - Workspace ID (required)
      expand - Which fields, if any, to expand. (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - name or dateCreated (optional)
      sortOrder - ascending or descending (optional, default to ascending)
      Returns:
      DocumentEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceDocuments

      public DocumentEntityListing getContentmanagementWorkspaceDocuments(GetContentmanagementWorkspaceDocumentsRequest request) throws IOException, ApiException
      Get a list of documents.
      Parameters:
      request - The request object
      Returns:
      DocumentEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceDocuments

      public ApiResponse<DocumentEntityListing> getContentmanagementWorkspaceDocuments(ApiRequest<Void> request) throws IOException
      Get a list of documents.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceMember

      public WorkspaceMember getContentmanagementWorkspaceMember(String workspaceId, String memberId, List<String> expand) throws IOException, ApiException
      Get a workspace member
      Parameters:
      workspaceId - Workspace ID (required)
      memberId - Member ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      WorkspaceMember
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceMemberWithHttpInfo

      public ApiResponse<WorkspaceMember> getContentmanagementWorkspaceMemberWithHttpInfo(String workspaceId, String memberId, List<String> expand) throws IOException
      Get a workspace member
      Parameters:
      workspaceId - Workspace ID (required)
      memberId - Member ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      WorkspaceMember
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceMember

      public WorkspaceMember getContentmanagementWorkspaceMember(GetContentmanagementWorkspaceMemberRequest request) throws IOException, ApiException
      Get a workspace member
      Parameters:
      request - The request object
      Returns:
      WorkspaceMember
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceMember

      public ApiResponse<WorkspaceMember> getContentmanagementWorkspaceMember(ApiRequest<Void> request) throws IOException
      Get a workspace member
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceMembers

      public WorkspaceMemberEntityListing getContentmanagementWorkspaceMembers(String workspaceId, Integer pageSize, Integer pageNumber, List<String> expand) throws IOException, ApiException
      Get a list workspace members
      Parameters:
      workspaceId - Workspace ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      WorkspaceMemberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceMembersWithHttpInfo

      public ApiResponse<WorkspaceMemberEntityListing> getContentmanagementWorkspaceMembersWithHttpInfo(String workspaceId, Integer pageSize, Integer pageNumber, List<String> expand) throws IOException
      Get a list workspace members
      Parameters:
      workspaceId - Workspace ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      WorkspaceMemberEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceMembers

      public WorkspaceMemberEntityListing getContentmanagementWorkspaceMembers(GetContentmanagementWorkspaceMembersRequest request) throws IOException, ApiException
      Get a list workspace members
      Parameters:
      request - The request object
      Returns:
      WorkspaceMemberEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceMembers

      public ApiResponse<WorkspaceMemberEntityListing> getContentmanagementWorkspaceMembers(ApiRequest<Void> request) throws IOException
      Get a list workspace members
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceTagvalue

      public TagValue getContentmanagementWorkspaceTagvalue(String workspaceId, String tagId, List<String> expand) throws IOException, ApiException
      Get a workspace tag
      Parameters:
      workspaceId - Workspace ID (required)
      tagId - Tag ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      TagValue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceTagvalueWithHttpInfo

      public ApiResponse<TagValue> getContentmanagementWorkspaceTagvalueWithHttpInfo(String workspaceId, String tagId, List<String> expand) throws IOException
      Get a workspace tag
      Parameters:
      workspaceId - Workspace ID (required)
      tagId - Tag ID (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      TagValue
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceTagvalue

      public TagValue getContentmanagementWorkspaceTagvalue(GetContentmanagementWorkspaceTagvalueRequest request) throws IOException, ApiException
      Get a workspace tag
      Parameters:
      request - The request object
      Returns:
      TagValue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceTagvalue

      public ApiResponse<TagValue> getContentmanagementWorkspaceTagvalue(ApiRequest<Void> request) throws IOException
      Get a workspace tag
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceTagvalues

      public TagValueEntityListing getContentmanagementWorkspaceTagvalues(String workspaceId, String value, Integer pageSize, Integer pageNumber, List<String> expand) throws IOException, ApiException
      Get a list of workspace tags
      Parameters:
      workspaceId - Workspace ID (required)
      value - filter the list of tags returned (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      TagValueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceTagvaluesWithHttpInfo

      public ApiResponse<TagValueEntityListing> getContentmanagementWorkspaceTagvaluesWithHttpInfo(String workspaceId, String value, Integer pageSize, Integer pageNumber, List<String> expand) throws IOException
      Get a list of workspace tags
      Parameters:
      workspaceId - Workspace ID (required)
      value - filter the list of tags returned (optional)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      TagValueEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceTagvalues

      public TagValueEntityListing getContentmanagementWorkspaceTagvalues(GetContentmanagementWorkspaceTagvaluesRequest request) throws IOException, ApiException
      Get a list of workspace tags
      Parameters:
      request - The request object
      Returns:
      TagValueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaceTagvalues

      public ApiResponse<TagValueEntityListing> getContentmanagementWorkspaceTagvalues(ApiRequest<Void> request) throws IOException
      Get a list of workspace tags
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaces

      public WorkspaceEntityListing getContentmanagementWorkspaces(Integer pageSize, Integer pageNumber, List<String> access, List<String> expand) throws IOException, ApiException
      Get a list of workspaces. Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      access - Requested access level. (optional)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      WorkspaceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspacesWithHttpInfo

      public ApiResponse<WorkspaceEntityListing> getContentmanagementWorkspacesWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> access, List<String> expand) throws IOException
      Get a list of workspaces. Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      access - Requested access level. (optional)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      WorkspaceEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaces

      public WorkspaceEntityListing getContentmanagementWorkspaces(GetContentmanagementWorkspacesRequest request) throws IOException, ApiException
      Get a list of workspaces. Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
      Parameters:
      request - The request object
      Returns:
      WorkspaceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getContentmanagementWorkspaces

      public ApiResponse<WorkspaceEntityListing> getContentmanagementWorkspaces(ApiRequest<Void> request) throws IOException
      Get a list of workspaces. Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementDocument

      public Document postContentmanagementDocument(String documentId, DocumentUpdate body, String expand, Boolean override) throws IOException, ApiException
      Update a document.
      Parameters:
      documentId - Document ID (required)
      body - Document (required)
      expand - Expand some document fields (optional)
      override - Override any lock on the document (optional)
      Returns:
      Document
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementDocumentWithHttpInfo

      public ApiResponse<Document> postContentmanagementDocumentWithHttpInfo(String documentId, DocumentUpdate body, String expand, Boolean override) throws IOException
      Update a document.
      Parameters:
      documentId - Document ID (required)
      body - Document (required)
      expand - Expand some document fields (optional)
      override - Override any lock on the document (optional)
      Returns:
      Document
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementDocument

      public Document postContentmanagementDocument(PostContentmanagementDocumentRequest request) throws IOException, ApiException
      Update a document.
      Parameters:
      request - The request object
      Returns:
      Document
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementDocument

      public ApiResponse<Document> postContentmanagementDocument(ApiRequest<DocumentUpdate> request) throws IOException
      Update a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementDocumentContent

      public ReplaceResponse postContentmanagementDocumentContent(String documentId, ReplaceRequest body, Boolean override) throws IOException, ApiException
      Replace the contents of a document.
      Parameters:
      documentId - Document ID (required)
      body - Replace Request (required)
      override - Override any lock on the document (optional)
      Returns:
      ReplaceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementDocumentContentWithHttpInfo

      public ApiResponse<ReplaceResponse> postContentmanagementDocumentContentWithHttpInfo(String documentId, ReplaceRequest body, Boolean override) throws IOException
      Replace the contents of a document.
      Parameters:
      documentId - Document ID (required)
      body - Replace Request (required)
      override - Override any lock on the document (optional)
      Returns:
      ReplaceResponse
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementDocumentContent

      public ReplaceResponse postContentmanagementDocumentContent(PostContentmanagementDocumentContentRequest request) throws IOException, ApiException
      Replace the contents of a document.
      Parameters:
      request - The request object
      Returns:
      ReplaceResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementDocumentContent

      public ApiResponse<ReplaceResponse> postContentmanagementDocumentContent(ApiRequest<ReplaceRequest> request) throws IOException
      Replace the contents of a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementDocuments

      public Document postContentmanagementDocuments(DocumentUpload body, String copySource, String moveSource, Boolean override) throws IOException, ApiException
      Add a document.
      Parameters:
      body - Document (required)
      copySource - Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. (optional)
      moveSource - Move a document to a new workspace. Provide a document ID as the move source. (optional)
      override - Override any lock on the source document (optional)
      Returns:
      Document
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementDocumentsWithHttpInfo

      public ApiResponse<Document> postContentmanagementDocumentsWithHttpInfo(DocumentUpload body, String copySource, String moveSource, Boolean override) throws IOException
      Add a document.
      Parameters:
      body - Document (required)
      copySource - Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. (optional)
      moveSource - Move a document to a new workspace. Provide a document ID as the move source. (optional)
      override - Override any lock on the source document (optional)
      Returns:
      Document
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementDocuments

      public Document postContentmanagementDocuments(PostContentmanagementDocumentsRequest request) throws IOException, ApiException
      Add a document.
      Parameters:
      request - The request object
      Returns:
      Document
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementDocuments

      public ApiResponse<Document> postContentmanagementDocuments(ApiRequest<DocumentUpload> request) throws IOException
      Add a document.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementQuery

      public QueryResults postContentmanagementQuery(QueryRequest body, String expand) throws IOException, ApiException
      Query content
      Parameters:
      body - Allows for a filtered query returning facet information (required)
      expand - Expand some document fields (optional)
      Returns:
      QueryResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementQueryWithHttpInfo

      public ApiResponse<QueryResults> postContentmanagementQueryWithHttpInfo(QueryRequest body, String expand) throws IOException
      Query content
      Parameters:
      body - Allows for a filtered query returning facet information (required)
      expand - Expand some document fields (optional)
      Returns:
      QueryResults
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementQuery

      public QueryResults postContentmanagementQuery(PostContentmanagementQueryRequest request) throws IOException, ApiException
      Query content
      Parameters:
      request - The request object
      Returns:
      QueryResults
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementQuery

      public ApiResponse<QueryResults> postContentmanagementQuery(ApiRequest<QueryRequest> request) throws IOException
      Query content
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementShares

      public CreateShareResponse postContentmanagementShares(CreateShareRequest body) throws IOException, ApiException
      Creates a new share or updates an existing share if the entity has already been shared
      Parameters:
      body - CreateShareRequest - entity id and type and a single member or list of members are required (required)
      Returns:
      CreateShareResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementSharesWithHttpInfo

      public ApiResponse<CreateShareResponse> postContentmanagementSharesWithHttpInfo(CreateShareRequest body) throws IOException
      Creates a new share or updates an existing share if the entity has already been shared
      Parameters:
      body - CreateShareRequest - entity id and type and a single member or list of members are required (required)
      Returns:
      CreateShareResponse
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementShares

      public CreateShareResponse postContentmanagementShares(PostContentmanagementSharesRequest request) throws IOException, ApiException
      Creates a new share or updates an existing share if the entity has already been shared
      Parameters:
      request - The request object
      Returns:
      CreateShareResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementShares

      public ApiResponse<CreateShareResponse> postContentmanagementShares(ApiRequest<CreateShareRequest> request) throws IOException
      Creates a new share or updates an existing share if the entity has already been shared
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaceTagvalues

      public TagValue postContentmanagementWorkspaceTagvalues(String workspaceId, TagValue body) throws IOException, ApiException
      Create a workspace tag
      Parameters:
      workspaceId - Workspace ID (required)
      body - tag (required)
      Returns:
      TagValue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaceTagvaluesWithHttpInfo

      public ApiResponse<TagValue> postContentmanagementWorkspaceTagvaluesWithHttpInfo(String workspaceId, TagValue body) throws IOException
      Create a workspace tag
      Parameters:
      workspaceId - Workspace ID (required)
      body - tag (required)
      Returns:
      TagValue
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaceTagvalues

      public TagValue postContentmanagementWorkspaceTagvalues(PostContentmanagementWorkspaceTagvaluesRequest request) throws IOException, ApiException
      Create a workspace tag
      Parameters:
      request - The request object
      Returns:
      TagValue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaceTagvalues

      public ApiResponse<TagValue> postContentmanagementWorkspaceTagvalues(ApiRequest<TagValue> request) throws IOException
      Create a workspace tag
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaceTagvaluesQuery

      public TagValueEntityListing postContentmanagementWorkspaceTagvaluesQuery(String workspaceId, TagQueryRequest body, List<String> expand) throws IOException, ApiException
      Perform a prefix query on tags in the workspace
      Parameters:
      workspaceId - Workspace ID (required)
      body - query (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      TagValueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaceTagvaluesQueryWithHttpInfo

      public ApiResponse<TagValueEntityListing> postContentmanagementWorkspaceTagvaluesQueryWithHttpInfo(String workspaceId, TagQueryRequest body, List<String> expand) throws IOException
      Perform a prefix query on tags in the workspace
      Parameters:
      workspaceId - Workspace ID (required)
      body - query (required)
      expand - Which fields, if any, to expand. (optional)
      Returns:
      TagValueEntityListing
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaceTagvaluesQuery

      public TagValueEntityListing postContentmanagementWorkspaceTagvaluesQuery(PostContentmanagementWorkspaceTagvaluesQueryRequest request) throws IOException, ApiException
      Perform a prefix query on tags in the workspace
      Parameters:
      request - The request object
      Returns:
      TagValueEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaceTagvaluesQuery

      public ApiResponse<TagValueEntityListing> postContentmanagementWorkspaceTagvaluesQuery(ApiRequest<TagQueryRequest> request) throws IOException
      Perform a prefix query on tags in the workspace
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaces

      public Workspace postContentmanagementWorkspaces(WorkspaceCreate body) throws IOException, ApiException
      Create a group workspace
      Parameters:
      body - Workspace (required)
      Returns:
      Workspace
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementWorkspacesWithHttpInfo

      public ApiResponse<Workspace> postContentmanagementWorkspacesWithHttpInfo(WorkspaceCreate body) throws IOException
      Create a group workspace
      Parameters:
      body - Workspace (required)
      Returns:
      Workspace
      Throws:
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaces

      public Workspace postContentmanagementWorkspaces(PostContentmanagementWorkspacesRequest request) throws IOException, ApiException
      Create a group workspace
      Parameters:
      request - The request object
      Returns:
      Workspace
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postContentmanagementWorkspaces

      public ApiResponse<Workspace> postContentmanagementWorkspaces(ApiRequest<WorkspaceCreate> request) throws IOException
      Create a group workspace
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putContentmanagementWorkspace

      public Workspace putContentmanagementWorkspace(String workspaceId, Workspace body) throws IOException, ApiException
      Update a workspace
      Parameters:
      workspaceId - Workspace ID (required)
      body - Workspace (required)
      Returns:
      Workspace
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceWithHttpInfo

      public ApiResponse<Workspace> putContentmanagementWorkspaceWithHttpInfo(String workspaceId, Workspace body) throws IOException
      Update a workspace
      Parameters:
      workspaceId - Workspace ID (required)
      body - Workspace (required)
      Returns:
      Workspace
      Throws:
      IOException - if the request fails to be processed

    • putContentmanagementWorkspace

      public Workspace putContentmanagementWorkspace(PutContentmanagementWorkspaceRequest request) throws IOException, ApiException
      Update a workspace
      Parameters:
      request - The request object
      Returns:
      Workspace
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putContentmanagementWorkspace

      public ApiResponse<Workspace> putContentmanagementWorkspace(ApiRequest<Workspace> request) throws IOException
      Update a workspace
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceMember

      public WorkspaceMember putContentmanagementWorkspaceMember(String workspaceId, String memberId, WorkspaceMember body) throws IOException, ApiException
      Add a member to a workspace
      Parameters:
      workspaceId - Workspace ID (required)
      memberId - Member ID (required)
      body - Workspace Member (required)
      Returns:
      WorkspaceMember
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceMemberWithHttpInfo

      public ApiResponse<WorkspaceMember> putContentmanagementWorkspaceMemberWithHttpInfo(String workspaceId, String memberId, WorkspaceMember body) throws IOException
      Add a member to a workspace
      Parameters:
      workspaceId - Workspace ID (required)
      memberId - Member ID (required)
      body - Workspace Member (required)
      Returns:
      WorkspaceMember
      Throws:
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceMember

      public WorkspaceMember putContentmanagementWorkspaceMember(PutContentmanagementWorkspaceMemberRequest request) throws IOException, ApiException
      Add a member to a workspace
      Parameters:
      request - The request object
      Returns:
      WorkspaceMember
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceMember

      public ApiResponse<WorkspaceMember> putContentmanagementWorkspaceMember(ApiRequest<WorkspaceMember> request) throws IOException
      Add a member to a workspace
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceTagvalue

      public TagValue putContentmanagementWorkspaceTagvalue(String workspaceId, String tagId, TagValue body) throws IOException, ApiException
      Update a workspace tag. Will update all documents with the new tag value.
      Parameters:
      workspaceId - Workspace ID (required)
      tagId - Tag ID (required)
      body - Workspace (required)
      Returns:
      TagValue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceTagvalueWithHttpInfo

      public ApiResponse<TagValue> putContentmanagementWorkspaceTagvalueWithHttpInfo(String workspaceId, String tagId, TagValue body) throws IOException
      Update a workspace tag. Will update all documents with the new tag value.
      Parameters:
      workspaceId - Workspace ID (required)
      tagId - Tag ID (required)
      body - Workspace (required)
      Returns:
      TagValue
      Throws:
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceTagvalue

      public TagValue putContentmanagementWorkspaceTagvalue(PutContentmanagementWorkspaceTagvalueRequest request) throws IOException, ApiException
      Update a workspace tag. Will update all documents with the new tag value.
      Parameters:
      request - The request object
      Returns:
      TagValue
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putContentmanagementWorkspaceTagvalue

      public ApiResponse<TagValue> putContentmanagementWorkspaceTagvalue(ApiRequest<TagValue> request) throws IOException
      Update a workspace tag. Will update all documents with the new tag value.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed