courseIds
optional

Courses related to the certificate

< string > array

created
optional

Certificate creation date

YYYY-MM-DDTHH:mm:ss.SSSZ

expiration
optional

Certificate expiration

CertificateExpiration

externalCertificateId
optional

External Certificate Id

string

name
optional

Certificate name

string

status
optional

Certificate status

enum (ACTIVE, INACTIVE, ARCHIVED)

duration
optional

integer(int32)

period
optional

enum (MONTH, YEAR, DAY)

schedule
optional

Channel Schedule

Schedule

status
required

Channel Status

enum (ACTIVE, NONACTIVE, DRAFT, SCHEDULED, STARTED, FINISHED)

identifier
required

The unique id of the model entity - defined by an external provider

string

name
required

Channel name

string

status
optional

Channel Status ACTIVE/INACTIVE

enum (ACTIVE, INACTIVE)

subAccountName
optional

The sub-account to which the channel belongs

string

type
required

Channel Type STREAM/COURSE

enum (STREAM, COURSE)

availability
required

Channel Availability

ChannelAvailability

categories
optional

Channel category names

< string > array

created
required

Channel creation date

YYYY-MM-DDTHH:mm:ss.SSSZ

directLink
optional

Channel direct link

string

duration
optional

Channel duration

integer(int64)

identifier
required

The unique id of the model entity - defined by an external provider

string

masterChannelId
optional

The unique channel id of the master channel as defined by an external provider, or null if this channel is not a master channel instance

string

masterChannelInstance
required

Is this channel an instance of a master channel
Example : false

boolean

name
required

Channel name

string

subAccountName
required

The name of the Sub-Account for this Channel

string

type
required

Channel Type STREAM/COURSE

enum (STREAM, COURSE)

error
required

The error may have one of the following values:

enum (invalid_request, invalid_client, not_found, access_denied, general_error, item_exists, item_not_exists, service_unavailable)

error_description
required

Error description

string

channelName
optional

Channel name

string

completionDate
optional

Completion date

YYYY-MM-DDTHH:mm:ss.SSSZ

externalChannelId
optional

External channel id

string

externalUserId
optional

External user id

string

progress
optional

Channel progress

integer(int32)

score
optional

Total score

integer(int32)

catalogItemId
optional

string

link
optional

string

identifier
required

The unique id of the model entity - defined by an external provider

string

masterCourseIdentifier
optional

The unique id of the master course - defined by an external provider

string

name
required

Channel name

string

subAccountName
optional

The sub-account to which the channel belongs

string

learners
required

The number of learners in the channel, 0 if none

integer(int32)

entityIdentifier
optional

string

entityType
optional

enum (COURSE, GROUP, WORKSPACE)

userIdentifier
required

string

userRole
required

enum (MANAGER, EDITOR, INSTRUCTOR)

categories
optional

Channel category names

< string > array

created
optional

The master channel creation date

YYYY-MM-DDTHH:mm:ss.SSSZ

identifier
required

The unique id of the model entity - defined by an external provider

string

name
required

The master channel name

string

published
optional

Only include published master channels
Example : false

boolean

subAccountName
optional

The sub-account to which the master channel belongs

string

files
required

< OrgBulkDataRequest > array

permissions
required

< enum (INSTRUCTOR_CREATE_COURSE_INSTANCE, INSTRUCTOR_CREATE_COURSE) > array

certificationDate
optional

The date in which the user was certified

YYYY-MM-DDTHH:mm:ss.SSSZ

expirationDate
optional

The date the user’s certification will no longer be valid

YYYY-MM-DDTHH:mm:ss.SSSZ

externalCertificateId
optional

External Certificate Id

string

isRequired
optional

isRequired
Example : false

boolean

name
optional

Certificate name

string

pdfUrl
optional

Certificate PDF

string

state
optional

Certificate state

enum (IN_PROGRESS, CERTIFIED, AWAITS_LEARNER_CONFIRMATION, ABOUT_TO_EXPIRE, EXPIRED, INIT, REVOKED)

identifier
required

The unique id of the model entity - defined by an external provider

string

name
required

Group name

string

parentIdentifier
optional

parent identifier, defined by an external provider. The group with parentIdentifier must exist

string

subAccountName
optional

Sub-account name

string

type
required

Group type according to group hierarchy

string

created
required

Group creation date

YYYY-MM-DDTHH:mm:ss.SSSZ

identifier
required

The unique id of the model entity - defined by an external provider

string

modified
required

Group modification date. i.e 2017-12-13T13:14:28.317Z

YYYY-MM-DDTHH:mm:ss.SSSZ

name
required

Group name

string

parentIdentifier
required

parent identifier, defined by an external provider

string

subAccountName
required

Sub-Account to which the group belongs

string

type
required

Group type according to group hierarchy

string

message
required

Message description

string

content
required

content

string

fileName
required

fileName

string

currentPage
optional

integer(int32)

items
optional

< Certificate information > array

pageSize
optional

integer(int32)

paginationKey
optional

string

totalPages
optional

integer(int64)

currentPage
optional

integer(int32)

items
optional

< ChannelInfo > array

pageSize
optional

integer(int32)

paginationKey
optional

string

totalPages
optional

integer(int64)

currentPage
optional

integer(int32)

items
optional

< External user channel performance > array

pageSize
optional

integer(int32)

paginationKey
optional

string

totalPages
optional

integer(int64)

currentPage
optional

integer(int32)

items
optional

< ExternalMasterChannelGet > array

pageSize
optional

integer(int32)

paginationKey
optional

string

totalPages
optional

integer(int64)

currentPage
optional

integer(int32)

items
optional

< UserInfo > array

pageSize
optional

integer(int32)

paginationKey
optional

string

totalPages
optional

integer(int64)

endDate
optional

Channel End Date

string

startDate
optional

Channel Start Date

string

access_token
required

Access token that should be used in API calls

string

expires_in
required

expiration time in ms

integer(int32)

token_type
required

token type; always bearer

string

allDayEvent
optional

Indicates if the training event lasts the entire day
Example : false

boolean

description
optional

Training event description

string

fromDate
optional

Start date and time of the training event

YYYY-MM-DDTHH:mm:ss.SSSZ

includeGrade
optional

Indicates if grading is included for the training event
Example : false

boolean

isPublished
optional

Indicates if the training event is published
Example : false

boolean

liveSession
optional

Indicates if the training event is a live session
Example : false

boolean

location
optional

Event location

string

name
optional

The name of the training event

string

untilDate
optional

End date and time of the training event

YYYY-MM-DDTHH:mm:ss.SSSZ

address
required

User address

string

customAttributes
optional

User attributes. These custom attributes are exposed to external BI systems for data analysis purposes (e.g. age, sex, geography, employee role in company, academic degree etc.)

object

email
optional

User email

string

firstName
optional

User first name

string

identifier
required

The unique id of the model entity - defined by an external provider
Example : "u1"

string

isActive
optional

User status. Possible values: "true" or "false". Default: true
Example : true

boolean

lastName
optional

User last name

string

password
optional

User password

string

phone
optional

User phone number

string

possibleRoles
optional

User possible roles

< enum (SITE_ADMIN, LEARNER, INSTRUCTOR, EDITOR, PREVIEW, MANAGER, HR_MANAGER, SITE_TRAINING_MANAGER, EVALUATOR) > array

subAccountName
optional

Sub-account name

string

username
optional

Username
Example : "albanB"

string

currentUserIdentifier
required

Existing user identifier

string

newUserIdentifier
required

New user identifier to assign

string

address
required

User address

string

created
required

User creation date

YYYY-MM-DDTHH:mm:ss.SSSZ

customAttributes
required

User attributes. These custom attributes are exposed to external BI systems for data analysis purposes (e.g. age, sex, geography, employee role in company, academic degree etc.)

object

email
required

User email

string

firstName
required

User first name

string

identifier
required
read-only

The unique id of the model entity - defined by an external provider

string

isActive
required

User status
Example : false

boolean

lastName
required

User last name

string

modified
required

User modification date