• Documentation >
• Apps >
• HR management >
• Trainual

Trainual

With Trainual modules in Ibexa Connect, you can:

• update, retrieve, list, archive, and unarchive the users, assign, and unassign subjects, and roles

• retrieve and list the subjects

• retrieve and list the topics

• retrieve and list the tests

To get started with Trainaul, create an account at trainual.com.

Connect Trainual to Ibexa Connect

To connect Trainual app, you need to obtain the Username, password, and Account Subdomain.

1. Log in to your Trainual account.

2. In your Ibexa Connect account, add a Trainual module in your scenario and click Add button next to the Connection field.

   

3. In the Connection name field, enter a name for the connection.

4. In the Username, and Password, fields, enter your Trainual account credentials.

5. Optional: In the Account Subdomain field, enter your account subdomain. For example, if your custom URL address is app.trainual.com/xyz then your subdomain is xyz.

6. Click Save.

You have successfully connected the Trianual app and can now build scenarios.

Users

You can update, retrieve, list, archive, and unarchive users, assign, and unassign subjects, and roles using the following modules.

Update a User

Invites a new user to the defined account.

User ID	Select or map the User ID whose details you want to update.

For field descriptions, see the Trainual API reference.

Get a User

Retrieves a specific user.

User ID	Select or map the User ID whose details you want to retrieve.

List Users

Retrieves a list of users.

Limit	Set the maximum number of users Ibexa Connect will return during one execution cycle.

For field descriptions, see the Trainual API reference.

Archive a User

Archives a user.

User ID	Select or map the User ID whom you want to archive.

Unarchive a User

Unarchives a user.

User ID	Select or map the User ID whom you want to unarchive.

Assign Subjects

Assigns subjects to a user.

User ID	Select or map the User ID to whom you want to assign subjects.
Subject IDs	Select or enter a comma-separated list of the Subject IDs you want to assign to the user.

Unassign Subjects

Unassigns subjects to a user.

User ID	Select or map the User ID to whom you want to unassign subjects.
Subject IDs	Select or enter a comma-separated list of the Subject IDs you want to unassign from the user.

Assign Roles

Assigns roles from a user.

User ID	Select or map the User ID to whom you want to assign roles.
Role IDs	Select or enter a comma-separated list of the Role IDs you wish to assign to the user.

For field descriptions, see the Trainual API reference.

Unassign Roles

Unassigns roles from a user.

User ID	Select or map the User ID whose roles you want to unassign.
Role IDs	Enter an array of the Role IDs you wish to unassign from the user.

For field descriptions, see the Trainual API reference.

Subjects

You can retrieve and list the subjects using the following modules.

Get a Subject

Retrieves a specific subject.

Subject ID	Select or map the Subject ID whose details you want to retrieve.

List Subjects

Retrieves a list of subjects.

Return Assigned Users	Select whether to return assigned users.
Limit	Set the maximum number of subjects Ibexa Connect will return during one execution cycle.

Topics

You can retrieve and list the topics using the following modules.

Get a Topic

Retrieves a specific topic

Subject ID	Select or map the Subject ID whose topic details you want to retrieve.
Topic ID	Select or map the Topic ID whose details you want to retrieve.

List Topics

Retrieves a list of topics for a specific subject.

Subject ID	Select or map the Subject ID whose topics you want to list.
Limit	Set the maximum number of topics Ibexa Connect will return during one execution cycle.

Tests

You can retrieve and list the tests using the following modules.

Get a Test

Retrieves a specific test.

Subject ID	Select or map the Subject ID whose tests you want to retrieve.
Test ID	Select or map the Test ID whose details you want to retrieve.

List Tests

Retrieves a list of tests

Subject ID	Select or map the Subject ID whose tests you want to list.
Limit	Set the maximum number of tests Ibexa Connect will return during one execution cycle.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the Trainual API documentation.

URL	Enter a path relative to https://www.trainualapp.com/api. For example, /v1/users.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - List All Subjects

The following API call returns all subjects from your account.

URL: /v1/curriculums

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body.

In our example 4 subjects were returned: