docs/ContentManagementApi.md in purecloudplatformclientv2-34.0.0 vs docs/ContentManagementApi.md in purecloudplatformclientv2-35.0.0
- old
+ new
@@ -50,17 +50,23 @@
<a name="delete_contentmanagement_document"></a>
## - delete_contentmanagement_document(document_id, opts)
+
+
Delete a document.
Wraps DELETE /api/v2/contentmanagement/documents/{documentId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -112,17 +118,23 @@
<a name="delete_contentmanagement_share"></a>
## - delete_contentmanagement_share(share_id)
+
+
Deletes an existing share.
This revokes sharing rights specified in the share record
Wraps DELETE /api/v2/contentmanagement/shares/{shareId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -170,17 +182,23 @@
<a name="delete_contentmanagement_status_status_id"></a>
## - delete_contentmanagement_status_status_id(status_id)
+
+
Cancel the command for this status
Wraps DELETE /api/v2/contentmanagement/status/{statusId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -228,17 +246,23 @@
<a name="delete_contentmanagement_workspace"></a>
## - delete_contentmanagement_workspace(workspace_id, opts)
+
+
Delete a workspace
Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -290,17 +314,23 @@
<a name="delete_contentmanagement_workspace_member"></a>
## - delete_contentmanagement_workspace_member(workspace_id, member_id)
+
+
Delete a member from a workspace
Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -351,17 +381,23 @@
<a name="delete_contentmanagement_workspace_tagvalue"></a>
## - delete_contentmanagement_workspace_tagvalue(workspace_id, tag_id)
+
+
Delete workspace tag
Delete a tag from a workspace. Will remove this tag from all documents.
Wraps DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -412,17 +448,23 @@
<a name="get_contentmanagement_document"></a>
## -[**Document**](Document.html) get_contentmanagement_document(document_id, opts)
+
+
Get a document.
Wraps GET /api/v2/contentmanagement/documents/{documentId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -475,17 +517,23 @@
<a name="get_contentmanagement_document_audits"></a>
## -[**DocumentAuditEntityListing**](DocumentAuditEntityListing.html) get_contentmanagement_document_audits(document_id, opts)
+
+
Get a list of audits for a document.
Wraps GET /api/v2/contentmanagement/documents/{documentId}/audits
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -548,17 +596,23 @@
<a name="get_contentmanagement_document_content"></a>
## -[**DownloadResponse**](DownloadResponse.html) get_contentmanagement_document_content(document_id, opts)
+
+
Download a document.
Wraps GET /api/v2/contentmanagement/documents/{documentId}/content
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -613,17 +667,23 @@
<a name="get_contentmanagement_documents"></a>
## -[**DocumentEntityListing**](DocumentEntityListing.html) get_contentmanagement_documents(workspace_id, opts)
+<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
+
Get a list of documents.
Wraps GET /api/v2/contentmanagement/documents
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -686,17 +746,23 @@
<a name="get_contentmanagement_query"></a>
## -[**QueryResults**](QueryResults.html) get_contentmanagement_query(query_phrase, opts)
+
+
Query content
Wraps GET /api/v2/contentmanagement/query
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -757,17 +823,23 @@
<a name="get_contentmanagement_securityprofile"></a>
## -[**SecurityProfile**](SecurityProfile.html) get_contentmanagement_securityprofile(security_profile_id)
+
+
Get a Security Profile
Wraps GET /api/v2/contentmanagement/securityprofiles/{securityProfileId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -816,17 +888,23 @@
<a name="get_contentmanagement_securityprofiles"></a>
## -[**SecurityProfileEntityListing**](SecurityProfileEntityListing.html) get_contentmanagement_securityprofiles
+
+
Get a List of Security Profiles
Wraps GET /api/v2/contentmanagement/securityprofiles
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -869,17 +947,23 @@
<a name="get_contentmanagement_share"></a>
## -[**Share**](Share.html) get_contentmanagement_share(share_id, opts)
+
+
Retrieve details about an existing share.
Wraps GET /api/v2/contentmanagement/shares/{shareId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -932,17 +1016,23 @@
<a name="get_contentmanagement_shared_shared_id"></a>
## -[**SharedResponse**](SharedResponse.html) get_contentmanagement_shared_shared_id(shared_id, opts)
+
+
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.
Wraps GET /api/v2/contentmanagement/shared/{sharedId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1001,17 +1091,23 @@
<a name="get_contentmanagement_shares"></a>
## -[**ShareEntityListing**](ShareEntityListing.html) get_contentmanagement_shares(opts)
+
+
Gets a list of shares. You must specify at least one filter (e.g. entityId).
Failing to specify a filter will return 400.
Wraps GET /api/v2/contentmanagement/shares
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1067,17 +1163,23 @@
<a name="get_contentmanagement_status"></a>
## -[**CommandStatusEntityListing**](CommandStatusEntityListing.html) get_contentmanagement_status(opts)
+
+
Get a list of statuses for pending operations
Wraps GET /api/v2/contentmanagement/status
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1129,17 +1231,23 @@
<a name="get_contentmanagement_status_status_id"></a>
## -[**CommandStatus**](CommandStatus.html) get_contentmanagement_status_status_id(status_id)
+
+
Get a status.
Wraps GET /api/v2/contentmanagement/status/{statusId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1188,17 +1296,23 @@
<a name="get_contentmanagement_usage"></a>
## -[**Usage**](Usage.html) get_contentmanagement_usage
+
+
Get usage details.
Wraps GET /api/v2/contentmanagement/usage
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1241,17 +1355,23 @@
<a name="get_contentmanagement_workspace"></a>
## -[**Workspace**](Workspace.html) get_contentmanagement_workspace(workspace_id, opts)
+
+
Get a workspace.
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1304,17 +1424,23 @@
<a name="get_contentmanagement_workspace_documents"></a>
## -[**DocumentEntityListing**](DocumentEntityListing.html) get_contentmanagement_workspace_documents(workspace_id, opts)
+
+
Get a list of documents.
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1375,17 +1501,23 @@
<a name="get_contentmanagement_workspace_member"></a>
## -[**WorkspaceMember**](WorkspaceMember.html) get_contentmanagement_workspace_member(workspace_id, member_id, opts)
+
+
Get a workspace member
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1441,17 +1573,23 @@
<a name="get_contentmanagement_workspace_members"></a>
## -[**WorkspaceMemberEntityListing**](WorkspaceMemberEntityListing.html) get_contentmanagement_workspace_members(workspace_id, opts)
+
+
Get a list workspace members
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/members
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1508,17 +1646,23 @@
<a name="get_contentmanagement_workspace_tagvalue"></a>
## -[**TagValue**](TagValue.html) get_contentmanagement_workspace_tagvalue(workspace_id, tag_id, opts)
+
+
Get a workspace tag
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1574,17 +1718,23 @@
<a name="get_contentmanagement_workspace_tagvalues"></a>
## -[**TagValueEntityListing**](TagValueEntityListing.html) get_contentmanagement_workspace_tagvalues(workspace_id, opts)
+
+
Get a list of workspace tags
Wraps GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1643,17 +1793,23 @@
<a name="get_contentmanagement_workspaces"></a>
## -[**WorkspaceEntityListing**](WorkspaceEntityListing.html) get_contentmanagement_workspaces(opts)
+
+
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.
Wraps GET /api/v2/contentmanagement/workspaces
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1709,17 +1865,23 @@
<a name="post_contentmanagement_auditquery"></a>
## -[**QueryResults**](QueryResults.html) post_contentmanagement_auditquery(body)
+
+
Query audits
Wraps POST /api/v2/contentmanagement/auditquery
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1768,17 +1930,23 @@
<a name="post_contentmanagement_document"></a>
## -[**Document**](Document.html) post_contentmanagement_document(document_id, body, opts)
+
+
Update a document.
Wraps POST /api/v2/contentmanagement/documents/{documentId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1836,17 +2004,23 @@
<a name="post_contentmanagement_document_content"></a>
## -[**ReplaceResponse**](ReplaceResponse.html) post_contentmanagement_document_content(document_id, body, opts)
+
+
Replace the contents of a document.
Wraps POST /api/v2/contentmanagement/documents/{documentId}/content
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1902,17 +2076,23 @@
<a name="post_contentmanagement_documents"></a>
## -[**Document**](Document.html) post_contentmanagement_documents(body, opts)
+
+
Add a document.
Wraps POST /api/v2/contentmanagement/documents
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -1969,17 +2149,23 @@
<a name="post_contentmanagement_query"></a>
## -[**QueryResults**](QueryResults.html) post_contentmanagement_query(body, opts)
+
+
Query content
Wraps POST /api/v2/contentmanagement/query
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2032,17 +2218,23 @@
<a name="post_contentmanagement_shares"></a>
## -[**CreateShareResponse**](CreateShareResponse.html) post_contentmanagement_shares(body)
+
+
Creates a new share or updates an existing share if the entity has already been shared
Wraps POST /api/v2/contentmanagement/shares
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2091,17 +2283,23 @@
<a name="post_contentmanagement_workspace_tagvalues"></a>
## -[**TagValue**](TagValue.html) post_contentmanagement_workspace_tagvalues(workspace_id, body)
+
+
Create a workspace tag
Wraps POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2153,17 +2351,23 @@
<a name="post_contentmanagement_workspace_tagvalues_query"></a>
## -[**TagValueEntityListing**](TagValueEntityListing.html) post_contentmanagement_workspace_tagvalues_query(workspace_id, body, opts)
+
+
Perform a prefix query on tags in the workspace
Wraps POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2219,17 +2423,23 @@
<a name="post_contentmanagement_workspaces"></a>
## -[**Workspace**](Workspace.html) post_contentmanagement_workspaces(body)
+
+
Create a group workspace
Wraps POST /api/v2/contentmanagement/workspaces
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2278,17 +2488,23 @@
<a name="put_contentmanagement_workspace"></a>
## -[**Workspace**](Workspace.html) put_contentmanagement_workspace(workspace_id, body)
+
+
Update a workspace
Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2340,17 +2556,23 @@
<a name="put_contentmanagement_workspace_member"></a>
## -[**WorkspaceMember**](WorkspaceMember.html) put_contentmanagement_workspace_member(workspace_id, member_id, body)
+
+
Add a member to a workspace
Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}
+Requires NO permissions:
+
+
+
### Example
~~~ruby
# load the gem
require 'purecloudplatformclientv2'
# setup authorization
@@ -2405,14 +2627,20 @@
<a name="put_contentmanagement_workspace_tagvalue"></a>
## -[**TagValue**](TagValue.html) put_contentmanagement_workspace_tagvalue(workspace_id, tag_id, body)
+
+
Update a workspace tag. Will update all documents with the new tag value.
Wraps PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}
+
+Requires NO permissions:
+
+
### Example
~~~ruby
# load the gem