> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# genesys-tasks-quality
> Genesys Tasks & Quality - workitem lifecycle, workbins, worktypes, evaluations, surveys, and scoring
**Server path:** `/genesys-tasks-quality` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`genesys_tasks_quality_delete_conversation_evaluation`](#genesys_tasks_quality_delete_conversation_evaluation) | Delete an evaluation |
| [`genesys_tasks_quality_delete_forms_evaluation`](#genesys_tasks_quality_delete_forms_evaluation) | Delete an evaluation form. |
| [`genesys_tasks_quality_delete_forms_survey`](#genesys_tasks_quality_delete_forms_survey) | Delete a survey form. |
| [`genesys_tasks_quality_delete_program_agentscoringrule`](#genesys_tasks_quality_delete_program_agentscoringrule) | Delete an Agent Scoring Rule |
| [`genesys_tasks_quality_delete_taskmanagement_workitem`](#genesys_tasks_quality_delete_taskmanagement_workitem) | Delete a workitem |
| [`genesys_tasks_quality_delete_workbin`](#genesys_tasks_quality_delete_workbin) | Delete a workbin |
| [`genesys_tasks_quality_delete_workitem`](#genesys_tasks_quality_delete_workitem) | Delete a workitem |
| [`genesys_tasks_quality_delete_worktype`](#genesys_tasks_quality_delete_worktype) | Delete a worktype |
| [`genesys_tasks_quality_delete_worktype_status`](#genesys_tasks_quality_delete_worktype_status) | Delete a status |
| [`genesys_tasks_quality_get_agents_activity`](#genesys_tasks_quality_get_agents_activity) | Gets a list of Agent Activities |
| [`genesys_tasks_quality_get_conversation_evaluation`](#genesys_tasks_quality_get_conversation_evaluation) | Get an evaluation |
| [`genesys_tasks_quality_get_conversation_surveys`](#genesys_tasks_quality_get_conversation_surveys) | Get the surveys for a conversation |
| [`genesys_tasks_quality_get_conversations_audits_query_transaction_id`](#genesys_tasks_quality_get_conversations_audits_query_transaction_id) | Get status of audit query execution |
| [`genesys_tasks_quality_get_conversations_audits_query_transaction_id_results`](#genesys_tasks_quality_get_conversations_audits_query_transaction_id_results) | Get results of audit query |
| [`genesys_tasks_quality_get_evaluations_query`](#genesys_tasks_quality_get_evaluations_query) | Queries Evaluations and returns a paged list |
| [`genesys_tasks_quality_get_evaluators_activity`](#genesys_tasks_quality_get_evaluators_activity) | Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests. |
| [`genesys_tasks_quality_get_forms_evaluation`](#genesys_tasks_quality_get_forms_evaluation) | Get an evaluation form |
| [`genesys_tasks_quality_get_forms_evaluation_versions`](#genesys_tasks_quality_get_forms_evaluation_versions) | Gets all the revisions for a specific evaluation. |
| [`genesys_tasks_quality_get_forms_evaluations`](#genesys_tasks_quality_get_forms_evaluations) | Get the list of evaluation forms |
| [`genesys_tasks_quality_get_forms_survey`](#genesys_tasks_quality_get_forms_survey) | Get a survey form |
| [`genesys_tasks_quality_get_forms_surveys`](#genesys_tasks_quality_get_forms_surveys) | Get the list of survey forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding survey form. |
| [`genesys_tasks_quality_get_program_agentscoringrule`](#genesys_tasks_quality_get_program_agentscoringrule) | Get an Agent Scoring Rule |
| [`genesys_tasks_quality_get_program_agentscoringrules`](#genesys_tasks_quality_get_program_agentscoringrules) | Get Agent Scoring Rules for a program |
| [`genesys_tasks_quality_get_quality_conversation_evaluation`](#genesys_tasks_quality_get_quality_conversation_evaluation) | Get an evaluation |
| [`genesys_tasks_quality_get_quality_evaluations_query`](#genesys_tasks_quality_get_quality_evaluations_query) | Queries Evaluations and returns a paged list |
| [`genesys_tasks_quality_get_survey`](#genesys_tasks_quality_get_survey) | Get a survey for a conversation |
| [`genesys_tasks_quality_get_surveys_scorable`](#genesys_tasks_quality_get_surveys_scorable) | Get a survey as an end-customer, for the purposes of scoring it. |
| [`genesys_tasks_quality_get_taskmanagement_workbin`](#genesys_tasks_quality_get_taskmanagement_workbin) | Get a workbin |
| [`genesys_tasks_quality_get_taskmanagement_workitem`](#genesys_tasks_quality_get_taskmanagement_workitem) | Get a workitem |
| [`genesys_tasks_quality_get_taskmanagement_worktype`](#genesys_tasks_quality_get_taskmanagement_worktype) | Get a worktype |
| [`genesys_tasks_quality_get_taskmanagement_worktype_statuses`](#genesys_tasks_quality_get_taskmanagement_worktype_statuses) | Get list of statuses for this worktype. |
| [`genesys_tasks_quality_get_workbin`](#genesys_tasks_quality_get_workbin) | Get a workbin |
| [`genesys_tasks_quality_get_workbin_history`](#genesys_tasks_quality_get_workbin_history) | Get a listing of a workbin's attribute change history |
| [`genesys_tasks_quality_get_workbin_version`](#genesys_tasks_quality_get_workbin_version) | Get a version of a workbin |
| [`genesys_tasks_quality_get_workbin_versions`](#genesys_tasks_quality_get_workbin_versions) | Get all versions of a workbin |
| [`genesys_tasks_quality_get_workitem`](#genesys_tasks_quality_get_workitem) | Get a workitem |
| [`genesys_tasks_quality_get_workitem_history`](#genesys_tasks_quality_get_workitem_history) | Get a listing of a workitem's attribute change history |
| [`genesys_tasks_quality_get_workitem_user_wrapups`](#genesys_tasks_quality_get_workitem_user_wrapups) | Get all wrapup codes added for the given user for a workitem. |
| [`genesys_tasks_quality_get_workitem_version`](#genesys_tasks_quality_get_workitem_version) | Get a version of a workitem |
| [`genesys_tasks_quality_get_workitem_versions`](#genesys_tasks_quality_get_workitem_versions) | Get all versions of a workitem |
| [`genesys_tasks_quality_get_workitem_wrapups`](#genesys_tasks_quality_get_workitem_wrapups) | Get all wrapup codes added for all users for a workitem. |
| [`genesys_tasks_quality_get_worktype`](#genesys_tasks_quality_get_worktype) | Get a worktype |
| [`genesys_tasks_quality_get_worktype_history`](#genesys_tasks_quality_get_worktype_history) | Get a listing of a worktype's attribute change history |
| [`genesys_tasks_quality_get_worktype_status`](#genesys_tasks_quality_get_worktype_status) | Get a status |
| [`genesys_tasks_quality_get_worktype_statuses`](#genesys_tasks_quality_get_worktype_statuses) | Get list of statuses for this worktype. |
| [`genesys_tasks_quality_get_worktype_version`](#genesys_tasks_quality_get_worktype_version) | Get a version of a worktype |
| [`genesys_tasks_quality_get_worktype_versions`](#genesys_tasks_quality_get_worktype_versions) | Get all versions of a worktype |
| [`genesys_tasks_quality_patch_forms_survey`](#genesys_tasks_quality_patch_forms_survey) | Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form. |
| [`genesys_tasks_quality_patch_taskmanagement_workitem`](#genesys_tasks_quality_patch_taskmanagement_workitem) | Update the attributes of a workitem |
| [`genesys_tasks_quality_patch_taskmanagement_workitem_assignment`](#genesys_tasks_quality_patch_taskmanagement_workitem_assignment) | Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages. |
| [`genesys_tasks_quality_patch_workbin`](#genesys_tasks_quality_patch_workbin) | Update the attributes of a workbin |
| [`genesys_tasks_quality_patch_workitem`](#genesys_tasks_quality_patch_workitem) | Update the attributes of a workitem |
| [`genesys_tasks_quality_patch_workitem_assignment`](#genesys_tasks_quality_patch_workitem_assignment) | Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages. |
| [`genesys_tasks_quality_patch_workitem_user_wrapups`](#genesys_tasks_quality_patch_workitem_user_wrapups) | Add/Remove a wrapup code for a given user in a workitem. |
| [`genesys_tasks_quality_patch_workitem_users_me_wrapups`](#genesys_tasks_quality_patch_workitem_users_me_wrapups) | Add/Remove a wrapup code for the current user in a workitem. |
| [`genesys_tasks_quality_patch_worktype`](#genesys_tasks_quality_patch_worktype) | Update the attributes of a worktype |
| [`genesys_tasks_quality_patch_worktype_status`](#genesys_tasks_quality_patch_worktype_status) | Update the attributes of a status |
| [`genesys_tasks_quality_post_conversation_evaluations`](#genesys_tasks_quality_post_conversation_evaluations) | Create an evaluation |
| [`genesys_tasks_quality_post_conversations_audits_query`](#genesys_tasks_quality_post_conversations_audits_query) | Create audit query execution |
| [`genesys_tasks_quality_post_evaluations_aggregates_query_me`](#genesys_tasks_quality_post_evaluations_aggregates_query_me) | Query for evaluation aggregates for the current user |
| [`genesys_tasks_quality_post_evaluations_scoring`](#genesys_tasks_quality_post_evaluations_scoring) | Score evaluation |
| [`genesys_tasks_quality_post_evaluations_search`](#genesys_tasks_quality_post_evaluations_search) | Search evaluations based along specified criteria |
| [`genesys_tasks_quality_post_forms_evaluations`](#genesys_tasks_quality_post_forms_evaluations) | Create an evaluation form. |
| [`genesys_tasks_quality_post_forms_surveys`](#genesys_tasks_quality_post_forms_surveys) | Create a survey form. |
| [`genesys_tasks_quality_post_program_agentscoringrules`](#genesys_tasks_quality_post_program_agentscoringrules) | Create an Agent Scoring Rule |
| [`genesys_tasks_quality_post_quality_evaluations_search`](#genesys_tasks_quality_post_quality_evaluations_search) | Search evaluations based along specified criteria |
| [`genesys_tasks_quality_post_surveys`](#genesys_tasks_quality_post_surveys) | Create a survey for a conversation |
| [`genesys_tasks_quality_post_surveys_scoring`](#genesys_tasks_quality_post_surveys_scoring) | Score survey |
| [`genesys_tasks_quality_post_taskmanagement_workbins_query`](#genesys_tasks_quality_post_taskmanagement_workbins_query) | Query for workbins |
| [`genesys_tasks_quality_post_taskmanagement_workitem_terminate`](#genesys_tasks_quality_post_taskmanagement_workitem_terminate) | Terminate a workitem |
| [`genesys_tasks_quality_post_taskmanagement_workitems`](#genesys_tasks_quality_post_taskmanagement_workitems) | Create a workitem |
| [`genesys_tasks_quality_post_taskmanagement_workitems_query`](#genesys_tasks_quality_post_taskmanagement_workitems_query) | Query for workitems |
| [`genesys_tasks_quality_post_taskmanagement_worktypes_query`](#genesys_tasks_quality_post_taskmanagement_worktypes_query) | Query for worktypes |
| [`genesys_tasks_quality_post_workbins`](#genesys_tasks_quality_post_workbins) | Create a workbin |
| [`genesys_tasks_quality_post_workbins_query`](#genesys_tasks_quality_post_workbins_query) | Query for workbins |
| [`genesys_tasks_quality_post_workitem_acd_cancel`](#genesys_tasks_quality_post_workitem_acd_cancel) | Cancel the assignment process for a workitem that is currently queued for assignment through ACD. |
| [`genesys_tasks_quality_post_workitem_disconnect`](#genesys_tasks_quality_post_workitem_disconnect) | Disconnect the assignee of the workitem |
| [`genesys_tasks_quality_post_workitem_terminate`](#genesys_tasks_quality_post_workitem_terminate) | Terminate a workitem |
| [`genesys_tasks_quality_post_workitems`](#genesys_tasks_quality_post_workitems) | Create a workitem |
| [`genesys_tasks_quality_post_workitems_query`](#genesys_tasks_quality_post_workitems_query) | Query for workitems |
| [`genesys_tasks_quality_post_worktype_statuses`](#genesys_tasks_quality_post_worktype_statuses) | Add a status to a worktype |
| [`genesys_tasks_quality_post_worktypes`](#genesys_tasks_quality_post_worktypes) | Create a worktype |
| [`genesys_tasks_quality_post_worktypes_query`](#genesys_tasks_quality_post_worktypes_query) | Query for worktypes |
| [`genesys_tasks_quality_put_conversation_evaluation`](#genesys_tasks_quality_put_conversation_evaluation) | Update an evaluation |
| [`genesys_tasks_quality_put_forms_evaluation`](#genesys_tasks_quality_put_forms_evaluation) | Update an evaluation form. |
| [`genesys_tasks_quality_put_forms_survey`](#genesys_tasks_quality_put_forms_survey) | Update a survey form. |
| [`genesys_tasks_quality_put_program_agentscoringrule`](#genesys_tasks_quality_put_program_agentscoringrule) | Update an Agent Scoring Rule |
| [`genesys_tasks_quality_put_surveys_scorable`](#genesys_tasks_quality_put_surveys_scorable) | Update a survey as an end-customer, for the purposes of scoring it. |
***
## genesys\_tasks\_quality\_delete\_conversation\_evaluation
Delete an evaluation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | --------------------------- |
| `conversationId` | string | Yes | — | Conversation Id |
| `evaluationId` | string | Yes | — | Evaluation Id |
| `expand` | string | No | — | evaluatorId, evaluationForm |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversationId": {
"type": "string",
"description": "Conversation Id"
},
"evaluationId": {
"type": "string",
"description": "Evaluation Id"
},
"expand": {
"type": "string",
"description": "evaluatorId, evaluationForm"
}
},
"required": [
"PCID",
"conversationId",
"evaluationId"
]
}
```
***
## genesys\_tasks\_quality\_delete\_forms\_evaluation
Delete an evaluation form.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `formId` | string | Yes | — | Form ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"formId": {
"type": "string",
"description": "Form ID"
}
},
"required": [
"PCID",
"formId"
]
}
```
***
## genesys\_tasks\_quality\_delete\_forms\_survey
Delete a survey form.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `formId` | string | Yes | — | Form ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"formId": {
"type": "string",
"description": "Form ID"
}
},
"required": [
"PCID",
"formId"
]
}
```
***
## genesys\_tasks\_quality\_delete\_program\_agentscoringrule
Delete an Agent Scoring Rule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------------------------------------- |
| `programId` | string | Yes | — | Program ID from Speech and Text Analytics |
| `ruleId` | string | Yes | — | Agent Scoring Rule ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"programId": {
"type": "string",
"description": "Program ID from Speech and Text Analytics"
},
"ruleId": {
"type": "string",
"description": "Agent Scoring Rule ID"
}
},
"required": [
"PCID",
"programId",
"ruleId"
]
}
```
***
## genesys\_tasks\_quality\_delete\_taskmanagement\_workitem
Delete a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `workitemId` | string | Yes | — | Workitem ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_delete\_workbin
Delete a workbin
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `workbinId` | string | Yes | — | Workbin ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workbinId": {
"type": "string",
"description": "Workbin ID"
}
},
"required": [
"PCID",
"workbinId"
]
}
```
***
## genesys\_tasks\_quality\_delete\_workitem
Delete a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `workitemId` | string | Yes | — | Workitem ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_delete\_worktype
Delete a worktype
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `worktypeId` | string | Yes | — | Worktype id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
}
},
"required": [
"PCID",
"worktypeId"
]
}
```
***
## genesys\_tasks\_quality\_delete\_worktype\_status
Delete a status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `worktypeId` | string | Yes | — | Worktype id |
| `statusId` | string | Yes | — | Status id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"statusId": {
"type": "string",
"description": "Status id"
}
},
"required": [
"PCID",
"worktypeId",
"statusId"
]
}
```
***
## genesys\_tasks\_quality\_get\_agents\_activity
Gets a list of Agent Activities
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `startTime` | string | No | — | Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `endTime` | string | No | — | End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `agentUserId` | string\[] | No | — | user id of agent requested |
| `evaluatorUserId` | string | No | — | user id of the evaluator |
| `name` | string | No | — | The name value |
| `group` | string | No | — | group id |
| `agentTeamId` | string | No | — | team id of agents requested |
| `formContextId` | string | No | — | shared id between form versions |
| `userState` | string | No | — | 'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. 'Any' fetches users of 'active', 'inactive' and 'deleted' states. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"startTime": {
"type": "string",
"description": "Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"endTime": {
"type": "string",
"description": "End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"agentUserId": {
"type": "array",
"items": {
"type": "string"
},
"description": "user id of agent requested"
},
"evaluatorUserId": {
"type": "string",
"description": "user id of the evaluator"
},
"name": {
"type": "string",
"description": "The name value"
},
"group": {
"type": "string",
"description": "group id"
},
"agentTeamId": {
"type": "string",
"description": "team id of agents requested"
},
"formContextId": {
"type": "string",
"description": "shared id between form versions"
},
"userState": {
"type": "string",
"description": "'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. 'Any' fetches users of 'active', 'inactive' and 'deleted' states.",
"enum": [
"Any",
"Legacy"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_tasks\_quality\_get\_conversation\_evaluation
Get an evaluation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ------------------------------------------ |
| `conversationId` | string | Yes | — | Conversation Id |
| `evaluationId` | string | Yes | — | Evaluation Id |
| `expand` | string | No | — | agent, assignee, evaluator, evaluationForm |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversationId": {
"type": "string",
"description": "Conversation Id"
},
"evaluationId": {
"type": "string",
"description": "Evaluation Id"
},
"expand": {
"type": "string",
"description": "agent, assignee, evaluator, evaluationForm"
}
},
"required": [
"PCID",
"conversationId",
"evaluationId"
]
}
```
***
## genesys\_tasks\_quality\_get\_conversation\_surveys
Get the surveys for a conversation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | --------------- |
| `conversationId` | string | Yes | — | Conversation Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversationId": {
"type": "string",
"description": "Conversation Id"
}
},
"required": [
"PCID",
"conversationId"
]
}
```
***
## genesys\_tasks\_quality\_get\_conversations\_audits\_query\_transaction\_id
Get status of audit query execution
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------- |
| `transactionId` | string | Yes | — | Transaction ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transactionId": {
"type": "string",
"description": "Transaction ID"
}
},
"required": [
"PCID",
"transactionId"
]
}
```
***
## genesys\_tasks\_quality\_get\_conversations\_audits\_query\_transaction\_id\_results
Get results of audit query
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | --------------------------------------------------------------------- |
| `transactionId` | string | Yes | — | Transaction ID |
| `cursor` | string | No | — | Indicates where to resume query results (not required for first page) |
| `pageSize` | integer | No | — | Page size |
| `expand` | string\[] | No | — | Which fields, if any, to expand |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transactionId": {
"type": "string",
"description": "Transaction ID"
},
"cursor": {
"type": "string",
"description": "Indicates where to resume query results (not required for first page)"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"user"
]
},
"description": "Which fields, if any, to expand"
}
},
"required": [
"PCID",
"transactionId"
]
}
```
***
## genesys\_tasks\_quality\_get\_evaluations\_query
Queries Evaluations and returns a paged list
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `previousPage` | string | No | — | Previous page token |
| `conversationId` | string | No | — | conversationId specified |
| `agentUserId` | string | No | — | user id of the agent |
| `agentTeamId` | string | No | — | team id of the agent |
| `evaluatorUserId` | string | No | — | evaluator user id |
| `assigneeUserId` | string | No | — | assignee user id |
| `queueId` | string | No | — | queue id |
| `startTime` | string | No | — | start time of the evaluation query |
| `endTime` | string | No | — | end time of the evaluation query |
| `formContextId` | string | No | — | shared id between form versions |
| `evaluationState` | string\[] | No | — | Evaluation State |
| `isReleased` | boolean | No | — | the evaluation has been released |
| `agentHasRead` | boolean | No | — | agent has the evaluation |
| `expandAnswerTotalScores` | boolean | No | — | get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request. |
| `maximum` | integer | No | — | the maximum number of results to return |
| `sortOrder` | string | No | — | NOTE: Does not work when conversationId is supplied. |
| `includeDeletedUsers` | boolean | No | — | Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"conversationId": {
"type": "string",
"description": "conversationId specified"
},
"agentUserId": {
"type": "string",
"description": "user id of the agent"
},
"agentTeamId": {
"type": "string",
"description": "team id of the agent"
},
"evaluatorUserId": {
"type": "string",
"description": "evaluator user id"
},
"assigneeUserId": {
"type": "string",
"description": "assignee user id"
},
"queueId": {
"type": "string",
"description": "queue id"
},
"startTime": {
"type": "string",
"description": "start time of the evaluation query"
},
"endTime": {
"type": "string",
"description": "end time of the evaluation query"
},
"formContextId": {
"type": "string",
"description": "shared id between form versions"
},
"evaluationState": {
"type": "array",
"items": {
"type": "string"
},
"description": "Evaluation State"
},
"isReleased": {
"type": "boolean",
"description": "the evaluation has been released"
},
"agentHasRead": {
"type": "boolean",
"description": "agent has the evaluation"
},
"expandAnswerTotalScores": {
"type": "boolean",
"description": "get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request."
},
"maximum": {
"type": "integer",
"description": "the maximum number of results to return"
},
"sortOrder": {
"type": "string",
"description": "NOTE: Does not work when conversationId is supplied."
},
"includeDeletedUsers": {
"type": "boolean",
"description": "Allow returning an agent or evaluator user with a 'delete' status. Defaults to false."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_tasks\_quality\_get\_evaluators\_activity
Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `expand` | string\[] | No | — | variable name requested by expand list |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `startTime` | string | No | — | The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `endTime` | string | No | — | The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | No | — | Evaluator name |
| `permission` | string\[] | No | — | permission strings |
| `group` | string | No | — | group id |
| `agentTeamId` | string | No | — | team id of agents to be considered |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "variable name requested by expand list"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"startTime": {
"type": "string",
"description": "The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"endTime": {
"type": "string",
"description": "The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "Evaluator name"
},
"permission": {
"type": "array",
"items": {
"type": "string"
},
"description": "permission strings"
},
"group": {
"type": "string",
"description": "group id"
},
"agentTeamId": {
"type": "string",
"description": "team id of agents to be considered"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_tasks\_quality\_get\_forms\_evaluation
Get an evaluation form
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `formId` | string | Yes | — | Form ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"formId": {
"type": "string",
"description": "Form ID"
}
},
"required": [
"PCID",
"formId"
]
}
```
***
## genesys\_tasks\_quality\_get\_forms\_evaluation\_versions
Gets all the revisions for a specific evaluation.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------- |
| `formId` | string | Yes | — | Form ID |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
| `sortOrder` | string | No | — | Sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"formId": {
"type": "string",
"description": "Form ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"sortOrder": {
"type": "string",
"description": "Sort order"
}
},
"required": [
"PCID",
"formId"
]
}
```
***
## genesys\_tasks\_quality\_get\_forms\_evaluations
Get the list of evaluation forms
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `expand` | string | No | — | If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions |
| `name` | string | No | — | The name value |
| `sortOrder` | string | No | — | Order to sort results, either asc or desc |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"expand": {
"type": "string",
"description": "If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions",
"enum": [
"publishHistory"
]
},
"name": {
"type": "string",
"description": "The name value"
},
"sortOrder": {
"type": "string",
"description": "Order to sort results, either asc or desc"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_tasks\_quality\_get\_forms\_survey
Get a survey form
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `formId` | string | Yes | — | Form ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"formId": {
"type": "string",
"description": "Form ID"
}
},
"required": [
"PCID",
"formId"
]
}
```
***
## genesys\_tasks\_quality\_get\_forms\_surveys
Get the list of survey forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding survey form.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `sortBy` | string | No | — | variable name requested to sort by |
| `nextPage` | string | No | — | next page token |
| `previousPage` | string | No | — | Previous page token |
| `expand` | string | No | — | If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions |
| `name` | string | No | — | The name value |
| `sortOrder` | string | No | — | Order to sort results, either asc or desc |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"sortBy": {
"type": "string",
"description": "variable name requested to sort by"
},
"nextPage": {
"type": "string",
"description": "next page token"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"expand": {
"type": "string",
"description": "If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions",
"enum": [
"publishHistory"
]
},
"name": {
"type": "string",
"description": "The name value"
},
"sortOrder": {
"type": "string",
"description": "Order to sort results, either asc or desc"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_tasks\_quality\_get\_program\_agentscoringrule
Get an Agent Scoring Rule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------------------------------------- |
| `programId` | string | Yes | — | Program ID from Speech and Text Analytics |
| `ruleId` | string | Yes | — | Agent Scoring Rule ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"programId": {
"type": "string",
"description": "Program ID from Speech and Text Analytics"
},
"ruleId": {
"type": "string",
"description": "Agent Scoring Rule ID"
}
},
"required": [
"PCID",
"programId",
"ruleId"
]
}
```
***
## genesys\_tasks\_quality\_get\_program\_agentscoringrules
Get Agent Scoring Rules for a program
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------------------------------------- |
| `programId` | string | Yes | — | Program ID from Speech and Text Analytics |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"programId": {
"type": "string",
"description": "Program ID from Speech and Text Analytics"
}
},
"required": [
"PCID",
"programId"
]
}
```
***
## genesys\_tasks\_quality\_get\_quality\_conversation\_evaluation
Get an evaluation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ------------------------------------------ |
| `conversationId` | string | Yes | — | conversationId |
| `evaluationId` | string | Yes | — | evaluationId |
| `expand` | string | No | — | agent, assignee, evaluator, evaluationForm |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversationId": {
"type": "string",
"description": "conversationId"
},
"evaluationId": {
"type": "string",
"description": "evaluationId"
},
"expand": {
"type": "string",
"description": "agent, assignee, evaluator, evaluationForm"
}
},
"required": [
"PCID",
"conversationId",
"evaluationId"
]
}
```
***
## genesys\_tasks\_quality\_get\_quality\_evaluations\_query
Queries Evaluations and returns a paged list
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | The total page size requested |
| `pageNumber` | integer | No | — | The page number requested |
| `expand` | any\[] | No | — | variable name requested by expand list |
| `previousPage` | string | No | — | Previous page token |
| `conversationId` | string | No | — | conversationId specified |
| `agentUserId` | string | No | — | user id of the agent |
| `agentTeamId` | string | No | — | team id of the agent |
| `evaluatorUserId` | string | No | — | evaluator user id |
| `assigneeUserId` | string | No | — | assignee user id |
| `queueId` | string | No | — | queue id |
| `startTime` | string | No | — | start time of the evaluation query |
| `endTime` | string | No | — | end time of the evaluation query |
| `formContextId` | string | No | — | shared id between form versions |
| `evaluationState` | any\[] | No | — | evaluationState |
| `isReleased` | boolean | No | — | the evaluation has been released |
| `agentHasRead` | boolean | No | — | agent has the evaluation |
| `expandAnswerTotalScores` | boolean | No | — | get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request. |
| `maximum` | integer | No | — | the maximum number of results to return |
| `sortOrder` | string | No | — | NOTE: Does not work when conversationId is supplied. |
| `includeDeletedUsers` | boolean | No | — | Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "The total page size requested"
},
"pageNumber": {
"type": "integer",
"description": "The page number requested"
},
"expand": {
"type": "array",
"description": "variable name requested by expand list"
},
"previousPage": {
"type": "string",
"description": "Previous page token"
},
"conversationId": {
"type": "string",
"description": "conversationId specified"
},
"agentUserId": {
"type": "string",
"description": "user id of the agent"
},
"agentTeamId": {
"type": "string",
"description": "team id of the agent"
},
"evaluatorUserId": {
"type": "string",
"description": "evaluator user id"
},
"assigneeUserId": {
"type": "string",
"description": "assignee user id"
},
"queueId": {
"type": "string",
"description": "queue id"
},
"startTime": {
"type": "string",
"description": "start time of the evaluation query"
},
"endTime": {
"type": "string",
"description": "end time of the evaluation query"
},
"formContextId": {
"type": "string",
"description": "shared id between form versions"
},
"evaluationState": {
"type": "array",
"description": "evaluationState"
},
"isReleased": {
"type": "boolean",
"description": "the evaluation has been released"
},
"agentHasRead": {
"type": "boolean",
"description": "agent has the evaluation"
},
"expandAnswerTotalScores": {
"type": "boolean",
"description": "get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request."
},
"maximum": {
"type": "integer",
"description": "the maximum number of results to return"
},
"sortOrder": {
"type": "string",
"description": "NOTE: Does not work when conversationId is supplied."
},
"includeDeletedUsers": {
"type": "boolean",
"description": "Allow returning an agent or evaluator user with a 'delete' status. Defaults to false."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_tasks\_quality\_get\_survey
Get a survey for a conversation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------- |
| `surveyId` | string | Yes | — | Survey Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"surveyId": {
"type": "string",
"description": "Survey Id"
}
},
"required": [
"PCID",
"surveyId"
]
}
```
***
## genesys\_tasks\_quality\_get\_surveys\_scorable
Get a survey as an end-customer, for the purposes of scoring it.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------ | -------- | ------- | ------------------- |
| `customerSurveyUrl` | string | Yes | — | Customer Survey Url |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerSurveyUrl": {
"type": "string",
"description": "Customer Survey Url"
}
},
"required": [
"PCID",
"customerSurveyUrl"
]
}
```
***
## genesys\_tasks\_quality\_get\_taskmanagement\_workbin
Get a workbin
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `workbinId` | string | Yes | — | Workbin ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workbinId": {
"type": "string",
"description": "Workbin ID"
}
},
"required": [
"PCID",
"workbinId"
]
}
```
***
## genesys\_tasks\_quality\_get\_taskmanagement\_workitem
Get a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------------------------------------------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `expands` | any\[] | No | — | Which fields to expand. Comma separated if more than one. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"expands": {
"type": "array",
"description": "Which fields to expand. Comma separated if more than one."
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_get\_taskmanagement\_worktype
Get a worktype
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `worktypeId` | string | Yes | — | Worktype id |
| `expands` | any\[] | No | — | Which fields, if any, to expand. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"expands": {
"type": "array",
"description": "Which fields, if any, to expand."
}
},
"required": [
"PCID",
"worktypeId"
]
}
```
***
## genesys\_tasks\_quality\_get\_taskmanagement\_worktype\_statuses
Get list of statuses for this worktype.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `worktypeId` | string | Yes | — | Worktype id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
}
},
"required": [
"PCID",
"worktypeId"
]
}
```
***
## genesys\_tasks\_quality\_get\_workbin
Get a workbin
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `workbinId` | string | Yes | — | Workbin ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workbinId": {
"type": "string",
"description": "Workbin ID"
}
},
"required": [
"PCID",
"workbinId"
]
}
```
***
## genesys\_tasks\_quality\_get\_workbin\_history
Get a listing of a workbin's attribute change history
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `workbinId` | string | Yes | — | Workbin ID |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workbinId": {
"type": "string",
"description": "Workbin ID"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"workbinId"
]
}
```
***
## genesys\_tasks\_quality\_get\_workbin\_version
Get a version of a workbin
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------- |
| `workbinId` | string | Yes | — | Workbin ID |
| `entityVersion` | integer | Yes | — | Workbin version |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workbinId": {
"type": "string",
"description": "Workbin ID"
},
"entityVersion": {
"type": "integer",
"description": "Workbin version"
}
},
"required": [
"PCID",
"workbinId",
"entityVersion"
]
}
```
***
## genesys\_tasks\_quality\_get\_workbin\_versions
Get all versions of a workbin
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `workbinId` | string | Yes | — | Workbin ID |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workbinId": {
"type": "string",
"description": "Workbin ID"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"workbinId"
]
}
```
***
## genesys\_tasks\_quality\_get\_workitem
Get a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | --------------------------------------------------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `expands` | string\[] | No | — | Which fields to expand. Comma separated if more than one. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"expands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"type",
"workbin",
"status",
"queue",
"assignee"
]
},
"description": "Which fields to expand. Comma separated if more than one."
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_get\_workitem\_history
Get a listing of a workitem's attribute change history
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `workitemId` | string | Yes | — | Workitem ID |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_get\_workitem\_user\_wrapups
Get all wrapup codes added for the given user for a workitem.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workitemId` | string | Yes | — | The ID of the Workitem. |
| `userId` | string | Yes | — | The ID of the user |
| `expands` | string | No | — | Which fields, if any, to expand. |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "The ID of the Workitem."
},
"userId": {
"type": "string",
"description": "The ID of the user"
},
"expands": {
"type": "string",
"description": "Which fields, if any, to expand.",
"enum": [
"wrapupCode"
]
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50."
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"workitemId",
"userId"
]
}
```
***
## genesys\_tasks\_quality\_get\_workitem\_version
Get a version of a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `entityVersion` | integer | Yes | — | Workitem version |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"entityVersion": {
"type": "integer",
"description": "Workitem version"
}
},
"required": [
"PCID",
"workitemId",
"entityVersion"
]
}
```
***
## genesys\_tasks\_quality\_get\_workitem\_versions
Get all versions of a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `workitemId` | string | Yes | — | Workitem ID |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_get\_workitem\_wrapups
Get all wrapup codes added for all users for a workitem.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workitemId` | string | Yes | — | The ID of the Workitem. |
| `expands` | string | No | — | Which fields, if any, to expand. |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "The ID of the Workitem."
},
"expands": {
"type": "string",
"description": "Which fields, if any, to expand.",
"enum": [
"wrapupCode"
]
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50."
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_get\_worktype
Get a worktype
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | -------------------------------- |
| `worktypeId` | string | Yes | — | Worktype id |
| `expands` | string\[] | No | — | Which fields, if any, to expand. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"expands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"defaultQueue",
"defaultSkills",
"defaultLanguage",
"schema",
"flow",
"defaultScript"
]
},
"description": "Which fields, if any, to expand."
}
},
"required": [
"PCID",
"worktypeId"
]
}
```
***
## genesys\_tasks\_quality\_get\_worktype\_history
Get a listing of a worktype's attribute change history
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `worktypeId` | string | Yes | — | Worktype id |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `sortOrder` | string | No | — | Ascending or descending sort order |
| `fields` | string\[] | No | — | Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
},
"fields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"serviceLevelTarget",
"defaultWorkbinId",
"defaultDueDurationSeconds",
"defaultExpirationSeconds",
"defaultPriority",
"defaultLanguageId",
"defaultSkillIds",
"defaultQueueId",
"assignmentEnabled",
"defaultStatusId",
"statuses"
]
},
"description": "Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields."
}
},
"required": [
"PCID",
"worktypeId"
]
}
```
***
## genesys\_tasks\_quality\_get\_worktype\_status
Get a status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `worktypeId` | string | Yes | — | Worktype id |
| `statusId` | string | Yes | — | Status id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"statusId": {
"type": "string",
"description": "Status id"
}
},
"required": [
"PCID",
"worktypeId",
"statusId"
]
}
```
***
## genesys\_tasks\_quality\_get\_worktype\_statuses
Get list of statuses for this worktype.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `worktypeId` | string | Yes | — | Worktype id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
}
},
"required": [
"PCID",
"worktypeId"
]
}
```
***
## genesys\_tasks\_quality\_get\_worktype\_version
Get a version of a worktype
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------- |
| `worktypeId` | string | Yes | — | Worktype id |
| `entityVersion` | integer | Yes | — | Worktype version |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"entityVersion": {
"type": "integer",
"description": "Worktype version"
}
},
"required": [
"PCID",
"worktypeId",
"entityVersion"
]
}
```
***
## genesys\_tasks\_quality\_get\_worktype\_versions
Get all versions of a worktype
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `worktypeId` | string | Yes | — | Worktype id |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"worktypeId"
]
}
```
***
## genesys\_tasks\_quality\_patch\_forms\_survey
Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `formId` | string | Yes | — | Form ID |
| `contextId` | string | Yes | — | Unique Id for all versions of this form |
| `disabled` | boolean | No | — | Is this form disabled |
| `footer` | string | No | — | Markdown text for the bottom of the form. |
| `header` | string | No | — | Markdown text for the top of the form. |
| `id` | string | No | — | The globally unique identifier for the object. |
| `language` | string | Yes | — | Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW |
| `modifiedDate` | string | No | — | Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | Yes | — | The survey form name |
| `published` | boolean | No | — | Is this form published |
| `publishedVersions` | object | No | — | Published Versions |
| `questionGroups` | object\[] | No | — | A list of question groups |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"formId": {
"type": "string",
"description": "Form ID"
},
"contextId": {
"type": "string",
"description": "Unique Id for all versions of this form"
},
"disabled": {
"type": "boolean",
"description": "Is this form disabled"
},
"footer": {
"type": "string",
"description": "Markdown text for the bottom of the form."
},
"header": {
"type": "string",
"description": "Markdown text for the top of the form."
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"language": {
"type": "string",
"description": "Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"
},
"modifiedDate": {
"type": "string",
"description": "Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The survey form name"
},
"published": {
"type": "boolean",
"description": "Is this form published"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions",
"properties": {
"entities": {
"type": "array",
"items": {
"type": "object"
},
"description": "The entities value"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"total": {
"type": "integer",
"description": "The total value"
},
"firstUri": {
"type": "string",
"description": "First Uri"
},
"nextUri": {
"type": "string",
"description": "Next Uri"
},
"previousUri": {
"type": "string",
"description": "Previous Uri"
},
"lastUri": {
"type": "string",
"description": "Last Uri"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
},
"pageCount": {
"type": "integer",
"description": "Page Count"
}
}
},
"questionGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"contextId": {
"type": "string",
"description": "An identifier for this question group that stays the same across versions of the form."
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "string",
"description": "The type value"
},
"naEnabled": {
"type": "boolean",
"description": "Na Enabled"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "An identifier for this question that stays the same across versions of the form."
},
"text": {
"type": "string"
},
"helpText": {
"type": "string"
},
"type": {
"type": "string"
},
"naEnabled": {
"type": "boolean"
},
"visibilityCondition": {
"type": "object"
},
"answerOptions": {
"type": "array",
"description": "Options from which to choose an answer for this question. Only used by Multiple Choice type questions."
},
"maxResponseCharacters": {
"type": "integer",
"description": "How many characters are allowed in the text response to this question. Used by NPS and Free Text question types."
},
"explanationPrompt": {
"type": "string",
"description": "Prompt for details explaining the chosen NPS score. Used by NPS questions."
}
}
},
"description": "The questions value"
},
"visibilityCondition": {
"type": "object",
"description": "Visibility Condition"
}
}
},
"description": "A list of question groups"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"formId",
"contextId",
"language",
"name"
]
}
```
***
## genesys\_tasks\_quality\_patch\_taskmanagement\_workitem
Update the attributes of a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `assigneeId` | string | No | — | The ID of the assignee of the Workitem. If supplied it must be a valid UUID. |
| `assignmentOperation` | string | No | — | Set this value to AgentAssignmentAlerting and supply an 'assigneeId' to assign the workitem to an agent and alert the agent of the assignment. Set this value to QueueAssignmentAlerting and supply a 'queueId' to route the workitem to an agent who is a member of the queue and alert the agent. |
| `assignmentState` | string | No | — | The assignment state of the Workitem. |
| `autoStatusTransition` | boolean | No | — | Set it to false to disable auto status transition. By default, it is enabled. |
| `customFields` | object | No | — | Custom fields defined in the schema referenced by the worktype of the workitem. If set to \{}, the existing keys and values will be removed. |
| `dateClosed` | string | No | — | The closed date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateDue` | string | No | — | The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateExpires` | string | No | — | The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | The description of the Workitem. Maximum length of 512 characters. |
| `durationSeconds` | integer | No | — | The estimated duration in seconds to complete the Workitem. Maximum of 365 days. |
| `externalContactId` | string | No | — | The ID of the external contact of the Workitem. Must be a valid UUID. |
| `externalTag` | string | No | — | The external tag of the Workitem. |
| `languageId` | string | No | — | The ID of language of the Workitem. Must be a valid UUID. |
| `name` | string | No | — | The name of the Workitem. Valid length between 3 and 256 characters. |
| `preferredAgentIds` | any\[] | No | — | The preferred agent IDs of the Workitem. Must be valid UUIDs. |
| `priority` | integer | No | — | The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. |
| `queueId` | string | No | — | The ID of the Workitems queue. Must be a valid UUID. |
| `scoredAgents` | any\[] | No | — | A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. |
| `scriptId` | string | No | — | The ID of the Workitems script. Must be a valid UUID. |
| `skillIds` | any\[] | No | — | The skill IDs of the Workitem. Must be valid UUIDs. |
| `statusId` | string | No | — | The ID of the Status of the Workitem. |
| `ttl` | integer | No | — | The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time. |
| `utilizationLabelId` | string | No | — | The ID of the utilization label of the Workitem. Must be a valid UUID. |
| `workbinId` | string | No | — | The ID of Workbin that contains the Workitem. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"assigneeId": {
"type": "string",
"description": "The ID of the assignee of the Workitem. If supplied it must be a valid UUID."
},
"assignmentOperation": {
"type": "string",
"description": "Set this value to AgentAssignmentAlerting and supply an 'assigneeId' to assign the workitem to an agent and alert the agent of the assignment. Set this value to QueueAssignmentAlerting and supply a 'queueId' to route the workitem to an agent who is a member of the queue and alert the agent.",
"enum": [
"AgentAssignmentAlerting",
"QueueAssignmentAlerting"
]
},
"assignmentState": {
"type": "string",
"description": "The assignment state of the Workitem.",
"enum": [
"Unknown",
"AcdStarted",
"Alerting",
"AlertTimeout",
"AcdCancelled",
"Terminated",
"Idle",
"Declined",
"Connected",
"Disconnected",
"Parked",
"Held",
"AcdExpired"
]
},
"autoStatusTransition": {
"type": "boolean",
"description": "Set it to false to disable auto status transition. By default, it is enabled."
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by the worktype of the workitem. If set to {}, the existing keys and values will be removed."
},
"dateClosed": {
"type": "string",
"description": "The closed date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateDue": {
"type": "string",
"description": "The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateExpires": {
"type": "string",
"description": "The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "The description of the Workitem. Maximum length of 512 characters."
},
"durationSeconds": {
"type": "integer",
"description": "The estimated duration in seconds to complete the Workitem. Maximum of 365 days."
},
"externalContactId": {
"type": "string",
"description": "The ID of the external contact of the Workitem. Must be a valid UUID."
},
"externalTag": {
"type": "string",
"description": "The external tag of the Workitem."
},
"languageId": {
"type": "string",
"description": "The ID of language of the Workitem. Must be a valid UUID."
},
"name": {
"type": "string",
"description": "The name of the Workitem. Valid length between 3 and 256 characters."
},
"preferredAgentIds": {
"type": "array",
"description": "The preferred agent IDs of the Workitem. Must be valid UUIDs."
},
"priority": {
"type": "integer",
"description": "The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."
},
"queueId": {
"type": "string",
"description": "The ID of the Workitems queue. Must be a valid UUID."
},
"scoredAgents": {
"type": "array",
"description": "A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents."
},
"scriptId": {
"type": "string",
"description": "The ID of the Workitems script. Must be a valid UUID."
},
"skillIds": {
"type": "array",
"description": "The skill IDs of the Workitem. Must be valid UUIDs."
},
"statusId": {
"type": "string",
"description": "The ID of the Status of the Workitem."
},
"ttl": {
"type": "integer",
"description": "The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time."
},
"utilizationLabelId": {
"type": "string",
"description": "The ID of the utilization label of the Workitem. Must be a valid UUID."
},
"workbinId": {
"type": "string",
"description": "The ID of Workbin that contains the Workitem."
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_patch\_taskmanagement\_workitem\_assignment
Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------------------------------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `id` | string | Yes | — | The globally unique identifier for this user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"id": {
"type": "string",
"description": "The globally unique identifier for this user."
}
},
"required": [
"PCID",
"workitemId",
"id"
]
}
```
***
## genesys\_tasks\_quality\_patch\_workbin
Update the attributes of a workbin
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `workbinId` | string | Yes | — | Workbin ID |
| `description` | string | No | — | Workbin description. Maximum length of 512 characters. |
| `name` | string | No | — | Workbin name. Valid length between 3 and 256 characters. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workbinId": {
"type": "string",
"description": "Workbin ID"
},
"description": {
"type": "string",
"description": "Workbin description. Maximum length of 512 characters."
},
"name": {
"type": "string",
"description": "Workbin name. Valid length between 3 and 256 characters."
}
},
"required": [
"PCID",
"workbinId"
]
}
```
***
## genesys\_tasks\_quality\_patch\_workitem
Update the attributes of a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `assigneeId` | string | No | — | The ID of the assignee of the Workitem. If supplied it must be a valid UUID. |
| `assignmentOperation` | string | No | — | Set this value to AgentAssignmentAlerting and supply an 'assigneeId' to assign the workitem to an agent and alert the agent of the assignment. Set this value to QueueAssignmentAlerting and supply a 'queueId' to route the workitem to an agent who is a member of the queue and alert the agent. |
| `assignmentState` | string | No | — | The assignment state of the Workitem. |
| `autoStatusTransition` | boolean | No | — | Set it to false to disable auto status transition. By default, it is enabled. |
| `customFields` | object | No | — | Custom fields defined in the schema referenced by the worktype of the workitem. If set to \{}, the existing keys and values will be removed. |
| `dateClosed` | string | No | — | The closed date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateDue` | string | No | — | The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateExpires` | string | No | — | The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | The description of the Workitem. Maximum length of 512 characters. |
| `durationSeconds` | integer | No | — | The estimated duration in seconds to complete the Workitem. Maximum of 365 days. |
| `externalContactId` | string | No | — | The ID of the external contact of the Workitem. Must be a valid UUID. |
| `externalTag` | string | No | — | The external tag of the Workitem. |
| `languageId` | string | No | — | The ID of language of the Workitem. Must be a valid UUID. |
| `name` | string | No | — | The name of the Workitem. Valid length between 3 and 256 characters. |
| `preferredAgentIds` | string\[] | No | — | The preferred agent IDs of the Workitem. Must be valid UUIDs. |
| `priority` | integer | No | — | The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. |
| `queueId` | string | No | — | The ID of the Workitems queue. Must be a valid UUID. |
| `scoredAgents` | object\[] | No | — | A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. |
| `scriptId` | string | No | — | The ID of the Workitems script. Must be a valid UUID. |
| `skillIds` | string\[] | No | — | The skill IDs of the Workitem. Must be valid UUIDs. |
| `statusId` | string | No | — | The ID of the Status of the Workitem. |
| `ttl` | integer | No | — | The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time. |
| `utilizationLabelId` | string | No | — | The ID of the utilization label of the Workitem. Must be a valid UUID. |
| `workbinId` | string | No | — | The ID of Workbin that contains the Workitem. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"assigneeId": {
"type": "string",
"description": "The ID of the assignee of the Workitem. If supplied it must be a valid UUID."
},
"assignmentOperation": {
"type": "string",
"description": "Set this value to AgentAssignmentAlerting and supply an 'assigneeId' to assign the workitem to an agent and alert the agent of the assignment. Set this value to QueueAssignmentAlerting and supply a 'queueId' to route the workitem to an agent who is a member of the queue and alert the agent.",
"enum": [
"AgentAssignmentAlerting",
"QueueAssignmentAlerting"
]
},
"assignmentState": {
"type": "string",
"description": "The assignment state of the Workitem.",
"enum": [
"Unknown",
"AcdStarted",
"Alerting",
"AlertTimeout",
"AcdCancelled",
"Terminated",
"Idle",
"Declined",
"Connected",
"Disconnected",
"Parked",
"Held",
"AcdExpired"
]
},
"autoStatusTransition": {
"type": "boolean",
"description": "Set it to false to disable auto status transition. By default, it is enabled."
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by the worktype of the workitem. If set to {}, the existing keys and values will be removed."
},
"dateClosed": {
"type": "string",
"description": "The closed date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateDue": {
"type": "string",
"description": "The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateExpires": {
"type": "string",
"description": "The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "The description of the Workitem. Maximum length of 512 characters."
},
"durationSeconds": {
"type": "integer",
"description": "The estimated duration in seconds to complete the Workitem. Maximum of 365 days."
},
"externalContactId": {
"type": "string",
"description": "The ID of the external contact of the Workitem. Must be a valid UUID."
},
"externalTag": {
"type": "string",
"description": "The external tag of the Workitem."
},
"languageId": {
"type": "string",
"description": "The ID of language of the Workitem. Must be a valid UUID."
},
"name": {
"type": "string",
"description": "The name of the Workitem. Valid length between 3 and 256 characters."
},
"preferredAgentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The preferred agent IDs of the Workitem. Must be valid UUIDs."
},
"priority": {
"type": "integer",
"description": "The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."
},
"queueId": {
"type": "string",
"description": "The ID of the Workitems queue. Must be a valid UUID."
},
"scoredAgents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "An agents ID. Must be a valid UUID."
},
"score": {
"type": "integer",
"format": "int32",
"description": "Agent's score for the workitem, from 0 - 100, higher being better"
}
}
},
"description": "A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents."
},
"scriptId": {
"type": "string",
"description": "The ID of the Workitems script. Must be a valid UUID."
},
"skillIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The skill IDs of the Workitem. Must be valid UUIDs."
},
"statusId": {
"type": "string",
"description": "The ID of the Status of the Workitem."
},
"ttl": {
"type": "integer",
"description": "The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time."
},
"utilizationLabelId": {
"type": "string",
"description": "The ID of the utilization label of the Workitem. Must be a valid UUID."
},
"workbinId": {
"type": "string",
"description": "The ID of Workbin that contains the Workitem."
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_patch\_workitem\_assignment
Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------------------------------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `id` | string | Yes | — | The globally unique identifier for this user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"id": {
"type": "string",
"description": "The globally unique identifier for this user."
}
},
"required": [
"PCID",
"workitemId",
"id"
]
}
```
***
## genesys\_tasks\_quality\_patch\_workitem\_user\_wrapups
Add/Remove a wrapup code for a given user in a workitem.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------- |
| `workitemId` | string | Yes | — | The ID of the Workitem. |
| `userId` | string | Yes | — | The ID of the user |
| `action` | string | Yes | — | Action to be performed for the wrapup code. |
| `wrapupCode` | string | Yes | — | The wrapup code which will be added/removed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "The ID of the Workitem."
},
"userId": {
"type": "string",
"description": "The ID of the user"
},
"action": {
"type": "string",
"description": "Action to be performed for the wrapup code.",
"enum": [
"Add",
"Remove"
]
},
"wrapupCode": {
"type": "string",
"description": "The wrapup code which will be added/removed."
}
},
"required": [
"PCID",
"workitemId",
"userId",
"action",
"wrapupCode"
]
}
```
***
## genesys\_tasks\_quality\_patch\_workitem\_users\_me\_wrapups
Add/Remove a wrapup code for the current user in a workitem.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------- |
| `workitemId` | string | Yes | — | The ID of the Workitem. |
| `action` | string | Yes | — | Action to be performed for the wrapup code. |
| `wrapupCode` | string | Yes | — | The wrapup code which will be added/removed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "The ID of the Workitem."
},
"action": {
"type": "string",
"description": "Action to be performed for the wrapup code.",
"enum": [
"Add",
"Remove"
]
},
"wrapupCode": {
"type": "string",
"description": "The wrapup code which will be added/removed."
}
},
"required": [
"PCID",
"workitemId",
"action",
"wrapupCode"
]
}
```
***
## genesys\_tasks\_quality\_patch\_worktype
Update the attributes of a worktype
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `worktypeId` | string | Yes | — | Worktype id |
| `assignmentEnabled` | boolean | No | — | When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false. |
| `defaultDueDurationSeconds` | integer | No | — | The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days. |
| `defaultDurationSeconds` | integer | No | — | The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days. |
| `defaultExpirationSeconds` | integer | No | — | The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days. |
| `defaultLanguageId` | string | No | — | The ID of the default language for Workitems created from the Worktype. Must be a valid UUID. |
| `defaultPriority` | integer | No | — | The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000. |
| `defaultQueueId` | string | No | — | The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID. |
| `defaultScriptId` | string | No | — | The default script for Workitems created from the Worktype. Must be a valid UUID. |
| `defaultSkillIds` | string\[] | No | — | The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs |
| `defaultStatusId` | string | No | — | The ID of the default status for Workitems created from the Worktype. Must be a valid UUID. |
| `defaultTtlSeconds` | integer | No | — | The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days. |
| `defaultWorkbinId` | string | No | — | The ID of the default Workbin for Workitems created from the Worktype. |
| `description` | string | No | — | The description of the Worktype. Maximum length of 512 characters. |
| `name` | string | No | — | The name of the Worktype. Valid length between 3 and 256 characters. |
| `ruleSettings` | object | No | — | Rule Settings |
| `schemaId` | string | No | — | The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID. |
| `schemaVersion` | integer | No | — | The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set. |
| `serviceLevelTarget` | integer | No | — | The target service level for Workitems created from the Worktype. The default value is 100. |
| `unassignedDivisionContactsEnabled` | boolean | No | — | When set to true, will allow Workitems to be associated with External Contacts that are not assigned to any division. Default value is true. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"assignmentEnabled": {
"type": "boolean",
"description": "When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."
},
"defaultDueDurationSeconds": {
"type": "integer",
"description": "The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days."
},
"defaultDurationSeconds": {
"type": "integer",
"description": "The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days."
},
"defaultExpirationSeconds": {
"type": "integer",
"description": "The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days."
},
"defaultLanguageId": {
"type": "string",
"description": "The ID of the default language for Workitems created from the Worktype. Must be a valid UUID."
},
"defaultPriority": {
"type": "integer",
"description": "The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."
},
"defaultQueueId": {
"type": "string",
"description": "The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID."
},
"defaultScriptId": {
"type": "string",
"description": "The default script for Workitems created from the Worktype. Must be a valid UUID."
},
"defaultSkillIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs"
},
"defaultStatusId": {
"type": "string",
"description": "The ID of the default status for Workitems created from the Worktype. Must be a valid UUID."
},
"defaultTtlSeconds": {
"type": "integer",
"description": "The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days."
},
"defaultWorkbinId": {
"type": "string",
"description": "The ID of the default Workbin for Workitems created from the Worktype."
},
"description": {
"type": "string",
"description": "The description of the Worktype. Maximum length of 512 characters."
},
"name": {
"type": "string",
"description": "The name of the Worktype. Valid length between 3 and 256 characters."
},
"ruleSettings": {
"type": "object",
"description": "Rule Settings",
"properties": {
"flowRulesEnabled": {
"type": "boolean",
"description": "When set to true, the worktypes flow rules will be processed. Default value is false."
}
}
},
"schemaId": {
"type": "string",
"description": "The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID."
},
"schemaVersion": {
"type": "integer",
"description": "The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set."
},
"serviceLevelTarget": {
"type": "integer",
"description": "The target service level for Workitems created from the Worktype. The default value is 100."
},
"unassignedDivisionContactsEnabled": {
"type": "boolean",
"description": "When set to true, will allow Workitems to be associated with External Contacts that are not assigned to any division. Default value is true."
}
},
"required": [
"PCID",
"worktypeId"
]
}
```
***
## genesys\_tasks\_quality\_patch\_worktype\_status
Update the attributes of a status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `worktypeId` | string | Yes | — | Worktype id |
| `statusId` | string | Yes | — | Status id |
| `autoTerminateWorkitem` | boolean | No | — | Terminate workitem on selection of status. Applicable only for statuses in the Closed category. |
| `defaultDestinationStatusId` | string | No | — | Default destination status to which this Status will transition to if auto status transition enabled. |
| `description` | string | No | — | The description of the Status. Maximum length of 512 characters. |
| `destinationStatusIds` | string\[] | No | — | A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations. |
| `name` | string | No | — | The name of the Status. Valid length between 3 and 256 characters. |
| `statusTransitionDelaySeconds` | integer | No | — | Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided. |
| `statusTransitionTime` | string | No | — | Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"statusId": {
"type": "string",
"description": "Status id"
},
"autoTerminateWorkitem": {
"type": "boolean",
"description": "Terminate workitem on selection of status. Applicable only for statuses in the Closed category."
},
"defaultDestinationStatusId": {
"type": "string",
"description": "Default destination status to which this Status will transition to if auto status transition enabled."
},
"description": {
"type": "string",
"description": "The description of the Status. Maximum length of 512 characters."
},
"destinationStatusIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations."
},
"name": {
"type": "string",
"description": "The name of the Status. Valid length between 3 and 256 characters."
},
"statusTransitionDelaySeconds": {
"type": "integer",
"description": "Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided."
},
"statusTransitionTime": {
"type": "string",
"description": "Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS"
}
},
"required": [
"PCID",
"worktypeId",
"statusId"
]
}
```
***
## genesys\_tasks\_quality\_post\_conversation\_evaluations
Create an evaluation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `conversationId` | string | Yes | — | Conversation Id |
| `Idempotency-Key` | string | No | — | Idempotency key for request deduplication |
| `expand` | string | No | — | evaluatorId |
| `agent` | object | No | — | The agent value |
| `agentHasRead` | boolean | No | — | Agent Has Read |
| `answers` | object | No | — | The answers value |
| `assignee` | object | No | — | The assignee value |
| `calibration` | object | No | — | The calibration value |
| `conversation` | object | No | — | The conversation value |
| `dateAssigneeChanged` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `evaluationContextId` | string | No | — | Evaluation Context Id |
| `evaluationForm` | object | No | — | Evaluation Form |
| `evaluationSource` | object | No | — | Evaluation Source |
| `evaluator` | object | No | — | The evaluator value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `neverRelease` | boolean | No | — | Never Release |
| `queue` | object | No | — | The queue value |
| `releaseDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `rescore` | boolean | No | — | The rescore value |
| `resourceType` | string | No | — | Resource Type |
| `selfUri` | string | No | — | The URI for this object |
| `status` | string | No | — | The status value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversationId": {
"type": "string",
"description": "Conversation Id"
},
"Idempotency-Key": {
"type": "string",
"description": "Idempotency key for request deduplication"
},
"expand": {
"type": "string",
"description": "evaluatorId"
},
"agent": {
"type": "object",
"description": "The agent value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"id"
]
},
"agentHasRead": {
"type": "boolean",
"description": "Agent Has Read"
},
"answers": {
"type": "object",
"description": "The answers value",
"properties": {
"totalScore": {
"type": "number",
"description": "Score of all questions"
},
"totalCriticalScore": {
"type": "number",
"description": "Score of only the critical questions"
},
"maxTotalRawCriticalScore": {
"type": "number",
"description": "Maximum total raw score for the critical questions. Raw score is the actual point values before applying weights or percentages."
},
"maxTotalRawScore": {
"type": "number",
"description": "Maximum total raw score for all questions. Raw score is the actual point values before applying weights or percentages."
},
"totalNonCriticalScore": {
"type": "number",
"description": "Score of only the non-critical questions"
},
"questionGroupScores": {
"type": "array",
"items": {
"type": "object"
},
"description": "Question Group Scores"
},
"anyFailedKillQuestions": {
"type": "boolean",
"description": "Indicates that at least one fatal question was answered without having the highest score available for the question"
},
"comments": {
"type": "string",
"description": "Overall comments from the evaluator"
},
"privateComments": {
"type": "string",
"description": "Overall private comments from the evaluator"
},
"agentComments": {
"type": "string",
"description": "Comments from the agent while reviewing evaluation results"
},
"transcriptTopics": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of topics found within the conversation's transcripts"
}
}
},
"assignee": {
"type": "object",
"description": "The assignee value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"id"
]
},
"calibration": {
"type": "object",
"description": "The calibration value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"conversation": {
"type": "object",
"description": "The conversation value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"dateAssigneeChanged": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"evaluationContextId": {
"type": "string",
"description": "Evaluation Context Id"
},
"evaluationForm": {
"type": "object",
"description": "Evaluation Form",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"evaluationSource": {
"type": "object",
"description": "Evaluation Source",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "string",
"description": "Type of the evaluation source.",
"enum": [
"Policy",
"User",
"Unknown",
"Program"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"evaluator": {
"type": "object",
"description": "The evaluator value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"id"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"neverRelease": {
"type": "boolean",
"description": "Never Release"
},
"queue": {
"type": "object",
"description": "The queue value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"releaseDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"rescore": {
"type": "boolean",
"description": "The rescore value"
},
"resourceType": {
"type": "string",
"description": "Resource Type",
"enum": [
"EMAIL"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"PENDING",
"INPROGRESS",
"FINISHED",
"INREVIEW",
"RETRACTED"
]
}
},
"required": [
"PCID",
"conversationId"
]
}
```
***
## genesys\_tasks\_quality\_post\_conversations\_audits\_query
Create audit query execution
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `filters` | object\[] | Yes | — | List of filters for the query. |
| `interval` | string | Yes | — | Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
| `sort` | object\[] | No | — | Sort parameter for the query. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"enum": [
"UserId",
"TrusteeOrganizationId",
"TrusteeOnlyAudits",
"ClientId",
"Action",
"EntityType",
"EntityId",
"ConversationId",
"ServiceName"
],
"description": "Name of the property to filter."
},
"value": {
"type": "string",
"description": "Value of the property to filter."
}
},
"required": [
"property",
"value"
]
},
"description": "List of filters for the query."
},
"interval": {
"type": "string",
"description": "Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Timestamp"
],
"description": "Name of the property to sort."
},
"sortOrder": {
"type": "string",
"enum": [
"ascending",
"descending"
],
"description": "Sort Order"
}
},
"required": [
"name",
"sortOrder"
]
},
"description": "Sort parameter for the query."
}
},
"required": [
"PCID",
"filters",
"interval"
]
}
```
***
## genesys\_tasks\_quality\_post\_evaluations\_aggregates\_query\_me
Query for evaluation aggregates for the current user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `alternateTimeDimension` | string | No | — | Dimension to use as the alternative timestamp for data in the aggregate. Choosing "eventTime" uses the actual time of the data event. |
| `contextId` | string | No | — | Evaluation context Id |
| `groupBy` | string\[] | No | — | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. |
| `interval` | string | Yes | — | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss |
| `metrics` | string\[] | Yes | — | Behaves like a SQL SELECT clause. Only named metrics will be retrieved. |
| `timeZone` | string | No | — | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alternateTimeDimension": {
"type": "string",
"description": "Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.",
"enum": [
"conversationStart",
"evaluationCreatedDate",
"evaluationReleaseDate",
"eventTime"
]
},
"contextId": {
"type": "string",
"description": "Evaluation context Id"
},
"groupBy": {
"type": "array",
"items": {
"type": "string",
"enum": [
"assigneeApplicable",
"assigneeId",
"calibrationId",
"contextId",
"conversationId",
"divisionId",
"evaluationContextId",
"evaluationId",
"evaluatorId",
"formId",
"mediaType",
"queueId",
"released",
"rescored",
"systemSubmitted",
"teamId",
"userId"
]
},
"description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
},
"interval": {
"type": "string",
"description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
},
"metrics": {
"type": "array",
"items": {
"type": "string",
"enum": [
"nEvaluations",
"nEvaluationsDeleted",
"nEvaluationsRescored",
"oTotalCriticalScore",
"oTotalScore"
]
},
"description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
},
"timeZone": {
"type": "string",
"description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
}
},
"required": [
"PCID",
"interval",
"metrics"
]
}
```
***
## genesys\_tasks\_quality\_post\_evaluations\_scoring
Score evaluation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ----------------- |
| `answers` | object | No | — | The answers value |
| `evaluationForm` | object | No | — | Evaluation Form |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"answers": {
"type": "object",
"description": "The answers value",
"properties": {
"totalScore": {
"type": "number",
"description": "Score of all questions"
},
"totalCriticalScore": {
"type": "number",
"description": "Score of only the critical questions"
},
"maxTotalRawCriticalScore": {
"type": "number",
"description": "Maximum total raw score for the critical questions. Raw score is the actual point values before applying weights or percentages."
},
"maxTotalRawScore": {
"type": "number",
"description": "Maximum total raw score for all questions. Raw score is the actual point values before applying weights or percentages."
},
"totalNonCriticalScore": {
"type": "number",
"description": "Score of only the non-critical questions"
},
"questionGroupScores": {
"type": "array",
"items": {
"type": "object"
},
"description": "Question Group Scores"
},
"anyFailedKillQuestions": {
"type": "boolean",
"description": "Indicates that at least one fatal question was answered without having the highest score available for the question"
},
"comments": {
"type": "string",
"description": "Overall comments from the evaluator"
},
"privateComments": {
"type": "string",
"description": "Overall private comments from the evaluator"
},
"agentComments": {
"type": "string",
"description": "Comments from the agent while reviewing evaluation results"
},
"transcriptTopics": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of topics found within the conversation's transcripts"
}
}
},
"evaluationForm": {
"type": "object",
"description": "Evaluation Form",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The evaluation form name"
},
"modifiedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"published": {
"type": "boolean",
"description": "The published value"
},
"contextId": {
"type": "string",
"description": "Context Id"
},
"questionGroups": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of question groups"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions"
},
"evaluationSettings": {
"type": "object",
"description": "Evaluation Settings"
},
"latestVersionFormName": {
"type": "string",
"description": "The name of the form's most recently published version"
},
"aiScoring": {
"type": "object",
"description": "Ai Scoring"
},
"dialect": {
"type": "string",
"description": "The language dialect for this evaluation form. Supported dialects: ar, cs, da, de, en-US, es, fi, fr, fr-CA, he, hi, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, th, tr, uk, zh-CN, zh-TW"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name",
"questionGroups"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_tasks\_quality\_post\_evaluations\_search
Search evaluations based along specified criteria
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------- |
| `aggregations` | object\[] | No | — | Aggregations to compute on the search results |
| `pageNumber` | integer | Yes | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page. For aggregation requests, must be omitted or 0. |
| `query` | object\[] | Yes | — | Search query string |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by. Include with sortOrder. |
| `sortOrder` | string | No | — | The sort order for results. Include with sortBy. |
| `systemSubmitted` | boolean | No | — | Filter for automated evaluations submitted by virtual supervisor. Defaults to false. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"aggregations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the aggregation"
},
"field": {
"type": "string",
"enum": [
"formId",
"formIdReleased",
"contextId",
"questionGroupId",
"questionId",
"questionAnswerId",
"evaluationStatus",
"aiScoringFailureType",
"questionAiAnswerFailureType",
"released",
"questionGroupMarkedNA",
"questionMarkedNA",
"questionAiScored",
"questionEaScored",
"totalScore",
"totalCriticalScore",
"questionGroupScorePercentage",
"criticalQuestionGroupScorePercentage",
"questionGroupScore",
"criticalQuestionGroupScore",
"questionScore",
"disputeCount",
"rescoreCount",
"eaSuggestionCount",
"eaAcceptedSuggestionCount",
"aiSuggestionCount",
"aiAcceptedSuggestionCount",
"conversationDate",
"createdDate",
"submittedDate",
"releaseDate"
],
"description": "The field to aggregate on.ALLOWED FIELDS BY AGGREGATION TYPE:TERM/COUNT: evaluationStatus, aiScoringFailureType, questionAiAnswerFailureType,TERM: formId, formIdReleased, contextId, questionGroupId, questionId, questionAnswerId, released, questionGroupMarkedNA, questionMarkedNA, questionAiScored, questionEaScored,SUM/AVERAGE/STATS/RANGE: totalScore, totalCriticalScore, questionGroupScorePercentage,criticalQuestionGroupScorePercentage, questionScore,SUM: disputeCount, rescoreCount, eaSuggestionCount, eaAcceptedSuggestionCount,aiSuggestionCount, aiAcceptedSuggestionCount,DATE_HISTOGRAM: conversationDate, createdDate, submittedDate, releaseDate"
},
"type": {
"type": "string",
"enum": [
"TERM",
"STATS",
"SUM",
"COUNT",
"AVERAGE",
"RANGE",
"DATE_HISTOGRAM"
],
"description": "The Type of Aggregation to Perform"
},
"size": {
"type": "integer",
"format": "int32",
"description": "The size limit for term aggregations, 100 size limit for all fields"
},
"calendarInterval": {
"type": "string",
"description": "The calendar interval for date histogram aggregations"
},
"format": {
"type": "string",
"description": "The format for date histogram aggregations"
},
"ranges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"to": {
"type": "number"
},
"from": {
"type": "number"
}
}
},
"description": "The ranges for range aggregations"
},
"subAggregations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the aggregation"
},
"field": {
"type": "string",
"description": "The field to aggregate on.ALLOWED FIELDS BY AGGREGATION TYPE:TERM/COUNT: evaluationStatus, aiScoringFailureType, questionAiAnswerFailureType,TERM: formId, formIdReleased, contextId, questionGroupId, questionId, questionAnswerId, released, questionGroupMarkedNA, questionMarkedNA, questionAiScored, questionEaScored,SUM/AVERAGE/STATS/RANGE: totalScore, totalCriticalScore, questionGroupScorePercentage,criticalQuestionGroupScorePercentage, questionScore,SUM: disputeCount, rescoreCount, eaSuggestionCount, eaAcceptedSuggestionCount,aiSuggestionCount, aiAcceptedSuggestionCount,DATE_HISTOGRAM: conversationDate, createdDate, submittedDate, releaseDate"
},
"type": {
"type": "string",
"description": "The Type of Aggregation to Perform"
},
"size": {
"type": "integer",
"description": "The size limit for term aggregations, 100 size limit for all fields"
},
"calendarInterval": {
"type": "string",
"description": "The calendar interval for date histogram aggregations"
},
"format": {
"type": "string",
"description": "The format for date histogram aggregations"
},
"ranges": {
"type": "array",
"description": "The ranges for range aggregations"
},
"subAggregations": {
"type": "array",
"description": "Sub-aggregations to be computed within this aggregation"
}
}
},
"description": "Sub-aggregations to be computed within this aggregation"
}
},
"required": [
"field",
"name",
"type"
]
},
"description": "Aggregations to compute on the search results"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page. For aggregation requests, must be omitted or 0."
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"EXACT",
"DATE_RANGE",
"GREATER_THAN",
"GREATER_THAN_EQUAL_TO",
"LESS_THAN",
"LESS_THAN_EQUAL_TO",
"RANGE",
"REQUIRED_FIELDS"
],
"description": "The type of query Operation to Perform"
},
"field": {
"type": "string",
"enum": [
"evaluationId",
"conversationId",
"contextId",
"formId",
"evaluationStatus",
"queueId",
"agentTeamId",
"divisionId",
"agentId",
"evaluatorId",
"assigneeId",
"totalScore",
"totalCriticalScore",
"conversationDate",
"createdDate",
"submittedDate",
"releaseDate",
"released",
"mediaType",
"questionGroupId",
"questionGroupMarkedNA",
"questionGroupScore",
"criticalQuestionGroupScore",
"questionGroupScorePercentage",
"criticalQuestionGroupScorePercentage",
"questionId",
"questionAnswerId",
"questionScore",
"questionMarkedNA",
"failedKillQuestion"
],
"description": "Field name to search against"
},
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types. Date values must be in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against. Only for Type: EXACT"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types. Date values must be in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
}
},
"required": [
"field",
"type"
]
},
"description": "Search query string"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by. Include with sortOrder.",
"enum": [
"conversationDate",
"createdDate",
"submittedDate",
"releaseDate"
]
},
"sortOrder": {
"type": "string",
"description": "The sort order for results. Include with sortBy.",
"enum": [
"ASC",
"DESC"
]
},
"systemSubmitted": {
"type": "boolean",
"description": "Filter for automated evaluations submitted by virtual supervisor. Defaults to false."
}
},
"required": [
"PCID",
"pageNumber",
"query"
]
}
```
***
## genesys\_tasks\_quality\_post\_forms\_evaluations
Create an evaluation form.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `aiScoring` | object | No | — | Ai Scoring |
| `contextId` | string | No | — | Context Id |
| `dialect` | string | No | — | The language dialect for this evaluation form. Supported dialects: ar, cs, da, de, en-US, es, fi, fr, fr-CA, he, hi, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, th, tr, uk, zh-CN, zh-TW |
| `evaluationSettings` | object | No | — | Evaluation Settings |
| `id` | string | No | — | The globally unique identifier for the object. |
| `latestVersionFormName` | string | No | — | The name of the form's most recently published version |
| `modifiedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | Yes | — | The evaluation form name |
| `published` | boolean | No | — | The published value |
| `publishedVersions` | object | No | — | Published Versions |
| `questionGroups` | object\[] | Yes | — | A list of question groups |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"aiScoring": {
"type": "object",
"description": "Ai Scoring",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"questionGroupSettings": {
"type": "array",
"items": {
"type": "object"
},
"description": "Question Group Settings"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"contextId": {
"type": "string",
"description": "Context Id"
},
"dialect": {
"type": "string",
"description": "The language dialect for this evaluation form. Supported dialects: ar, cs, da, de, en-US, es, fi, fr, fr-CA, he, hi, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, th, tr, uk, zh-CN, zh-TW"
},
"evaluationSettings": {
"type": "object",
"description": "Evaluation Settings",
"properties": {
"revisionsEnabled": {
"type": "boolean",
"description": "Whether revisions are allowed for evaluations. When enabled, rescoring creates a new version of the evaluation and retracts the existing evaluation version. Does not apply for calibration evaluations."
},
"disputesEnabled": {
"type": "boolean",
"description": "Whether disputes are allowed for evaluations. Does not apply for calibration evaluations."
},
"disputesAllowedPerEvaluation": {
"type": "integer",
"description": "The maximum number of disputes allowed for an evaluation."
},
"disputesAssignees": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of assignees responsible for handling each dispute. This list size needs to be equal to disputesAllowedPerEvaluation."
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"latestVersionFormName": {
"type": "string",
"description": "The name of the form's most recently published version"
},
"modifiedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The evaluation form name"
},
"published": {
"type": "boolean",
"description": "The published value"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions",
"properties": {
"entities": {
"type": "array",
"items": {
"type": "object"
},
"description": "The entities value"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"total": {
"type": "integer",
"description": "The total value"
},
"firstUri": {
"type": "string",
"description": "First Uri"
},
"nextUri": {
"type": "string",
"description": "Next Uri"
},
"previousUri": {
"type": "string",
"description": "Previous Uri"
},
"lastUri": {
"type": "string",
"description": "Last Uri"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
},
"pageCount": {
"type": "integer",
"description": "Page Count"
}
}
},
"questionGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"contextId": {
"type": "string",
"description": "An identifier for this question group that stays the same across versions of the form."
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "string",
"description": "The type value"
},
"defaultAnswersToHighest": {
"type": "boolean",
"description": "Default Answers To Highest"
},
"defaultAnswersToNA": {
"type": "boolean",
"description": "Default Answers To NA"
},
"naEnabled": {
"type": "boolean",
"description": "Na Enabled"
},
"weight": {
"type": "number",
"format": "float",
"description": "The weight value"
},
"manualWeight": {
"type": "boolean",
"description": "Manual Weight"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "An identifier for this question that stays the same across versions of the form."
},
"text": {
"type": "string"
},
"helpText": {
"type": "string"
},
"type": {
"type": "string"
},
"naEnabled": {
"type": "boolean"
},
"commentsRequired": {
"type": "boolean"
},
"visibilityCondition": {
"type": "object"
},
"answerOptions": {
"type": "array",
"description": "Options from which to choose an answer for this question. Only used by Multiple Choice type questions."
},
"multipleSelectOptionQuestions": {
"type": "array",
"description": "Only used by Multiple Select type questions. A list of multiple choice questions representing selectable options."
},
"defaultAnswer": {
"type": "object"
},
"automatedScoringFocus": {
"type": "string",
"description": "Focus setting for automated scoring"
},
"isKill": {
"type": "boolean"
},
"isCritical": {
"type": "boolean"
}
}
},
"description": "The questions value"
},
"visibilityCondition": {
"type": "object",
"description": "Visibility Condition"
},
"defaultAnswersTo": {
"type": "object",
"description": "Default Answers To"
}
}
},
"description": "A list of question groups"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"name",
"questionGroups"
]
}
```
***
## genesys\_tasks\_quality\_post\_forms\_surveys
Create a survey form.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contextId` | string | Yes | — | Unique Id for all versions of this form |
| `disabled` | boolean | No | — | Is this form disabled |
| `footer` | string | No | — | Markdown text for the bottom of the form. |
| `header` | string | No | — | Markdown text for the top of the form. |
| `id` | string | No | — | The globally unique identifier for the object. |
| `language` | string | Yes | — | Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW |
| `modifiedDate` | string | No | — | Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | Yes | — | The survey form name |
| `published` | boolean | No | — | Is this form published |
| `publishedVersions` | object | No | — | Published Versions |
| `questionGroups` | object\[] | No | — | A list of question groups |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contextId": {
"type": "string",
"description": "Unique Id for all versions of this form"
},
"disabled": {
"type": "boolean",
"description": "Is this form disabled"
},
"footer": {
"type": "string",
"description": "Markdown text for the bottom of the form."
},
"header": {
"type": "string",
"description": "Markdown text for the top of the form."
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"language": {
"type": "string",
"description": "Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"
},
"modifiedDate": {
"type": "string",
"description": "Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The survey form name"
},
"published": {
"type": "boolean",
"description": "Is this form published"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions",
"properties": {
"entities": {
"type": "array",
"items": {
"type": "object"
},
"description": "The entities value"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"total": {
"type": "integer",
"description": "The total value"
},
"firstUri": {
"type": "string",
"description": "First Uri"
},
"nextUri": {
"type": "string",
"description": "Next Uri"
},
"previousUri": {
"type": "string",
"description": "Previous Uri"
},
"lastUri": {
"type": "string",
"description": "Last Uri"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
},
"pageCount": {
"type": "integer",
"description": "Page Count"
}
}
},
"questionGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"contextId": {
"type": "string",
"description": "An identifier for this question group that stays the same across versions of the form."
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "string",
"description": "The type value"
},
"naEnabled": {
"type": "boolean",
"description": "Na Enabled"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "An identifier for this question that stays the same across versions of the form."
},
"text": {
"type": "string"
},
"helpText": {
"type": "string"
},
"type": {
"type": "string"
},
"naEnabled": {
"type": "boolean"
},
"visibilityCondition": {
"type": "object"
},
"answerOptions": {
"type": "array",
"description": "Options from which to choose an answer for this question. Only used by Multiple Choice type questions."
},
"maxResponseCharacters": {
"type": "integer",
"description": "How many characters are allowed in the text response to this question. Used by NPS and Free Text question types."
},
"explanationPrompt": {
"type": "string",
"description": "Prompt for details explaining the chosen NPS score. Used by NPS questions."
}
}
},
"description": "The questions value"
},
"visibilityCondition": {
"type": "object",
"description": "Visibility Condition"
}
}
},
"description": "A list of question groups"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"contextId",
"language",
"name"
]
}
```
***
## genesys\_tasks\_quality\_post\_program\_agentscoringrules
Create an Agent Scoring Rule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `programId` | string | Yes | — | Program ID from Speech and Text Analytics |
| `agentToScore` | string | No | — | Which agent(s) to score. Valid values: First, Last, Each. |
| `dateCreated` | string | No | — | Date when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateModified` | string | No | — | Date when the rule was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `enabled` | boolean | Yes | — | Whether the rule is enabled. |
| `evaluationFormContextId` | string | Yes | — | The evaluation form contextID to use for scoring. |
| `evaluator` | object | No | — | The evaluator value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `published` | boolean | No | — | Whether the rule is published. |
| `samplingPercentage` | number | No | — | Percentage of interactions to evaluate (0.01-100.00). Required when samplingType is Percentage, null when All. |
| `samplingType` | string | Yes | — | Sampling type setting. Valid values: All, Percentage |
| `selfUri` | string | No | — | The URI for this object |
| `submissionType` | string | Yes | — | Submission type for evaluations. Valid values: Automated, Manual |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"programId": {
"type": "string",
"description": "Program ID from Speech and Text Analytics"
},
"agentToScore": {
"type": "string",
"description": "Which agent(s) to score. Valid values: First, Last, Each.",
"enum": [
"First",
"Last",
"Each"
]
},
"dateCreated": {
"type": "string",
"description": "Date when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the rule was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"enabled": {
"type": "boolean",
"description": "Whether the rule is enabled."
},
"evaluationFormContextId": {
"type": "string",
"description": "The evaluation form contextID to use for scoring."
},
"evaluator": {
"type": "object",
"description": "The evaluator value",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"published": {
"type": "boolean",
"description": "Whether the rule is published."
},
"samplingPercentage": {
"type": "number",
"description": "Percentage of interactions to evaluate (0.01-100.00). Required when samplingType is Percentage, null when All."
},
"samplingType": {
"type": "string",
"description": "Sampling type setting. Valid values: All, Percentage",
"enum": [
"All",
"Percentage"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"submissionType": {
"type": "string",
"description": "Submission type for evaluations. Valid values: Automated, Manual",
"enum": [
"Automated",
"Manual"
]
}
},
"required": [
"PCID",
"programId",
"enabled",
"evaluationFormContextId",
"samplingType",
"submissionType"
]
}
```
***
## genesys\_tasks\_quality\_post\_quality\_evaluations\_search
Search evaluations based along specified criteria
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------- |
| `aggregations` | any\[] | No | — | Aggregations to compute on the search results |
| `pageNumber` | integer | Yes | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page. For aggregation requests, must be omitted or 0. |
| `query` | any\[] | Yes | — | query |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by. Include with sortOrder. |
| `sortOrder` | string | No | — | The sort order for results. Include with sortBy. |
| `systemSubmitted` | boolean | No | — | Filter for automated evaluations submitted by virtual supervisor. Defaults to false. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"aggregations": {
"type": "array",
"description": "Aggregations to compute on the search results"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page. For aggregation requests, must be omitted or 0."
},
"query": {
"type": "array",
"description": "query"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by. Include with sortOrder.",
"enum": [
"conversationDate",
"createdDate",
"submittedDate",
"releaseDate"
]
},
"sortOrder": {
"type": "string",
"description": "The sort order for results. Include with sortBy.",
"enum": [
"ASC",
"DESC"
]
},
"systemSubmitted": {
"type": "boolean",
"description": "Filter for automated evaluations submitted by virtual supervisor. Defaults to false."
}
},
"required": [
"PCID",
"pageNumber",
"query"
]
}
```
***
## genesys\_tasks\_quality\_post\_surveys
Create a survey for a conversation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| `agentId` | string | No | — | The agent to associate with the survey. If not specified, the last agent on the conversation will be selected. |
| `conversationId` | string | Yes | — | The conversation to create the survey for. |
| `queueId` | string | No | — | The queue to associate with the survey. If not specified, the queue associated with the selected agent will be used. |
| `surveyFormContextId` | string | Yes | — | The survey form context to use for the survey. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"agentId": {
"type": "string",
"description": "The agent to associate with the survey. If not specified, the last agent on the conversation will be selected."
},
"conversationId": {
"type": "string",
"description": "The conversation to create the survey for."
},
"queueId": {
"type": "string",
"description": "The queue to associate with the survey. If not specified, the queue associated with the selected agent will be used."
},
"surveyFormContextId": {
"type": "string",
"description": "The survey form context to use for the survey."
}
},
"required": [
"PCID",
"conversationId",
"surveyFormContextId"
]
}
```
***
## genesys\_tasks\_quality\_post\_surveys\_scoring
Score survey
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------------- |
| `answers` | object | No | — | The answers value |
| `surveyForm` | object | No | — | Survey Form |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"answers": {
"type": "object",
"description": "The answers value",
"properties": {
"totalScore": {
"type": "number",
"description": "Total Score"
},
"npsScore": {
"type": "integer",
"description": "Nps Score"
},
"questionGroupScores": {
"type": "array",
"items": {
"type": "object"
},
"description": "Question Group Scores"
}
}
},
"surveyForm": {
"type": "object",
"description": "Survey Form",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The survey form name"
},
"modifiedDate": {
"type": "string",
"description": "Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"published": {
"type": "boolean",
"description": "Is this form published"
},
"disabled": {
"type": "boolean",
"description": "Is this form disabled"
},
"contextId": {
"type": "string",
"description": "Unique Id for all versions of this form"
},
"language": {
"type": "string",
"description": "Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"
},
"header": {
"type": "string",
"description": "Markdown text for the top of the form."
},
"footer": {
"type": "string",
"description": "Markdown text for the bottom of the form."
},
"questionGroups": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of question groups"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"contextId",
"language",
"name"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_tasks\_quality\_post\_taskmanagement\_workbins\_query
Query for workbins
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `attributes` | any\[] | No | — | List of entity attributes to be retrieved in the result. |
| `filters` | any\[] | Yes | — | List of filter objects to be used in the search. Valid filter names are: 'id', 'name', 'description', 'divisionId', 'dateCreated', 'dateModified', 'modifiedBy' |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `select` | string | No | — | Specify the value 'Count' for this parameter in order to return only the record count. |
| `sort` | object | No | — | sort |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"attributes": {
"type": "array",
"description": "List of entity attributes to be retrieved in the result."
},
"filters": {
"type": "array",
"description": "List of filter objects to be used in the search. Valid filter names are: 'id', 'name', 'description', 'divisionId', 'dateCreated', 'dateModified', 'modifiedBy'"
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"select": {
"type": "string",
"description": "Specify the value 'Count' for this parameter in order to return only the record count.",
"enum": [
"Count"
]
},
"sort": {
"type": "object",
"description": "sort"
}
},
"required": [
"PCID",
"filters"
]
}
```
***
## genesys\_tasks\_quality\_post\_taskmanagement\_workitem\_terminate
Terminate a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `statusId` | string | No | — | The ID of the status the workitem should be updated to when terminating. The status must be a 'Closed' category status. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"statusId": {
"type": "string",
"description": "The ID of the status the workitem should be updated to when terminating. The status must be a 'Closed' category status."
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_post\_taskmanagement\_workitems
Create a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `assigneeId` | string | No | — | The ID of the assignee of the Workitem. Must be a valid UUID. |
| `autoStatusTransition` | boolean | No | — | Set it to false to disable auto status transition. By default, it is enabled. |
| `customFields` | object | No | — | Custom fields defined in the schema referenced by the worktype of the workitem. |
| `dateDue` | string | No | — | The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateExpires` | string | No | — | The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | The description of the Workitem. Maximum length of 512 characters. |
| `durationSeconds` | integer | No | — | The estimated duration in seconds to complete the Workitem. Maximum of 365 days. |
| `externalContactId` | string | No | — | The ID of the external contact of the Workitem. Must be a valid UUID. |
| `externalTag` | string | No | — | The external tag of the Workitem. |
| `languageId` | string | No | — | The ID of language of the Workitem. Must be a valid UUID. |
| `name` | string | Yes | — | The name of the Workitem. Valid length between 3 and 256 characters. |
| `preferredAgentIds` | any\[] | No | — | The preferred agent IDs of the Workitem. Must be valid UUIDs. |
| `priority` | integer | No | — | The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. |
| `queueId` | string | No | — | The ID of the Workitems queue. Must be a valid UUID. |
| `scoredAgents` | any\[] | No | — | A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. |
| `scriptId` | string | No | — | The ID of the Workitems script. Must be a valid UUID. |
| `skillIds` | any\[] | No | — | The skill IDs of the Workitem. Must be valid UUIDs. |
| `statusId` | string | No | — | The ID of the Status of the Workitem. |
| `ttl` | integer | No | — | The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time. |
| `typeId` | string | Yes | — | The ID of the Worktype of the Workitem. |
| `utilizationLabelId` | string | No | — | The ID of utilization label of the Workitem. Must be a valid UUID. |
| `workbinId` | string | No | — | The ID of Workbin that contains the Workitem. |
| `wrapupCode` | string | No | — | The ID of the wrapup. Must be a valid UUID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assigneeId": {
"type": "string",
"description": "The ID of the assignee of the Workitem. Must be a valid UUID."
},
"autoStatusTransition": {
"type": "boolean",
"description": "Set it to false to disable auto status transition. By default, it is enabled."
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by the worktype of the workitem."
},
"dateDue": {
"type": "string",
"description": "The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateExpires": {
"type": "string",
"description": "The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "The description of the Workitem. Maximum length of 512 characters."
},
"durationSeconds": {
"type": "integer",
"description": "The estimated duration in seconds to complete the Workitem. Maximum of 365 days."
},
"externalContactId": {
"type": "string",
"description": "The ID of the external contact of the Workitem. Must be a valid UUID."
},
"externalTag": {
"type": "string",
"description": "The external tag of the Workitem."
},
"languageId": {
"type": "string",
"description": "The ID of language of the Workitem. Must be a valid UUID."
},
"name": {
"type": "string",
"description": "The name of the Workitem. Valid length between 3 and 256 characters."
},
"preferredAgentIds": {
"type": "array",
"description": "The preferred agent IDs of the Workitem. Must be valid UUIDs."
},
"priority": {
"type": "integer",
"description": "The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."
},
"queueId": {
"type": "string",
"description": "The ID of the Workitems queue. Must be a valid UUID."
},
"scoredAgents": {
"type": "array",
"description": "A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents."
},
"scriptId": {
"type": "string",
"description": "The ID of the Workitems script. Must be a valid UUID."
},
"skillIds": {
"type": "array",
"description": "The skill IDs of the Workitem. Must be valid UUIDs."
},
"statusId": {
"type": "string",
"description": "The ID of the Status of the Workitem."
},
"ttl": {
"type": "integer",
"description": "The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time."
},
"typeId": {
"type": "string",
"description": "The ID of the Worktype of the Workitem."
},
"utilizationLabelId": {
"type": "string",
"description": "The ID of utilization label of the Workitem. Must be a valid UUID."
},
"workbinId": {
"type": "string",
"description": "The ID of Workbin that contains the Workitem."
},
"wrapupCode": {
"type": "string",
"description": "The ID of the wrapup. Must be a valid UUID."
}
},
"required": [
"PCID",
"name",
"typeId"
]
}
```
***
## genesys\_tasks\_quality\_post\_taskmanagement\_workitems\_query
Query for workitems
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `attributes` | any\[] | No | — | List of entity attributes to be retrieved in the result. |
| `expands` | any\[] | No | — | List of entity attributes to be expanded in the result. |
| `filters` | any\[] | Yes | — | List of filter objects to be used in the search. Valid filter names are: 'id', 'name', 'description', 'languageId', 'priority', 'dateCreated', 'dateModified', 'dateDue', 'dateExpires', 'durationInSeconds', 'ttl', 'statusId', 'statusCategory', 'dateClosed', 'externalContactId', 'reporterId', 'queueId', 'externalTag', 'modifiedBy', 'assignmentState', 'divisionId', 'customFields.\' |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `select` | string | No | — | Specify the value 'Count' for this parameter in order to return only the record count. |
| `sort` | object | No | — | sort |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"attributes": {
"type": "array",
"description": "List of entity attributes to be retrieved in the result."
},
"expands": {
"type": "array",
"description": "List of entity attributes to be expanded in the result."
},
"filters": {
"type": "array",
"description": "List of filter objects to be used in the search. Valid filter names are: 'id', 'name', 'description', 'languageId', 'priority', 'dateCreated', 'dateModified', 'dateDue', 'dateExpires', 'durationInSeconds', 'ttl', 'statusId', 'statusCategory', 'dateClosed', 'externalContactId', 'reporterId', 'queueId', 'externalTag', 'modifiedBy', 'assignmentState', 'divisionId', 'customFields.'"
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"select": {
"type": "string",
"description": "Specify the value 'Count' for this parameter in order to return only the record count.",
"enum": [
"Count"
]
},
"sort": {
"type": "object",
"description": "sort"
}
},
"required": [
"PCID",
"filters"
]
}
```
***
## genesys\_tasks\_quality\_post\_taskmanagement\_worktypes\_query
Query for worktypes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `attributes` | any\[] | No | — | List of entity attributes to be retrieved in the result. |
| `filters` | any\[] | Yes | — | List of filter objects to be used in the search. Valid filter names are: 'divisionId', 'id', 'name', 'description', 'defaultWorkbinId', 'defaultDurationSeconds', 'defaultExpirationSeconds', 'defaultDueDurationSeconds', 'defaultPriority', 'defaultLanguageId', 'defaultTtlSeconds', 'assignmentEnabled', 'defaultQueueId', 'schemaId', 'schemaVersion', 'dateCreated', 'dateModified', 'modifiedBy' |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `select` | string | No | — | Specify the value 'Count' for this parameter in order to return only the record count. |
| `sort` | object | No | — | sort |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"attributes": {
"type": "array",
"description": "List of entity attributes to be retrieved in the result."
},
"filters": {
"type": "array",
"description": "List of filter objects to be used in the search. Valid filter names are: 'divisionId', 'id', 'name', 'description', 'defaultWorkbinId', 'defaultDurationSeconds', 'defaultExpirationSeconds', 'defaultDueDurationSeconds', 'defaultPriority', 'defaultLanguageId', 'defaultTtlSeconds', 'assignmentEnabled', 'defaultQueueId', 'schemaId', 'schemaVersion', 'dateCreated', 'dateModified', 'modifiedBy'"
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"select": {
"type": "string",
"description": "Specify the value 'Count' for this parameter in order to return only the record count.",
"enum": [
"Count"
]
},
"sort": {
"type": "object",
"description": "sort"
}
},
"required": [
"PCID",
"filters"
]
}
```
***
## genesys\_tasks\_quality\_post\_workbins
Create a workbin
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- |
| `description` | string | No | — | Workbin description. Maximum length of 512 characters. |
| `divisionId` | string | No | — | The ID of the division the Workbin belongs to. Defaults to home division ID. |
| `name` | string | Yes | — | Workbin name. Valid length between 3 and 256 characters. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "Workbin description. Maximum length of 512 characters."
},
"divisionId": {
"type": "string",
"description": "The ID of the division the Workbin belongs to. Defaults to home division ID."
},
"name": {
"type": "string",
"description": "Workbin name. Valid length between 3 and 256 characters."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## genesys\_tasks\_quality\_post\_workbins\_query
Query for workbins
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `attributes` | string\[] | No | — | List of entity attributes to be retrieved in the result. |
| `filters` | object\[] | Yes | — | List of filter objects to be used in the search. Valid filter names are: 'id', 'name', 'description', 'divisionId', 'dateCreated', 'dateModified', 'modifiedBy' |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `select` | string | No | — | Specify the value 'Count' for this parameter in order to return only the record count. |
| `sort` | object | No | — | Sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of entity attributes to be retrieved in the result."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Attribute name."
},
"type": {
"type": "string",
"enum": [
"String",
"Int"
],
"description": "Attribute type."
},
"operator": {
"type": "string",
"enum": [
"EQ",
"NEQ",
"GT",
"LT",
"GTE",
"LTE",
"IN",
"CONTAINS",
"BETWEEN",
"BEGINS_WITH"
],
"description": "Filter operator."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of values to be used in the filter."
}
},
"required": [
"name",
"operator",
"type",
"values"
]
},
"description": "List of filter objects to be used in the search. Valid filter names are: 'id', 'name', 'description', 'divisionId', 'dateCreated', 'dateModified', 'modifiedBy'"
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"select": {
"type": "string",
"description": "Specify the value 'Count' for this parameter in order to return only the record count.",
"enum": [
"Count"
]
},
"sort": {
"type": "object",
"description": "Sort order for results",
"properties": {
"name": {
"type": "string",
"description": "Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.",
"enum": [
"dateModified",
"name"
]
},
"ascending": {
"type": "boolean",
"description": "Sort Ascending"
}
}
}
},
"required": [
"PCID",
"filters"
]
}
```
***
## genesys\_tasks\_quality\_post\_workitem\_acd\_cancel
Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `workitemId` | string | Yes | — | Workitem ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_post\_workitem\_disconnect
Disconnect the assignee of the workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `workitemId` | string | Yes | — | Workitem ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_post\_workitem\_terminate
Terminate a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `workitemId` | string | Yes | — | Workitem ID |
| `statusId` | string | No | — | The ID of the status the workitem should be updated to when terminating. The status must be a 'Closed' category status. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workitemId": {
"type": "string",
"description": "Workitem ID"
},
"statusId": {
"type": "string",
"description": "The ID of the status the workitem should be updated to when terminating. The status must be a 'Closed' category status."
}
},
"required": [
"PCID",
"workitemId"
]
}
```
***
## genesys\_tasks\_quality\_post\_workitems
Create a workitem
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `assigneeId` | string | No | — | The ID of the assignee of the Workitem. Must be a valid UUID. |
| `autoStatusTransition` | boolean | No | — | Set it to false to disable auto status transition. By default, it is enabled. |
| `customFields` | object | No | — | Custom fields defined in the schema referenced by the worktype of the workitem. |
| `dateDue` | string | No | — | The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateExpires` | string | No | — | The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | The description of the Workitem. Maximum length of 512 characters. |
| `durationSeconds` | integer | No | — | The estimated duration in seconds to complete the Workitem. Maximum of 365 days. |
| `externalContactId` | string | No | — | The ID of the external contact of the Workitem. Must be a valid UUID. |
| `externalTag` | string | No | — | The external tag of the Workitem. |
| `languageId` | string | No | — | The ID of language of the Workitem. Must be a valid UUID. |
| `name` | string | Yes | — | The name of the Workitem. Valid length between 3 and 256 characters. |
| `preferredAgentIds` | string\[] | No | — | The preferred agent IDs of the Workitem. Must be valid UUIDs. |
| `priority` | integer | No | — | The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000. |
| `queueId` | string | No | — | The ID of the Workitems queue. Must be a valid UUID. |
| `scoredAgents` | object\[] | No | — | A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. |
| `scriptId` | string | No | — | The ID of the Workitems script. Must be a valid UUID. |
| `skillIds` | string\[] | No | — | The skill IDs of the Workitem. Must be valid UUIDs. |
| `statusId` | string | No | — | The ID of the Status of the Workitem. |
| `ttl` | integer | No | — | The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time. |
| `typeId` | string | Yes | — | The ID of the Worktype of the Workitem. |
| `utilizationLabelId` | string | No | — | The ID of utilization label of the Workitem. Must be a valid UUID. |
| `workbinId` | string | No | — | The ID of Workbin that contains the Workitem. |
| `wrapupCode` | string | No | — | The ID of the wrapup. Must be a valid UUID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assigneeId": {
"type": "string",
"description": "The ID of the assignee of the Workitem. Must be a valid UUID."
},
"autoStatusTransition": {
"type": "boolean",
"description": "Set it to false to disable auto status transition. By default, it is enabled."
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by the worktype of the workitem."
},
"dateDue": {
"type": "string",
"description": "The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateExpires": {
"type": "string",
"description": "The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "The description of the Workitem. Maximum length of 512 characters."
},
"durationSeconds": {
"type": "integer",
"description": "The estimated duration in seconds to complete the Workitem. Maximum of 365 days."
},
"externalContactId": {
"type": "string",
"description": "The ID of the external contact of the Workitem. Must be a valid UUID."
},
"externalTag": {
"type": "string",
"description": "The external tag of the Workitem."
},
"languageId": {
"type": "string",
"description": "The ID of language of the Workitem. Must be a valid UUID."
},
"name": {
"type": "string",
"description": "The name of the Workitem. Valid length between 3 and 256 characters."
},
"preferredAgentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The preferred agent IDs of the Workitem. Must be valid UUIDs."
},
"priority": {
"type": "integer",
"description": "The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000."
},
"queueId": {
"type": "string",
"description": "The ID of the Workitems queue. Must be a valid UUID."
},
"scoredAgents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "An agents ID. Must be a valid UUID."
},
"score": {
"type": "integer",
"format": "int32",
"description": "Agent's score for the workitem, from 0 - 100, higher being better"
}
}
},
"description": "A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents."
},
"scriptId": {
"type": "string",
"description": "The ID of the Workitems script. Must be a valid UUID."
},
"skillIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The skill IDs of the Workitem. Must be valid UUIDs."
},
"statusId": {
"type": "string",
"description": "The ID of the Status of the Workitem."
},
"ttl": {
"type": "integer",
"description": "The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time."
},
"typeId": {
"type": "string",
"description": "The ID of the Worktype of the Workitem."
},
"utilizationLabelId": {
"type": "string",
"description": "The ID of utilization label of the Workitem. Must be a valid UUID."
},
"workbinId": {
"type": "string",
"description": "The ID of Workbin that contains the Workitem."
},
"wrapupCode": {
"type": "string",
"description": "The ID of the wrapup. Must be a valid UUID."
}
},
"required": [
"PCID",
"name",
"typeId"
]
}
```
***
## genesys\_tasks\_quality\_post\_workitems\_query
Query for workitems
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `attributes` | string\[] | No | — | List of entity attributes to be retrieved in the result. |
| `expands` | string\[] | No | — | List of entity attributes to be expanded in the result. |
| `filters` | object\[] | Yes | — | List of filter objects to be used in the search. Valid filter names are: 'workbinId', 'typeId, 'assigneeId', 'id', 'name', 'description', 'languageId', 'priority', 'dateCreated', 'dateModified', 'dateDue', 'dateExpires', 'durationInSeconds', 'ttl', 'statusId', 'statusCategory', 'dateClosed', 'externalContactId', 'reporterId', 'queueId', 'externalTag', 'modifiedBy', 'assignmentState', 'divisionId', 'caseId', 'externalContactId', 'customFields.\' |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `select` | string | No | — | Specify the value 'Count' for this parameter in order to return only the record count. |
| `sort` | object | No | — | Sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of entity attributes to be retrieved in the result."
},
"expands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"type",
"workbin",
"status",
"assignee",
"reporter",
"queue",
"case",
"externalContact"
]
},
"description": "List of entity attributes to be expanded in the result."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Attribute name."
},
"type": {
"type": "string",
"enum": [
"String",
"Int"
],
"description": "Attribute type."
},
"operator": {
"type": "string",
"enum": [
"EQ",
"NEQ",
"GT",
"LT",
"GTE",
"LTE",
"IN",
"CONTAINS",
"BETWEEN",
"BEGINS_WITH"
],
"description": "Filter operator."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of values to be used in the filter."
}
},
"required": [
"name",
"operator",
"type",
"values"
]
},
"description": "List of filter objects to be used in the search. Valid filter names are: 'workbinId', 'typeId, 'assigneeId', 'id', 'name', 'description', 'languageId', 'priority', 'dateCreated', 'dateModified', 'dateDue', 'dateExpires', 'durationInSeconds', 'ttl', 'statusId', 'statusCategory', 'dateClosed', 'externalContactId', 'reporterId', 'queueId', 'externalTag', 'modifiedBy', 'assignmentState', 'divisionId', 'caseId', 'externalContactId', 'customFields.'"
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"select": {
"type": "string",
"description": "Specify the value 'Count' for this parameter in order to return only the record count.",
"enum": [
"Count"
]
},
"sort": {
"type": "object",
"description": "Sort order for results",
"properties": {
"name": {
"type": "string",
"description": "Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.",
"enum": [
"dateDue",
"priority"
]
},
"ascending": {
"type": "boolean",
"description": "Sort Ascending"
}
}
}
},
"required": [
"PCID",
"filters"
]
}
```
***
## genesys\_tasks\_quality\_post\_worktype\_statuses
Add a status to a worktype
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `worktypeId` | string | Yes | — | Worktype id |
| `autoTerminateWorkitem` | boolean | No | — | Terminate workitem on selection of status. Applicable only for statuses in the Closed category. |
| `category` | string | Yes | — | The Category of the Status. |
| `defaultDestinationStatusId` | string | No | — | Default destination status to which this Status will transition to if auto status transition enabled. |
| `description` | string | No | — | The description of the Status. Maximum length of 512 characters. |
| `destinationStatusIds` | string\[] | No | — | A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations. |
| `name` | string | Yes | — | The name of the Status. Valid length between 3 and 256 characters. |
| `statusTransitionDelaySeconds` | integer | No | — | Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided. |
| `statusTransitionTime` | string | No | — | Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"worktypeId": {
"type": "string",
"description": "Worktype id"
},
"autoTerminateWorkitem": {
"type": "boolean",
"description": "Terminate workitem on selection of status. Applicable only for statuses in the Closed category."
},
"category": {
"type": "string",
"description": "The Category of the Status.",
"enum": [
"Open",
"InProgress",
"Waiting",
"Closed",
"Unknown"
]
},
"defaultDestinationStatusId": {
"type": "string",
"description": "Default destination status to which this Status will transition to if auto status transition enabled."
},
"description": {
"type": "string",
"description": "The description of the Status. Maximum length of 512 characters."
},
"destinationStatusIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of destination Statuses where a Workitem with this Status can transition to. If the list is empty Workitems with this Status can transition to all other Statuses defined on the Worktype. A Status can have a maximum of 24 destinations."
},
"name": {
"type": "string",
"description": "The name of the Status. Valid length between 3 and 256 characters."
},
"statusTransitionDelaySeconds": {
"type": "integer",
"description": "Delay in seconds for auto status transition. Required if defaultDestinationStatusId is provided."
},
"statusTransitionTime": {
"type": "string",
"description": "Time is represented as an ISO-8601 string without a timezone. For example: HH:mm:ss.SSS"
}
},
"required": [
"PCID",
"worktypeId",
"category",
"name"
]
}
```
***
## genesys\_tasks\_quality\_post\_worktypes
Create a worktype
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `assignmentEnabled` | boolean | No | — | When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false. |
| `defaultDueDurationSeconds` | integer | No | — | The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days. |
| `defaultDurationSeconds` | integer | No | — | The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days. |
| `defaultExpirationSeconds` | integer | No | — | The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days. |
| `defaultLanguageId` | string | No | — | The ID of the default language for Workitems created from the Worktype. Must be a valid UUID. |
| `defaultPriority` | integer | No | — | The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000. |
| `defaultQueueId` | string | No | — | The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID. |
| `defaultScriptId` | string | No | — | The default script for Workitems created from the Worktype. Must be a valid UUID. |
| `defaultSkillIds` | string\[] | No | — | The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs |
| `defaultTtlSeconds` | integer | No | — | The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days. |
| `defaultWorkbinId` | string | Yes | — | The ID of the default Workbin for Workitems created from the Worktype. |
| `description` | string | No | — | The description of the Worktype. Maximum length of 512 characters. |
| `disableDefaultStatusCreation` | boolean | No | — | Set to true to disable default status creation. Default statuses are created with the Worktype by default |
| `divisionId` | string | No | — | The ID of the division the Worktype belongs to. Defaults to the default Workbin division ID. The Worktype must be in the same division as its default Workbin. |
| `name` | string | Yes | — | The name of the Worktype. Valid length between 3 and 256 characters. |
| `ruleSettings` | object | No | — | Rule Settings |
| `schemaId` | string | No | — | The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID. |
| `schemaVersion` | integer | No | — | The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set. |
| `serviceLevelTarget` | integer | No | — | The target service level for Workitems created from the Worktype. The default value is 100. |
| `unassignedDivisionContactsEnabled` | boolean | No | — | When set to true, will allow Workitems to be associated with External Contacts that are not assigned to any division. Default value is true. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assignmentEnabled": {
"type": "boolean",
"description": "When set to true, Workitems will be sent to the queue of the Worktype as they are created. Default value is false."
},
"defaultDueDurationSeconds": {
"type": "integer",
"description": "The default due duration in seconds for Workitems created from the Worktype. Maximum of 365 days."
},
"defaultDurationSeconds": {
"type": "integer",
"description": "The default duration in seconds for Workitems created from the Worktype. Maximum of 365 days."
},
"defaultExpirationSeconds": {
"type": "integer",
"description": "The default expiration time in seconds for Workitems created from the Worktype. Maximum of 365 days."
},
"defaultLanguageId": {
"type": "string",
"description": "The ID of the default language for Workitems created from the Worktype. Must be a valid UUID."
},
"defaultPriority": {
"type": "integer",
"description": "The default priority for Workitems created from the Worktype. The valid range is between -25,000,000 and 25,000,000."
},
"defaultQueueId": {
"type": "string",
"description": "The ID of the default queue for Workitems created from the Worktype. Must be a valid UUID."
},
"defaultScriptId": {
"type": "string",
"description": "The default script for Workitems created from the Worktype. Must be a valid UUID."
},
"defaultSkillIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the default skills for Workitems created from the Worktype. Must be valid UUIDs. Maximum of 20 IDs"
},
"defaultTtlSeconds": {
"type": "integer",
"description": "The default time to time to live in seconds for Workitems created from the Worktype. The valid range is between 1 and 365 days."
},
"defaultWorkbinId": {
"type": "string",
"description": "The ID of the default Workbin for Workitems created from the Worktype."
},
"description": {
"type": "string",
"description": "The description of the Worktype. Maximum length of 512 characters."
},
"disableDefaultStatusCreation": {
"type": "boolean",
"description": "Set to true to disable default status creation. Default statuses are created with the Worktype by default"
},
"divisionId": {
"type": "string",
"description": "The ID of the division the Worktype belongs to. Defaults to the default Workbin division ID. The Worktype must be in the same division as its default Workbin."
},
"name": {
"type": "string",
"description": "The name of the Worktype. Valid length between 3 and 256 characters."
},
"ruleSettings": {
"type": "object",
"description": "Rule Settings",
"properties": {
"flowRulesEnabled": {
"type": "boolean",
"description": "When set to true, the worktypes flow rules will be processed. Default value is false."
}
}
},
"schemaId": {
"type": "string",
"description": "The ID of the custom attribute schema for Workitems created from the Worktype. Must be a valid UUID."
},
"schemaVersion": {
"type": "integer",
"description": "The version of the Worktypes custom attribute schema. The latest schema version will be used if this property is not set."
},
"serviceLevelTarget": {
"type": "integer",
"description": "The target service level for Workitems created from the Worktype. The default value is 100."
},
"unassignedDivisionContactsEnabled": {
"type": "boolean",
"description": "When set to true, will allow Workitems to be associated with External Contacts that are not assigned to any division. Default value is true."
}
},
"required": [
"PCID",
"defaultWorkbinId",
"name"
]
}
```
***
## genesys\_tasks\_quality\_post\_worktypes\_query
Query for worktypes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
| `attributes` | string\[] | No | — | List of entity attributes to be retrieved in the result. |
| `expands` | string | No | — | List of entity attributes to be expanded in the result. |
| `filters` | object\[] | Yes | — | List of filter objects to be used in the search. Valid filter names are: 'divisionId', 'id', 'name', 'description', 'defaultWorkbinId', 'defaultDurationSeconds', 'defaultExpirationSeconds', 'defaultDueDurationSeconds', 'defaultPriority', 'defaultLanguageId', 'defaultTtlSeconds', 'assignmentEnabled', 'defaultQueueId', 'schemaId', 'schemaVersion', 'dateCreated', 'dateModified', 'modifiedBy' |
| `pageSize` | integer | No | — | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. |
| `select` | string | No | — | Specify the value 'Count' for this parameter in order to return only the record count. |
| `sort` | object | No | — | Sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"attributes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of entity attributes to be retrieved in the result."
},
"expands": {
"type": "string",
"description": "List of entity attributes to be expanded in the result.",
"enum": [
"schema"
]
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Attribute name."
},
"type": {
"type": "string",
"enum": [
"String",
"Int"
],
"description": "Attribute type."
},
"operator": {
"type": "string",
"enum": [
"EQ",
"NEQ",
"GT",
"LT",
"GTE",
"LTE",
"IN",
"CONTAINS",
"BETWEEN",
"BEGINS_WITH"
],
"description": "Filter operator."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of values to be used in the filter."
}
},
"required": [
"name",
"operator",
"type",
"values"
]
},
"description": "List of filter objects to be used in the search. Valid filter names are: 'divisionId', 'id', 'name', 'description', 'defaultWorkbinId', 'defaultDurationSeconds', 'defaultExpirationSeconds', 'defaultDueDurationSeconds', 'defaultPriority', 'defaultLanguageId', 'defaultTtlSeconds', 'assignmentEnabled', 'defaultQueueId', 'schemaId', 'schemaVersion', 'dateCreated', 'dateModified', 'modifiedBy'"
},
"pageSize": {
"type": "integer",
"description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200."
},
"select": {
"type": "string",
"description": "Specify the value 'Count' for this parameter in order to return only the record count.",
"enum": [
"Count"
]
},
"sort": {
"type": "object",
"description": "Sort order for results",
"properties": {
"name": {
"type": "string",
"description": "Specify an attribute for sorting. It's possible to use an attribute both for sorting and in the query at the same time, but these restrictions apply: Only the operators EQ, LT, LTE, GT, GTE, BETWEEN and BEGINS_WITH are supported and the attribute can't be present in more than one filter.",
"enum": [
"dateModified",
"name"
]
},
"ascending": {
"type": "boolean",
"description": "Sort Ascending"
}
}
}
},
"required": [
"PCID",
"filters"
]
}
```
***
## genesys\_tasks\_quality\_put\_conversation\_evaluation
Update an evaluation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `conversationId` | string | Yes | — | Conversation Id |
| `evaluationId` | string | Yes | — | Evaluation Id |
| `expand` | string | No | — | evaluatorId, evaluationForm, assignee, evaluator |
| `agent` | object | No | — | The agent value |
| `agentHasRead` | boolean | No | — | Agent Has Read |
| `agentTeam` | object | No | — | Agent Team |
| `aiScoring` | object | No | — | Ai Scoring |
| `answers` | object | No | — | The answers value |
| `assigned` | boolean | No | — | Set to false to unassign the evaluation. This cannot be set to false when assignee is also set. |
| `assignedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `assignee` | object | No | — | The assignee value |
| `assigneeApplicable` | boolean | No | — | Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable. |
| `authorizedActions` | string\[] | No | — | List of user authorized actions on evaluation. Possible values: assign, edit, editScore, editAgentSignoff, delete, release, viewAudit |
| `calibration` | object | No | — | The calibration value |
| `changedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `conversation` | object | No | — | The conversation value |
| `conversationDate` | string | No | — | Creation date of the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `conversationEndDate` | string | No | — | End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `createdDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateAssigneeChanged` | string | No | — | Date when the assignee was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `divisionIds` | string\[] | No | — | Evaluation is assigned in the following division(s). |
| `evaluationForm` | object | No | — | Evaluation Form |
| `evaluationSource` | object | No | — | Evaluation Source |
| `evaluator` | object | No | — | The evaluator value |
| `hasAssistanceFailed` | boolean | No | — | Is true when evaluation assistance didn't execute successfully |
| `id` | string | No | — | The globally unique identifier for the object. |
| `isScoringIndex` | boolean | No | — | Is Scoring Index |
| `mediaType` | string\[] | No | — | List of different communication types used in conversation. |
| `name` | string | No | — | The name value |
| `neverRelease` | boolean | No | — | Signifies if the evaluation is never to be released. This cannot be set true if release date is also set. |
| `queue` | object | No | — | The queue value |
| `redacted` | boolean | No | — | Is only true when the user making the request does not have sufficient permissions to see evaluation |
| `releaseDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `rescore` | boolean | No | — | Is only true when evaluation is re-scored. |
| `resourceId` | string | No | — | Only used for email evaluations. Will be null for all other evaluations. |
| `resourceType` | string | No | — | The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources. |
| `revisionCreatedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `selfUri` | string | No | — | The URI for this object |
| `status` | string | No | — | The status value |
| `submittedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversationId": {
"type": "string",
"description": "Conversation Id"
},
"evaluationId": {
"type": "string",
"description": "Evaluation Id"
},
"expand": {
"type": "string",
"description": "evaluatorId, evaluationForm, assignee, evaluator"
},
"agent": {
"type": "object",
"description": "The agent value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"agentHasRead": {
"type": "boolean",
"description": "Agent Has Read"
},
"agentTeam": {
"type": "object",
"description": "Agent Team",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The team name"
},
"division": {
"type": "object",
"description": "The division value"
},
"description": {
"type": "string",
"description": "Team information."
},
"dateCreated": {
"type": "string",
"description": "Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"memberCount": {
"type": "integer",
"description": "Number of members in a team"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"aiScoring": {
"type": "object",
"description": "Ai Scoring",
"properties": {
"failureType": {
"type": "string",
"description": "The type of error that occurred while processing AI scores. It is null where there is no error.",
"enum": [
"QuotaReached",
"ParsingError",
"ServiceError",
"InvalidRequest",
"DuplicateFormSameAgent",
"Unauthorized",
"DuplicateAutomatedFormWithCopiedScore"
]
},
"pending": {
"type": "boolean",
"description": "Indicates whether AI scoring is currently processing the evaluation."
},
"dateLastChanged": {
"type": "string",
"description": "The date when the AI scores were last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
}
}
},
"answers": {
"type": "object",
"description": "The answers value",
"properties": {
"totalScore": {
"type": "number",
"description": "Score of all questions"
},
"totalCriticalScore": {
"type": "number",
"description": "Score of only the critical questions"
},
"maxTotalRawCriticalScore": {
"type": "number",
"description": "Maximum total raw score for the critical questions. Raw score is the actual point values before applying weights or percentages."
},
"maxTotalRawScore": {
"type": "number",
"description": "Maximum total raw score for all questions. Raw score is the actual point values before applying weights or percentages."
},
"totalNonCriticalScore": {
"type": "number",
"description": "Score of only the non-critical questions"
},
"questionGroupScores": {
"type": "array",
"items": {
"type": "object"
},
"description": "Question Group Scores"
},
"anyFailedKillQuestions": {
"type": "boolean",
"description": "Indicates that at least one fatal question was answered without having the highest score available for the question"
},
"comments": {
"type": "string",
"description": "Overall comments from the evaluator"
},
"privateComments": {
"type": "string",
"description": "Overall private comments from the evaluator"
},
"agentComments": {
"type": "string",
"description": "Comments from the agent while reviewing evaluation results"
},
"transcriptTopics": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of topics found within the conversation's transcripts"
}
}
},
"assigned": {
"type": "boolean",
"description": "Set to false to unassign the evaluation. This cannot be set to false when assignee is also set."
},
"assignedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"assignee": {
"type": "object",
"description": "The assignee value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"assigneeApplicable": {
"type": "boolean",
"description": "Indicates whether an assignee is applicable for the evaluation. Set to false when assignee is not applicable."
},
"authorizedActions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user authorized actions on evaluation. Possible values: assign, edit, editScore, editAgentSignoff, delete, release, viewAudit"
},
"calibration": {
"type": "object",
"description": "The calibration value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"calibrator": {
"type": "object",
"description": "The calibrator value"
},
"agent": {
"type": "object",
"description": "The agent value"
},
"conversation": {
"type": "object",
"description": "The conversation value"
},
"evaluationForm": {
"type": "object",
"description": "Evaluation Form"
},
"contextId": {
"type": "string",
"description": "Context Id"
},
"averageScore": {
"type": "integer",
"description": "Average Score"
},
"highScore": {
"type": "integer",
"description": "High Score"
},
"lowScore": {
"type": "integer",
"description": "Low Score"
},
"createdDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"evaluations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The evaluations value"
},
"evaluators": {
"type": "array",
"items": {
"type": "object"
},
"description": "The evaluators value"
},
"scoringIndex": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/Evaluation"
},
"expertEvaluator": {
"type": "object",
"description": "Expert Evaluator"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"changedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"conversation": {
"type": "object",
"description": "The conversation value",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
},
"conversationDate": {
"type": "string",
"description": "Creation date of the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"conversationEndDate": {
"type": "string",
"description": "End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateAssigneeChanged": {
"type": "string",
"description": "Date when the assignee was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"divisionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Evaluation is assigned in the following division(s)."
},
"evaluationForm": {
"type": "object",
"description": "Evaluation Form",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The evaluation form name"
},
"modifiedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"published": {
"type": "boolean",
"description": "The published value"
},
"contextId": {
"type": "string",
"description": "Context Id"
},
"questionGroups": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of question groups"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions"
},
"evaluationSettings": {
"type": "object",
"description": "Evaluation Settings"
},
"latestVersionFormName": {
"type": "string",
"description": "The name of the form's most recently published version"
},
"aiScoring": {
"type": "object",
"description": "Ai Scoring"
},
"dialect": {
"type": "string",
"description": "The language dialect for this evaluation form. Supported dialects: ar, cs, da, de, en-US, es, fi, fr, fr-CA, he, hi, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, th, tr, uk, zh-CN, zh-TW"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name",
"questionGroups"
]
},
"evaluationSource": {
"type": "object",
"description": "Evaluation Source",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "string",
"description": "Type of the evaluation source.",
"enum": [
"Policy",
"User",
"Unknown",
"Program"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"evaluator": {
"type": "object",
"description": "The evaluator value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"hasAssistanceFailed": {
"type": "boolean",
"description": "Is true when evaluation assistance didn't execute successfully"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"isScoringIndex": {
"type": "boolean",
"description": "Is Scoring Index"
},
"mediaType": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CALL",
"CALLBACK",
"CHAT",
"COBROWSE",
"EMAIL",
"MESSAGE",
"INTERNAL_MESSAGE",
"SCREEN_MONITORING",
"SOCIAL_EXPRESSION",
"VIDEO",
"SCREENSHARE"
]
},
"description": "List of different communication types used in conversation."
},
"name": {
"type": "string",
"description": "The name value"
},
"neverRelease": {
"type": "boolean",
"description": "Signifies if the evaluation is never to be released. This cannot be set true if release date is also set."
},
"queue": {
"type": "object",
"description": "The queue value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"description": {
"type": "string",
"description": "The queue description."
},
"dateCreated": {
"type": "string",
"description": "The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"modifiedBy": {
"type": "string",
"description": "The ID of the user that last modified the queue."
},
"createdBy": {
"type": "string",
"description": "The ID of the user that created the queue."
},
"memberCount": {
"type": "integer",
"description": "The total number of members in the queue."
},
"userMemberCount": {
"type": "integer",
"description": "The number of user members (i.e., non-group members) in the queue."
},
"joinedMemberCount": {
"type": "integer",
"description": "The number of joined members in the queue."
},
"mediaSettings": {
"type": "object",
"description": "Media Settings"
},
"routingRules": {
"type": "array",
"items": {
"type": "object"
},
"description": "The routing rules for the queue, used for Preferred Agent Routing."
},
"conditionalGroupRouting": {
"type": "object",
"description": "Conditional Group Routing"
},
"conditionalGroupActivation": {
"type": "object",
"description": "Conditional Group Activation"
},
"bullseye": {
"type": "object",
"description": "The bullseye value"
},
"scoringMethod": {
"type": "string",
"description": "The Scoring Method for the queue.",
"enum": [
"TimestampAndPriority",
"PriorityOnly"
]
},
"lastAgentRoutingMode": {
"type": "string",
"description": "The Last Agent Routing Mode for the queue.",
"enum": [
"Disabled",
"QueueMembersOnly",
"AnyAgent"
]
},
"acwSettings": {
"type": "object",
"description": "Acw Settings"
},
"skillEvaluationMethod": {
"type": "string",
"description": "The skill evaluation method to use when routing conversations.",
"enum": [
"NONE",
"BEST",
"ALL"
]
},
"memberGroups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes."
},
"queueFlow": {
"type": "object",
"description": "Queue Flow"
},
"emailInQueueFlow": {
"type": "object",
"description": "Email In Queue Flow"
},
"messageInQueueFlow": {
"type": "object",
"description": "Message In Queue Flow"
},
"whisperPrompt": {
"type": "object",
"description": "Whisper Prompt"
},
"onHoldPrompt": {
"type": "object",
"description": "On Hold Prompt"
},
"autoAnswerOnly": {
"type": "boolean",
"description": "Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."
},
"cannedResponseLibraries": {
"type": "object",
"description": "Canned Response Libraries"
},
"enableTranscription": {
"type": "boolean",
"description": "Indicates whether voice transcription is enabled for this queue."
},
"enableAudioMonitoring": {
"type": "boolean",
"description": "Indicates whether audio monitoring is enabled for this queue."
},
"enableManualAssignment": {
"type": "boolean",
"description": "Indicates whether manual assignment is enabled for this queue."
},
"agentOwnedRouting": {
"type": "object",
"description": "Agent Owned Routing"
},
"directRouting": {
"type": "object",
"description": "Direct Routing"
},
"callingPartyName": {
"type": "string",
"description": "The name to use for caller identification for outbound calls from this queue."
},
"callingPartyNumber": {
"type": "string",
"description": "The phone number to use for caller identification for outbound calls from this queue."
},
"defaultScripts": {
"type": "object",
"description": "The default script Ids for the communication types."
},
"outboundMessagingAddresses": {
"type": "object",
"description": "Outbound Messaging Addresses"
},
"outboundEmailAddress": {
"type": "object",
"description": "Outbound Email Address"
},
"peerId": {
"type": "string",
"description": "The ID of an associated external queue."
},
"suppressInQueueCallRecording": {
"type": "boolean",
"description": "Indicates whether recording in-queue calls is suppressed for this queue."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"redacted": {
"type": "boolean",
"description": "Is only true when the user making the request does not have sufficient permissions to see evaluation"
},
"releaseDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"rescore": {
"type": "boolean",
"description": "Is only true when evaluation is re-scored."
},
"resourceId": {
"type": "string",
"description": "Only used for email evaluations. Will be null for all other evaluations."
},
"resourceType": {
"type": "string",
"description": "The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.",
"enum": [
"EMAIL"
]
},
"revisionCreatedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"PENDING",
"INPROGRESS",
"FINISHED",
"INREVIEW",
"RETRACTED"
]
},
"submittedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
}
},
"required": [
"PCID",
"conversationId",
"evaluationId"
]
}
```
***
## genesys\_tasks\_quality\_put\_forms\_evaluation
Update an evaluation form.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `formId` | string | Yes | — | Form ID |
| `aiScoring` | object | No | — | Ai Scoring |
| `contextId` | string | No | — | Context Id |
| `dialect` | string | No | — | The language dialect for this evaluation form. Supported dialects: ar, cs, da, de, en-US, es, fi, fr, fr-CA, he, hi, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, th, tr, uk, zh-CN, zh-TW |
| `evaluationSettings` | object | No | — | Evaluation Settings |
| `id` | string | No | — | The globally unique identifier for the object. |
| `latestVersionFormName` | string | No | — | The name of the form's most recently published version |
| `modifiedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | Yes | — | The evaluation form name |
| `published` | boolean | No | — | The published value |
| `publishedVersions` | object | No | — | Published Versions |
| `questionGroups` | object\[] | Yes | — | A list of question groups |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"formId": {
"type": "string",
"description": "Form ID"
},
"aiScoring": {
"type": "object",
"description": "Ai Scoring",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"questionGroupSettings": {
"type": "array",
"items": {
"type": "object"
},
"description": "Question Group Settings"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"contextId": {
"type": "string",
"description": "Context Id"
},
"dialect": {
"type": "string",
"description": "The language dialect for this evaluation form. Supported dialects: ar, cs, da, de, en-US, es, fi, fr, fr-CA, he, hi, it, ja, ko, nl, no, pl, pt-BR, pt-PT, ru, sv, th, tr, uk, zh-CN, zh-TW"
},
"evaluationSettings": {
"type": "object",
"description": "Evaluation Settings",
"properties": {
"revisionsEnabled": {
"type": "boolean",
"description": "Whether revisions are allowed for evaluations. When enabled, rescoring creates a new version of the evaluation and retracts the existing evaluation version. Does not apply for calibration evaluations."
},
"disputesEnabled": {
"type": "boolean",
"description": "Whether disputes are allowed for evaluations. Does not apply for calibration evaluations."
},
"disputesAllowedPerEvaluation": {
"type": "integer",
"description": "The maximum number of disputes allowed for an evaluation."
},
"disputesAssignees": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of assignees responsible for handling each dispute. This list size needs to be equal to disputesAllowedPerEvaluation."
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"latestVersionFormName": {
"type": "string",
"description": "The name of the form's most recently published version"
},
"modifiedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The evaluation form name"
},
"published": {
"type": "boolean",
"description": "The published value"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions",
"properties": {
"entities": {
"type": "array",
"items": {
"type": "object"
},
"description": "The entities value"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"total": {
"type": "integer",
"description": "The total value"
},
"firstUri": {
"type": "string",
"description": "First Uri"
},
"nextUri": {
"type": "string",
"description": "Next Uri"
},
"previousUri": {
"type": "string",
"description": "Previous Uri"
},
"lastUri": {
"type": "string",
"description": "Last Uri"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
},
"pageCount": {
"type": "integer",
"description": "Page Count"
}
}
},
"questionGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"contextId": {
"type": "string",
"description": "An identifier for this question group that stays the same across versions of the form."
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "string",
"description": "The type value"
},
"defaultAnswersToHighest": {
"type": "boolean",
"description": "Default Answers To Highest"
},
"defaultAnswersToNA": {
"type": "boolean",
"description": "Default Answers To NA"
},
"naEnabled": {
"type": "boolean",
"description": "Na Enabled"
},
"weight": {
"type": "number",
"format": "float",
"description": "The weight value"
},
"manualWeight": {
"type": "boolean",
"description": "Manual Weight"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "An identifier for this question that stays the same across versions of the form."
},
"text": {
"type": "string"
},
"helpText": {
"type": "string"
},
"type": {
"type": "string"
},
"naEnabled": {
"type": "boolean"
},
"commentsRequired": {
"type": "boolean"
},
"visibilityCondition": {
"type": "object"
},
"answerOptions": {
"type": "array",
"description": "Options from which to choose an answer for this question. Only used by Multiple Choice type questions."
},
"multipleSelectOptionQuestions": {
"type": "array",
"description": "Only used by Multiple Select type questions. A list of multiple choice questions representing selectable options."
},
"defaultAnswer": {
"type": "object"
},
"automatedScoringFocus": {
"type": "string",
"description": "Focus setting for automated scoring"
},
"isKill": {
"type": "boolean"
},
"isCritical": {
"type": "boolean"
}
}
},
"description": "The questions value"
},
"visibilityCondition": {
"type": "object",
"description": "Visibility Condition"
},
"defaultAnswersTo": {
"type": "object",
"description": "Default Answers To"
}
}
},
"description": "A list of question groups"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"formId",
"name",
"questionGroups"
]
}
```
***
## genesys\_tasks\_quality\_put\_forms\_survey
Update a survey form.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `formId` | string | Yes | — | Form ID |
| `contextId` | string | Yes | — | Unique Id for all versions of this form |
| `disabled` | boolean | No | — | Is this form disabled |
| `footer` | string | No | — | Markdown text for the bottom of the form. |
| `header` | string | No | — | Markdown text for the top of the form. |
| `id` | string | No | — | The globally unique identifier for the object. |
| `language` | string | Yes | — | Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW |
| `modifiedDate` | string | No | — | Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | Yes | — | The survey form name |
| `published` | boolean | No | — | Is this form published |
| `publishedVersions` | object | No | — | Published Versions |
| `questionGroups` | object\[] | No | — | A list of question groups |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"formId": {
"type": "string",
"description": "Form ID"
},
"contextId": {
"type": "string",
"description": "Unique Id for all versions of this form"
},
"disabled": {
"type": "boolean",
"description": "Is this form disabled"
},
"footer": {
"type": "string",
"description": "Markdown text for the bottom of the form."
},
"header": {
"type": "string",
"description": "Markdown text for the top of the form."
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"language": {
"type": "string",
"description": "Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"
},
"modifiedDate": {
"type": "string",
"description": "Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The survey form name"
},
"published": {
"type": "boolean",
"description": "Is this form published"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions",
"properties": {
"entities": {
"type": "array",
"items": {
"type": "object"
},
"description": "The entities value"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"total": {
"type": "integer",
"description": "The total value"
},
"firstUri": {
"type": "string",
"description": "First Uri"
},
"nextUri": {
"type": "string",
"description": "Next Uri"
},
"previousUri": {
"type": "string",
"description": "Previous Uri"
},
"lastUri": {
"type": "string",
"description": "Last Uri"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
},
"pageCount": {
"type": "integer",
"description": "Page Count"
}
}
},
"questionGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"contextId": {
"type": "string",
"description": "An identifier for this question group that stays the same across versions of the form."
},
"name": {
"type": "string",
"description": "The name value"
},
"type": {
"type": "string",
"description": "The type value"
},
"naEnabled": {
"type": "boolean",
"description": "Na Enabled"
},
"questions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "An identifier for this question that stays the same across versions of the form."
},
"text": {
"type": "string"
},
"helpText": {
"type": "string"
},
"type": {
"type": "string"
},
"naEnabled": {
"type": "boolean"
},
"visibilityCondition": {
"type": "object"
},
"answerOptions": {
"type": "array",
"description": "Options from which to choose an answer for this question. Only used by Multiple Choice type questions."
},
"maxResponseCharacters": {
"type": "integer",
"description": "How many characters are allowed in the text response to this question. Used by NPS and Free Text question types."
},
"explanationPrompt": {
"type": "string",
"description": "Prompt for details explaining the chosen NPS score. Used by NPS questions."
}
}
},
"description": "The questions value"
},
"visibilityCondition": {
"type": "object",
"description": "Visibility Condition"
}
}
},
"description": "A list of question groups"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"formId",
"contextId",
"language",
"name"
]
}
```
***
## genesys\_tasks\_quality\_put\_program\_agentscoringrule
Update an Agent Scoring Rule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `programId` | string | Yes | — | Program ID from Speech and Text Analytics |
| `ruleId` | string | Yes | — | Agent Scoring Rule ID |
| `agentToScore` | string | No | — | Which agent(s) to score. Valid values: First, Last, Each. |
| `dateCreated` | string | No | — | Date when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateModified` | string | No | — | Date when the rule was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `enabled` | boolean | Yes | — | Whether the rule is enabled. |
| `evaluationFormContextId` | string | Yes | — | The evaluation form contextID to use for scoring. |
| `evaluator` | object | No | — | The evaluator value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `published` | boolean | No | — | Whether the rule is published. |
| `samplingPercentage` | number | No | — | Percentage of interactions to evaluate (0.01-100.00). Required when samplingType is Percentage, null when All. |
| `samplingType` | string | Yes | — | Sampling type setting. Valid values: All, Percentage |
| `selfUri` | string | No | — | The URI for this object |
| `submissionType` | string | Yes | — | Submission type for evaluations. Valid values: Automated, Manual |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"programId": {
"type": "string",
"description": "Program ID from Speech and Text Analytics"
},
"ruleId": {
"type": "string",
"description": "Agent Scoring Rule ID"
},
"agentToScore": {
"type": "string",
"description": "Which agent(s) to score. Valid values: First, Last, Each.",
"enum": [
"First",
"Last",
"Each"
]
},
"dateCreated": {
"type": "string",
"description": "Date when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Date when the rule was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"enabled": {
"type": "boolean",
"description": "Whether the rule is enabled."
},
"evaluationFormContextId": {
"type": "string",
"description": "The evaluation form contextID to use for scoring."
},
"evaluator": {
"type": "object",
"description": "The evaluator value",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"published": {
"type": "boolean",
"description": "Whether the rule is published."
},
"samplingPercentage": {
"type": "number",
"description": "Percentage of interactions to evaluate (0.01-100.00). Required when samplingType is Percentage, null when All."
},
"samplingType": {
"type": "string",
"description": "Sampling type setting. Valid values: All, Percentage",
"enum": [
"All",
"Percentage"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"submissionType": {
"type": "string",
"description": "Submission type for evaluations. Valid values: Automated, Manual",
"enum": [
"Automated",
"Manual"
]
}
},
"required": [
"PCID",
"programId",
"ruleId",
"enabled",
"evaluationFormContextId",
"samplingType",
"submissionType"
]
}
```
***
## genesys\_tasks\_quality\_put\_surveys\_scorable
Update a survey as an end-customer, for the purposes of scoring it.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------ | -------- | ------- | ---------------------------------------------- |
| `customerSurveyUrl` | string | Yes | — | Customer Survey Url |
| `answers` | object | No | — | The answers value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `status` | string | No | — | The status value |
| `surveyForm` | object | No | — | Survey Form |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerSurveyUrl": {
"type": "string",
"description": "Customer Survey Url"
},
"answers": {
"type": "object",
"description": "The answers value",
"properties": {
"totalScore": {
"type": "number",
"description": "Total Score"
},
"npsScore": {
"type": "integer",
"description": "Nps Score"
},
"questionGroupScores": {
"type": "array",
"items": {
"type": "object"
},
"description": "Question Group Scores"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"status": {
"type": "string",
"description": "The status value",
"enum": [
"Pending",
"Sent",
"InProgress",
"Finished",
"OptOut",
"Error",
"Expired"
]
},
"surveyForm": {
"type": "object",
"description": "Survey Form",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The survey form name"
},
"modifiedDate": {
"type": "string",
"description": "Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"published": {
"type": "boolean",
"description": "Is this form published"
},
"disabled": {
"type": "boolean",
"description": "Is this form disabled"
},
"contextId": {
"type": "string",
"description": "Unique Id for all versions of this form"
},
"language": {
"type": "string",
"description": "Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"
},
"header": {
"type": "string",
"description": "Markdown text for the top of the form."
},
"footer": {
"type": "string",
"description": "Markdown text for the bottom of the form."
},
"questionGroups": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of question groups"
},
"publishedVersions": {
"type": "object",
"description": "Published Versions"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"contextId",
"language",
"name"
]
}
},
"required": [
"PCID",
"customerSurveyUrl"
]
}
```