How to add and manage custom columns in the Users panel via API

Introduction

You can create user profile columns as well as edit existing ones (except the Username, User is in Course Catalog and Manager columns) with your own data source, using the LMS365 API e.g. using Swagger or Postman.

These endpoints have been implemented for you to:

create a new custom column;

use existing user profile columns with your own Data.

NOTE   

 

Creating a new custom column

To create a new custom column do the following:

  1. Use the endpoint /odata/v2/UserFields

  2. Specify the required parameters, e.g:

{"Description":"new custom column",
"IsVisible":true,
"IsSynced":true,
"Type":"String",
"Title":"new column"}

NOTE   

  • We support the following data type: String (enter 0 in the parameters field), Boolean (enter 1), Number (enter 2), Date and Time (enter 3).
  • You will not be able to change the column type.

 

Updating the existing columns in the API

To update the values for the custom column:

  1. Use the endpoint /odata/v2/Users('{LoginName}')/ UpdateUserFieldValuese.

  2. Enter the full login name with all the prefixes of the user for whom you want to specify the value and all the needed parameters, e.g:

{
    "UserFieldValues": [
{"FieldId": "enter the custom column ID",
"Value": "2019-04-01T14:48:16.877Z"},
{"FieldId": " enter the custom column ID ",
"Value": 53789}
]
}

NOTE   

  • To get the FieldId, please navigate to the endpoint GET /odata/v2/UserFields, you can find the required FieldId in the Response Body.
  • Value should be corresponded to the type of the column.
  • For the column with the number type you can specify the positive or decimal numbers (max. 2 digits after the decimal point or comma).

 

Updating the LMS365 system field

To update the LMS365 System field:

  1. Navigate to the endpoint PUT odata/v2/Users(‘{LoginName}’).

  2. Enter the full login name with all the prefixes of the user for whom you want to specify the value and all the parameters, e.g:

{"Department": "Department 1",
"Office": "Office, 1",
"JobTitle": "Developer",
"City": "Amsterdam",
"Company": "BIG Company"}

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.