Import

The endpoints on this page provide an abstract way of importing data into ClearXP without the need to understand the underlying implementation details. Because ClearXP is a configuration-driven platform, these endpoints are versatile in their use and can be adapted to each organisation's unique data needs.

Take for example, importing an Org Structure and the two use-cases below:

Use Case 1: Import Position Hierarchy As demonstrated in the documented examples below, by attaching a Position Number to each user profile and linking this to an org structure by id, the system would be able to place the user within the org structure and attach metadata to their profile to control permissions, learning assignments and enhance reporting.

Furthermore, linking this to Job Architecture would enable the platform to be able to automatically recommend content to learner to satisfy the requirements for promotion to the next position in the org hierarchy.

Use Case 2: Import Location Data Alternatively, the org structure endpoint can be minimally used to attach flat location data to each user's profile. In this case, the parentId isn't required and the id may represent an attribute on the user's profile such as City. In this case, the org data could be used to populate the State and Country for that user.

Again, this location data can assist with configuring permissions, learning assignments and enhance reporting.

Although not essential for ClearXP to operate, importing richer data enables greater platform functionality. AI and Machine Learning algorithms utilised by the platform benefit from clean and complete metadata and will ensure more accurate results.

Import Users

PUT https://{organisation}.clearlrs.com/api/import/users

Imports user profile information for one or more users into ClearXP. Where one of the attributes is a unique identifier that matches an existing user in the system, an update operation will be performed, otherwise a new user will be created.

Request Body

Name
Type
Description

name

string

The name of the user.

attributes

object

Key-value pairs of any attributes to attach to the imported or updated user.

Example Request Body

[
    {
        "name": "John Smith",
        "attributes": {
            "Email": "john@example.com",
            "Hire Date": "2020-06-01",
            "Position Number": "00002",
            "Position Title": "Senior Sales Representative",
            "Manager Email": "ceo@example.com"
        }
    }
]

Import Org Structure

PUT https://{organisation}.clearlrs.com/api/import/organisation

Imports organisational structure data into ClearXP which can be used to populate additional metadata against the user for reporting, activity assignment and Machine Learning purposes. When attaching org data to users, ClearXP will match the id against an attribute in the user's profile and look-up the remaining associated attributes.

Request Body

Name
Type
Description

id

string

A unique ID for each entry in the org data – this could be a Position Code or Location ID depending on the dataset.

parentId

string

A reference to the parent in the org structure for the entry, if relevant.

attributes

object

Key-value pairs of any organisational data for the entry.

Example Request Body

[
    {
        "id": "00002",
        "parentId": "00001",
        "attributes": {
            "Position Number": "00002",
            "Position Title": "Sales Representative",
            "Department": "Sales",
            "State": "VIC",
            "Country": "Australia"
        }
    }
]

Import Job Architecture

PUT https://{organisation}.clearlrs.com/api/import/jobs

Imports job and competency data into the platform for utilisation in talent management functionality such as identifying skills gaps and recommending training to suit job roles. To take full advantage of this data, competencies should then be linked to courses and learning activities in the system.

Request Body

Name
Type
Description

id

string

A unique ID for this job (i.e. job code).

name

string

The name of the job.

competencies

array

An array of Competencies that should be attached to the job.

attributes

object

Any additional metadata attributes that should be attached to the job.

Example Request Body

[
    {
        "id": "10001",    
        "name": "Sales Representative",
        "competencies": [
            {
                "Name": "Persuades",
                "Description": "Using compelling arguments to gain the support and commitment of others."
            },
            {
                "Name": "Being Resilient",
                "Description": "Rebounding from setbacks and adversity when facing difficult situations."
            }
        ],
        "attributes": {
            "Job Family": "Sales & Marketing",
        }
    }
]
PreviousNotifications

Last updated