docs/ContentManagementApi.md in purecloudplatformclientv2-8.0.0 vs docs/ContentManagementApi.md in purecloudplatformclientv2-9.0.0

- old
+ new

@@ -92,12 +92,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **document_id** | **String**| Document ID | - **override** | **BOOLEAN**| Override any lock on the document | [optional] + **document_id** | **String**| Document ID | | + **override** | **BOOLEAN**| Override any lock on the document | [optional] | {: class="table table-striped"} ### Return type @@ -151,11 +151,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **share_id** | **String**| Share ID | + **share_id** | **String**| Share ID | | {: class="table table-striped"} ### Return type @@ -209,11 +209,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status_id** | **String**| Status ID | + **status_id** | **String**| Status ID | | {: class="table table-striped"} ### Return type @@ -270,12 +270,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **move_children_to_workspace_id** | **String**| New location for objects in deleted workspace. | [optional] + **workspace_id** | **String**| Workspace ID | | + **move_children_to_workspace_id** | **String**| New location for objects in deleted workspace. | [optional] | {: class="table table-striped"} ### Return type @@ -331,12 +331,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **member_id** | **String**| Member ID | + **workspace_id** | **String**| Workspace ID | | + **member_id** | **String**| Member ID | | {: class="table table-striped"} ### Return type @@ -392,12 +392,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **tag_id** | **String**| Tag ID | + **workspace_id** | **String**| Workspace ID | | + **tag_id** | **String**| Tag ID | | {: class="table table-striped"} ### Return type @@ -455,12 +455,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **document_id** | **String**| Document ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **document_id** | **String**| Document ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: lockInfo, acl, workspace | {: class="table table-striped"} ### Return type @@ -523,17 +523,17 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **document_id** | **String**| Document ID | - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] - **transaction_filter** | **String**| Transaction filter | [optional] - **level** | **String**| level | [optional] [default to USER] - **sort_by** | **String**| Sort by | [optional] - **sort_order** | **String**| Sort order | [optional] [default to ascending] + **document_id** | **String**| Document ID | | + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **transaction_filter** | **String**| Transaction filter | [optional] | + **level** | **String**| level | [optional] [default to USER] | + **sort_by** | **String**| Sort by | [optional] | + **sort_order** | **String**| Sort order | [optional] [default to ascending] | {: class="table table-striped"} ### Return type @@ -592,13 +592,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **document_id** | **String**| Document ID | - **disposition** | **String**| Request how the content will be downloaded: a file attachment or inline. Default is attachment. | [optional] - **content_type** | **String**| The requested format for the specified document. If supported, the document will be returned in that format. Example contentType&#x3D;audio/wav | [optional] + **document_id** | **String**| Document ID | | + **disposition** | **String**| Request how the content will be downloaded: a file attachment or inline. Default is attachment. | [optional] <br />**Values**: attachment, inline | + **content_type** | **String**| The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav | [optional] | {: class="table table-striped"} ### Return type @@ -661,17 +661,17 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **name** | **String**| Name | [optional] - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] - **sort_by** | **String**| name or dateCreated | [optional] - **sort_order** | **String**| ascending or descending | [optional] [default to ascending] + **workspace_id** | **String**| Workspace ID | | + **name** | **String**| Name | [optional] | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: acl, workspace | + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **sort_by** | **String**| name or dateCreated | [optional] | + **sort_order** | **String**| ascending or descending | [optional] [default to ascending] | {: class="table table-striped"} ### Return type @@ -733,16 +733,16 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query_phrase** | **String**| Phrase tokens are ANDed together over all searchable fields | - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] - **sort_by** | **String**| name or dateCreated | [optional] [default to name] - **sort_order** | **String**| ascending or descending | [optional] [default to ascending] - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **query_phrase** | **String**| Phrase tokens are ANDed together over all searchable fields | | + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **sort_by** | **String**| name or dateCreated | [optional] [default to name] | + **sort_order** | **String**| ascending or descending | [optional] [default to ascending] | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: acl, workspace | {: class="table table-striped"} ### Return type @@ -797,11 +797,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **security_profile_id** | **String**| Security Profile Id | + **security_profile_id** | **String**| Security Profile Id | | {: class="table table-striped"} ### Return type @@ -912,12 +912,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **share_id** | **String**| Share ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **share_id** | **String**| Share ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: member | {: class="table table-striped"} ### Return type @@ -978,15 +978,15 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **shared_id** | **String**| Shared ID | - **redirect** | **BOOLEAN**| Turn on or off redirect | [optional] [default to true] - **disposition** | **String**| Request how the share content will be downloaded: attached as a file or inline. Default is attachment. | [optional] [default to attachment] - **content_type** | **String**| The requested format for the specified document. If supported, the document will be returned in that format. Example contentType&#x3D;audio/wav | [optional] - **expand** | **String**| Expand some document fields | [optional] + **shared_id** | **String**| Shared ID | | + **redirect** | **BOOLEAN**| Turn on or off redirect | [optional] [default to true] | + **disposition** | **String**| Request how the share content will be downloaded: attached as a file or inline. Default is attachment. | [optional] [default to attachment]<br />**Values**: attachment, inline, none | + **content_type** | **String**| The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav | [optional] | + **expand** | **String**| Expand some document fields | [optional] <br />**Values**: document.acl | {: class="table table-striped"} ### Return type @@ -1045,14 +1045,14 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **entity_id** | **String**| Filters the shares returned to only the entity specified by the value of this parameter. | [optional] - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] + **entity_id** | **String**| Filters the shares returned to only the entity specified by the value of this parameter. | [optional] | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: member | + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | {: class="table table-striped"} ### Return type @@ -1109,12 +1109,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | {: class="table table-striped"} ### Return type @@ -1169,11 +1169,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status_id** | **String**| Status ID | + **status_id** | **String**| Status ID | | {: class="table table-striped"} ### Return type @@ -1284,12 +1284,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **workspace_id** | **String**| Workspace ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: summary, acl | {: class="table table-striped"} ### Return type @@ -1351,16 +1351,16 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] - **sort_by** | **String**| name or dateCreated | [optional] - **sort_order** | **String**| ascending or descending | [optional] [default to ascending] + **workspace_id** | **String**| Workspace ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: acl, workspace | + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **sort_by** | **String**| name or dateCreated | [optional] | + **sort_order** | **String**| ascending or descending | [optional] [default to ascending] | {: class="table table-striped"} ### Return type @@ -1420,13 +1420,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **member_id** | **String**| Member ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **workspace_id** | **String**| Workspace ID | | + **member_id** | **String**| Member ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: member | {: class="table table-striped"} ### Return type @@ -1486,14 +1486,14 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **workspace_id** | **String**| Workspace ID | | + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: member | {: class="table table-striped"} ### Return type @@ -1553,13 +1553,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **tag_id** | **String**| Tag ID | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **workspace_id** | **String**| Workspace ID | | + **tag_id** | **String**| Tag ID | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: acl | {: class="table table-striped"} ### Return type @@ -1620,15 +1620,15 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **value** | **String**| filter the list of tags returned | [optional] - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **workspace_id** | **String**| Workspace ID | | + **value** | **String**| filter the list of tags returned | [optional] | + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: acl | {: class="table table-striped"} ### Return type @@ -1687,14 +1687,14 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_size** | **Integer**| Page size | [optional] [default to 25] - **page_number** | **Integer**| Page number | [optional] [default to 1] - **access** | [**Array&lt;String&gt;**](String.html)| Requested access level. | [optional] - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **access** | [**Array&lt;String&gt;**](String.html)| Requested access level. | [optional] <br />**Values**: content, admin, document:create, document:viewContent, document:viewMetadata, document:download, document:delete, document:update, document:share, document:shareView, document:email, document:print, document:auditView, document:replace, document:tag, tag:create, tag:view, tag:update, tag:apply, tag:remove, tag:delete | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: summary, acl | {: class="table table-striped"} ### Return type @@ -1749,11 +1749,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**ContentQueryRequest**](ContentQueryRequest.html)| Allows for a filtered query returning facet information | + **body** | [**ContentQueryRequest**](ContentQueryRequest.html)| Allows for a filtered query returning facet information | | {: class="table table-striped"} ### Return type @@ -1814,14 +1814,14 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **document_id** | **String**| Document ID | - **body** | [**DocumentUpdate**](DocumentUpdate.html)| Document | - **expand** | **String**| Expand some document fields | [optional] - **override** | **BOOLEAN**| Override any lock on the document | [optional] + **document_id** | **String**| Document ID | | + **body** | [**DocumentUpdate**](DocumentUpdate.html)| Document | | + **expand** | **String**| Expand some document fields | [optional] <br />**Values**: acl | + **override** | **BOOLEAN**| Override any lock on the document | [optional] | {: class="table table-striped"} ### Return type @@ -1881,13 +1881,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **document_id** | **String**| Document ID | - **body** | [**ReplaceRequest**](ReplaceRequest.html)| Replace Request | - **override** | **BOOLEAN**| Override any lock on the document | [optional] + **document_id** | **String**| Document ID | | + **body** | [**ReplaceRequest**](ReplaceRequest.html)| Replace Request | | + **override** | **BOOLEAN**| Override any lock on the document | [optional] | {: class="table table-striped"} ### Return type @@ -1947,14 +1947,14 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**DocumentUpload**](DocumentUpload.html)| Document | - **copy_source** | **String**| Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. | [optional] - **move_source** | **String**| Move a document to a new workspace. Provide a document ID as the move source. | [optional] - **override** | **BOOLEAN**| Override any lock on the source document | [optional] + **body** | [**DocumentUpload**](DocumentUpload.html)| Document | | + **copy_source** | **String**| Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. | [optional] | + **move_source** | **String**| Move a document to a new workspace. Provide a document ID as the move source. | [optional] | + **override** | **BOOLEAN**| Override any lock on the source document | [optional] | {: class="table table-striped"} ### Return type @@ -2012,12 +2012,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**QueryRequest**](QueryRequest.html)| Allows for a filtered query returning facet information | - **expand** | **String**| Expand some document fields | [optional] + **body** | [**QueryRequest**](QueryRequest.html)| Allows for a filtered query returning facet information | | + **expand** | **String**| Expand some document fields | [optional] <br />**Values**: acl, workspace | {: class="table table-striped"} ### Return type @@ -2072,11 +2072,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**CreateShareRequest**](CreateShareRequest.html)| CreateShareRequest - entity id and type and a single member or list of members are required | + **body** | [**CreateShareRequest**](CreateShareRequest.html)| CreateShareRequest - entity id and type and a single member or list of members are required | | {: class="table table-striped"} ### Return type @@ -2133,12 +2133,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **body** | [**TagValue**](TagValue.html)| tag | + **workspace_id** | **String**| Workspace ID | | + **body** | [**TagValue**](TagValue.html)| tag | | {: class="table table-striped"} ### Return type @@ -2198,13 +2198,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **body** | [**TagQueryRequest**](TagQueryRequest.html)| query | - **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] + **workspace_id** | **String**| Workspace ID | | + **body** | [**TagQueryRequest**](TagQueryRequest.html)| query | | + **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: acl | {: class="table table-striped"} ### Return type @@ -2259,11 +2259,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**WorkspaceCreate**](WorkspaceCreate.html)| Workspace | + **body** | [**WorkspaceCreate**](WorkspaceCreate.html)| Workspace | | {: class="table table-striped"} ### Return type @@ -2320,12 +2320,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **body** | [**Workspace**](Workspace.html)| Workspace | + **workspace_id** | **String**| Workspace ID | | + **body** | [**Workspace**](Workspace.html)| Workspace | | {: class="table table-striped"} ### Return type @@ -2384,13 +2384,13 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **member_id** | **String**| Member ID | - **body** | [**WorkspaceMember**](WorkspaceMember.html)| Workspace Member | + **workspace_id** | **String**| Workspace ID | | + **member_id** | **String**| Member ID | | + **body** | [**WorkspaceMember**](WorkspaceMember.html)| Workspace Member | | {: class="table table-striped"} ### Return type @@ -2449,12 +2449,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **String**| Workspace ID | - **tag_id** | **String**| Tag ID | - **body** | [**TagValue**](TagValue.html)| Workspace | + **workspace_id** | **String**| Workspace ID | | + **tag_id** | **String**| Tag ID | | + **body** | [**TagValue**](TagValue.html)| Workspace | | {: class="table table-striped"} ### Return type