Methods
(static) bulkExportCoursesAttendance(exportName, getFullPath, uniqueByDate, userIdsToIgnore) → {BulkExportResult}
This is the service that's called by the core-bulk-import to generate the csv with the courses attendance required by SAP to track the training status of each user. It will process the editions referenced by the existing t_bulk_export records that can be processed (not in status CLOSED/FAILED_NO_RETRY). The rows included in the export will be created (or updated, if they were already present but still not sent) and marked as sent in the t_bulk_export_row table. NB: Concurrent executions on the same editions will be blocked by using a redis key.
Parameters:
| Name | Type | Description |
|---|---|---|
exportName |
string | Optional: Name of the export |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned instead of the filename only |
uniqueByDate |
string | Optional: If true, the unique identifier won't be a UUID but it will be a formatted date with this pattern: YYYY-MM-DD |
userIdsToIgnore |
string | Array.<string> | Optional: If defined, the enrolls of the specified users won't be retrieved (ie: the demo users, which list is defined in the atfcore-services project) |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/bulk-export-courses-attendance
Returns:
Object with the export's path and the exported rows count
- Type
- BulkExportResult
(static) exportAllItemsOfUserAnalytics(description, startDate, endDate, userId, token) → {CustomCourseAndDate}
Export all items (course and online items) where the user have at least one completion (for online items related to a course, will be retrieved only 1 row for the engangement: EVENT_COURSE_PASSED, ignoring EVENT_ITEM_CONSUMED)
Parameters:
| Name | Type | Description |
|---|---|---|
description |
string | Optional by the action: Filter the list of courses by description parameter |
startDate |
Date | Optional by the action: If filterByDateRange is true specify the startDate to filter |
endDate |
Date | Optional by the action: If filterByDateRange is true specify the endDate to filter |
userId |
string | Optional by the action: The userId to retrieve the data |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-all-items-of-user-analytics
Returns:
the required data
- Type
- CustomCourseAndDate
(static) exportCourseCreditsAnalytics(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}
Retrieve the training hours grouped by time period(week or date)
Parameters:
| Name | Type | Description |
|---|---|---|
fromDate |
Date | Optional for the action: The date range - start |
toDate |
Date | Optional for the action: The date range - end |
myDataOnly |
booelan | Optional: retrieve only user's personal data |
gaiDataOnly |
booelan | Optional: retrieve only user's gai data |
hrbpDataOnly |
booelan | Optional: retrieve only user's hrbp data |
managerDataOnly |
booelan | Optional: retrieve only user's manager data |
socDistacco |
string | Array.<string> | Optional |
chief |
string | Array.<string> | Optional |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-course-credits-analytics
Returns:
The data to display
- Type
- Array.<User>
(static) exportDashboardSuggestedItems(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, exportName, token) → {Array.<SuggestedItem>}
Generate excel with suggested items data
Parameters:
| Name | Type | Description |
|---|---|---|
fromDate |
Date | Optional for the action: The date range - start |
toDate |
Date | Optional for the action: The date range - end |
myDataOnly |
booelan | Optional: retrieve only user's personal data |
gaiDataOnly |
booelan | Optional: retrieve only user's gai data |
hrbpDataOnly |
booelan | Optional: retrieve only user's hrbp data |
managerDataOnly |
booelan | Optional: retrieve only user's manager data |
socDistacco |
string | Array.<string> | Optional |
chief |
string | Array.<string> | Optional |
exportName |
string | Optional: The name of the excel |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-dashboard-suggested-items
Returns:
The data to display
- Type
- Array.<SuggestedItem>
(static) exportEditionTakers(withAllStatusLoaded, exportName) → {string}
Exports the course participant excel for the provided edition
Parameters:
| Name | Type | Description |
|---|---|---|
withAllStatusLoaded |
boolean | Optional: If true, all the faculty rent statuses will be retrieved (and not only the active ones) |
exportName |
string | Optional: The export's filename, by default its "faculty_members.xlsx". An UUID will be appended to the filename. |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-edition-takers/:langCode/:tenant/:editionId/:exportName
Returns:
Export's filename
- Type
- string
(static) exportExcelConsumedObjectsFlatData(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {string}
Export excel of engagement flat data for consumed objects
Parameters:
| Name | Type | Description |
|---|---|---|
fromDate |
Date | Optional for the action: The date range - start |
toDate |
Date | Optional for the action: The date range - end |
myDataOnly |
booelan | Optional: retrieve only user's personal data |
gaiDataOnly |
booelan | Optional: retrieve only user's gai data |
hrbpDataOnly |
booelan | Optional: retrieve only user's hrbp data |
managerDataOnly |
booelan | Optional: retrieve only user's manager data |
socDistacco |
string | Array.<string> | Optional |
chief |
string | Array.<string> | Optional |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-excel-consumed-objects-flat-data
Returns:
filename
- Type
- string
(static) exportExcelTopActiveUsers(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {string}
Export excel of active users with aggregation counts
Parameters:
| Name | Type | Description |
|---|---|---|
fromDate |
Date | Optional for the action: The date range - start |
toDate |
Date | Optional for the action: The date range - end |
myDataOnly |
booelan | Optional: retrieve only user's personal data |
gaiDataOnly |
booelan | Optional: retrieve only user's gai data |
hrbpDataOnly |
booelan | Optional: retrieve only user's hrbp data |
managerDataOnly |
booelan | Optional: retrieve only user's manager data |
socDistacco |
string | Array.<string> | Optional |
chief |
string | Array.<string> | Optional |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-excel-top-active-users
Returns:
filename
- Type
- string
(static) exportExcelTrainedUsersFlatData(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {string}
Export excel of engagement flat data for consumed objects and courses
Parameters:
| Name | Type | Description |
|---|---|---|
fromDate |
Date | Optional for the action: The date range - start |
toDate |
Date | Optional for the action: The date range - end |
myDataOnly |
booelan | Optional: retrieve only user's personal data |
gaiDataOnly |
booelan | Optional: retrieve only user's gai data |
hrbpDataOnly |
booelan | Optional: retrieve only user's hrbp data |
managerDataOnly |
booelan | Optional: retrieve only user's manager data |
socDistacco |
string | Array.<string> | Optional |
chief |
string | Array.<string> | Optional |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-excel-trained-users-flat-data
Returns:
filename
- Type
- string
(static) exportGetCourseInvitesUsers(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, textFilter, eventName, token)
Retrieve the users which accepted and refused course invites
Parameters:
| Name | Type | Description |
|---|---|---|
fromDate |
Date | Optional for the action: The date range - start |
toDate |
Date | Optional for the action: The date range - end |
myDataOnly |
booelan | Optional: retrieve only user's personal data |
gaiDataOnly |
booelan | Optional: retrieve only user's gai data |
hrbpDataOnly |
booelan | Optional: retrieve only user's hrbp data |
managerDataOnly |
booelan | Optional: retrieve only user's manager data |
socDistacco |
string | Array.<string> | Optional |
chief |
string | Array.<string> | Optional |
textFilter |
string | Optional: Text used to filter the users |
eventName |
string | Optional: Event name to retrieve |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-get-course-invites-users
Returns:
{{rows: CourseInviteUser[], totalRowsCount: number} The data to display
(static) exportMandatoryTrainingGroupsRecap(userRoleIds, groupId, roleCode, perimeterType, exportName, getFullPath, ignoreServiceExecutionLock, token) → {boolean|string}
Exports a recap of the mandatory training's users training status, divided by group. The workbook will be generated with N worksheets, one for each group. The file will be generated and sent by email. By default, multiple executions of the same export service (with the same types of parameters) aren't allowed and an error will be thrown.
Parameters:
| Name | Type | Description |
|---|---|---|
userRoleIds |
string | Array.<string> | Optional: Rents reference id(s), that corresponds to the role's tagId |
groupId |
string | Array.<string> | Required: Id(s) of the group(s) to include in the export |
roleCode |
string | Array.<string> | Optional: Role code(s) used to retrieve the role tag(s) |
perimeterType |
string | Array.<string> | Optional: Perimeter(s) for which the data will be retrieved (@see {MandatoryTrainingPerimeterTypes} for available values). If not defined, all the perimeters will be used. |
exportName |
string | Optional: Name of the export |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned instead of the filename only |
ignoreServiceExecutionLock |
boolean | Optional: If true, the redis key that blocks the multiple service executions won't be checked |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-mandatory-training-groups-recap
Returns:
True if ignoreServiceExecutionLock is false and the execution has been correctly started, or the name of the export (or full path if getFullPath is true)
- Type
- boolean | string
(static) exportMandatoryTrainingGroupsRecapByHrbp(userRoleIds, groupId, roleCode, perimeterType, exportName, getFullPath, ignoreServiceExecutionLock, token) → {boolean|string}
Exports a recap of the mandatory training's users training status, divided by group. The workbook will be generated with N worksheets, one for each group. The file will be generated and sent by email. By default, multiple executions of the same export service (with the same types of parameters) aren't allowed and an error will be thrown.
Parameters:
| Name | Type | Description |
|---|---|---|
userRoleIds |
string | Array.<string> | Optional: Rents reference id(s), that corresponds to the role's tagId |
groupId |
string | Array.<string> | Required: Id(s) of the group(s) to include in the export |
roleCode |
string | Array.<string> | Optional: Role code(s) used to retrieve the role tag(s) |
perimeterType |
string | Array.<string> | Optional: Perimeter(s) for which the data will be retrieved (@see {MandatoryTrainingPerimeterTypes} for available values). If not defined, all the perimeters will be used. |
exportName |
string | Optional: Name of the export |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned instead of the filename only |
ignoreServiceExecutionLock |
boolean | Optional: If true, the redis key that blocks the multiple service executions won't be checked |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-mandatory-training-groups-recap-by-hrbp
Returns:
True if ignoreServiceExecutionLock is false and the execution has been correctly started, or the name of the export (or full path if getFullPath is true)
- Type
- boolean | string
(static) exportMandatoryTrainingRolesWithTotalCounters(userRoleIds, groupId, roleCode, perimeterType, exportName, getFullPath, ignoreServiceExecutionLock, token) → {boolean|string}
Exports all the mandatory training's roles with their total counters. The file will be generated and sent by email. By default, multiple executions of the same export service (with the same types of parameters) aren't allowed and an error will be thrown.
Parameters:
| Name | Type | Description |
|---|---|---|
userRoleIds |
string | Array.<string> | Optional: Rents reference id(s), that corresponds to the role's tagId |
groupId |
string | Array.<string> | Required: Id(s) of the group(s) to include in the export |
roleCode |
string | Array.<string> | Optional: Role code(s) used to retrieve the role tag(s) |
perimeterType |
string | Array.<string> | Optional: Perimeter(s) for which the data will be retrieved (@see {MandatoryTrainingPerimeterTypes} for available values). If not defined, all the perimeters will be used. |
exportName |
string | Optional: Name of the export |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned instead of the filename only |
ignoreServiceExecutionLock |
boolean | Optional: If true, the redis key that blocks the multiple service executions won't be checked |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-mandatory-training-roles-with-total-counters
Returns:
True if ignoreServiceExecutionLock is false and the execution has been correctly started, or the name of the export (or full path if getFullPath is true)
- Type
- boolean | string
(static) exportMandatoryTrainingUsersDetails(statusType, userRoleIds, rentUserId, groupIds, roleCode, perimeterType, exportName, getFullPath, ignoreServiceExecutionLock, token) → {boolean|string}
Exports the details of the mandatory training's users rents. The file will be generated and sent by email. By default, multiple executions of the same export service (with the same types of parameters) aren't allowed and an error will be thrown.
Parameters:
| Name | Type | Description |
|---|---|---|
statusType |
string | Array.<string> | Optional: Status type(s) of the rents to include in the export |
userRoleIds |
string | Array.<string> | Optional: Rents reference id(s), that corresponds to the role's tagId |
rentUserId |
string | Array.<string> | Optional: Id(s) of the user(s) to include in the export |
groupIds |
string | Array.<string> | Optional (if allUsers is true or userIds is defined): Id(s) of the groups from where the userIds to process will be retrived |
roleCode |
string | Array.<string> | Optional: Role code(s) used to retrieve the role tag(s) |
perimeterType |
string | Array.<string> | Optional: Perimeter(s) for which the data will be retrieved (@see {MandatoryTrainingPerimeterTypes} for available values). If not defined, all the perimeters will be used. |
exportName |
string | Optional: Name of the export |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned instead of the filename only |
ignoreServiceExecutionLock |
boolean | Optional: If true, the redis key that blocks the multiple service executions won't be checked |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-mandatory-training-users-details
Returns:
True if ignoreServiceExecutionLock is false and the execution has been correctly started, or the name of the export (or full path if getFullPath is true)
- Type
- boolean | string
(static) exportMostDetectedDevicesAnalytics(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}
Retrieve the top active devices with their count
Parameters:
| Name | Type | Description |
|---|---|---|
fromDate |
Date | Optional for the action: The date range - start |
toDate |
Date | Optional for the action: The date range - end |
myDataOnly |
booelan | Optional: retrieve only user's personal data |
gaiDataOnly |
booelan | Optional: retrieve only user's gai data |
hrbpDataOnly |
booelan | Optional: retrieve only user's hrbp data |
managerDataOnly |
booelan | Optional: retrieve only user's manager data |
socDistacco |
string | Array.<string> | Optional |
chief |
string | Array.<string> | Optional |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-most-detected-devices-analytics
Returns:
The data to display
- Type
- Array.<User>
(static) exportSocialActivitiesUsersData(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, eventName, textFilter, exportName, token) → {UsersActivities}
Retrieve the users with the data of the performed social activities (suggested items, likes and logins)
Parameters:
| Name | Type | Description |
|---|---|---|
fromDate |
Date | Optional for the action: The date range - start |
toDate |
Date | Optional for the action: The date range - end |
myDataOnly |
booelan | Optional: retrieve only user's personal data |
gaiDataOnly |
booelan | Optional: retrieve only user's gai data |
hrbpDataOnly |
booelan | Optional: retrieve only user's hrbp data |
managerDataOnly |
booelan | Optional: retrieve only user's manager data |
socDistacco |
string | Array.<string> | Optional |
chief |
string | Array.<string> | Optional |
eventName |
string | Array.<string> | Optional: Retrieves only the given types of events |
textFilter |
string | Optional: Filters the users serching for the given text |
exportName |
string | Optional: The export's filename. An UUID will be appended to the filename. |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-social-activities-users-data
Returns:
The data to display
- Type
- UsersActivities
(static) exportStageForMandatoryTraining(itemId) → {string}
Return a list of users for every single item passed and its childs
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
string | Required by the action: The id of the item to retrieve |
Listens to Events:
- event:HTTP POST /rest-api/corporateacademy-mediator/export-stage-for-mandatory-training
Returns:
The URL where the XLSX file with the report is
- Type
- string
(static) exportStageTakers(withAllStatusLoaded, exportName) → {string}
Exports the course participant excel for the provided stage
Parameters:
| Name | Type | Description |
|---|---|---|
withAllStatusLoaded |
boolean | Optional: If true, all the faculty rent statuses will be retrieved (and not only the active ones) |
exportName |
string | Optional: The export's filename, by default its "faculty_members.xlsx". An UUID will be appended to the filename. |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-stage-takers/:langCode/:tenant/:stageId/:exportName
Returns:
Export's filename
- Type
- string
(static) exportSurveyAnswersAnalyticsByItemid(itemId, getFullPath, token) → {string}
Generates an excel file with the surveys questions as columns and the user answers as rows. Only the completed surveys that are referred to the specified item will be retrieved.
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
string | Required: Id of the item to which the survey is associated. It can be a COURSE_EDITION or an ASSESSMENT item. |
getFullPath |
boolean | Optional: If true, the full path of the generated file will be returned |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-survey-answers-analytics-by-itemId
Returns:
The filename (or full path, if requested) of the generated excel file
- Type
- string
(static) exportUsersToTrainInCurrentYearForSupplier(syllabusId, mandatoryCourseCode, stageId, exportName, getFullPath, ignoreServiceExecutionLock, token) → {boolean|string}
Exports the details of the mandatory training's users rents. The file will be generated and sent by email. By default, multiple executions of the same export service (with the same types of parameters) aren't allowed and an error will be thrown.
Parameters:
| Name | Type | Description |
|---|---|---|
syllabusId |
string | Required (if mandatoryCourseCode isn't defined): Id of the syllabus from where the IT9054's course code will be retrived |
mandatoryCourseCode |
string | Optional (required if syllabusId isn't defined): IT9054's course code used for the data retrieval |
stageId |
string | Optional: Stage's ids, used to check the type of the derogation to use for the supplier (by group or by IT9054) |
exportName |
string | Optional: Name of the export |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned instead of the filename only |
ignoreServiceExecutionLock |
boolean | Optional: If true, the redis key that blocks the multiple service executions won't be checked |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/export-users-to-train-in-current-year-for-supplier
Returns:
True if ignoreServiceExecutionLock is false and the execution has been correctly started, or the name of the export (or full path if getFullPath is true)
- Type
- boolean | string
(static) generateAndAssignUserCourseCertificateEngagement(editionIds, stageIds, userIds, startDate, endDate, token)
Generate the engagements of EVENT_CERTIFICATE_ASSIGNED, with the link of the generated certified in the engagement detail
Parameters:
| Name | Type | Description |
|---|---|---|
editionIds |
string | Array.<string> | Optional: Id of the editions to use for the massive assign of course certificates |
stageIds |
string | Array.<string> | Optional: Id of the items to use for the massive assign of course certificates |
userIds |
string | Array.<string> | Optional: The users to generate certificates |
startDate |
Date | Optional by the action: If filterByDateRange is true specify the startDate to filter |
endDate |
Date | Optional by the action: If filterByDateRange is true specify the endDate to filter |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Returns:
(static) getAllCertificates(itemId, containerId, getFullPath, asImage, token) → {string}
Generates all certificates' pdf (or image, if requested) only for a Certificate Item contained in LP or PL in a single zip file
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
string | Required: Id of the item to use as source |
containerId |
string | Required: Id of the item container |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned |
asImage |
boolean | Optional: If true, the produced file will be an image (not a pdf) |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/get-all-certificates
Returns:
The filename (or full path) of the generated zip
- Type
- string
(static) getCertificate(itemId, containerId, getFullPath, asImage, isPreview, userId, token) → {string}
Generates the certificate's pdf (or image, if requested)
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
string | Required: Id of the item to use as source |
containerId |
string | Required if called for CERTIFICATE_ITEM type: Id of the item container |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned |
asImage |
boolean | Optional: If true, the produced file will be an image (not a pdf) |
isPreview |
boolean | Optional: If true, the certificate data will be mocked |
userId |
string | Optional: The user to generate certificate for (require admin rights) |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/get-certificate
Returns:
The filename (or full path) of the generated pdf/image
- Type
- string
(static) getCertificateImageCommon(userId, itemId) → {string}
Generates the candidate certificate's pdf (or image, if requested)
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
string | Required: Id of the user to use as source |
itemId |
string | Required: Id of the item to use as source |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/get-certificate-image-common
Returns:
The filename (or full path) of the generated pdf/image
- Type
- string
(static) getEticketPdf(itemId, userId, getFullPath, token) → {string}
Generates a pdf with the questions and answers of the completed survey of an item. Only the answers of the specified user will be used to produce the pdf.
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
string | Required: Id of the item to which the survey is associated. It can be a COURSE_EDITION or an ASSESSMENT item. |
userId |
string | Required: Id of the user who completed the survey |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/get-eTicket-pdf
Returns:
The filename (or full path) of the generated pdf
- Type
- string
(static) getRecordBook(editionItemId, projectTitle, editionNumber, actuator, activityType, totPagesOverride, getFullPath, allPersons, asXlsx, token) → {string}
Generates the record book's pdf (or excel, if requested), retriveving the confirmed and present users of an edition
Parameters:
| Name | Type | Description |
|---|---|---|
editionItemId |
string | Required: Id of the edition item to use as source |
projectTitle |
string | Optional: Title of the projetc |
editionNumber |
string | Optional: Number of the edition |
actuator |
string | Optional: Actuator |
activityType |
string | Optional: Type of the activity |
totPagesOverride |
string | Optional: Number used to override the total number of pages |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned |
allPersons |
boolean | Optional: If true, all the takers will be retrieved (and not only the confirmed/present ones) |
asXlsx |
boolean | Optional: If true, the produced file will be a xlsx (and not a pdf) |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/get-record-book
Returns:
The filename (or full path) of the generated pdf/excel
- Type
- string
(static) getSurveyListReport(itemId, takerId, getFullPath, token) → {string}
Generates a pdf with the questions and answers of the completed survey of an item. Only the answers of the specified user will be used to produce the pdf.
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
string | Required: Id of the item to which the survey is associated. It can be a COURSE_EDITION or an ASSESSMENT item. |
takerId |
string | Array.<string> | Optional: Id of the taker whit status present. |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/get-survey-list-report
Returns:
The filename (or full path) of the generated pdf
- Type
- string
(static) getSurveyReport(itemId, userId, getFullPath, token) → {string}
Generates a pdf with the questions and answers of the completed survey of an item. Only the answers of the specified user will be used to produce the pdf.
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
string | Required: Id of the item to which the survey is associated. It can be a COURSE_EDITION or an ASSESSMENT item. |
userId |
string | Required: Id of the user who completed the survey |
getFullPath |
boolean | Optional: If true, the full path of the file will be returned |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/get-survey-report
Returns:
The filename (or full path) of the generated pdf
- Type
- string
(static) usersItemAndScormRegistrationSessions(itemId, tenant, langCode, token) → {string}
Return a list of users' sessions for every single item passed and its childs joined with all referenced scorm registrations sessions
Parameters:
| Name | Type | Description |
|---|---|---|
itemId |
string | Required by the action: The item id |
tenant |
string | Array.<string> | Optional: The tenant of the user |
langCode |
string | Required by the action: The lang of the user |
token |
string | Required: the Authorization Bearer token passed in the Header of the request |
Listens to Events:
- event:HTTP GET /rest-api/corporateacademy-mediator/users-item-and-scorm-registration-sessions
Returns:
The URL where the XLSX file with the report is
- Type
- string