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.
put
https://{organisation}.clearlrs.com
/api/import/users
Import Users
Example Request Body
1
[
2
    {
3
        "name": "John Smith",
4
        "attributes": {
5
            "Email": "[email protected]",
6
            "Hire Date": "2020-06-01",
7
            "Position Number": "00002",
8
            "Position Title": "Senior Sales Representative",
9
            "Manager Email": "[email protected]"
10
        }
11
    }
12
]
Copied!
put
https://{organisation}.clearlrs.com
/api/import/organisation
Import Org Structure
Example Request Body
1
[
2
    {
3
        "id": "00002",
4
        "parentId": "00001",
5
        "attributes": {
6
            "Position Number": "00002",
7
            "Position Title": "Sales Representative",
8
            "Department": "Sales",
9
            "State": "VIC",
10
            "Country": "Australia"
11
        }
12
    }
13
]
Copied!
put
https://{organisation}.clearlrs.com
/api/import/jobs
Import Job Architecture
Example Request Body
1
[
2
    {
3
        "id": "10001",    
4
        "name": "Sales Representative",
5
        "competencies": [
6
            {
7
                "Name": "Persuades",
8
                "Description": "Using compelling arguments to gain the support and commitment of others."
9
            },
10
            {
11
                "Name": "Being Resilient",
12
                "Description": "Rebounding from setbacks and adversity when facing difficult situations."
13
            }
14
        ],
15
        "attributes": {
16
            "Job Family": "Sales & Marketing",
17
        }
18
    }
19
]
Copied!

Clear API Reference - Previous

Notifications

Last modified 11mo ago

Copy link

Contents

Import Job Architecture