Connectors Reference
LMS365 provides a modern, cloud based and secure learning management system, fit for the Modern Digital Workplace. It eliminates complexity by providing a complete learning solution that integrates seamlessly into your existing Office 365 and SharePoint environments. LMS365 is easy accessible from your browser, our intuitive mobile app or from Microsoft Teams enabling all companies to deliver training in any context, anytime, anywhere.
|
Status: Production |
Tier: Standard |
Version: 1.2 |
|
Name |
Summary |
|
ApproveEnrollmentRequest (string Id, [advanced][Optional]string LMS365-User-Id) |
Approve enrollment request |
|
Enroll user to training |
|
|
Reject enrollment request |
|
|
Get course categories |
|
|
Create course category |
|
|
CreateCourse (CreateCourseParameterBody body, [advanced][Optional]string LMS365-User-Id) |
Create training course |
|
Get course details |
|
|
CompleteEnrollmentById (string Id, [advanced][Optional]string LMS365-User-Id) |
Set enrollment status to completed |
|
Force user to retake training |
|
|
Get course tags |
|
|
CreateCourseTag (CreateCourseTagParameterBody body, [advanced][Optional]string LMS365-User-Id) |
Create course tag |
|
Get course provisioning status |
|
|
GetCoursesFromCatalog (string CourseCatalogId, [Optional]string $expand) |
Get all courses from related course catalog |
|
Get enrollment info |
|
|
Cancel enrollment |
|
|
Get all course catalogs |
|
|
Get users |
|
|
Create course session |
|
|
FileUpload (string FileUploadUrl, file File, [Optional]string Content-Type) |
Upload File |
|
Send an HTTP request |
|
|
Send an HTTP request |
|
Name |
Summary |
|
EnrollmentApprovalRequest (EnrollmentApprovalRequestParameterBody body) |
When a learner has requested approval for training |
|
When a learner has enrolled into training |
|
|
When a learner has unenrolled from training |
|
|
When a learner has started any of the course activities |
|
|
When a learner has completed training |
|
|
When training has been published to a catalog |
|
|
When training has been unpublished from a catalog |
|
|
When a user has been created |
|
|
When a user has been deleted |
|
|
When training has been created |
|
|
When training has been deleted from a catalog |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
File Content |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Approve enrollment request
Description: This action will approve the training enrollment request
Syntax:
LMS365.ApproveEnrollmentRequest (string Id, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Id |
string (Enrollment Id) |
Specify the enrollment id |
True |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Summary: Enroll user to training
Description: This action will enroll user to training object by user login name and course id
Syntax:
LMS365.EnrollUserToCourse (string courseId, EnrollUserToCourseParameterBody body, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
courseId |
string (Course Id) |
Specify the internal course id |
True |
|
|
body |
EnrollUserToCourseParameterBody
|
|
True |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Type:EnrollUserToCourseResponse
Summary: Reject enrollment request
Description: This action will reject the training enrollment request
Syntax:
LMS365.RejectEnrollmentRequest (string Id, [Optional]RejectEnrollmentRequestParameterBody body, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Id |
string (Enrollment Id) |
Specify the enrollment id |
True |
|
|
body |
RejectEnrollmentRequestParameterBody
|
|
False |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Summary: Get course categories
Description: This action will get all course categories
Syntax:
LMS365.GetCourseCategories ([Optional]string $filter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$filter |
string (Filter Query) |
Filters the results, based on a Boolean condition. |
False |
Returns:
Type:GetCourseCategoriesResponse
Summary: Create course category
Description: This action will create a new course category
Syntax:
LMS365.CreateCourseCategory (CreateCourseCategoryParameterBody body, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CreateCourseCategoryParameterBody
|
|
True |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Type:CreateCourseCategoryResponse
Summary: Create training course
Description: This action will create a new course
Syntax:
LMS365.CreateCourse (CreateCourseParameterBody body, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Type:CreateCourseResponse
Summary: Get course details
Description: This action will provide all available information about selected course and related catalog
Syntax:
LMS365.GetCourseInfo (string CourseId, [Optional]string $expand)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
CourseId |
string (Course Id) |
Specify the internal course id |
True |
|
|
$expand |
string (Expand Query) |
Expands related entities inline. |
False |
Returns:
Summary: Set enrollment status to completed
Description: This action will change the enrollment status to completed for the related training
Syntax:
LMS365.CompleteEnrollmentById (string Id, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Id |
string (Enrollment Id) |
Specify the enrollment id |
True |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Summary: Force user to retake training
Description: This action will force the user to retake the related training
Syntax:
LMS365.RetakeEnrollmentById (string Id, [Optional]RetakeEnrollmentByIdParameterBody body, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Id |
string (Enrollment id) |
Specify the enrollment id |
True |
|
|
body |
RetakeEnrollmentByIdParameterBody
|
|
False |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Summary: Get course tags
Description: This action will get all course tags
Syntax:
LMS365.GetCourseTags ([Optional]string $filter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$filter |
string (Filter Query) |
Filters the results, based on a Boolean condition. |
False |
Returns:
Summary: Create course tag
Description: This action will create a new course tag
Syntax:
LMS365.CreateCourseTag (CreateCourseTagParameterBody body, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Summary: Get course provisioning status
Description: This action will get course provisioning status
Syntax:
LMS365.GetCourseProvisioningStatus ([Optional]string $expand, [Optional]string $filter, [Optional]string $select)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$expand |
string (Expand Filter) |
Expands related entities inline. |
False |
|
|
$filter |
string (Filter Query) |
Filters the results, based on a Boolean condition. |
False |
|
|
$select |
string (Select Query) |
Selects which properties to include in the response. |
False |
Returns:
Type:GetCourseProvisioningStatusResponse
Summary: Get all courses from related course catalog
Description: This action will retrieve all courses from related course catalog
Syntax:
LMS365.GetCoursesFromCatalog (string CourseCatalogId, [Optional]string $expand)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
CourseCatalogId |
string (Course Catalog Id) |
Specify the course catalog id |
True |
|
|
$expand |
string (Expand Query) |
Expands related entities inline. |
False |
Returns:
Type:GetCoursesFromCatalogResponse
Summary: Get enrollment info
Description: This action will get enrollment info
Syntax:
LMS365.GetEnrollmentById (string EnrollmentId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
EnrollmentId |
string (Enrollment Id) |
Specify the enrollment id |
True |
Returns:
Type:GetEnrollmentByIdResponse
Summary: Cancel enrollment
Description: This action will cancel the training enrollment
Syntax:
LMS365.CancelEnrollment (string EnrollmentId, [Optional]CancelEnrollmentParameterBody body, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
EnrollmentId |
string (Enrollment Id) |
Specify the enrollment id |
True |
|
|
body |
|
|
False |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Summary: Get all course catalogs
Description: This internal action will get all available course catalogs
Syntax:
LMS365.GetCourseCatalogs ()
Returns:
Type:GetCourseCatalogsResponse
Summary: Get users
Description: This action will get list of user
Syntax:
LMS365.GetUsers ([Optional]string $filter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
$filter |
string (Filter Query) |
Filters the results, based on a Boolean condition. |
False |
Returns:
Type:GetUsersResponse
Summary: Create course session
Description: This action will create a new course session
Syntax:
LMS365.CreateCourseSession (string courseId, CreateCourseSessionParameterBody body, [advanced][Optional]string LMS365-User-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
courseId |
string (Course Id) |
Specify the internal course id |
True |
|
|
body |
CreateCourseSessionParameterBody
|
|
True |
|
|
LMS365-User-Id |
string (On behalf of user) |
Specify the LMS365 User Id or Azure AD Object Id on behalf of whom the action will be performed |
False |
Returns:
Type:CreateCourseSessionResponse
Summary: Upload File
Description: Uploads and create a file in LMS365 cloud storage.
Syntax:
LMS365.FileUpload (string FileUploadUrl, file File, [Optional]string Content-Type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
FileUploadUrl |
string (Uri) |
Relative path to the POST operator. Example: certificates/027707f9-98d5-5ddf-b98f-0a99a220c1ef/upload |
True |
|
|
File |
(File Content) |
Content of the file. |
True |
|
|
Content-Type |
string (Content Type) |
Specify the content-type of the file. Example: application/pdf |
False |
Returns:
Type:FileUploadResponse
Summary: Send an HTTP request
Description: Construct a REST API request to invoke.
Syntax:
LMS365.HttpRequest (HttpRequestBodyParameters parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
|
Body parameters for HttpRequest operation. |
True |
Returns:
Type:HttpRequestResponse
Summary: Send an HTTP request
Description: Construct a REST API request to invoke.
Syntax:
LMS365.HttpRequest_v2 (HttpRequestBodyParameters_v2 parameters)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
parameters |
|
Body parameters for HttpRequest operation. |
True |
Returns:
Summary: When a learner has requested approval for training
Description: This operation is triggered when a learner enrolls into training configured for External Approval Flow
Syntax:
LMS365.EnrollmentApprovalRequest (EnrollmentApprovalRequestParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
EnrollmentApprovalRequestParameterBody
|
|
True |
Returns:
Type:EnrollmentApprovalRequestResponse
Summary: When a learner has enrolled into training
Description: This operation is triggered when a learner has enrolled into training
Syntax:
LMS365.CourseEnrollment (CourseEnrollmentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: When a learner has unenrolled from training
Description: This operation is triggered when a learner has unenrolled from assigned training
Syntax:
LMS365.CourseUnenrollment (CourseUnenrollmentParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CourseUnenrollmentParameterBody
|
|
True |
Returns:
Type:CourseUnenrollmentResponse
Summary: When a learner has started any of the course activities
Description: This operation is triggered when a learner has started any of the course activities
Syntax:
LMS365.CourseStarted (CourseStartedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: When a learner has completed training
Description: This operation is triggered when a learner has completed assigned training
Syntax:
LMS365.CourseCompleted (CourseCompletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: When training has been published to a catalog
Description: This operation is triggered when a course or training plan has been published to a catalog
Syntax:
LMS365.CoursePublished (CoursePublishedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: When training has been unpublished from a catalog
Description: This operation is triggered when a course or training plan has been unpublished from a catalog
Syntax:
LMS365.CourseUnpublished (CourseUnpublishedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CourseUnpublishedParameterBody
|
|
True |
Returns:
Type:CourseUnpublishedResponse
Summary: When a user has been created
Description: This operation is triggered when a user entity has been enabled/created in LMS365
Syntax:
LMS365.UserCreated (UserCreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:UserCreatedResponse
Summary: When a user has been deleted
Description: This operation is triggered when a user entity has been disabled/deleted from LMS365
Syntax:
LMS365.UserDeleted (UserDeletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:UserDeletedResponse
Summary: When training has been created
Description: This operation is triggered when a course or training plan has been created
Syntax:
LMS365.CourseCreated (CourseCreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: When training has been deleted from a catalog
Description: This operation is triggered when a course or training plan has been deleted from a catalog
Syntax:
LMS365.CourseDeleted (CourseDeletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
string Cancellation Message |
Specify the cancellation message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string Webhook Uri |
Webhook uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string
|
Webhook Uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string
|
Webhook Uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string Webhook Uri |
Webhook uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string Webhook Uri |
Webhook uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string Webhook Uri |
Webhook uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string Webhook Uri |
Webhook uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string Webhook Uri |
Webhook uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string Category Name |
Specify the name of the category |
|
CourseCatalogId |
string Course Catalog Id |
Specify the course catalog id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string Catagory Unique Id |
Catagory unique id |
|
Name |
string Category Name |
Category name |
|
CourseCatalogId |
string Course Catalog Id |
Course catalog Id |
|
ParentCategoryId |
string Parent Category Id |
Parent category id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
CourseCatalogId |
string Course Catalog Id |
Course catalog Id |
|
CourseType |
string Coursetype |
Coursetype Values: [ELearning, ClassRoom, Webinar, TrainingPlan] |
|
Title |
string Training Title |
Title of the training plan or course |
|
Description |
string Description |
Short description |
|
Culture |
string Culture |
Culture |
|
UICulture |
string UI Culture |
Specify the course UI Culture |
|
Categories |
array of (CategoriesItem) Categories |
Categories |
|
Tags |
array of (TagsItem) Tags |
Tags |
|
EnrollmentFlow |
string Enrollment Flow |
Enrollment flow Values: [AutomaticApproval, LineManagerApproval, LMSAdministratorsApproval, CustomApproval, ExternalWebhookApproval] |
|
Url |
string Url |
Specify the course url |
|
SiteTemplate |
string SiteTemplate |
SiteTemplate |
|
LearningModules |
array of (string) Learning Modules |
Learning modules |
|
Quizzes |
array of (string) Quizzes |
Quizzes |
|
AutoResolveUrlConflict |
boolean Auto Resolve Url Conflict |
Auto resolve url conflict |
|
CourseLayoutId |
string Course Layout Id |
Course layout id |
|
CourseSessionEnrollmentType |
string Course Session Enrollment Type |
Course session enrollment type Values: [EnrollToSingle, EnrollToAll] |
|
TeacherLogins |
array of (string) Teacher Logins |
Teacher login names |
|
TrainerLogins |
array of (string) Trainer Logins |
Trainer login names |
|
CertificateTemplateId |
string Certificate Template Id |
Certificate template id |
|
CourseID |
string Course ID |
Optional visible Course ID |
|
Duration |
string Duration |
Duration |
|
LongDescription |
string Long Description |
Long description |
|
PublishingSettings |
Publishing Settings |
Publishing settings |
|
ExpirySettings |
Expiry Settings |
Expiry settings |
|
DueDateSettings |
Due Date Settings |
Due date settings |
|
ShowInCatalog |
boolean Show In Catalog |
Show in catalog |
|
CEU |
number Continuing Education Units |
Continuing education units (CEU) |
|
ImageUrl |
string ImageUrl |
Course image url |
|
FailedCourseId |
string Failed Course Id |
Failed course id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string Id |
Id |
|
Name |
string Name |
Name |
|
IsNew |
boolean Is New |
Is the category new? |
|
ParentCategoryId |
string Parent Category Id |
Parent category id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string Id |
Id |
|
TagName |
string Name |
Name of the Tag |
|
IsNew |
boolean Is New |
Is new category |
Summary: Publishing Settings
Description: Publishing settings
Properties:
|
Name |
Type |
Summary |
|
IsEnabled |
boolean Is Enabled |
Is publishing enabled? |
|
StartDate |
string Start Date |
Start date |
|
EndDate |
string End Date |
End date |
Summary: Expiry Settings
Description: Expiry settings
Properties:
|
Name |
Type |
Summary |
|
IsEnabled |
boolean Is Enabled |
Is enabled |
|
FixedDate |
string Fixed Date |
Fixed date |
|
DaysAfterCompletion |
string Days After Completion |
Days after completion |
Summary: Due Date Settings
Description: Due date settings
Properties:
|
Name |
Type |
Summary |
|
IsEnabled |
boolean Is Enabled |
Is enabled |
|
FixedDate |
string Fixed Date |
Fixed date |
|
DaysAfterEnrollment |
string Days After Enrollment |
Days after enrollment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string Course Unique Id |
Course unique id |
|
CourseCatalogId |
string Course Catalog Id |
Course catalog Id |
|
Title |
string Training Title |
Title of the training plan or course |
|
Description |
string Course Description |
Course description |
|
LongDescription |
string Course Long Description |
Course long description |
|
CEU |
integer(int32) Continuing Education Units |
Continuing education units (CEU) |
|
DecimalCEU |
number(double) Continuing Education Units |
Continuing education units (CEU) |
|
ShowInCatalog |
boolean Show In Catalog |
Show the course in catalog or not? |
|
IsRequired |
boolean Is Required |
Is the course required or not? |
|
IsPublished |
boolean Is Published |
Is the course published or not? |
|
IsEnded |
boolean Is Ended |
Is the course ended or not? |
|
CourseID |
string Course ID |
Optional visible Course ID |
|
Duration |
string Duration |
Course duration |
|
CourseType |
string Coursetype |
Coursetype |
|
ImageUrl |
string Image Url |
Specify the course catalog and site image url. |
|
CertificateTemplateId |
string Certificate Template Id |
Certificate template id |
|
EnrollmentFlow |
string Enrollment Flow |
Enrollment flow |
|
IsDeleted |
boolean Is Deleted |
Is course deleted or not? |
|
CourseSessionEnrollmentType |
string Course Session Enrollment Type |
Course session enrollment type |
|
CreatedAt |
string(date-time) Created At |
Created at |
|
CourseLayoutId |
string Course Layout Id |
Course layout id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
StartDate |
string(date-time)
|
Start Date |
|
EndDate |
string(date-time)
|
End Date |
|
TimeZone |
string
|
Specify the Microsoft time zone name see https://support.microsoft.com/en-ie/help/973627/microsoft-time-zone-index-values Values: [Afghanistan Standard Time, Alaskan Standard Time, Aleutian Standard Time, Altai Standard Time, Arab Standard Time, Arabian Standard Time, Arabic Standard Time, Argentina Standard Time, Astrakhan Standard Time, Atlantic Standard Time, AUS Central Standard Time, Aus Central W. Standard Time, AUS Eastern Standard Time, Azerbaijan Standard Time, Azores Standard Time, Bahia Standard Time, Bangladesh Standard Time, Belarus Standard Time, Bougainville Standard Time, Canada Central Standard Time, Cape Verde Standard Time, Caucasus Standard Time, Cen. Australia Standard Time, Central America Standard Time, Central Asia Standard Time, Central Brazilian Standard Time, Central Europe Standard Time, Central European Standard Time, Central Pacific Standard Time, Central Standard Time, Central Standard Time (Mexico), Chatham Islands Standard Time, China Standard Time, Cuba Standard Time, Dateline Standard Time, E. Africa Standard Time, E. Australia Standard Time, E. Europe Standard Time, E. South America Standard Time, Easter Island Standard Time, Eastern Standard Time, Eastern Standard Time (Mexico), Egypt Standard Time, Ekaterinburg Standard Time, Fiji Standard Time, FLE Standard Time, Georgian Standard Time, GMT Standard Time, Greenland Standard Time, Greenwich Standard Time, GTB Standard Time, Haiti Standard Time, Hawaiian Standard Time, India Standard Time, Iran Standard Time, Israel Standard Time, Jordan Standard Time, Kaliningrad Standard Time, Kamchatka Standard Time, Korea Standard Time, Libya Standard Time, Line Islands Standard Time, Lord Howe Standard Time, Magadan Standard Time, Magallanes Standard Time, Marquesas Standard Time, Mauritius Standard Time, Mid-Atlantic Standard Time, Middle East Standard Time, Montevideo Standard Time, Morocco Standard Time, Mountain Standard Time, Mountain Standard Time (Mexico), Myanmar Standard Time, N. Central Asia Standard Time, Namibia Standard Time, Nepal Standard Time, New Zealand Standard Time, Newfoundland Standard Time, Norfolk Standard Time, North Asia East Standard Time, North Asia Standard Time, North Korea Standard Time, Omsk Standard Time, Pacific SA Standard Time, Pacific Standard Time, Pacific Standard Time (Mexico), Pakistan Standard Time, Paraguay Standard Time, Romance Standard Time, Russia Time Zone 10, Russia Time Zone 11, Russia Time Zone 3, Russian Standard Time, SA Eastern Standard Time, SA Pacific Standard Time, SA Western Standard Time, Saint Pierre Standard Time, Sakhalin Standard Time, Samoa Standard Time, Sao Tome Standard Time, Saratov Standard Time, SE Asia Standard Time, Singapore Standard Time, South Africa Standard Time, Sri Lanka Standard Time, Sudan Standard Time, Syria Standard Time, Taipei Standard Time, Tasmania Standard Time, Tocantins Standard Time, Tokyo Standard Time, Tomsk Standard Time, Tonga Standard Time, Transbaikal Standard Time, Turkey Standard Time, Turks And Caicos Standard Time, Ulaanbaatar Standard Time, US Eastern Standard Time, US Mountain Standard Time, UTC, UTC+12, UTC+13, UTC-02, UTC-08, UTC-09, UTC-11, Venezuela Standard Time, Vladivostok Standard Time, W. Australia Standard Time, W. Central Africa Standard Time, W. Europe Standard Time, W. Mongolia Standard Time, West Asia Standard Time, West Bank Standard Time, West Pacific Standard Time, Yakutsk Standard Time] |
|
Room |
|
Room |
|
MeetingUrl |
string
|
Meeting url |
|
MaxAttendees |
string
|
Max attendees |
Summary:
Description: Room
Properties:
|
Name |
Type |
Summary |
|
EmailAddress |
string
|
Room email address |
|
Title |
string
|
Room Title |
|
Location |
string
|
Room location |
|
Source |
string
|
Room source Values: [Unknown, Exchange] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Name |
string Name |
Specify the name of the tag |
|
CourseCatalogId |
string Course Catalog Id |
Specify the course catalog id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
Name |
string
|
Name |
|
CourseCatalogId |
string
|
Course catalog Id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string Webhook Uri |
Webhook uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userLoginName |
string User Login Name |
User login name |
|
courseSessionId |
string Course Session Id |
Course session id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
@odata.context |
|
Id |
string
|
Id |
|
CourseId |
string
|
Specify the course id |
|
UserId |
string
|
User id |
|
UserLoginName |
string
|
User principal name or email id |
|
Roles |
array of (string)
|
Roles |
|
RegistrationDate |
string(date-time)
|
Registration date |
|
StartDate |
string(date-time)
|
Start date |
|
CompletionDate |
string
|
Completion date |
|
RegistrationStatus |
string
|
Registration status |
|
CoursePassingStatus |
string
|
Course passing status |
|
CertificateId |
string
|
Certificate id |
|
CEU |
integer(int32) Continuing Education Units |
Continuing education units (CEU) |
|
DecimalCEU |
number(double) Continuing Education Units |
Continuing education units (CEU) |
|
DueDate |
string(date-time)
|
Due date |
|
EndDate |
string
|
End date |
|
IsPartOfTrainingPlan |
boolean
|
Is part of a training plan |
|
CanUnenroll |
boolean
|
Can user unenroll |
|
CancellationReason |
string
|
Specify the cancellation reason |
|
courseSessionId |
string Course Session Id |
Course session id |
Summary: File Content
Description: Content of the file.
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem)
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
Title |
string Course Catalog Title |
Title of the course catalog |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
@odata.context |
|
value |
array of (ValueItem)
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string Category Unique Id |
Category unique id |
|
Name |
string Category Name |
Category name |
|
CourseCatalogId |
string Course Catalog Id |
Course catalog Id |
|
ParentCategoryId |
string Parent Category Id |
Parent category id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
@odata.context |
|
Id |
string
|
Id |
|
CourseCatalogId |
string
|
Course catalog Id |
|
Title |
string Training Title |
Title of the training plan or course |
|
Description |
string
|
Short description |
|
LongDescription |
string
|
Long description |
|
CEU |
integer(int32) Continuing Education Units |
Continuing education units (CEU) |
|
DecimalCEU |
number(double) Continuing Education Units |
Continuing education units (CEU) |
|
ShowInCatalog |
boolean
|
Show in catalog |
|
IsRequired |
boolean
|
Is required |
|
IsPublished |
boolean
|
Is published |
|
IsEnded |
boolean
|
Is ended |
|
CourseID |
string
|
Optional visible Course ID |
|
Duration |
string
|
Duration |
|
CourseType |
string
|
Coursetype |
|
ImageUrl |
string
|
Course image url |
|
CertificateTemplateId |
string
|
Certificate template id |
|
EnrollmentFlow |
string
|
Enrollment flow |
|
IsDeleted |
boolean
|
Is deleted |
|
CourseSessionEnrollmentType |
string
|
Course session enrollment type |
|
CreatedAt |
string(date-time)
|
Created at |
|
CourseLayoutId |
string
|
Course layout id |
|
DueDate@odata.context |
string
|
DueDate@odata.context |
|
DueDate |
|
Due date |
|
Publishing@odata.context |
string
|
Publishing@odata.context |
|
Publishing |
|
Publishing |
|
CertificateExpiry@odata.context |
string
|
CertificateExpiry@odata.context |
|
CertificateExpiry |
|
Certificate expiry |
|
SharepointWeb |
|
SharepointWeb |
|
Categories |
array of (CategoriesItem)
|
Categories |
|
Tags |
array of (TagsItem)
|
Tags |
|
CourseSessions |
array of (CourseSessionsItem)
|
Course sessions |
|
LearningModules |
array of (LearningModulesItem)
|
Learning modules |
|
ProvisioningProgress@odata.context |
string
|
ProvisioningProgress@odata.context |
|
ProvisioningProgress |
string
|
Provisioning progress |
|
Trainers |
array of (TrainersItem)
|
Trainers |
|
Quizzes |
array of (QuizzesItem)
|
Quizzes |
Summary:
Description: Due date
Properties:
|
Name |
Type |
Summary |
|
CourseId |
string
|
The internal course id |
|
IsEnabled |
boolean
|
Is due date enabled |
|
FixedDate |
string
|
Fixed date |
|
DaysAfterEnrollment |
integer(int32)
|
Days after enrollment |
Summary:
Description: Publishing
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
IsEnabled |
boolean
|
Is enabled |
|
StartDate |
string(date-time)
|
Start date |
|
EndDate |
string
|
End date |
Summary:
Description: Certificate expiry
Properties:
|
Name |
Type |
Summary |
|
CourseId |
string
|
The internal course id |
|
IsEnabled |
boolean
|
Is enabled |
|
FixedDate |
string
|
Fixed date |
|
DaysAfterCompletion |
integer(int32)
|
Days after completion |
Summary:
Description: SharepointWeb
Properties:
|
Name |
Type |
Summary |
|
Url |
string
|
Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
Name |
string
|
Name |
|
CourseCatalogId |
string
|
Course catalog Id |
|
ParentCategoryId |
string
|
Parent category id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
Name |
string
|
Name |
|
CourseCatalogId |
string
|
Course catalog Id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
CourseId |
string
|
The internal course id |
|
Title |
string
|
Title |
|
Description |
string
|
Short description |
|
IsPublished |
boolean
|
Is published |
|
Order |
integer(int32)
|
Order |
|
HasPrerequisite |
boolean
|
Has prerequisite |
|
Configuration |
|
Configuration |
Summary:
Description: Configuration
Properties:
|
Name |
Type |
Summary |
|
LearningModuleId |
string
|
Learning module id |
|
Items |
array of (ItemsItem)
|
Items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Content |
string
|
Content |
|
EmbedType |
integer(int32)
|
Embed type |
|
Id |
string
|
Id |
|
Title |
string
|
Title |
|
ItemType |
integer(int32)
|
Item type |
|
ConfirmationMessage |
string
|
Confirmation message |
|
CheckMarkMessage |
string
|
Checkmark message |
|
Type |
integer(int32)
|
Type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
Department |
string
|
Department |
|
LoginName |
string
|
User login name |
|
Title |
string Trainers Display Name |
Display name of the trainer |
|
|
string
|
|
|
ManagerId |
string
|
Manager Id |
|
ManagerLoginName |
string
|
Manager login name |
|
City |
string
|
City |
|
Country |
string
|
Country |
|
Office |
string
|
Office |
|
JobTitle |
string
|
Job title |
|
IsExternal |
boolean
|
Is external |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
Title |
string
|
Title |
|
Description |
string
|
Short description |
|
MaxAttemptsLimit |
integer(int32)
|
Max attempts limit |
|
PassingPercentage |
integer(int32)
|
Passing percentage |
|
IsPublished |
boolean
|
Is published |
|
PublishingStartDate |
string
|
Publishing start date |
|
PublishingEndDate |
string
|
Publishing end date |
|
Randomize |
boolean
|
Randomize |
|
ShowScore |
boolean
|
Show score |
|
AllowReview |
boolean
|
Allow review |
|
ShowCorrectAnswers |
boolean
|
Show correct answers |
|
TimeLimit |
string
|
Time limit |
|
ShowTimer |
boolean
|
Show timer |
|
ModifiedAt |
string(date-time)
|
Modified at |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
@odata.context |
|
value |
array of (ValueItem)
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
ProvisioningProgress@odata.context |
string
|
ProvisioningProgress@odata.context |
|
ProvisioningProgress |
string
|
Provisioning progress |
|
SharepointWeb |
|
SharepointWeb |
Summary:
Description: SharepointWeb
Properties:
|
Name |
Type |
Summary |
|
SiteId |
string
|
SiteId |
|
Id |
string
|
Id |
|
Url |
string
|
Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
@odata.context |
|
Id |
string
|
Id |
|
Title |
string Course Catalog Title |
Title of the catalog |
|
Courses |
array of (CoursesItem)
|
Courses |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
CourseCatalogId |
string
|
Course catalog Id |
|
Title |
string Training Title |
Title of the training plan or course |
|
Description |
string
|
Short description |
|
LongDescription |
string
|
Long description |
|
CEU |
integer(int32) Continuing Education Units |
Continuing education units (CEU) |
|
DecimalCEU |
number(double) Continuing Education Units |
Continuing education units (CEU) |
|
ShowInCatalog |
boolean
|
Show in catalog |
|
IsRequired |
boolean
|
Is required |
|
IsPublished |
boolean
|
Is published |
|
IsEnded |
boolean
|
Is ended |
|
CourseID |
string
|
Optional visible Course ID |
|
Duration |
string
|
Duration |
|
CourseType |
string
|
Coursetype |
|
ImageUrl |
string
|
Course image url |
|
CertificateTemplateId |
string
|
Certificate template id |
|
EnrollmentFlow |
string
|
Enrollment flow |
|
IsDeleted |
boolean
|
Is deleted |
|
CourseSessionEnrollmentType |
string
|
Course session enrollment type |
|
CreatedAt |
string(date-time)
|
Created at |
|
CourseLayoutId |
string
|
Course layout id |
|
SharepointWeb |
|
SharepointWeb |
Summary:
Description: SharepointWeb
Properties:
|
Name |
Type |
Summary |
|
SiteId |
string
|
SiteId |
|
Id |
string
|
Id |
|
Url |
string
|
Url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
@odata.context |
|
value |
array of (ValueItem)
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
Name |
string
|
Name |
|
CourseCatalogId |
string
|
Course catalog Id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
@odata.context |
string
|
@odata.context |
|
Id |
string
|
Id |
|
CourseId |
string
|
Specify the course id |
|
UserId |
string
|
User id |
|
UserLoginName |
string
|
User principal name or email id |
|
Roles |
array of (string)
|
Roles |
|
RegistrationDate |
string(date-time)
|
Registration date |
|
StartDate |
string(date-time)
|
Start date |
|
CompletionDate |
string
|
Completion date |
|
RegistrationStatus |
string
|
Registration status |
|
CoursePassingStatus |
string
|
Course passing status |
|
CertificateId |
string
|
Certificate id |
|
CEU |
integer(int32) Continuing Education Units |
Continuing education units (CEU) |
|
DecimalCEU |
number(double) Continuing Education Units |
Continuing education units (CEU) |
|
DueDate |
string(date-time)
|
Due date |
|
EndDate |
string
|
End date |
|
IsPartOfTrainingPlan |
boolean
|
Is part of a training plan |
|
CanUnenroll |
boolean
|
Can user unenroll |
|
CancellationReason |
string
|
Specify the cancellation reason |
|
courseSessionId |
string Course Session Id |
Course session id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
value |
array of (ValueItem)
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
Id |
|
Department |
string
|
Department |
|
LoginName |
string
|
LoginName |
|
Title |
string User Display Name |
Display name of the user |
|
|
string
|
|
|
ManagerId |
string
|
ManagerId |
|
ManagerLoginName |
string
|
ManagerLoginName |
|
City |
string
|
City |
|
Country |
string
|
Country |
|
DirectoryObjectId |
string
|
Azure active directory object id |
|
Office |
string(date-time)
|
Office |
|
JobTitle |
string
|
JobTitle |
|
IsExternal |
boolean
|
IsExternal |
Summary:
Description: Body parameters for HttpRequest operation.
Properties:
|
Name |
Type |
Summary |
|
method |
string Method |
Http Method Values: [GET, PUT, POST, PATCH, DELETE] |
|
uri |
string Uri |
Relative path after /odata/v2/ prefix. Example: Competencies |
|
headers |
Headers |
Enter JSON object of request headers |
|
body |
string Body |
Enter request content in JSON |
Summary: Headers
Description: Enter JSON object of request headers
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Body parameters for HttpRequest operation.
Properties:
|
Name |
Type |
Summary |
|
method |
string Method |
Http Method Values: [GET, PUT, POST, PATCH, DELETE] |
|
uri |
string Uri |
Relative url. Example: odata/v2/Competencies |
|
headers |
Headers |
Enter JSON object of request headers |
|
body |
string Body |
Enter request content in JSON |
Summary: Headers
Description: Enter JSON object of request headers
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
string
|
Specify the cancellation message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
courseSessionId |
string Course Session Id |
Course session id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string
|
Webhook Uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
WebHookUri |
string
|
WebHook Uri |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |