All REST Endpoints

Sort by

Task Path Method

Group by API

Catalog

Rest API endpoints for Meta-data Catalog.

Catalog of all API end points.

Method: get

Path: /learn.rest/v1/metadata-catalog

Groups

The groups resource includes the groups service used to create, view, update, and delete groups for users.

Creates a new group

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups

Creates a new group mapped item

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems

Creates a new group user mapping

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/users

Deletes a group mapped item

Method: delete

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems

Deletes a group user mapped item

Method: delete

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/Users/{userId}

Get a list of groups in LearnCenter.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups

Get a list of items mapped to a group in LearnCenter.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems

Get a list of owners for groups in LearnCenter.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/owners

Get a list of users mapped to groups in LearnCenter

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/users

Get group details by group id.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}

Get group user details by user id.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/Users/{userId}

Get the owner for a group in LearnCenter using Owner Id.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/owners/{ownerId}

Update all properties of a group

Method: put

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}

Updates a group mapped item

Method: patch

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems

Updates a group mapped item

Method: put

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems

Updates a group user mapped item

Method: put

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/Users/{userId}

Updates subset of properties for a group

Method: patch

Path: /learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}

LearnCenters

Rest API endpoints for LearnCenters.

Get a LearnCenter

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}

Get learnCenters

Method: get

Path: /learn.rest/v1/learnCenters

Memberships

Rest API endpoints to create, fetch, update, and delete membership details.

Create a new custom Field Value.

Method: post

Path: /learn.rest/v1/memberships/{membershipId}/customFieldValues

Creates a new membership

Method: post

Path: /learn.rest/v1/memberships

Delete a custom field value

Method: delete

Path: /learn.rest/v1/memberships/{membershipId}/customerFieldValues/{customFieldValueId}

Delete a user custom field value

Method: delete

Path: /learn.rest/v1/memberships/{membershipId}/customFieldValues/{userCustomFieldValueId}

Get a custom field value

Method: get

Path: /learn.rest/v1/memberships/{membershipId}/customerFieldValues/{customFieldValueId}

Get a list of custom field values

Method: get

Path: /learn.rest/v1/memberships/{membershipId}/customFieldValues

Get a membership.

Method: get

Path: /learn.rest/v1/memberships/{membershipId}

Get a user custom field value

Method: get

Path: /learn.rest/v1/memberships/{membershipId}/customFieldValues/{userCustomFieldValueId}

Update all properties of a custom field value

Method: put

Path: /learn.rest/v1/memberships/{membershipId}/customerFieldValues/{customFieldValueId}

Update all properties of a membership.

Method: put

Path: /learn.rest/v1/memberships/{membershipId}

Update all the properties of a custom field value

Method: put

Path: /learn.rest/v1/memberships/{membershipId}/customFieldValues/{userCustomFieldValueId}

Update subset of properties of a membership.

Method: patch

Path: /learn.rest/v1/memberships/{membershipId}

Supervisor Accounts

Rest API endpoints for Supervisor Accounts

Creates a new supervisee

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees

Creates a new supervisor account

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts

Delete a supervisee

Method: delete

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees/{superviseeId}

Delete a supervisor account

Method: delete

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}

Get a list of supervisees mapped to a supervisor account in a LearnCenter

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees

Get a list of supervisor accounts in a LearnCenter.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts

Get a list of supervisor accounts mapped to a supervisor role in a LearnCenter.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts

Get a list of supervisor roles mapped to a supervisor account in a LearnCenter

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisorRoles

Get supervisee details

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees/{superviseeId}

Gets details of supervisor account

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}

Update all properties of a supervisee

Method: put

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees/{superviseeId}

Supervisor Roles

Rest API endpoints for Supervisor Roles

Creates a new supervisor role.

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles

Get a list of supervisor roles in a LearnCenter.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles

Get mapping details of supervisor accounts mapped to a supervisor role in a LearnCenter

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}

Get supervisor role details

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}

Map a new supervisor account with an existing supervisor role.

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts

Update all properties of a supervisor role and supervisor account.

Method: put

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}

Update all properties of a supervisor role.

Method: put

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}

Updates subset of properties for a supervisor role and supervisor account mapping.

Method: patch

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}

Updates subset of properties for a supervisor role.

Method: patch

Path: /learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}

System Processes

Rest API endpoints for System Processes

Get a list of system processes.

Method: get

Path: /learn.rest/v1/systemProcesses

Get the status of a specific system process.

Method: get

Path: /learn.rest/v1/systemProcesses/{id}

System Registry Keys

System Registry keys are used to customize Learn settings, and apply to all LearnCenters, including root LearnCenter and all of its sub LearnCenters. The following keys are used with Learn REST API, and are categorized as RestApiSettings.\n\nGeneratePassword: Values = 0 or 1, Default = 0, Description = Enables automatic generation of password\n\nTriggerUserMessages: Values = 0 or 1, Default = 0, Description = Enables email notifications

Get a list of system registry keys.

Method: get

Path: /learn.rest/v1/systemRegistryKeys

Get a System Registry Key.

Method: get

Path: /learn.rest/v1/systemRegistryKeys/{systemRegistryKey}

Update all properties of a System Registry Key.

Method: put

Path: /learn.rest/v1/systemRegistryKeys/{systemRegistryKey}

User Custom Fields

Rest API endpoints for User Custom Fields.

Create a new user Custom Field.

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields

Get a list of user Custom Fields.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields

Get a user Custom Field.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}

Update all properties of a user Custom Field.

Method: put

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}

Update subset of properties of a userCustomField

Method: patch

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}

User Roles

Rest API endpoints for User Roles.

Creates a new user and role mapping.

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userRoles/{userRoleId}/users

Creates a new user role

Method: post

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userRoles

Get a list of user role in a LearnCenter.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userRoles

Get a list of users mapped to a user role in a learnCenter.

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userRoles/{userRoleId}/users

Get user role details

Method: get

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userRoles/{userRoleId}

Update all properties of a user role.

Method: put

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userRoles/{userRoleId}

Updates subset of properties for a user role.

Method: patch

Path: /learn.rest/v1/learnCenters/{learnCenterId}/userRoles/{userRoleId}

Users

Rest API endpoints for Users.

Creates a new user

Method: post

Path: /learn.rest/v1/users

Get a user

Method: get

Path: /learn.rest/v1/users/{userId}

Get all users.

Method: get

Path: /learn.rest/v1/users

Get memberships for user

Method: get

Path: /learn.rest/v1/users/{userId}/memberships

Update all properties of a user

Method: put

Path: /learn.rest/v1/users/{userId}

Update subset of properties of a user

Method: patch

Path: /learn.rest/v1/users/{userId}