> ## 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-coaching > Genesys Coaching & Learning - coaching appointments, notifications, learning assignments, modules, and assessments **Server path:** `/genesys-coaching` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | [`genesys_coaching_delete_appointment`](#genesys_coaching_delete_appointment) | Delete an existing appointment | | [`genesys_coaching_delete_appointment_annotation`](#genesys_coaching_delete_appointment_annotation) | Delete an existing annotation | | [`genesys_coaching_delete_learning_assignment`](#genesys_coaching_delete_learning_assignment) | Delete a learning assignment | | [`genesys_coaching_delete_learning_module`](#genesys_coaching_delete_learning_module) | Delete a learning module | | [`genesys_coaching_get_appointment`](#genesys_coaching_get_appointment) | Retrieve an appointment | | [`genesys_coaching_get_appointment_annotation`](#genesys_coaching_get_appointment_annotation) | Retrieve an annotation. | | [`genesys_coaching_get_appointment_annotations`](#genesys_coaching_get_appointment_annotations) | Get a list of annotations. | | [`genesys_coaching_get_appointment_statuses`](#genesys_coaching_get_appointment_statuses) | Get the list of status changes for a coaching appointment. | | [`genesys_coaching_get_appointments`](#genesys_coaching_get_appointments) | Get appointments for users and optional date range | | [`genesys_coaching_get_appointments_me`](#genesys_coaching_get_appointments_me) | Get my appointments for a given date range | | [`genesys_coaching_get_learning_assignment`](#genesys_coaching_get_learning_assignment) | Get Learning Assignment | | [`genesys_coaching_get_learning_assignment_step`](#genesys_coaching_get_learning_assignment_step) | Get Learning Assignment Step | | [`genesys_coaching_get_learning_assignments`](#genesys_coaching_get_learning_assignments) | List of Learning module Assignments | | [`genesys_coaching_get_learning_assignments_me`](#genesys_coaching_get_learning_assignments_me) | List of Learning Assignments assigned to current user | | [`genesys_coaching_get_learning_module`](#genesys_coaching_get_learning_module) | Get a learning module | | [`genesys_coaching_get_learning_module_job`](#genesys_coaching_get_learning_module_job) | Get a specific Learning Module job status | | [`genesys_coaching_get_learning_module_preview`](#genesys_coaching_get_learning_module_preview) | Get a learning module preview | | [`genesys_coaching_get_learning_module_rule`](#genesys_coaching_get_learning_module_rule) | Get a learning module rule | | [`genesys_coaching_get_learning_module_version`](#genesys_coaching_get_learning_module_version) | Get specific version of a published module | | [`genesys_coaching_get_learning_modules`](#genesys_coaching_get_learning_modules) | Get all learning modules of an organization | | [`genesys_coaching_get_learning_modules_assignments`](#genesys_coaching_get_learning_modules_assignments) | Get all learning modules of an organization including assignments for a specific user | | [`genesys_coaching_get_learning_modules_coverart_cover_art_id`](#genesys_coaching_get_learning_modules_coverart_cover_art_id) | Get a specific Learning Module cover art using ID | | [`genesys_coaching_get_learning_scheduleslots_job`](#genesys_coaching_get_learning_scheduleslots_job) | Retrieve the status of the job for the slots where a learning activity can be scheduled. | | [`genesys_coaching_get_learning_scorm_scorm_id`](#genesys_coaching_get_learning_scorm_scorm_id) | Get Learning SCORM Result | | [`genesys_coaching_get_notification`](#genesys_coaching_get_notification) | Get an existing notification | | [`genesys_coaching_get_notifications`](#genesys_coaching_get_notifications) | Retrieve the list of your notifications. | | [`genesys_coaching_get_scheduleslots_job`](#genesys_coaching_get_scheduleslots_job) | Retrieve the status of the job for the slots where a coaching appointment can be scheduled. | | [`genesys_coaching_patch_appointment`](#genesys_coaching_patch_appointment) | Update an existing appointment | | [`genesys_coaching_patch_appointment_annotation`](#genesys_coaching_patch_appointment_annotation) | Update an existing annotation. | | [`genesys_coaching_patch_appointment_status`](#genesys_coaching_patch_appointment_status) | Update the status of a coaching appointment | | [`genesys_coaching_patch_learning_assignment`](#genesys_coaching_patch_learning_assignment) | Update Learning Assignment | | [`genesys_coaching_patch_learning_assignment_reschedule`](#genesys_coaching_patch_learning_assignment_reschedule) | Reschedule Learning Assignment | | [`genesys_coaching_patch_learning_assignment_step`](#genesys_coaching_patch_learning_assignment_step) | Update Learning Assignment Step | | [`genesys_coaching_patch_learning_module_user_assignments`](#genesys_coaching_patch_learning_module_user_assignments) | Update an external assignment for a specific user | | [`genesys_coaching_patch_notification`](#genesys_coaching_patch_notification) | Update an existing notification. | | [`genesys_coaching_post_appointment_annotations`](#genesys_coaching_post_appointment_annotations) | Create a new annotation. | | [`genesys_coaching_post_appointment_conversations`](#genesys_coaching_post_appointment_conversations) | Add a conversation to an appointment | | [`genesys_coaching_post_appointments`](#genesys_coaching_post_appointments) | Create a new appointment | | [`genesys_coaching_post_appointments_aggregates_query`](#genesys_coaching_post_appointments_aggregates_query) | Retrieve aggregated appointment data | | [`genesys_coaching_post_learning_assessments_scoring`](#genesys_coaching_post_learning_assessments_scoring) | Score learning assessment for preview | | [`genesys_coaching_post_learning_assignment_reassign`](#genesys_coaching_post_learning_assignment_reassign) | Reassign Learning Assignment | | [`genesys_coaching_post_learning_assignment_reset`](#genesys_coaching_post_learning_assignment_reset) | Reset Learning Assignment | | [`genesys_coaching_post_learning_assignments`](#genesys_coaching_post_learning_assignments) | Create Learning Assignment | | [`genesys_coaching_post_learning_assignments_aggregates_query`](#genesys_coaching_post_learning_assignments_aggregates_query) | Retrieve aggregated assignment data | | [`genesys_coaching_post_learning_module_jobs`](#genesys_coaching_post_learning_module_jobs) | Starts a specified operation on learning module | | [`genesys_coaching_post_learning_module_publish`](#genesys_coaching_post_learning_module_publish) | Publish a Learning module | | [`genesys_coaching_post_learning_modules`](#genesys_coaching_post_learning_modules) | Create a new learning module | | [`genesys_coaching_post_learning_rules_query`](#genesys_coaching_post_learning_rules_query) | Get users for learning module rule | | [`genesys_coaching_post_learning_scheduleslots_jobs`](#genesys_coaching_post_learning_scheduleslots_jobs) | Start job to retrieve slots where a learning activity can be scheduled. | | [`genesys_coaching_post_learning_scheduleslots_query`](#genesys_coaching_post_learning_scheduleslots_query) | Get list of possible slots where a learning activity can be scheduled. | | [`genesys_coaching_post_learning_scorm`](#genesys_coaching_post_learning_scorm) | Create a SCORM package upload request | | [`genesys_coaching_post_scheduleslots_jobs`](#genesys_coaching_post_scheduleslots_jobs) | Start job to retrieve the slots where a coaching appointment can be scheduled. | | [`genesys_coaching_post_scheduleslots_query`](#genesys_coaching_post_scheduleslots_query) | Get list of possible slots where a coaching appointment can be scheduled. | | [`genesys_coaching_put_learning_module`](#genesys_coaching_put_learning_module) | Update a learning module | | [`genesys_coaching_put_learning_module_preview`](#genesys_coaching_put_learning_module_preview) | Update a learning module preview | | [`genesys_coaching_put_learning_module_rule`](#genesys_coaching_put_learning_module_rule) | Update a learning module rule | *** ## genesys\_coaching\_delete\_appointment Delete an existing appointment **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." } }, "required": [ "PCID", "appointmentId" ] } ``` *** ## genesys\_coaching\_delete\_appointment\_annotation Delete an existing annotation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `annotationId` | string | Yes | — | The ID of the annotation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "annotationId": { "type": "string", "description": "The ID of the annotation." } }, "required": [ "PCID", "appointmentId", "annotationId" ] } ``` *** ## genesys\_coaching\_delete\_learning\_assignment Delete a learning assignment **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | -------------------------- | | `assignmentId` | string | Yes | — | The Learning Assignment ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignmentId": { "type": "string", "description": "The Learning Assignment ID" } }, "required": [ "PCID", "assignmentId" ] } ``` *** ## genesys\_coaching\_delete\_learning\_module Delete a learning module **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" } }, "required": [ "PCID", "moduleId" ] } ``` *** ## genesys\_coaching\_get\_appointment Retrieve an appointment **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." } }, "required": [ "PCID", "appointmentId" ] } ``` *** ## genesys\_coaching\_get\_appointment\_annotation Retrieve an annotation. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `annotationId` | string | Yes | — | The ID of the annotation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "annotationId": { "type": "string", "description": "The ID of the annotation." } }, "required": [ "PCID", "appointmentId", "annotationId" ] } ``` *** ## genesys\_coaching\_get\_appointment\_annotations Get a list of annotations. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ----------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `pageNumber` | integer | No | — | Page number | | `pageSize` | integer | No | — | Page size | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "pageNumber": { "type": "integer", "description": "Page number" }, "pageSize": { "type": "integer", "description": "Page size" } }, "required": [ "PCID", "appointmentId" ] } ``` *** ## genesys\_coaching\_get\_appointment\_statuses Get the list of status changes for a coaching appointment. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ----------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `pageNumber` | integer | No | — | Page number | | `pageSize` | integer | No | — | Page size | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "pageNumber": { "type": "integer", "description": "Page number" }, "pageSize": { "type": "integer", "description": "Page size" } }, "required": [ "PCID", "appointmentId" ] } ``` *** ## genesys\_coaching\_get\_appointments Get appointments for users and optional date range **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `userIds` | string\[] | Yes | — | The user IDs for which to retrieve appointments | | `interval` | string | No | — | Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `pageNumber` | integer | No | — | Page number | | `pageSize` | integer | No | — | Page size | | `statuses` | string\[] | No | — | Appointment Statuses to filter by | | `facilitatorIds` | string\[] | No | — | The facilitator IDs for which to retrieve appointments | | `sortOrder` | string | No | — | Sort (by due date) either Asc or Desc | | `relationships` | string\[] | No | — | Relationships to filter by | | `completionInterval` | string | No | — | Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `overdue` | string | No | — | Overdue status to filter by | | `intervalCondition` | string | No | — | Filter condition for interval | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "The user IDs for which to retrieve appointments" }, "interval": { "type": "string", "description": "Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "pageNumber": { "type": "integer", "description": "Page number" }, "pageSize": { "type": "integer", "description": "Page size" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "Scheduled", "InProgress", "Completed", "InvalidSchedule" ] }, "description": "Appointment Statuses to filter by" }, "facilitatorIds": { "type": "array", "items": { "type": "string" }, "description": "The facilitator IDs for which to retrieve appointments" }, "sortOrder": { "type": "string", "description": "Sort (by due date) either Asc or Desc", "enum": [ "Desc", "Asc" ] }, "relationships": { "type": "array", "items": { "type": "string", "enum": [ "Creator", "Facilitator", "Attendee" ] }, "description": "Relationships to filter by" }, "completionInterval": { "type": "string", "description": "Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "overdue": { "type": "string", "description": "Overdue status to filter by", "enum": [ "True", "False", "Any" ] }, "intervalCondition": { "type": "string", "description": "Filter condition for interval", "enum": [ "StartsIn", "Overlaps" ] } }, "required": [ "PCID", "userIds" ] } ``` *** ## genesys\_coaching\_get\_appointments\_me Get my appointments for a given date range **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `interval` | string | No | — | Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `pageNumber` | integer | No | — | Page number | | `pageSize` | integer | No | — | Page size | | `statuses` | string\[] | No | — | Appointment Statuses to filter by | | `facilitatorIds` | string\[] | No | — | The facilitator IDs for which to retrieve appointments | | `sortOrder` | string | No | — | Sort (by due date) either Asc or Desc | | `relationships` | string\[] | No | — | Relationships to filter by | | `completionInterval` | string | No | — | Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `overdue` | string | No | — | Overdue status to filter by | | `intervalCondition` | string | No | — | Filter condition for interval | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "interval": { "type": "string", "description": "Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "pageNumber": { "type": "integer", "description": "Page number" }, "pageSize": { "type": "integer", "description": "Page size" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "Scheduled", "InProgress", "Completed", "InvalidSchedule" ] }, "description": "Appointment Statuses to filter by" }, "facilitatorIds": { "type": "array", "items": { "type": "string" }, "description": "The facilitator IDs for which to retrieve appointments" }, "sortOrder": { "type": "string", "description": "Sort (by due date) either Asc or Desc", "enum": [ "Desc", "Asc" ] }, "relationships": { "type": "array", "items": { "type": "string", "enum": [ "Creator", "Facilitator", "Attendee" ] }, "description": "Relationships to filter by" }, "completionInterval": { "type": "string", "description": "Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "overdue": { "type": "string", "description": "Overdue status to filter by", "enum": [ "True", "False", "Any" ] }, "intervalCondition": { "type": "string", "description": "Filter condition for interval", "enum": [ "StartsIn", "Overlaps" ] } }, "required": [ "PCID" ] } ``` *** ## genesys\_coaching\_get\_learning\_assignment Get Learning Assignment **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ----------------------------- | | `assignmentId` | string | Yes | — | The ID of Learning Assignment | | `expand` | string\[] | No | — | Fields to expand in response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignmentId": { "type": "string", "description": "The ID of Learning Assignment" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "module", "assessment", "assessmentForm", "module.coverArt", "step", "step.moduleStep" ] }, "description": "Fields to expand in response" } }, "required": [ "PCID", "assignmentId" ] } ``` *** ## genesys\_coaching\_get\_learning\_assignment\_step Get Learning Assignment Step **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------- | --------- | -------- | ------- | ---------------------------------- | | `assignmentId` | string | Yes | — | The ID of Learning Assignment | | `stepId` | string | Yes | — | The ID of Learning Assignment Step | | `shareableContentObjectId` | string | No | — | The ID of SCO to load | | `defaultShareableContentObject` | string | No | — | The default SCO to retrieve | | `expand` | string\[] | No | — | Fields to expand in response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignmentId": { "type": "string", "description": "The ID of Learning Assignment" }, "stepId": { "type": "string", "description": "The ID of Learning Assignment Step" }, "shareableContentObjectId": { "type": "string", "description": "The ID of SCO to load" }, "defaultShareableContentObject": { "type": "string", "description": "The default SCO to retrieve", "enum": [ "First", "Last", "Next" ] }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "moduleStep" ] }, "description": "Fields to expand in response" } }, "required": [ "PCID", "assignmentId", "stepId" ] } ``` *** ## genesys\_coaching\_get\_learning\_assignments List of Learning module Assignments **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `moduleId` | string | No | — | Specifies the ID of the learning module. Fetch assignments for learning module ID | | `interval` | string | No | — | Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `completionInterval` | string | No | — | Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `overdue` | string | No | — | Specifies if only the non-overdue (overdue is "False") or overdue (overdue is "True") assignments are returned. If overdue is "Any" or if the overdue parameter is not supplied, all assignments are returned | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `pass` | string | No | — | Specifies if only the failed (pass is "False") or passed (pass is "True") assignments (completed with assessment)are returned. If pass is "Any" or if the pass parameter is not supplied, all assignments are returned | | `minPercentageScore` | number | No | — | The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) | | `maxPercentageScore` | number | No | — | The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) | | `sortOrder` | string | No | — | Specifies result set sort order; if not specified, default sort order is descending (Desc) | | `sortBy` | string | No | — | Specifies which field to sort the results by, default sort is by recommendedCompletionDate | | `userId` | string\[] | No | — | Specifies the list of user IDs to be queried, up to 100 user IDs. | | `types` | string\[] | No | — | Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated | | `states` | string\[] | No | — | Specifies the assignment states to filter by | | `expand` | string\[] | No | — | Specifies the expand option for returning additional information | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "Specifies the ID of the learning module. Fetch assignments for learning module ID" }, "interval": { "type": "string", "description": "Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "completionInterval": { "type": "string", "description": "Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "overdue": { "type": "string", "description": "Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned", "enum": [ "True", "False", "Any" ] }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "pass": { "type": "string", "description": "Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned", "enum": [ "True", "False", "Any" ] }, "minPercentageScore": { "type": "number", "description": "The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)" }, "maxPercentageScore": { "type": "number", "description": "The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)" }, "sortOrder": { "type": "string", "description": "Specifies result set sort order; if not specified, default sort order is descending (Desc)", "enum": [ "Asc", "Desc" ] }, "sortBy": { "type": "string", "description": "Specifies which field to sort the results by, default sort is by recommendedCompletionDate", "enum": [ "RecommendedCompletionDate", "DateModified" ] }, "userId": { "type": "array", "items": { "type": "string" }, "description": "Specifies the list of user IDs to be queried, up to 100 user IDs." }, "types": { "type": "array", "items": { "type": "string", "enum": [ "Informational", "AssessedContent", "Assessment", "External", "Native" ] }, "description": "Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated" }, "states": { "type": "array", "items": { "type": "string", "enum": [ "Assigned", "InProgress", "Completed", "NotCompleted", "InvalidSchedule" ] }, "description": "Specifies the assignment states to filter by" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "ModuleSummary" ] }, "description": "Specifies the expand option for returning additional information" } }, "required": [ "PCID" ] } ``` *** ## genesys\_coaching\_get\_learning\_assignments\_me List of Learning Assignments assigned to current user **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `moduleId` | string | No | — | Specifies the ID of the learning module. Fetch assignments for learning module ID | | `interval` | string | No | — | Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `completionInterval` | string | No | — | Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `overdue` | string | No | — | Specifies if only the non-overdue (overdue is "False") or overdue (overdue is "True") assignments are returned. If overdue is "Any" or if the overdue parameter is not supplied, all assignments are returned | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `pass` | string | No | — | Specifies if only the failed (pass is "False") or passed (pass is "True") assignments (completed with assessment)are returned. If pass is "Any" or if the pass parameter is not supplied, all assignments are returned | | `minPercentageScore` | number | No | — | The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) | | `maxPercentageScore` | number | No | — | The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) | | `sortOrder` | string | No | — | Specifies result set sort order; if not specified, default sort order is descending (Desc) | | `sortBy` | string | No | — | Specifies which field to sort the results by, default sort is by recommendedCompletionDate | | `types` | string\[] | No | — | Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated | | `states` | string\[] | No | — | Specifies the assignment states to filter by | | `expand` | string\[] | No | — | Specifies the expand option for returning additional information | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "Specifies the ID of the learning module. Fetch assignments for learning module ID" }, "interval": { "type": "string", "description": "Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "completionInterval": { "type": "string", "description": "Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "overdue": { "type": "string", "description": "Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned", "enum": [ "True", "False", "Any" ] }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "pass": { "type": "string", "description": "Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned", "enum": [ "True", "False", "Any" ] }, "minPercentageScore": { "type": "number", "description": "The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)" }, "maxPercentageScore": { "type": "number", "description": "The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)" }, "sortOrder": { "type": "string", "description": "Specifies result set sort order; if not specified, default sort order is descending (Desc)", "enum": [ "Asc", "Desc" ] }, "sortBy": { "type": "string", "description": "Specifies which field to sort the results by, default sort is by recommendedCompletionDate", "enum": [ "RecommendedCompletionDate", "DateModified" ] }, "types": { "type": "array", "items": { "type": "string", "enum": [ "Informational", "AssessedContent", "Assessment", "External", "Native" ] }, "description": "Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated" }, "states": { "type": "array", "items": { "type": "string", "enum": [ "Assigned", "InProgress", "Completed", "NotCompleted", "InvalidSchedule" ] }, "description": "Specifies the assignment states to filter by" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "ModuleSummary" ] }, "description": "Specifies the expand option for returning additional information" } }, "required": [ "PCID" ] } ``` *** ## genesys\_coaching\_get\_learning\_module Get a learning module **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ---------------------------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | | `expand` | string\[] | No | — | Fields to expand in response(case insensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "assessmentForm", "coverArt" ] }, "description": "Fields to expand in response(case insensitive)" } }, "required": [ "PCID", "moduleId" ] } ``` *** ## genesys\_coaching\_get\_learning\_module\_job Get a specific Learning Module job status **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | | `jobId` | string | Yes | — | The ID of the learning module job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" }, "jobId": { "type": "string", "description": "The ID of the learning module job" } }, "required": [ "PCID", "moduleId", "jobId" ] } ``` *** ## genesys\_coaching\_get\_learning\_module\_preview Get a learning module preview **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" } }, "required": [ "PCID", "moduleId" ] } ``` *** ## genesys\_coaching\_get\_learning\_module\_rule Get a learning module rule **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" } }, "required": [ "PCID", "moduleId" ] } ``` *** ## genesys\_coaching\_get\_learning\_module\_version Get specific version of a published module **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ---------------------------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | | `versionId` | string | Yes | — | The version of learning module | | `expand` | string\[] | No | — | Fields to expand in response(case insensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" }, "versionId": { "type": "string", "description": "The version of learning module" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "assessmentForm", "coverArt" ] }, "description": "Fields to expand in response(case insensitive)" } }, "required": [ "PCID", "moduleId", "versionId" ] } ``` *** ## genesys\_coaching\_get\_learning\_modules Get all learning modules of an organization **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------- | | `types` | string\[] | No | — | Specifies the module types. Informational, AssessedContent and Assessment are deprecated | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `sortOrder` | string | No | — | Sort order | | `sortBy` | string | No | — | Sort by | | `searchTerm` | string | No | — | Search Term (searchable by name) | | `expand` | string\[] | No | — | Fields to expand in response(case insensitive) | | `statuses` | string\[] | No | — | Specifies the module statuses to filter by | | `externalIds` | string\[] | No | — | Specifies the module external IDs to filter by. Only one ID is allowed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "types": { "type": "array", "items": { "type": "string", "enum": [ "Informational", "AssessedContent", "Assessment", "External", "Native" ] }, "description": "Specifies the module types. Informational, AssessedContent and Assessment are deprecated" }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "sortOrder": { "type": "string", "description": "Sort order", "enum": [ "ascending", "descending" ] }, "sortBy": { "type": "string", "description": "Sort by", "enum": [ "name", "createddate", "percentpassed", "averagescore" ] }, "searchTerm": { "type": "string", "description": "Search Term (searchable by name)" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "rule", "summaryData" ] }, "description": "Fields to expand in response(case insensitive)" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "Unpublished", "Published", "Archived" ] }, "description": "Specifies the module statuses to filter by" }, "externalIds": { "type": "array", "items": { "type": "string" }, "description": "Specifies the module external IDs to filter by. Only one ID is allowed" } }, "required": [ "PCID" ] } ``` *** ## genesys\_coaching\_get\_learning\_modules\_assignments Get all learning modules of an organization including assignments for a specific user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `userIds` | string\[] | Yes | — | The IDs of the users to include | | `pageSize` | integer | No | — | Page size | | `pageNumber` | integer | No | — | Page number | | `searchTerm` | string | No | — | Search Term (searches by name and description) | | `overdue` | string | No | — | Specifies if only modules with overdue/not overdue (overdue is "True" or "False") assignments are returned. If overdue is "Any" or omitted, both are returned and can including modules that are unassigned. | | `assignmentStates` | string\[] | No | — | Specifies the assignment states to return. | | `expand` | string\[] | No | — | Fields to expand in response(case insensitive) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the users to include" }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "searchTerm": { "type": "string", "description": "Search Term (searches by name and description)" }, "overdue": { "type": "string", "description": "Specifies if only modules with overdue/not overdue (overdue is \"True\" or \"False\") assignments are returned. If overdue is \"Any\" or omitted, both are returned and can including modules that are unassigned.", "enum": [ "True", "False", "Any" ] }, "assignmentStates": { "type": "array", "items": { "type": "string", "enum": [ "NotAssigned", "Assigned", "InProgress", "Completed", "InvalidSchedule" ] }, "description": "Specifies the assignment states to return." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "coverArt" ] }, "description": "Fields to expand in response(case insensitive)" } }, "required": [ "PCID", "userIds" ] } ``` *** ## genesys\_coaching\_get\_learning\_modules\_coverart\_cover\_art\_id Get a specific Learning Module cover art using ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | -------------------------------- | | `coverArtId` | string | Yes | — | Key identifier for the cover art | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "coverArtId": { "type": "string", "description": "Key identifier for the cover art" } }, "required": [ "PCID", "coverArtId" ] } ``` *** ## genesys\_coaching\_get\_learning\_scheduleslots\_job Retrieve the status of the job for the slots where a learning activity can be scheduled. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------- | | `jobId` | string | Yes | — | The ID of the job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The ID of the job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_coaching\_get\_learning\_scorm\_scorm\_id Get Learning SCORM Result **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------------- | | `scormId` | string | Yes | — | The ID of the SCORM package | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "scormId": { "type": "string", "description": "The ID of the SCORM package" } }, "required": [ "PCID", "scormId" ] } ``` *** ## genesys\_coaching\_get\_notification Get an existing notification **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | --------- | -------- | ------- | ----------------------------------------------------------- | | `notificationId` | string | Yes | — | The ID of the notification. | | `expand` | string\[] | No | — | Indicates a field in the response which should be expanded. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "notificationId": { "type": "string", "description": "The ID of the notification." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "appointment" ] }, "description": "Indicates a field in the response which should be expanded." } }, "required": [ "PCID", "notificationId" ] } ``` *** ## genesys\_coaching\_get\_notifications Retrieve the list of your notifications. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ----------------------------------------------------------- | | `pageNumber` | integer | No | — | Page number | | `pageSize` | integer | No | — | Page size | | `expand` | string\[] | No | — | Indicates a field in the response which should be expanded. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageNumber": { "type": "integer", "description": "Page number" }, "pageSize": { "type": "integer", "description": "Page size" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "appointment" ] }, "description": "Indicates a field in the response which should be expanded." } }, "required": [ "PCID" ] } ``` *** ## genesys\_coaching\_get\_scheduleslots\_job Retrieve the status of the job for the slots where a coaching appointment can be scheduled. **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------- | | `jobId` | string | Yes | — | The ID of job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The ID of job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_coaching\_patch\_appointment Update an existing appointment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `addToSchedule` | boolean | No | — | If True, adds the appointment to their schedule | | `conversationIds` | string\[] | No | — | IDs of conversations associated with this coaching appointment. | | `dateStart` | string | No | — | The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `description` | string | No | — | The description of coaching appointment. | | `documentIds` | string\[] | No | — | IDs of documents associated with this coaching appointment. | | `externalLinks` | string\[] | No | — | The list of external links related to the appointment | | `lengthInMinutes` | integer | No | — | The duration of coaching appointment in minutes. | | `location` | string | No | — | The location of the appointment | | `name` | string | No | — | The name of coaching appointment. | | `shareInsightsData` | boolean | No | — | Whether to share the insight data | | `status` | string | No | — | The status of the coaching appointment. | | `wfmSchedule` | object | No | — | Wfm Schedule | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "addToSchedule": { "type": "boolean", "description": "If True, adds the appointment to their schedule" }, "conversationIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of conversations associated with this coaching appointment." }, "dateStart": { "type": "string", "description": "The date/time the coaching appointment starts. Times will be rounded down to the minute. 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 coaching appointment." }, "documentIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of documents associated with this coaching appointment." }, "externalLinks": { "type": "array", "items": { "type": "string" }, "description": "The list of external links related to the appointment" }, "lengthInMinutes": { "type": "integer", "description": "The duration of coaching appointment in minutes." }, "location": { "type": "string", "description": "The location of the appointment" }, "name": { "type": "string", "description": "The name of coaching appointment." }, "shareInsightsData": { "type": "boolean", "description": "Whether to share the insight data" }, "status": { "type": "string", "description": "The status of the coaching appointment.", "enum": [ "Scheduled", "InProgress", "Completed" ] }, "wfmSchedule": { "type": "object", "description": "Wfm Schedule", "properties": { "id": { "type": "string", "description": "The ID of the WFM schedule" }, "businessUnit": { "type": "object", "description": "Business Unit" }, "weekDate": { "type": "string", "description": "The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "businessUnit", "id", "weekDate" ] } }, "required": [ "PCID", "appointmentId" ] } ``` *** ## genesys\_coaching\_patch\_appointment\_annotation Update an existing annotation. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `annotationId` | string | Yes | — | The ID of the annotation. | | `accessType` | string | No | — | Determines the permissions required to view this item. | | `createdBy` | object | No | — | Created By | | `dateCreated` | string | No | — | The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dateModified` | string | No | — | The date/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `id` | string | No | — | The globally unique identifier for the object. | | `isDeleted` | boolean | No | — | Flag indicating whether the annotation is deleted. | | `modifiedBy` | object | No | — | Modified By | | `selfUri` | string | No | — | The URI for this object | | `text` | string | Yes | — | The text of the annotation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "annotationId": { "type": "string", "description": "The ID of the annotation." }, "accessType": { "type": "string", "description": "Determines the permissions required to view this item.", "enum": [ "Public", "Private" ] }, "createdBy": { "type": "object", "description": "Created By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "dateCreated": { "type": "string", "description": "The date/time the annotation 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/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "isDeleted": { "type": "boolean", "description": "Flag indicating whether the annotation is deleted." }, "modifiedBy": { "type": "object", "description": "Modified By", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "selfUri": { "type": "string", "description": "The URI for this object" }, "text": { "type": "string", "description": "The text of the annotation." } }, "required": [ "PCID", "appointmentId", "annotationId", "text" ] } ``` *** ## genesys\_coaching\_patch\_appointment\_status Update the status of a coaching appointment **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | -------------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `status` | string | Yes | — | The status of the coaching appointment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "status": { "type": "string", "description": "The status of the coaching appointment", "enum": [ "Scheduled", "InProgress", "Completed" ] } }, "required": [ "PCID", "appointmentId", "status" ] } ``` *** ## genesys\_coaching\_patch\_learning\_assignment Update Learning Assignment **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ----------------------------- | | `assignmentId` | string | Yes | — | The ID of Learning Assignment | | `assessment` | object | No | — | The assessment value | | `state` | string | No | — | The Learning Assignment state | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignmentId": { "type": "string", "description": "The ID of Learning Assignment" }, "assessment": { "type": "object", "description": "The assessment value", "properties": { "assessmentId": { "type": "string", "description": "The Id of the assessment" }, "contextId": { "type": "string", "description": "The context Id of the related assessment form" }, "assessmentFormId": { "type": "string", "description": "The Id of the related assessment form" }, "status": { "type": "string", "description": "Status of the assessment", "enum": [ "Pending", "InProgress", "Finished" ] }, "answers": { "type": "object", "description": "The answers value" }, "dateCreated": { "type": "string", "description": "Date the assessment 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 the assessment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateSubmitted": { "type": "string", "description": "Date the assessment was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } } }, "state": { "type": "string", "description": "The Learning Assignment state", "enum": [ "Assigned", "InProgress", "Completed", "Deleted", "NotCompleted", "InvalidSchedule" ] } }, "required": [ "PCID", "assignmentId" ] } ``` *** ## genesys\_coaching\_patch\_learning\_assignment\_reschedule Reschedule Learning Assignment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `assignmentId` | string | Yes | — | The ID of Learning Assignment | | `addToSchedule` | boolean | No | — | If True, adds the assignment to their schedule | | `dateRecommendedForCompletion` | string | Yes | — | The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `lengthInMinutes` | integer | No | — | The length in minutes of the assignment | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignmentId": { "type": "string", "description": "The ID of Learning Assignment" }, "addToSchedule": { "type": "boolean", "description": "If True, adds the assignment to their schedule" }, "dateRecommendedForCompletion": { "type": "string", "description": "The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "lengthInMinutes": { "type": "integer", "description": "The length in minutes of the assignment" } }, "required": [ "PCID", "assignmentId", "dateRecommendedForCompletion" ] } ``` *** ## genesys\_coaching\_patch\_learning\_assignment\_step Update Learning Assignment Step **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | --------- | -------- | ------- | --------------------------------------------------- | | `assignmentId` | string | Yes | — | The ID of Learning Assignment | | `stepId` | string | Yes | — | The ID of Learning Assignment Step | | `completionPercentage` | number | No | — | The completion percentage for this step | | `completionStatus` | string | No | — | The completion status of the assignment step | | `id` | string | No | — | The ID of the learning assignment step | | `moduleStep` | object | No | — | Module Step | | `percentageScore` | number | No | — | The percentage score for this step | | `selfUri` | string | No | — | The URI for this object | | `shareableContentObject` | object | No | — | Learning assignment SCO (Shareable Content Object) | | `signedCookie` | object | No | — | Signed Cookie | | `structure` | object\[] | No | — | The structure for any SCO associated with this step | | `successStatus` | string | No | — | The success status of this step | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignmentId": { "type": "string", "description": "The ID of Learning Assignment" }, "stepId": { "type": "string", "description": "The ID of Learning Assignment Step" }, "completionPercentage": { "type": "number", "description": "The completion percentage for this step" }, "completionStatus": { "type": "string", "description": "The completion status of the assignment step", "enum": [ "Completed", "Incomplete", "NotAttempted", "Unknown" ] }, "id": { "type": "string", "description": "The ID of the learning assignment step" }, "moduleStep": { "type": "object", "description": "Module Step", "properties": { "type": { "type": "string", "description": "The learning module inform step type", "enum": [ "Url", "Content", "GenesysBuiltInCourse", "RichText", "Scorm" ] }, "name": { "type": "string", "description": "The name of the inform step or content" }, "value": { "type": "string", "description": "The value for inform step" }, "sharingUri": { "type": "string", "description": "The sharing uri for Content type inform step" }, "contentType": { "type": "string", "description": "The document type for Content type Inform step" }, "order": { "type": "integer", "description": "The order of inform step in a learning module" }, "displayName": { "type": "string", "description": "The display name for the inform step" }, "description": { "type": "string", "description": "The description for the inform step" } }, "required": [ "order", "type", "value" ] }, "percentageScore": { "type": "number", "description": "The percentage score for this step" }, "selfUri": { "type": "string", "description": "The URI for this object" }, "shareableContentObject": { "type": "object", "description": "Learning assignment SCO (Shareable Content Object)", "properties": { "id": { "type": "string", "description": "The ID of the SCO from the course manifest." }, "lessonStatus": { "type": "string", "description": "The status of the SCO. Maps to the SCORM 1.2 cmi.core.lesson_status property.", "enum": [ "Passed", "Completed", "Failed", "Incomplete", "Browsed", "NotAttempted" ] }, "exit": { "type": "string", "description": "Indicates how or why the learner left the SCO. Maps to the SCORM 1.2 cmi.core.exit property.", "enum": [ "Timeout", "Suspend", "Logout", "Empty" ] }, "location": { "type": "string", "description": "The learner’s current location in the SCO. Maps to the SCORM 1.2 cmi.core.lesson_location property." }, "scoreRaw": { "type": "number", "description": "The score of the most recent attempt on the SCO. Maps to the SCORM 1.2 cmi.core.score.raw property." }, "scoreMax": { "type": "number", "description": "The maximum score that could be achieved on the SCO. Maps to the SCORM 1.2 cmi.core.score.max property." }, "scoreMin": { "type": "number", "description": "The minimum score that could be achieved on the SCO. Maps to the SCORM 1.2 cmi.core.score.min property." }, "suspendData": { "type": "string", "description": "The unique information generated by the SCO from previous uses. Maps to the SCORM 1.2 cmi.suspend_data property." }, "credit": { "type": "string", "description": "Whether completing this course counts towards the overall assignment. Maps to the SCORM 1.2 cmi.core.credit property.", "enum": [ "Credit", "NoCredit" ] }, "entry": { "type": "string", "description": "Whether the learner has previously accessed this SCO. Maps to the SCORM 1.2 cmi.core.entry property.", "enum": [ "AbInitio", "Resume", "Empty" ] }, "mode": { "type": "string", "description": "Identifies the mode in which the SCO should be presented to the learner. Maps to the SCORM 1.2 cmi.core.lesson_mode property.", "enum": [ "Browse", "Normal", "Review" ] }, "totalTime": { "type": "string", "description": "The total amount of time the learner has spent in the SCO expressed as an ISO 8601 Duration, for example PT2H10M3.5S. Maps to the SCORM 1.2 cmi.core.total_time property." }, "sessionTime": { "type": "string", "description": "The amount of time spent in the SCO in this session expressed as an ISO-8601 Duration, for example PT2H10M3.5S. Maps to the SCORM 1.2 cmi.core.session_time property." }, "href": { "type": "string", "description": "The href from the course manifest for this SCO." }, "parameters": { "type": "string", "description": "The parameters from the course manifest for this SCO." }, "launchData": { "type": "string", "description": "The launch data from the course manifest for this SCO." } }, "required": [ "id" ] }, "signedCookie": { "type": "object", "description": "Signed Cookie", "properties": { "url": { "type": "string", "description": "The base URL for the signed cookie" }, "cookieValues": { "type": "object", "description": "The cookie values required to access content from the base URL" } } }, "structure": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of this SCO in the course manifest" }, "name": { "type": "string", "description": "The name of this SCO in the course manifest" }, "successStatus": { "type": "string", "enum": [ "Passed", "Failed", "Unknown" ], "description": "The success status of this SCO" }, "completionStatus": { "type": "string", "enum": [ "Completed", "Incomplete", "NotAttempted", "Unknown" ], "description": "The completion status of this SCO" }, "children": { "type": "array", "items": { "type": "object" }, "description": "Child items belonging to this SCO in the course manifest" } } }, "description": "The structure for any SCO associated with this step" }, "successStatus": { "type": "string", "description": "The success status of this step", "enum": [ "Passed", "Failed", "Unknown" ] } }, "required": [ "PCID", "assignmentId", "stepId" ] } ``` *** ## genesys\_coaching\_patch\_learning\_module\_user\_assignments Update an external assignment for a specific user **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ----------------------------------- | | `moduleId` | string | Yes | — | Key identifier for the module | | `userId` | string | Yes | — | Key identifier for the user | | `isPassed` | boolean | No | — | Was the assignment marked as passed | | `percentageScore` | number | No | — | The score | | `state` | string | No | — | The Learning Assignment state | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "Key identifier for the module" }, "userId": { "type": "string", "description": "Key identifier for the user" }, "isPassed": { "type": "boolean", "description": "Was the assignment marked as passed" }, "percentageScore": { "type": "number", "description": "The score" }, "state": { "type": "string", "description": "The Learning Assignment state", "enum": [ "Assigned", "InProgress", "Completed", "Deleted", "NotCompleted", "InvalidSchedule" ] } }, "required": [ "PCID", "moduleId", "userId" ] } ``` *** ## genesys\_coaching\_patch\_notification Update an existing notification. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `notificationId` | string | Yes | — | The ID of the notification. | | `actionType` | string | No | — | Action causing the notification. | | `appointment` | object | No | — | Coaching appointment response | | `dateStart` | string | No | — | The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `id` | string | No | — | The globally unique identifier for the object. | | `lengthInMinutes` | integer | No | — | The duration of the appointment on this notification | | `markedAsRead` | boolean | No | — | Indicates if notification is read or unread | | `name` | string | No | — | The name of the appointment for this notification. | | `relationship` | string | No | — | The relationship of this user to this notification's appointment | | `selfUri` | string | No | — | The URI for this object | | `status` | string | No | — | The status of the appointment for this notification | | `user` | object | No | — | The user value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "notificationId": { "type": "string", "description": "The ID of the notification." }, "actionType": { "type": "string", "description": "Action causing the notification.", "enum": [ "Create", "Update", "Delete", "StatusChange" ] }, "appointment": { "type": "object", "description": "Coaching appointment response", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name of coaching appointment" }, "description": { "type": "string", "description": "The description of coaching appointment" }, "dateStart": { "type": "string", "description": "The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "lengthInMinutes": { "type": "integer", "description": "The duration of coaching appointment in minutes" }, "status": { "type": "string", "description": "The status of coaching appointment", "enum": [ "Scheduled", "InProgress", "Completed", "InvalidSchedule" ] }, "facilitator": { "type": "object", "description": "The facilitator value" }, "attendees": { "type": "array", "items": { "type": "object" }, "description": "The list of attendees attending the coaching" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "conversations": { "type": "array", "items": { "type": "object" }, "description": "The list of conversations associated with coaching appointment." }, "documents": { "type": "array", "items": { "type": "object" }, "description": "The list of documents associated with coaching appointment." }, "isOverdue": { "type": "boolean", "description": "Whether the appointment is overdue." }, "wfmSchedule": { "type": "object", "description": "Wfm Schedule" }, "dateCompleted": { "type": "string", "description": "The date/time the coaching appointment was set to completed status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "externalLinks": { "type": "array", "items": { "type": "string" }, "description": "The list of external links related to the appointment" }, "location": { "type": "string", "description": "The location of the appointment" }, "shareInsightsData": { "type": "boolean", "description": "Whether to share the insight data" }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "dateStart": { "type": "string", "description": "The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "lengthInMinutes": { "type": "integer", "description": "The duration of the appointment on this notification" }, "markedAsRead": { "type": "boolean", "description": "Indicates if notification is read or unread" }, "name": { "type": "string", "description": "The name of the appointment for this notification." }, "relationship": { "type": "string", "description": "The relationship of this user to this notification's appointment", "enum": [ "Attendee", "Creator", "Facilitator" ] }, "selfUri": { "type": "string", "description": "The URI for this object" }, "status": { "type": "string", "description": "The status of the appointment for this notification", "enum": [ "Scheduled", "InProgress", "Completed", "InvalidSchedule" ] }, "user": { "type": "object", "description": "The user value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "description": "The URI for this object" } } } }, "required": [ "PCID", "notificationId" ] } ``` *** ## genesys\_coaching\_post\_appointment\_annotations Create a new annotation. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ------------------------------------------------------ | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `accessType` | string | Yes | — | Determines the permissions required to view this item. | | `text` | string | Yes | — | The text of the annotation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "accessType": { "type": "string", "description": "Determines the permissions required to view this item.", "enum": [ "Public", "Private" ] }, "text": { "type": "string", "description": "The text of the annotation." } }, "required": [ "PCID", "appointmentId", "accessType", "text" ] } ``` *** ## genesys\_coaching\_post\_appointment\_conversations Add a conversation to an appointment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ----------------------------------- | | `appointmentId` | string | Yes | — | The ID of the coaching appointment. | | `conversationId` | string | Yes | — | The id of the conversation to add | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appointmentId": { "type": "string", "description": "The ID of the coaching appointment." }, "conversationId": { "type": "string", "description": "The id of the conversation to add" } }, "required": [ "PCID", "appointmentId", "conversationId" ] } ``` *** ## genesys\_coaching\_post\_appointments Create a new appointment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `addToSchedule` | boolean | No | — | If True, adds the appointment to their schedule | | `attendeeIds` | string\[] | Yes | — | IDs of attendees in the coaching appointment. | | `conversationIds` | string\[] | No | — | IDs of conversations associated with this coaching appointment. | | `dateStart` | string | Yes | — | The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `description` | string | Yes | — | The description of coaching appointment. | | `documentIds` | string\[] | No | — | IDs of documents associated with this coaching appointment. | | `externalLinks` | string\[] | No | — | The list of external links related to the appointment | | `facilitatorId` | string | No | — | The facilitator ID of coaching appointment. | | `lengthInMinutes` | integer | Yes | — | The duration of coaching appointment in minutes. | | `location` | string | No | — | The location of the appointment | | `name` | string | Yes | — | The name of coaching appointment. | | `shareInsightsData` | boolean | No | — | Whether to share the insight data | | `wfmSchedule` | object | No | — | Wfm Schedule | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "addToSchedule": { "type": "boolean", "description": "If True, adds the appointment to their schedule" }, "attendeeIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of attendees in the coaching appointment." }, "conversationIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of conversations associated with this coaching appointment." }, "dateStart": { "type": "string", "description": "The date/time the coaching appointment starts. Times will be rounded down to the minute. 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 coaching appointment." }, "documentIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of documents associated with this coaching appointment." }, "externalLinks": { "type": "array", "items": { "type": "string" }, "description": "The list of external links related to the appointment" }, "facilitatorId": { "type": "string", "description": "The facilitator ID of coaching appointment." }, "lengthInMinutes": { "type": "integer", "description": "The duration of coaching appointment in minutes." }, "location": { "type": "string", "description": "The location of the appointment" }, "name": { "type": "string", "description": "The name of coaching appointment." }, "shareInsightsData": { "type": "boolean", "description": "Whether to share the insight data" }, "wfmSchedule": { "type": "object", "description": "Wfm Schedule", "properties": { "id": { "type": "string", "description": "The ID of the WFM schedule" }, "businessUnit": { "type": "object", "description": "Business Unit" }, "weekDate": { "type": "string", "description": "The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "businessUnit", "id", "weekDate" ] } }, "required": [ "PCID", "attendeeIds", "dateStart", "description", "lengthInMinutes", "name" ] } ``` *** ## genesys\_coaching\_post\_appointments\_aggregates\_query Retrieve aggregated appointment data **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `filter` | object | Yes | — | The filter value | | `groupBy` | string\[] | No | — | An optional list of items by which to group the result data. | | `interval` | string | Yes | — | Interval to aggregate across. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `metrics` | string\[] | No | — | A list of metrics to aggregate. If omitted, all metrics are returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter": { "type": "object", "description": "The filter value", "properties": { "type": { "type": "string", "description": "The logic used to combine the clauses", "enum": [ "And", "Or" ] }, "clauses": { "type": "array", "items": { "type": "object" }, "description": "The list of clauses used to filter the data" } }, "required": [ "clauses", "type" ] }, "groupBy": { "type": "array", "items": { "type": "string", "enum": [ "attendeeId" ] }, "description": "An optional list of items by which to group the result data." }, "interval": { "type": "string", "description": "Interval to aggregate across. End date is not inclusive. 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": [ "nActivities", "nPlannedActivities", "nInProgressActivities", "nCompleteActivities", "nOverdueActivities", "nInvalidScheduleActivities" ] }, "description": "A list of metrics to aggregate. If omitted, all metrics are returned." } }, "required": [ "PCID", "filter", "interval" ] } ``` *** ## genesys\_coaching\_post\_learning\_assessments\_scoring Score learning assessment for preview **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ----------------- | | `answers` | object | Yes | — | The answers value | | `assessmentForm` | object | Yes | — | Assessment 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": "The total score of the answers" }, "totalCriticalScore": { "type": "number", "description": "The total score for the critical questions" }, "totalNonCriticalScore": { "type": "number", "description": "The total score for the non-critical questions" }, "questionGroupScores": { "type": "array", "items": { "type": "object" }, "description": "The individual scores for each question group" }, "failureReasons": { "type": "array", "items": { "type": "string", "enum": [ "Score", "CriticalScore", "KillQuestion" ] }, "description": "If the assessment was not passed, the reasons for failure." }, "comments": { "type": "string", "description": "Comments provided for these answers." }, "agentComments": { "type": "string", "description": "Comments provided by agent." }, "isPassed": { "type": "boolean", "description": "True if the assessment was passed" } }, "required": [ "questionGroupScores" ] }, "assessmentForm": { "type": "object", "description": "Assessment Form", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "dateModified": { "type": "string", "description": "Last modified date of the assessment form. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "contextId": { "type": "string", "description": "The unique Id for all versions of this assessment form" }, "selfUri": { "type": "string", "description": "The URI for this object" }, "published": { "type": "boolean", "description": "If true, assessment form is published" }, "passPercent": { "type": "integer", "description": "The pass percent for the assessment form" }, "questionGroups": { "type": "array", "items": { "type": "object" }, "description": "A list of question groups" } }, "required": [ "passPercent", "questionGroups" ] } }, "required": [ "PCID", "answers", "assessmentForm" ] } ``` *** ## genesys\_coaching\_post\_learning\_assignment\_reassign Reassign Learning Assignment **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | -------------------------- | | `assignmentId` | string | Yes | — | The Learning Assignment ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignmentId": { "type": "string", "description": "The Learning Assignment ID" } }, "required": [ "PCID", "assignmentId" ] } ``` *** ## genesys\_coaching\_post\_learning\_assignment\_reset Reset Learning Assignment **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | -------------------------- | | `assignmentId` | string | Yes | — | The Learning Assignment ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assignmentId": { "type": "string", "description": "The Learning Assignment ID" } }, "required": [ "PCID", "assignmentId" ] } ``` *** ## genesys\_coaching\_post\_learning\_assignments Create Learning Assignment **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `addToSchedule` | boolean | No | — | If True, adds the assignment to their schedule | | `lengthInMinutes` | integer | No | — | The length in minutes of assignment | | `moduleId` | string | Yes | — | The Learning module Id associated with this assignment | | `recommendedCompletionDate` | string | No | — | The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `userId` | string | Yes | — | The User for whom the assignment is assigned | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "addToSchedule": { "type": "boolean", "description": "If True, adds the assignment to their schedule" }, "lengthInMinutes": { "type": "integer", "description": "The length in minutes of assignment" }, "moduleId": { "type": "string", "description": "The Learning module Id associated with this assignment" }, "recommendedCompletionDate": { "type": "string", "description": "The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "userId": { "type": "string", "description": "The User for whom the assignment is assigned" } }, "required": [ "PCID", "moduleId", "userId" ] } ``` *** ## genesys\_coaching\_post\_learning\_assignments\_aggregates\_query Retrieve aggregated assignment data **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `filter` | object | Yes | — | The filter value | | `groupBy` | string\[] | No | — | Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is "attendeeId") | | `interval` | string | Yes | — | Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `metrics` | string\[] | No | — | The list of metrics to be returned. If omitted, all metrics are returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter": { "type": "object", "description": "The filter value", "properties": { "type": { "type": "string", "description": "The logic used to combine the clauses", "enum": [ "And", "Or" ] }, "clauses": { "type": "array", "items": { "type": "object" }, "description": "The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed" } }, "required": [ "clauses", "type" ] }, "groupBy": { "type": "array", "items": { "type": "string", "enum": [ "attendeeId" ] }, "description": "Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")" }, "interval": { "type": "string", "description": "Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. 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": [ "nActivities", "nPlannedActivities", "nInProgressActivities", "nCompleteActivities", "nOverdueActivities", "nInvalidScheduleActivities", "nPassedActivities", "nFailedActivities", "oActivityScore", "nNotCompletedActivities" ] }, "description": "The list of metrics to be returned. If omitted, all metrics are returned." } }, "required": [ "PCID", "filter", "interval" ] } ``` *** ## genesys\_coaching\_post\_learning\_module\_jobs Starts a specified operation on learning module **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------ | | `moduleId` | string | Yes | — | The ID of the learning module | | `action` | string | Yes | — | The type for the learning module job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" }, "action": { "type": "string", "description": "The type for the learning module job", "enum": [ "Reassign", "GracefulArchive", "ImmediateArchive", "Unarchive", "Assign" ] } }, "required": [ "PCID", "moduleId", "action" ] } ``` *** ## genesys\_coaching\_post\_learning\_module\_publish Publish a Learning module **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------- | -------- | ------- | ---------------------------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | | `termsAndConditionsAccepted` | boolean | No | — | Whether the terms and conditions were accepted | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" }, "termsAndConditionsAccepted": { "type": "boolean", "description": "Whether the terms and conditions were accepted" } }, "required": [ "PCID", "moduleId" ] } ``` *** ## genesys\_coaching\_post\_learning\_modules Create a new learning module **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | | `assessmentForm` | object | No | — | Assessment Form | | `autoAssign` | object | No | — | Auto assign request | | `completionTimeInDays` | integer | Yes | — | The completion time of learning module in days | | `coverArt` | object | No | — | Cover Art | | `description` | string | No | — | The description of learning module | | `enforceContentOrder` | boolean | No | — | If true, learning module content should be viewed one by one in order | | `excludedFromCatalog` | boolean | No | — | If true, learning module is excluded when retrieving modules for manual assignment | | `externalId` | string | No | — | The external ID of the learning module. Maximum length: 50 characters. | | `informSteps` | object\[] | No | — | The list of inform steps in a learning module | | `lengthInMinutes` | integer | No | — | The recommended time in minutes to complete the module | | `name` | string | Yes | — | The name of learning module | | `reviewAssessmentResults` | object | No | — | Review Assessment Results | | `type` | string | No | — | The type for the learning module. Informational, AssessedContent and Assessment are deprecated | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "assessmentForm": { "type": "object", "description": "Assessment Form", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "dateModified": { "type": "string", "description": "Last modified date of the assessment form. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "contextId": { "type": "string", "description": "The unique Id for all versions of this assessment form" }, "selfUri": { "type": "string", "description": "The URI for this object" }, "published": { "type": "boolean", "description": "If true, assessment form is published" }, "passPercent": { "type": "integer", "description": "The pass percent for the assessment form" }, "questionGroups": { "type": "array", "items": { "type": "object" }, "description": "A list of question groups" } }, "required": [ "passPercent", "questionGroups" ] }, "autoAssign": { "type": "object", "description": "Auto assign request", "properties": { "ruleId": { "type": "string", "description": "The id of the rule" }, "enabled": { "type": "boolean", "description": "Whether the rule is enabled for the module" } }, "required": [ "enabled", "ruleId" ] }, "completionTimeInDays": { "type": "integer", "description": "The completion time of learning module in days" }, "coverArt": { "type": "object", "description": "Cover Art", "properties": { "id": { "type": "string", "description": "The key identifier for the cover art" } }, "required": [ "id" ] }, "description": { "type": "string", "description": "The description of learning module" }, "enforceContentOrder": { "type": "boolean", "description": "If true, learning module content should be viewed one by one in order" }, "excludedFromCatalog": { "type": "boolean", "description": "If true, learning module is excluded when retrieving modules for manual assignment" }, "externalId": { "type": "string", "description": "The external ID of the learning module. Maximum length: 50 characters." }, "informSteps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Url", "Content", "GenesysBuiltInCourse", "RichText", "Scorm" ], "description": "The learning module inform step type" }, "name": { "type": "string", "description": "The name of the inform step or content" }, "value": { "type": "string", "description": "The value for inform step" }, "sharingUri": { "type": "string", "description": "The sharing uri for Content type inform step" }, "contentType": { "type": "string", "description": "The document type for Content type Inform step" }, "order": { "type": "integer", "format": "int32", "description": "The order of inform step in a learning module" }, "displayName": { "type": "string", "description": "The display name for the inform step" }, "description": { "type": "string", "description": "The description for the inform step" } }, "required": [ "order", "type", "value" ] }, "description": "The list of inform steps in a learning module" }, "lengthInMinutes": { "type": "integer", "description": "The recommended time in minutes to complete the module" }, "name": { "type": "string", "description": "The name of learning module" }, "reviewAssessmentResults": { "type": "object", "description": "Review Assessment Results", "properties": { "byAssignees": { "type": "boolean", "description": "If true, learning assignment results can be seen in detail by assignees" }, "byViewers": { "type": "boolean", "description": "If true, learning assignment results can be seen in detail by people who are eligible to view" } } }, "type": { "type": "string", "description": "The type for the learning module. Informational, AssessedContent and Assessment are deprecated", "enum": [ "Informational", "AssessedContent", "Assessment", "External", "Native" ] } }, "required": [ "PCID", "completionTimeInDays", "name" ] } ``` *** ## genesys\_coaching\_post\_learning\_rules\_query Get users for learning module rule **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | -------------------------------- | | `pageSize` | integer | Yes | — | Page size | | `pageNumber` | integer | Yes | — | Page number | | `rule` | object | Yes | — | The rule value | | `searchTerm` | string | No | — | The user name to be searched for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "Page size" }, "pageNumber": { "type": "integer", "description": "Page number" }, "rule": { "type": "object", "description": "The rule value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "isActive": { "type": "boolean", "description": "If true, rule is active" }, "parts": { "type": "array", "items": { "type": "object" }, "description": "The parts of a learning module rule" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "isActive", "parts" ] }, "searchTerm": { "type": "string", "description": "The user name to be searched for" } }, "required": [ "PCID", "pageSize", "pageNumber", "rule" ] } ``` *** ## genesys\_coaching\_post\_learning\_scheduleslots\_jobs Start job to retrieve slots where a learning activity can be scheduled. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `activityCodeId` | string | Yes | — | The Activity Code Id of the slots. | | `intervals` | string\[] | Yes | — | The intervals to fetch the slots for. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `lengthInMinutes` | integer | Yes | — | The length in minutes of the slots, in 15 minutes granularity. | | `slotsType` | string | Yes | — | The type of slots to fetch in the job. | | `userIds` | string\[] | Yes | — | The user IDs to fetch the slots for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "activityCodeId": { "type": "string", "description": "The Activity Code Id of the slots." }, "intervals": { "type": "array", "items": { "type": "string", "format": "interval" }, "description": "The intervals to fetch the slots for. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "lengthInMinutes": { "type": "integer", "description": "The length in minutes of the slots, in 15 minutes granularity." }, "slotsType": { "type": "string", "description": "The type of slots to fetch in the job.", "enum": [ "BestTime" ] }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "The user IDs to fetch the slots for." } }, "required": [ "PCID", "activityCodeId", "intervals", "lengthInMinutes", "slotsType", "userIds" ] } ``` *** ## genesys\_coaching\_post\_learning\_scheduleslots\_query Get list of possible slots where a learning activity can be scheduled. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `interruptibleAssignmentId` | string | No | — | Assignment ID to exclude from consideration when determining blocked slots | | `interval` | string | Yes | — | Range of time to get slots for scheduling learning activities. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `lengthInMinutes` | integer | Yes | — | The duration of Learning Assignment to schedule in 15 minutes granularity | | `userIds` | string\[] | Yes | — | The user IDs for which to fetch schedules. Must be only 1. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "interruptibleAssignmentId": { "type": "string", "description": "Assignment ID to exclude from consideration when determining blocked slots" }, "interval": { "type": "string", "description": "Range of time to get slots for scheduling learning activities. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "lengthInMinutes": { "type": "integer", "description": "The duration of Learning Assignment to schedule in 15 minutes granularity" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "The user IDs for which to fetch schedules. Must be only 1." } }, "required": [ "PCID", "interval", "lengthInMinutes", "userIds" ] } ``` *** ## genesys\_coaching\_post\_learning\_scorm Create a SCORM package upload request **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------ | | `contentMd5` | string | Yes | — | The MD5 content of the SCORM package | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contentMd5": { "type": "string", "description": "The MD5 content of the SCORM package" } }, "required": [ "PCID", "contentMd5" ] } ``` *** ## genesys\_coaching\_post\_scheduleslots\_jobs Start job to retrieve the slots where a coaching appointment can be scheduled. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `activityCodeId` | string | Yes | — | The Activity Code Id of the slots. | | `attendeeIds` | string\[] | Yes | — | The attendee IDs to fetch the slots for. | | `facilitatorIds` | string\[] | No | — | The facilitator IDs to fetch the slots for. | | `intervals` | string\[] | Yes | — | The intervals to fetch the slots for. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `lengthInMinutes` | integer | Yes | — | The length in minutes of the slots, in 15 minutes granularity. | | `slotsType` | string | Yes | — | The type of slots to fetch in the job. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "activityCodeId": { "type": "string", "description": "The Activity Code Id of the slots." }, "attendeeIds": { "type": "array", "items": { "type": "string" }, "description": "The attendee IDs to fetch the slots for." }, "facilitatorIds": { "type": "array", "items": { "type": "string" }, "description": "The facilitator IDs to fetch the slots for." }, "intervals": { "type": "array", "items": { "type": "string", "format": "interval" }, "description": "The intervals to fetch the slots for. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "lengthInMinutes": { "type": "integer", "description": "The length in minutes of the slots, in 15 minutes granularity." }, "slotsType": { "type": "string", "description": "The type of slots to fetch in the job.", "enum": [ "BestTime" ] } }, "required": [ "PCID", "activityCodeId", "attendeeIds", "intervals", "lengthInMinutes", "slotsType" ] } ``` *** ## genesys\_coaching\_post\_scheduleslots\_query Get list of possible slots where a coaching appointment can be scheduled. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `attendeeIds` | string\[] | Yes | — | List of attendees to determine coaching appointment slots | | `facilitatorIds` | string\[] | No | — | List of facilitators to determine coaching appointment slots | | `interruptibleAppointmentIds` | string\[] | No | — | List of appointment ids to exclude from consideration when determining blocked slots | | `interval` | string | Yes | — | Range of time to get slots for scheduling coaching appointments. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `lengthInMinutes` | integer | Yes | — | The duration of coaching appointment to schedule in 15 minutes granularity up to maximum of 60 minutes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attendeeIds": { "type": "array", "items": { "type": "string" }, "description": "List of attendees to determine coaching appointment slots" }, "facilitatorIds": { "type": "array", "items": { "type": "string" }, "description": "List of facilitators to determine coaching appointment slots" }, "interruptibleAppointmentIds": { "type": "array", "items": { "type": "string" }, "description": "List of appointment ids to exclude from consideration when determining blocked slots" }, "interval": { "type": "string", "description": "Range of time to get slots for scheduling coaching appointments. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "lengthInMinutes": { "type": "integer", "description": "The duration of coaching appointment to schedule in 15 minutes granularity up to maximum of 60 minutes" } }, "required": [ "PCID", "attendeeIds", "interval", "lengthInMinutes" ] } ``` *** ## genesys\_coaching\_put\_learning\_module Update a learning module **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | | `assessmentForm` | object | No | — | Assessment Form | | `autoAssign` | object | No | — | Auto assign request | | `completionTimeInDays` | integer | Yes | — | The completion time of learning module in days | | `coverArt` | object | No | — | Cover Art | | `description` | string | No | — | The description of learning module | | `enforceContentOrder` | boolean | No | — | If true, learning module content should be viewed one by one in order | | `excludedFromCatalog` | boolean | No | — | If true, learning module is excluded when retrieving modules for manual assignment | | `externalId` | string | No | — | The external ID of the learning module. Maximum length: 50 characters. | | `informSteps` | object\[] | No | — | The list of inform steps in a learning module | | `lengthInMinutes` | integer | No | — | The recommended time in minutes to complete the module | | `name` | string | Yes | — | The name of learning module | | `reviewAssessmentResults` | object | No | — | Review Assessment Results | | `type` | string | No | — | The type for the learning module. Informational, AssessedContent and Assessment are deprecated | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" }, "assessmentForm": { "type": "object", "description": "Assessment Form", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "dateModified": { "type": "string", "description": "Last modified date of the assessment form. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "contextId": { "type": "string", "description": "The unique Id for all versions of this assessment form" }, "selfUri": { "type": "string", "description": "The URI for this object" }, "published": { "type": "boolean", "description": "If true, assessment form is published" }, "passPercent": { "type": "integer", "description": "The pass percent for the assessment form" }, "questionGroups": { "type": "array", "items": { "type": "object" }, "description": "A list of question groups" } }, "required": [ "passPercent", "questionGroups" ] }, "autoAssign": { "type": "object", "description": "Auto assign request", "properties": { "ruleId": { "type": "string", "description": "The id of the rule" }, "enabled": { "type": "boolean", "description": "Whether the rule is enabled for the module" } }, "required": [ "enabled", "ruleId" ] }, "completionTimeInDays": { "type": "integer", "description": "The completion time of learning module in days" }, "coverArt": { "type": "object", "description": "Cover Art", "properties": { "id": { "type": "string", "description": "The key identifier for the cover art" } }, "required": [ "id" ] }, "description": { "type": "string", "description": "The description of learning module" }, "enforceContentOrder": { "type": "boolean", "description": "If true, learning module content should be viewed one by one in order" }, "excludedFromCatalog": { "type": "boolean", "description": "If true, learning module is excluded when retrieving modules for manual assignment" }, "externalId": { "type": "string", "description": "The external ID of the learning module. Maximum length: 50 characters." }, "informSteps": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Url", "Content", "GenesysBuiltInCourse", "RichText", "Scorm" ], "description": "The learning module inform step type" }, "name": { "type": "string", "description": "The name of the inform step or content" }, "value": { "type": "string", "description": "The value for inform step" }, "sharingUri": { "type": "string", "description": "The sharing uri for Content type inform step" }, "contentType": { "type": "string", "description": "The document type for Content type Inform step" }, "order": { "type": "integer", "format": "int32", "description": "The order of inform step in a learning module" }, "displayName": { "type": "string", "description": "The display name for the inform step" }, "description": { "type": "string", "description": "The description for the inform step" } }, "required": [ "order", "type", "value" ] }, "description": "The list of inform steps in a learning module" }, "lengthInMinutes": { "type": "integer", "description": "The recommended time in minutes to complete the module" }, "name": { "type": "string", "description": "The name of learning module" }, "reviewAssessmentResults": { "type": "object", "description": "Review Assessment Results", "properties": { "byAssignees": { "type": "boolean", "description": "If true, learning assignment results can be seen in detail by assignees" }, "byViewers": { "type": "boolean", "description": "If true, learning assignment results can be seen in detail by people who are eligible to view" } } }, "type": { "type": "string", "description": "The type for the learning module. Informational, AssessedContent and Assessment are deprecated", "enum": [ "Informational", "AssessedContent", "Assessment", "External", "Native" ] } }, "required": [ "PCID", "moduleId", "completionTimeInDays", "name" ] } ``` *** ## genesys\_coaching\_put\_learning\_module\_preview Update a learning module preview **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | --------- | -------- | ------- | --------------------------------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | | `assessment` | object | No | — | The assessment value | | `assessmentForm` | object | No | — | Assessment Form | | `currentStep` | object | No | — | Learning module preview update request current step | | `state` | string | No | — | The assignment State | | `steps` | object\[] | No | — | The assignment Steps | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "moduleId": { "type": "string", "description": "The ID of the learning module" }, "assessment": { "type": "object", "description": "The assessment value", "properties": { "assessmentId": { "type": "string", "description": "The Id of the assessment" }, "contextId": { "type": "string", "description": "The context Id of the related assessment form" }, "assessmentFormId": { "type": "string", "description": "The Id of the related assessment form" }, "status": { "type": "string", "description": "Status of the assessment", "enum": [ "Pending", "InProgress", "Finished" ] }, "answers": { "type": "object", "description": "The answers value" }, "dateCreated": { "type": "string", "description": "Date the assessment 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 the assessment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateSubmitted": { "type": "string", "description": "Date the assessment was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } } }, "assessmentForm": { "type": "object", "description": "Assessment Form", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "dateModified": { "type": "string", "description": "Last modified date of the assessment form. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "contextId": { "type": "string", "description": "The unique Id for all versions of this assessment form" }, "selfUri": { "type": "string", "description": "The URI for this object" }, "published": { "type": "boolean", "description": "If true, assessment form is published" }, "passPercent": { "type": "integer", "description": "The pass percent for the assessment form" }, "questionGroups": { "type": "array", "items": { "type": "object" }, "description": "A list of question groups" } }, "required": [ "passPercent", "questionGroups" ] }, "currentStep": { "type": "object", "description": "Learning module preview update request current step", "properties": { "id": { "type": "string", "description": "The id of this step" }, "completionPercentage": { "type": "number", "description": "The completion percentage for this step" }, "shareableContentObject": { "type": "object", "description": "Learning assignment SCO (Shareable Content Object)" } } }, "state": { "type": "string", "description": "The assignment State", "enum": [ "Assigned", "InProgress", "Completed", "Deleted", "NotCompleted", "InvalidSchedule" ] }, "steps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the step" }, "successStatus": { "type": "string", "enum": [ "Passed", "Failed", "Unknown" ], "description": "The success status of the step" }, "completionStatus": { "type": "string", "enum": [ "Completed", "Incomplete", "NotAttempted", "Unknown" ], "description": "The completion status of the step" }, "completionPercentage": { "type": "number", "format": "float", "description": "The completion percentage of the step" }, "percentageScore": { "type": "number", "format": "float", "description": "Percentage Score" }, "structure": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of this SCO in the course manifest" }, "name": { "type": "string", "description": "The name of this SCO in the course manifest" }, "successStatus": { "type": "string", "description": "The success status of this SCO" }, "completionStatus": { "type": "string", "description": "The completion status of this SCO" }, "percentageScore": { "type": "number", "description": "Percentage Score" }, "children": { "type": "array", "description": "Child items belonging to this SCO in the course manifest" } } }, "description": "The structure for any SCO associated with this step" } } }, "description": "The assignment Steps" } }, "required": [ "PCID", "moduleId" ] } ``` *** ## genesys\_coaching\_put\_learning\_module\_rule Update a learning module rule **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ---------------------------------------------- | | `moduleId` | string | Yes | — | The ID of the learning module | | `assign` | boolean | No | — | Whether to assign the module to users or not | | `id` | string | No | — | The globally unique identifier for the object. | | `isActive` | boolean | Yes | — | If true, rule is active | | `parts` | object\[] | Yes | — | The parts of a learning module rule | | `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" }, "moduleId": { "type": "string", "description": "The ID of the learning module" }, "assign": { "type": "boolean", "description": "Whether to assign the module to users or not" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "isActive": { "type": "boolean", "description": "If true, rule is active" }, "parts": { "type": "array", "items": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "Include", "Exclude" ], "description": "The learning module rule operation" }, "selector": { "type": "string", "enum": [ "AcdSkills", "AgentName", "Division", "Group", "Location", "Queue", "Role", "Team", "User" ], "description": "The learning module rule selector" }, "value": { "type": "array", "items": { "type": "string" }, "description": "The value of rules" }, "order": { "type": "integer", "format": "int32", "description": "The order of rules in learning module rule" } }, "required": [ "operation", "order", "selector", "value" ] }, "description": "The parts of a learning module rule" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "moduleId", "isActive", "parts" ] } ```