flowground for Business Customers

Technical Specifications

startFlow

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

Attributes

-

get_coursedesigns

Lists all global course design templates. Only api callers that have full access can call this method.

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

Attributes

-

get_extorgunit

Returns information about the organization unit with the specified external id.

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

Attributes

-

get_extparticipation

Gets a participation by external id.

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

Attributes

-

get_extproject

Gets an Organization Unit by external id

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

Attributes

-

get_extuser

Gets a user by external id.

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

Attributes

-

get_globalusergroups

Returns a list of Global User Groups. Global User Groups are set up for the realm, and will generate groups that can be used on the client level.

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

Attributes

-

get_globalusergroups__groupid__members

Returns a list of all members in User Groups that are based on the Global Group with this groupid.

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

Attributes

-

get_orgunits

The orgunits endpoint returns information about the available organization units (orgunits). The response includes the display name, internal and external id and client number.

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

Attributes

-

post_orgunits

Adds an Organization Unit

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

Attributes

-

get_orgunits__orgid_

Returns information about the specified organization unit. The response includes the display name, internal and external id and client number.

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

Attributes

-

patch_orgunits__orgid_

Adds an Organization Unit

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

Attributes

-

get_orgunits__orgid__projects

Returns the available projects for the organization unit

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

Attributes

-

post_orgunits__orgid__projects

Creates a new project

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

Attributes

-

delete_orgunits__orgid__projects__projectid_

Deletes the project. The project can only be deleted if the project do not contain any participants.

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

Attributes

-

get_orgunits__orgid__projects__projectid_

Returns project information

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

Attributes

-

patch_orgunits__orgid__projects__projectid_

Updates information about a project. Values are only updated if the fields are specified in the input

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

Attributes

-

get_orgunits__orgid__projects__projectid__participants

Returns project participants

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

Attributes

-

post_orgunits__orgid__projects__projectid__participants

Add a user to the project. Participant information is created for the user. In the body object, only one of either email or userid must be specified. The participant needs to be activated before it the user can access it.

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

Attributes

-

delete_orgunits__orgid__projects__projectid__participants___participantId_

Deletes a participant. The user itself will still remain but any state related to the project will be deleted. It might not be possible due to constraints from the products in the project to delete the participant. However this can only be determined at the time of the delete. If a delete fails the participant will have their inError flag set.

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

Attributes

-

post_orgunits__orgid__projects__projectid__participants___participantId__activate

Activates a participant so that it can be used

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

Attributes

-

post_orgunits__orgid__projects__projectid__participants___participantId__loginlink

Returns a single sign on link for the participant. The link is only usable once and should be used directly. The link expires after a few minutes. This operation requires the *login link* permission.

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

Attributes

-

get_orgunits__orgid__projects__projectid__teammembers

Returns the project team members. A team member is a ....

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

Attributes

-

get_orgunits__orgid__usergroups

Returns a list of User Groups for the org unit.

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

Attributes

-

post_orgunits__orgid__usergroups

Create a User Group.

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

Attributes

-

get_orgunits__orgid__usergroups__groupid_

Returns single User Group.

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

Attributes

-

get_orgunits__orgid__usergroups__groupid__members

Returns a list of all members in User Groups that are based on the Global Group with this groupid.

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

Attributes

-

post_orgunits__orgid__usergroups__groupid__members

Adds a user to user group.

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

Attributes

-

delete_orgunits__orgid__usergroups__groupid__members__uuid_

Removes a user from a user group.

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

Attributes

-

get_users

Lists all users. Only api callers that have full access can call this method.

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

Attributes

-

post_users

Adds a user. No two users can have the same email address. Email is saved WITH case but compared regardless of case. Email can be changed for a user assuming it doesn't cause a conflict.

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

Attributes

-

get_users__userid_

Returns information about a user

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

Attributes

-

patch_users__userid_

Updates a user. All values that have a key defined in the input will be set. So if a value should not be updated omit it totally from the input, otherwise it will be unset.

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

Attributes

-

get_users__userid__pic_key__APIKEY_

Returns a thumbnail picture of the user. This can either be a selected picture or an auto generated image. This method doesn't require a full sign in. The api key is sufficient. The image is square and is likely, but not necessary, to be in 128x128 PNG format. However the format will always be either PNG, JPEG or GIF.

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

Attributes

-

get_users__userid__projectParticipations

Returns information about the projects the user is a participant in. Only the projects that the current token have access to will be listed.

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

Attributes

-

No data available for terms

No data available for environment