/genesys-content | Type: Application | PCID required: Yes
Tools
genesys_content_delete_contentmanagement_document
Delete a document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | string | Yes | — | Document ID |
override | boolean | No | — | Override any lock on the document |
genesys_content_delete_contentmanagement_share
Deletes an existing share. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shareId | string | Yes | — | Share ID |
genesys_content_delete_contentmanagement_status_status_id
Cancel the command for this status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
statusId | string | Yes | — | Status ID |
genesys_content_delete_contentmanagement_workspace
Delete a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
moveChildrenToWorkspaceId | string | No | — | New location for objects in deleted workspace. |
genesys_content_delete_contentmanagement_workspace_member
Delete a member from a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
memberId | string | Yes | — | Member ID |
genesys_content_delete_contentmanagement_workspace_tagvalue
Delete workspace tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
tagId | string | Yes | — | Tag ID |
genesys_content_delete_responsemanagement_library
Delete an existing response library. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
libraryId | string | Yes | — | Library ID |
genesys_content_delete_responsemanagement_response
Delete an existing response. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
responseId | string | Yes | — | Response ID |
genesys_content_delete_responsemanagement_responseasset
Delete response asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
responseAssetId | string | Yes | — | Asset Id |
genesys_content_get_contentmanagement_document
Get a document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | string | Yes | — | Document ID |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_contentmanagement_document_content
Download a document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | string | Yes | — | Document ID |
disposition | string | No | — | Request how the content will be downloaded: a file attachment or inline. Default is attachment. |
contentType | string | No | — | The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav |
genesys_content_get_contentmanagement_query
Query content Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortBy | string | No | — | name or dateCreated |
sortOrder | string | No | — | ascending or descending |
queryPhrase | string | Yes | — | Phrase tokens are ANDed together over all searchable fields |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_contentmanagement_securityprofile
Get a Security Profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
securityProfileId | string | Yes | — | Security Profile Id |
genesys_content_get_contentmanagement_securityprofiles
Get a List of Security Profilesgenesys_content_get_contentmanagement_share
Retrieve details about an existing share. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shareId | string | Yes | — | Share ID |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_contentmanagement_shared_shared_id
Get shared documents. Securely download a shared document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sharedId | string | Yes | — | Shared ID |
disposition | string | No | — | Request how the share content will be downloaded: attached as a file or inline. Default is attachment. |
contentType | string | No | — | The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav |
expand | string | No | — | Expand some document fields |
genesys_content_get_contentmanagement_shares
Gets a list of shares. You must specify at least one filter (e.g. entityId). Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
entityId | string | No | — | Filters the shares returned to only the entity specified by the value of this parameter. |
expand | any[] | No | — | Which fields, if any, to expand. |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
genesys_content_get_contentmanagement_status
Get a list of statuses for pending operations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
genesys_content_get_contentmanagement_status_status_id
Get a status. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
statusId | string | Yes | — | Status ID |
genesys_content_get_contentmanagement_usage
Get usage details.genesys_content_get_contentmanagement_workspace
Get a workspace. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_contentmanagement_workspace_documents
Get a list of documents. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
expand | any[] | No | — | Which fields, if any, to expand. |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortBy | string | No | — | name or dateCreated |
sortOrder | string | No | — | ascending or descending |
genesys_content_get_contentmanagement_workspace_member
Get a workspace member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
memberId | string | Yes | — | Member ID |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_contentmanagement_workspace_members
Get a list workspace members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_contentmanagement_workspace_tagvalue
Get a workspace tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
tagId | string | Yes | — | Tag ID |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_contentmanagement_workspace_tagvalues
Get a list of workspace tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
value | string | No | — | filter the list of tags returned |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_contentmanagement_workspaces
Get a list of workspaces. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
access | any[] | No | — | Requested access level. |
expand | any[] | No | — | Which fields, if any, to expand. |
genesys_content_get_responsemanagement_libraries
Gets a list of existing response libraries. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
messagingTemplateFilter | string | No | — | Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel |
libraryPrefix | string | No | — | Returns a list of libraries that contain the prefix provided |
genesys_content_get_responsemanagement_library
Get details about an existing response library. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
libraryId | string | Yes | — | Library ID |
genesys_content_get_responsemanagement_response
Get details about an existing response. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
responseId | string | Yes | — | Response ID |
expand | string | No | — | Expand instructions for the return value. |
genesys_content_get_responsemanagement_responseasset
Get response asset information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
responseAssetId | string | Yes | — | Asset Id |
genesys_content_get_responsemanagement_responseassets_status_status_id
Get response asset upload status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
statusId | string | Yes | — | Status Id |
genesys_content_get_responsemanagement_responses
Gets a list of existing responses. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
libraryId | string | Yes | — | Library ID |
pageNumber | integer | No | — | Page number |
pageSize | integer | No | — | Page size |
expand | string | No | — | Expand instructions for the return value. |
genesys_content_post_contentmanagement_document
Update a document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | string | Yes | — | Document ID |
expand | string | No | — | Expand some document fields |
override | boolean | No | — | Override any lock on the document |
addTagIds | any[] | No | — | addTagIds |
addTags | any[] | No | — | addTags |
changeNumber | integer | No | — | changeNumber |
name | string | Yes | — | The name of the document |
read | boolean | No | — | read |
removeAttributes | any[] | No | — | removeAttributes |
removeTagIds | any[] | No | — | removeTagIds |
removeTags | any[] | No | — | removeTags |
updateAttributes | any[] | No | — | updateAttributes |
genesys_content_post_contentmanagement_document_content
Replace the contents of a document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | string | Yes | — | Document ID |
override | boolean | No | — | Override any lock on the document |
authToken | string | No | — | authToken |
changeNumber | integer | No | — | changeNumber |
name | string | No | — | name |
genesys_content_post_contentmanagement_documents
Add a document. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
copySource | string | No | — | Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. |
moveSource | string | No | — | Move a document to a new workspace. Provide a document ID as the move source. |
override | boolean | No | — | Override any lock on the source document |
name | string | Yes | — | The name of the document |
tagIds | any[] | No | — | tagIds |
tags | any[] | No | — | tags |
workspace | object | Yes | — | workspace |
genesys_content_post_contentmanagement_query
Query content Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string | No | — | Expand some document fields |
attributeFilters | any[] | No | — | attributeFilters |
facetNameRequests | any[] | No | — | facetNameRequests |
filters | any[] | No | — | filters |
includeShares | boolean | No | — | includeShares |
pageNumber | integer | No | — | pageNumber |
pageSize | integer | No | — | pageSize |
queryPhrase | string | No | — | queryPhrase |
sort | any[] | No | — | sort |
genesys_content_post_contentmanagement_shares
Creates a new share or updates an existing share if the entity has already been shared Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
member | object | No | — | member |
members | any[] | No | — | members |
memberType | string | No | — | memberType |
sharedEntity | object | Yes | — | sharedEntity |
sharedEntityType | string | Yes | — | The share entity type |
genesys_content_post_contentmanagement_workspace_tagvalues
Create a workspace tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
acl | any[] | No | — | acl |
id | string | No | — | The globally unique identifier for the object. |
inUse | boolean | No | — | inUse |
name | string | Yes | — | The workspace tag name. |
selfUri | string | No | — | The URI for this object |
genesys_content_post_contentmanagement_workspace_tagvalues_query
Perform a prefix query on tags in the workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
expand | any[] | No | — | Which fields, if any, to expand. |
pageNumber | integer | No | — | pageNumber |
pageSize | integer | No | — | pageSize |
query | string | No | — | query |
genesys_content_post_contentmanagement_workspaces
Create a group workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bucket | string | No | — | bucket |
description | string | No | — | description |
name | string | Yes | — | The workspace name |
genesys_content_post_responsemanagement_libraries
Create a response library. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
createdBy | object | No | — | createdBy |
dateCreated | string | No | — | The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
id | string | No | — | The globally unique identifier for the object. |
name | string | Yes | — | The library name. |
responseType | string | No | — | This value is deprecated. Responses representing message templates may be added to any library. |
selfUri | string | No | — | The URI for this object |
version | integer | No | — | Current version for this resource. |
genesys_content_post_responsemanagement_responseassets_search
Search response assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | any[] | No | — | Which fields, if any, to expand |
pageNumber | integer | No | — | The page of resources you want to retrieve |
pageSize | integer | No | — | The number of results per page. Default: 25, Maximum: 100. |
query | any[] | Yes | — | Filter the query results. |
sortBy | string | No | — | The field in the resource that you want to sort the results by |
sortOrder | string | No | — | The sort order for results |
genesys_content_post_responsemanagement_responseassets_uploads
Creates pre-signed url for uploading response asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contentMd5 | string | No | — | Content MD-5 of the file to upload |
divisionId | string | No | — | Division to associate to this asset. Can only be used with this division. |
name | string | Yes | — | Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: {^}%`]”>[~<#| |
genesys_content_post_responsemanagement_responses
Create a response. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string | No | — | Expand instructions for the return value. |
assets | any[] | No | — | Assets used in the response |
createdBy | object | No | — | createdBy |
dateCreated | string | No | — | The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
footer | object | No | — | The Footer template identifies the Footer type and its footerUsage |
id | string | No | — | The globally unique identifier for the object. |
interactionType | string | No | — | The interaction type for this response. |
libraries | any[] | Yes | — | One or more libraries response is associated with. |
messagingTemplate | object | No | — | The messaging template identifies a structured message templates supported by a messaging channel. |
name | string | No | — | name |
responseType | string | No | — | The response type represented by the response. |
selfUri | string | No | — | The URI for this object |
substitutions | any[] | No | — | Details about any text substitutions used in the texts for this response. |
substitutionsSchema | object | No | — | A JSON Schema document. |
texts | any[] | Yes | — | One or more texts associated with the response. |
version | integer | No | — | Version number required for updates. |
genesys_content_post_responsemanagement_responses_query
Query responses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filters | any[] | No | — | Filter the query results. |
pageNumber | integer | No | — | Page Number |
pageSize | integer | No | — | The maximum number of hits to return. Default: 25, Maximum: 500. |
queryPhrase | string | No | — | Query phrase to search response text and name. If not set will match all. |
genesys_content_put_contentmanagement_workspace
Update a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
acl | any[] | No | — | acl |
bucket | string | No | — | bucket |
dateCreated | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateModified | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | No | — | description |
id | string | No | — | The globally unique identifier for the object. |
isCurrentUserWorkspace | boolean | No | — | isCurrentUserWorkspace |
name | string | Yes | — | The current name of the workspace. |
selfUri | string | No | — | The URI for this object |
summary | object | No | — | summary |
type | string | No | — | type |
user | object | No | — | user |
genesys_content_put_contentmanagement_workspace_member
Add a member to a workspace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
memberId | string | Yes | — | Member ID |
group | object | No | — | group |
id | string | No | — | The globally unique identifier for the object. |
member | object | No | — | member |
memberType | string | Yes | — | The workspace member type. |
name | string | No | — | name |
securityProfile | object | No | — | securityProfile |
selfUri | string | No | — | The URI for this object |
user | object | No | — | user |
workspace | object | No | — | workspace |
genesys_content_put_contentmanagement_workspace_tagvalue
Update a workspace tag. Will update all documents with the new tag value. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | Workspace ID |
tagId | string | Yes | — | Tag ID |
acl | any[] | No | — | acl |
id | string | No | — | The globally unique identifier for the object. |
inUse | boolean | No | — | inUse |
name | string | Yes | — | The workspace tag name. |
selfUri | string | No | — | The URI for this object |
genesys_content_put_responsemanagement_library
Update an existing response library. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
libraryId | string | Yes | — | Library ID |
createdBy | object | No | — | createdBy |
dateCreated | string | No | — | The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
id | string | No | — | The globally unique identifier for the object. |
name | string | Yes | — | The library name. |
responseType | string | No | — | This value is deprecated. Responses representing message templates may be added to any library. |
selfUri | string | No | — | The URI for this object |
version | integer | No | — | Current version for this resource. |
genesys_content_put_responsemanagement_response
Update an existing response. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
responseId | string | Yes | — | Response ID |
expand | string | No | — | Expand instructions for the return value. |
assets | any[] | No | — | Assets used in the response |
createdBy | object | No | — | createdBy |
dateCreated | string | No | — | The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
footer | object | No | — | The Footer template identifies the Footer type and its footerUsage |
id | string | No | — | The globally unique identifier for the object. |
interactionType | string | No | — | The interaction type for this response. |
libraries | any[] | Yes | — | One or more libraries response is associated with. |
messagingTemplate | object | No | — | The messaging template identifies a structured message templates supported by a messaging channel. |
name | string | No | — | name |
responseType | string | No | — | The response type represented by the response. |
selfUri | string | No | — | The URI for this object |
substitutions | any[] | No | — | Details about any text substitutions used in the texts for this response. |
substitutionsSchema | object | No | — | A JSON Schema document. |
texts | any[] | Yes | — | One or more texts associated with the response. |
version | integer | No | — | Version number required for updates. |
genesys_content_put_responsemanagement_responseasset
Update response asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
responseAssetId | string | Yes | — | Asset Id |
divisionId | string | No | — | Division to associate to this asset. Can only be used with this division. |
name | string | Yes | — | Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: {^}%`]”>[~<#| |

