flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

get_

Responds with all supported endpoints URLs for v1 version.

OnInit
./lib/actions/get_.js
OnStartup
-
OnClose
-

Attributes

-

get_course_mappings

Returns all the course mappings

OnInit
./lib/actions/get_course_mappings.js
OnStartup
-
OnClose
-

Attributes

-

get_course_mappings__offeringId_

OnInit
./lib/actions/get_course_mappings__offeringId_.js
OnStartup
-
OnClose
-

Attributes

-

delete_course_mappings__offeringId___externalCourseId_

Removes the course mapping between the offering and the external course id

OnInit
./lib/actions/delete_course_mappings__offeringId___externalCourseId_.js
OnStartup
-
OnClose
-

Attributes

-

put_course_mappings__offeringId___externalCourseId_

Creates a mapping between the offering and the external course id

OnInit
./lib/actions/put_course_mappings__offeringId___externalCourseId_.js
OnStartup
-
OnClose
-

Attributes

-

get_courses

Responds with courses that can be activated (made to an offering).

OnInit
./lib/actions/get_courses.js
OnStartup
-
OnClose
-

Attributes

-

get_courses__contentId_

OnInit
./lib/actions/get_courses__contentId_.js
OnStartup
-
OnClose
-

Attributes

-

put_courses__contentId__metadata_category

OnInit
./lib/actions/put_courses__contentId__metadata_category.js
OnStartup
-
OnClose
-

Attributes

-

put_courses__contentId__metadata_level

OnInit
./lib/actions/put_courses__contentId__metadata_level.js
OnStartup
-
OnClose
-

Attributes

-

put_courses__contentId__metadata_tags

OnInit
./lib/actions/put_courses__contentId__metadata_tags.js
OnStartup
-
OnClose
-

Attributes

-

put_courses__contentId__metadata_topic

OnInit
./lib/actions/put_courses__contentId__metadata_topic.js
OnStartup
-
OnClose
-

Attributes

-

post_courses__contentId__permissions

OnInit
./lib/actions/post_courses__contentId__permissions.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings

Responds with all offerings for your organisation.

OnInit
./lib/actions/get_offerings.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings

Creates new offering.

OnInit
./lib/actions/post_offerings.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings_current

Responds with current (active) offerings for your organisation. Offering is current when today's date is between (inclusive) it's `start` and `end` date.

OnInit
./lib/actions/get_offerings_current.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings_future

Responds with future (inactive) offerings for your organisation. Future offerings have their `start` date after today's date (inclusive).

OnInit
./lib/actions/get_offerings_future.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings_past

Responds with past (inactive) offerings for your organisation. Past offerings have their `end` date before today's date (inclusive).

OnInit
./lib/actions/get_offerings_past.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId_

Returns an offering matching the offeringId.

OnInit
./lib/actions/get_offerings__offeringId_.js
OnStartup
-
OnClose
-

Attributes

-

patch_offerings__offeringId_

Updates the offering.

OnInit
./lib/actions/patch_offerings__offeringId_.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_channels__channelId__comments

Responds with a list of all comments in any of the posts for a channel in a offering

OnInit
./lib/actions/get_offerings__offeringId__analytics_channels__channelId__comments.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_channels__channelId__posts

Responds with a list of posts for a channel in a offering

OnInit
./lib/actions/get_offerings__offeringId__analytics_channels__channelId__posts.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_channels__channelId__replies

Responds with a list of all replies in any of the posts for a channel in a offering

OnInit
./lib/actions/get_offerings__offeringId__analytics_channels__channelId__replies.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_learners_progress

Responds with learners progress.

OnInit
./lib/actions/get_offerings__offeringId__analytics_learners_progress.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_marks_assignments

Responds with assignments marks.

OnInit
./lib/actions/get_offerings__offeringId__analytics_marks_assignments.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_marks_quizzes

Responds with quizzes marks.

OnInit
./lib/actions/get_offerings__offeringId__analytics_marks_quizzes.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_pulses_

Returns ids of all pulses that learners responded to.

OnInit
./lib/actions/get_offerings__offeringId__analytics_pulses_.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_pulses_responses

Returns pulses' responses matching the offeringId.

OnInit
./lib/actions/get_offerings__offeringId__analytics_pulses_responses.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_pulses__pulseId__responses

Returns pulse's responses matching the offeringId and pulseId.

OnInit
./lib/actions/get_offerings__offeringId__analytics_pulses__pulseId__responses.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__analytics_submissions_assignments

Responds with assignments submissions.

OnInit
./lib/actions/get_offerings__offeringId__analytics_submissions_assignments.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__assessments

Get all offering's assessments

OnInit
./lib/actions/get_offerings__offeringId__assessments.js
OnStartup
-
OnClose
-

Attributes

-

patch_offerings__offeringId__assessments__assessmentId_

Modifies assessment details

OnInit
./lib/actions/patch_offerings__offeringId__assessments__assessmentId_.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings__offeringId__assessments__assessmentId__documents

Uploads assessment document file

OnInit
./lib/actions/post_offerings__offeringId__assessments__assessmentId__documents.js
OnStartup
-
OnClose
-

Attributes

-

delete_offerings__offeringId__assessments__assessmentId__documents__documentId_

Removes assessment document file

OnInit
./lib/actions/delete_offerings__offeringId__assessments__assessmentId__documents__documentId_.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__channels

Responds with a list of channels in a offering

OnInit
./lib/actions/get_offerings__offeringId__channels.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings__offeringId__channels

Adds new channel to the offering

OnInit
./lib/actions/post_offerings__offeringId__channels.js
OnStartup
-
OnClose
-

Attributes

-

patch_offerings__offeringId__channels__channelId_

Updates the channel

OnInit
./lib/actions/patch_offerings__offeringId__channels__channelId_.js
OnStartup
-
OnClose
-

Attributes

-

put_offerings__offeringId__cover_image

Replaces offering's cover image with uploaded image

OnInit
./lib/actions/put_offerings__offeringId__cover_image.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__groups

Responds with a list of assessment groups in an offering

OnInit
./lib/actions/get_offerings__offeringId__groups.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings__offeringId__groups

Creates a new assessment group in a offering

OnInit
./lib/actions/post_offerings__offeringId__groups.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__groups__groupId__learners

Responds with a list of learners for the assessment group

OnInit
./lib/actions/get_offerings__offeringId__groups__groupId__learners.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings__offeringId__groups__groupId__learners

OnInit
./lib/actions/post_offerings__offeringId__groups__groupId__learners.js
OnStartup
-
OnClose
-

Attributes

-

delete_offerings__offeringId__groups__groupId__learners__userEmail_

OnInit
./lib/actions/delete_offerings__offeringId__groups__groupId__learners__userEmail_.js
OnStartup
-
OnClose
-

Attributes

-

put_offerings__offeringId__metadata_category

Updates the offering category metadata.

OnInit
./lib/actions/put_offerings__offeringId__metadata_category.js
OnStartup
-
OnClose
-

Attributes

-

put_offerings__offeringId__metadata_level

Updates the offering level metadata.

OnInit
./lib/actions/put_offerings__offeringId__metadata_level.js
OnStartup
-
OnClose
-

Attributes

-

put_offerings__offeringId__metadata_tags

Updates the offering tags metadata.

OnInit
./lib/actions/put_offerings__offeringId__metadata_tags.js
OnStartup
-
OnClose
-

Attributes

-

put_offerings__offeringId__metadata_topic

Updates the offering topic metadata.

OnInit
./lib/actions/put_offerings__offeringId__metadata_topic.js
OnStartup
-
OnClose
-

Attributes

-

put_offerings__offeringId__study_plan

Replaces offering's study plan with uploaded file

OnInit
./lib/actions/put_offerings__offeringId__study_plan.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__users

Responds with a list of offering's users (facilitators, learners and markers).

OnInit
./lib/actions/get_offerings__offeringId__users.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings__offeringId__users

Adds one or more users to the offering.

OnInit
./lib/actions/post_offerings__offeringId__users.js
OnStartup
-
OnClose
-

Attributes

-

delete_offerings__offeringId__users__evaluatorEmail__evaluates

Remove learners from evaluator's list.

OnInit
./lib/actions/delete_offerings__offeringId__users__evaluatorEmail__evaluates.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__users__evaluatorEmail__evaluates

Get learners evaluated by the peer evaluator.

OnInit
./lib/actions/get_offerings__offeringId__users__evaluatorEmail__evaluates.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings__offeringId__users__evaluatorEmail__evaluates

Add learners to be evaluated by the peer evaluator.

OnInit
./lib/actions/post_offerings__offeringId__users__evaluatorEmail__evaluates.js
OnStartup
-
OnClose
-

Attributes

-

delete_offerings__offeringId__users__markerEmail__marks

Remove learners from marker's list.

OnInit
./lib/actions/delete_offerings__offeringId__users__markerEmail__marks.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__users__markerEmail__marks

Get learners marked by the marker.

OnInit
./lib/actions/get_offerings__offeringId__users__markerEmail__marks.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings__offeringId__users__markerEmail__marks

Add learners to be marked by the marker.

OnInit
./lib/actions/post_offerings__offeringId__users__markerEmail__marks.js
OnStartup
-
OnClose
-

Attributes

-

delete_offerings__offeringId__users__userEmail_

Removes user from the offering.

OnInit
./lib/actions/delete_offerings__offeringId__users__userEmail_.js
OnStartup
-
OnClose
-

Attributes

-

post_offerings__offeringId__users__userEmail__invite_email

Re-sends the invitation e-mail to the user.

OnInit
./lib/actions/post_offerings__offeringId__users__userEmail__invite_email.js
OnStartup
-
OnClose
-

Attributes

-

get_offerings__offeringId__users__userEmail__submissions_open_response

Gets user's open response assignment submissions.

OnInit
./lib/actions/get_offerings__offeringId__users__userEmail__submissions_open_response.js
OnStartup
-
OnClose
-

Attributes

-

post_users

Adds new user

OnInit
./lib/actions/post_users.js
OnStartup
-
OnClose
-

Attributes

-

get_users_all_progress

Returns offering progress for each learner

OnInit
./lib/actions/get_users_all_progress.js
OnStartup
-
OnClose
-

Attributes

-

get_users__userEmail_

Returns a user matching the email.

OnInit
./lib/actions/get_users__userEmail_.js
OnStartup
-
OnClose
-

Attributes

-

patch_users__userEmail_

Updates the user

OnInit
./lib/actions/patch_users__userEmail_.js
OnStartup
-
OnClose
-

Attributes

-

get_users__userEmail__offerings

Responds with all user's offerings.

OnInit
./lib/actions/get_users__userEmail__offerings.js
OnStartup
-
OnClose
-

Attributes

-

post_users__userEmail__permissions__permissionName_

Adds permission to user

OnInit
./lib/actions/post_users__userEmail__permissions__permissionName_.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment