NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

D2L Brightspace

d2lbrightspace

D2L Brightspace is a learning management system that provides a comprehensive suite of tools for educators to create, manage, and deliver online courses and learning experiences.

EducationOnline CoursesWeb del proveedor
Acciones
45
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (45)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Copy RoleD2LBRIGHTSPACE_COPY_ROLEAcción

Creates a new role copied from an existing role in d2l brightspace. notes: - the new role will not have any capabilities upon the old role from which it was created - some capabilities will be copied for the new role (e.g., if old role users could impersonate other old role users, new role users will be able to impersonate other new role users) - additional capabilities must be manually created after copying requires oauth2 scope: - role:detail:create available in api versions unstable (lms v10.4.10+)

Parámetros de entrada

  • role_dataobjectObligatorio

    Properties for the new role

  • deep_copy_role_idintegerObligatorio

    Source role ID to act as template for new role

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Course OfferingD2LBRIGHTSPACE_CREATE_A_COURSE_OFFERINGAcción

Creates a new course offering in d2l brightspace. notes: - course code limitations: max 50 chars, no special chars: \ : * ? " < > | ' # , % & - path: leave empty if path enforcement is enabled - semesterid: provide null if not using the semester element - canselfregister: required for api v1.28+, not supported before v1.28 requires oauth2 scope: - orgunits:course:create available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • course_dataobjectObligatorio

    Data for creating the new course offering

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Course TemplateD2LBRIGHTSPACE_CREATE_A_COURSE_TEMPLATEAcción

Creates a new course template in d2l brightspace. notes: - course template code limitations: max 50 chars, no special chars: \ : * ? " < > | ' # , % & - path: leave empty if path enforcement is enabled requires oauth2 scope: - orgunits:coursetemplate:create available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • course_template_dataobjectObligatorio

    Data for creating the new course template

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Grade ObjectD2LBRIGHTSPACE_CREATE_GRADE_OBJECTAcción

Creates a new grade object for a particular org unit. the grade object can be one of four types: 1. numeric: for numeric grades with max points 2. passfail: for pass/fail assessments 3. selectbox: for predefined grade options 4. text: for text-only feedback returns a gradeobject json block containing the created grade object's data, including its assigned id. requires oauth2 scope: - grades:gradeobjects:write available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit to create the grade object in

  • grade_objectobjectObligatorio

    Grade object data. Must be one of these types: - Numeric: Includes MaxPoints, CanExceedMaxPoints, etc. - PassFail: Includes MaxPoints, IsBonus, etc. - SelectBox: Includes MaxPoints, IsBonus, GradeSchemeId (required), etc. - Text: Basic grade object with Name, ShortName, etc.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create QuizD2LBRIGHTSPACE_CREATE_QUIZAcción

Creates a new quiz in d2l brightspace. notes: - numberofattemptsallowed must be between 1 and 10 (inclusive) or null for unlimited - password must not be empty or whitespace if provided - notificationemail must be a valid email address if provided - timelimitvalue: 0 for no limit (with isenforced false), or 1-9999 for enforced limit - deductionpercentage must be between 0 and 100 if provided - as of le api v1.71: - latelimitminutes is ignored - latesubmissionoption 1 is treated as 2 (autosubmitattempt) - submissiongraceperiod is not used - pagingtypeid added in le api v1.78 - date fields should be in utc format requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:create available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • quiz_dataobjectObligatorio

    Quiz creation data

  • org_unit_idintegerObligatorio

    ID of the org unit to create the quiz in

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Quiz CategoryD2LBRIGHTSPACE_CREATE_QUIZ_CATEGORYAcción

Creates a new quiz category in d2l brightspace. returns a quizcategoryreaddata json block containing: - categoryid: the id of the created category - name: the name of the category - sortorder: the sort order value requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:create available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit to create the quiz category in

  • category_dataobjectObligatorio

    Quiz category creation data

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create UserD2LBRIGHTSPACE_CREATE_USERAcción

Creates a new user entity in d2l brightspace. requires oauth2 scope: - users:userdata:create available in api versions 1.46+ (lms v20.24.3+) notes: - firstname and lastname are used as legal names - externalemail must be null or a valid email address - orgdefinedid must be unique across the organization if provided - preferred names must be set separately after user creation

Parámetros de entrada

  • user_dataobjectObligatorio

    Data for creating the new user

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Course TemplateD2LBRIGHTSPACE_DELETE_A_COURSE_TEMPLATEAcción

Deletes a course template from d2l brightspace. requires oauth2 scope: - orgunits:course:delete available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the course template to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CourseD2LBRIGHTSPACE_DELETE_COURSEAcción

Deletes a course offering from d2l brightspace. requires oauth2 scope: - orgunits:course:delete available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the course offering to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Grade ObjectD2LBRIGHTSPACE_DELETE_GRADE_OBJECTAcción

Deletes a specific grade object from an org unit. requires oauth2 scope: - grades:gradeobjects:delete available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit containing the grade object

  • grade_object_idintegerObligatorio

    ID of the grade object to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete QuizD2LBRIGHTSPACE_DELETE_QUIZAcción

Deletes a quiz from d2l brightspace. requires oauth2 scope: - quizzing:quizzes:delete available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • quiz_idintegerObligatorio

    ID of the quiz to delete

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Quiz CategoryD2LBRIGHTSPACE_DELETE_QUIZ_CATEGORYAcción

Deletes a quiz category from d2l brightspace. requires oauth2 scope: - quizzing:quizzes:delete available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • category_idintegerObligatorio

    ID of the quiz category to delete

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz category

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete UserD2LBRIGHTSPACE_DELETE_USERAcción

Deletes a user entity from d2l brightspace. requires oauth2 scope: - users:userdata:delete available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • user_idintegerObligatorio

    ID of the user to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete User DemographicsD2LBRIGHTSPACE_DELETE_USER_DEMOGRAPHICSAcción

Deletes one or more of a particular user's associated demographics entries. notes: - if entry ids are provided, only those specific entries will be deleted - if entry ids are not provided, all demographics entries for the user will be deleted requires oauth2 scope: - demographics:user:delete available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • user_idintegerObligatorio

    ID of the user whose demographics to delete

  • entry_idsstring[]

    Optional. Specific entry IDs to delete. If not provided, all entries will be deleted.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Course OfferingD2LBRIGHTSPACE_GET_A_COURSE_OFFERINGAcción

Retrieves a specific course offering from d2l brightspace. returns a courseoffering json block with the course's information. requires oauth2 scope: - orgunits:course:read available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the course offering to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Course TemplateD2LBRIGHTSPACE_GET_A_COURSE_TEMPLATEAcción

Retrieves a course template from d2l brightspace. returns a coursetemplate json block with the template's information. available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the course template to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Course SchemaD2LBRIGHTSPACE_GET_COURSE_SCHEMAAcción

Retrieves the list of parent org unit type constraints for course offerings. returns a json array of schemaelement blocks defining the allowed parent organizational unit types for courses. available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Course Template SchemaD2LBRIGHTSPACE_GET_COURSE_TEMPLATE_SCHEMAAcción

Retrieves the list of parent org unit type constraints for course offerings built on this template. returns a json array of schemaelement blocks defining the allowed parent organizational unit types for course templates. available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Current User InformationD2LBRIGHTSPACE_GET_CURRENT_USERAcción

Retrieves the current user context's user information from d2l brightspace. requires one of these oauth2 scopes: - users:profile:read - users:own profile:read available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Enrolled RolesD2LBRIGHTSPACE_GET_ENROLLED_ROLESAcción

Retrieves a list of all enrolled user roles the calling user can view in an org unit. returns a json array of role data blocks containing the properties of all user roles that the calling user context has permission to view and that are currently enrolled in the provided org unit. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit to get enrolled roles from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Grade AccessD2LBRIGHTSPACE_GET_GRADE_ACCESSAcción

Retrieves a list of users with access to a specified grade. returns an objectlistpage containing useraccess blocks. can optionally filter by specific user id or role id. requires oauth2 scope: - grades:access:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • role_idinteger

    Optional. Get access for users with this role

  • user_idinteger

    Optional. Get access for a specific user

  • org_unit_idintegerObligatorio

    ID of the org unit containing the grade

  • grade_object_idintegerObligatorio

    ID of the grade object to get access for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Grade ObjectD2LBRIGHTSPACE_GET_GRADE_OBJECTAcción

Retrieves a specific grade object for a particular org unit. returns a gradeobject json block containing the grade object's properties. requires oauth2 scope: - grades:gradeobjects:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit containing the grade object

  • grade_object_idintegerObligatorio

    ID of the grade object to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Grade ObjectsD2LBRIGHTSPACE_GET_GRADE_OBJECTSAcción

Retrieves all current grade objects for a particular org unit. returns an array of grade objects. requires oauth2 scope: - grades:gradeobjects:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit to get grade objects from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Grade SetupD2LBRIGHTSPACE_GET_GRADE_SETUPAcción

Retrieves the grades configuration for an org unit. returns a gradesetupinfo json block containing the grades setup information. requires oauth2 scope: - grades:gradesettings:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit to get grades configuration from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Grade StatisticsD2LBRIGHTSPACE_GET_GRADE_STATISTICSAcción

Retrieves statistics for a specified grade item. returns a gradestatisticsinfo json block containing statistical data about the grade item. requires oauth2 scope: - grades:gradestatistics:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit containing the grade

  • grade_object_idintegerObligatorio

    ID of the grade object to get statistics for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Org Unit DemographicsD2LBRIGHTSPACE_GET_ORG_UNIT_DEMOGRAPHICSAcción

Retrieves all demographics entries for users enrolled in a particular org unit. notes: - filters are applied cumulatively (all conditions must match) - when using id lists in filters, matching any id in the list satisfies that filter - for example: with roleids=[1,2], userids=[3,4], search="value": * users must have role 1 or 2 (either role matches) * and must have id 3 or 4 (either id matches) * and must have a field matching "value" - results are paged; use bookmark parameter for subsequent pages requires oauth2 scope: - demographics:orgunit:read available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • searchstring

    Optional. Search string to look for in the demographic field values

  • bookmarkstring

    Optional. Bookmark to use for fetching the next data set segment

  • role_idsstring[]

    Optional. List of user role IDs to filter by

  • user_idsstring[]

    Optional. List of user IDs to filter by

  • field_idsstring[]

    Optional. List of demographic field IDs to filter by

  • org_unit_idintegerObligatorio

    ID of the org unit to get demographics from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get QuizD2LBRIGHTSPACE_GET_QUIZAcción

Retrieves a specific quiz from an org unit. returns a quizreaddata json block containing the quiz's properties. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • quiz_idintegerObligatorio

    ID of the quiz to retrieve

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Quiz AccessD2LBRIGHTSPACE_GET_QUIZ_ACCESSAcción

Retrieves a list of users with access to a specified quiz. returns an objectlistpage json block containing a list of useraccess blocks. can filter by specific user id or role id. requires oauth2 scope: - quizzing:access:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • quiz_idintegerObligatorio

    ID of the quiz to get access information for

  • role_idinteger

    Optional. Get access for users with this role

  • user_idinteger

    Optional. Get access for a specific user

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Quiz AttemptD2LBRIGHTSPACE_GET_QUIZ_ATTEMPTAcción

Retrieves a specific quiz attempt. returns a quizattemptdata json block containing the attempt's properties. requires oauth2 scope: - quizzing:attempts:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • quiz_idintegerObligatorio

    ID of the quiz

  • attempt_idintegerObligatorio

    ID of the attempt to retrieve

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Quiz AttemptsD2LBRIGHTSPACE_GET_QUIZ_ATTEMPTSAcción

Retrieves a list of attempts for a quiz. can optionally filter attempts for a specific user. returns an objectlistpage json block containing a list of quizattemptdata blocks. requires oauth2 scope: - quizzing:attempts:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • quiz_idintegerObligatorio

    ID of the quiz to get attempts for

  • user_idinteger

    Optional. Get attempts for a specific user

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Quiz CategoriesD2LBRIGHTSPACE_GET_QUIZ_CATEGORIESAcción

Retrieves all quiz categories belonging to an org unit. returns an objectlistpage json block containing a list of quizcategoryreaddata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit to get quiz categories from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Quiz CategoryD2LBRIGHTSPACE_GET_QUIZ_CATEGORYAcción

Retrieves a specific quiz category from an org unit. returns a quizcategoryreaddata json block containing the category's properties. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • category_idintegerObligatorio

    ID of the quiz category to retrieve

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz category

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Quiz QuestionsD2LBRIGHTSPACE_GET_QUIZ_QUESTIONSAcción

Retrieves all questions in a quiz. returns an objectlistpage json block containing a list of questiondata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • quiz_idintegerObligatorio

    ID of the quiz to get questions from

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get QuizzesD2LBRIGHTSPACE_GET_QUIZZESAcción

Retrieves all quizzes belonging to an org unit. returns an objectlistpage json block containing a list of quizreaddata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit to get quizzes from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Role by IDD2LBRIGHTSPACE_GET_ROLE_BY_IDAcción

Retrieves a particular user role from d2l brightspace by its id. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • role_idintegerObligatorio

    ID of the role to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get RolesD2LBRIGHTSPACE_GET_ROLESAcción

Retrieves a list of all known user roles in d2l brightspace. returns a list of role data blocks containing the properties of all user roles that the calling user context has permission to manage. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get User by IDD2LBRIGHTSPACE_GET_USER_BY_IDAcción

Retrieves data for a particular user from d2l brightspace. requires oauth2 scope: - users:userdata:read available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • user_idstringObligatorio

    The ID of the user to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get UsersD2LBRIGHTSPACE_GET_USERSAcción

Retrieves data for one or more users from d2l brightspace. requires oauth2 scope: - users:userdata:read available in api versions 1.46+ (lms v20.24.3+) notes: - all search parameters (orgdefinedid, username, externalemail) are optional - returns paginated results when using bookmark parameter

Parámetros de entrada

  • bookmarkstring

    Optional. Bookmark to use for fetching next data set segment

  • userNamestring

    Optional. User name to look for

  • orgDefinedIdstring

    Optional. Org-defined identifier to look for

  • externalEmailstring

    Optional. External email address to look for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Course OfferingD2LBRIGHTSPACE_UPDATE_A_COURSE_OFFERINGAcción

Updates an existing course offering in d2l brightspace. notes: - course code limitations: max 50 chars, no special chars: \ : * ? " < > | ' # , % & - startdate/enddate: null values won't overwrite existing dates - canselfregister: required for api v1.27+, not supported before v1.27 - description: ignored in api versions 1.25 and earlier requires oauth2 scope: - orgunits:course:update available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • course_dataobjectObligatorio

    Updated course offering properties

  • org_unit_idintegerObligatorio

    ID of the course offering to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Course TemplateD2LBRIGHTSPACE_UPDATE_A_COURSE_TEMPLATEAcción

Updates an existing course template in d2l brightspace. notes: - this action completely replaces the template's data with the provided values - course template code limitations: max 50 chars, no special chars: \ : * ? " < > | ' # , % & available in api versions 1.46+ (lms v20.24.3+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the course template to update

  • template_dataobjectObligatorio

    Updated course template properties

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Grade ObjectD2LBRIGHTSPACE_UPDATE_GRADE_OBJECTAcción

Updates a specific grade object. the grade object can be one of four types: 1. numeric: for numeric grades with max points 2. passfail: for pass/fail assessments 3. selectbox: for predefined grade options 4. text: for text-only feedback note: the provided data completely replaces the existing grade object's data. returns a gradeobject json block containing the updated grade object's data. requires oauth2 scope: - grades:gradeobjects:write available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • org_unit_idintegerObligatorio

    ID of the org unit containing the grade object

  • grade_objectobjectObligatorio

    Updated grade object data. Must be one of these types: - Numeric: Includes MaxPoints, CanExceedMaxPoints, etc. - PassFail: Includes MaxPoints, IsBonus, etc. - SelectBox: Includes MaxPoints, IsBonus, GradeSchemeId (required), etc. - Text: Basic grade object with Name, ShortName, etc. Common restrictions: - Do not provide Id field - CategoryId must be valid or 0 - Description must use RichTextInput format - MaxPoints (if applicable) must be between 0.01 and 9999999999 - Name must be unique in the gradebook - Name cannot contain: / " * < > + = | , % - Name and ShortName must be ≤128 characters - Do not provide GradeSchemeUrl or Weight fields Note: All provided data will replace the existing grade object's data.

  • grade_object_idintegerObligatorio

    ID of the grade object to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Grade SetupD2LBRIGHTSPACE_UPDATE_GRADE_SETUPAcción

Updates the grades configuration for an org unit. expects a gradesetupinfo json block containing: - gradingsystem: the grading system type - isnullgradezero: whether null grades should be treated as zero - defaultgradeschemeid: id of the default grade scheme returns the updated gradesetupinfo json block. requires oauth2 scope: - grades:gradesettings:write available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • setup_infoobjectObligatorio

    The new grades configuration data

  • org_unit_idintegerObligatorio

    ID of the org unit to update grades configuration for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update QuizD2LBRIGHTSPACE_UPDATE_QUIZAcción

Updates an existing quiz in d2l brightspace. notes: - this action updates only the provided quiz properties - numberofattemptsallowed must be between 1 and 10 (inclusive) or null for unlimited - password must not be empty or whitespace if provided - notificationemail must be a valid email address if provided - timelimitvalue: 0 for no limit (with isenforced false), or 1-9999 for enforced limit - deductionpercentage must be between 0 and 100 if provided - cannot restrict shared quizzes for special access - cannot set auto-submit for quizzes with mandatory questions - as of le api v1.71: - latelimitminutes is ignored - latesubmissionoption 1 is treated as 2 (autosubmitattempt) - submissiongraceperiod is not used - pagingtypeid added in le api v1.78 - date fields should be in utc format requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:write available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • quiz_idintegerObligatorio

    ID of the quiz to update

  • quiz_dataobjectObligatorio

    Updated quiz data

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Quiz CategoryD2LBRIGHTSPACE_UPDATE_QUIZ_CATEGORYAcción

Updates an existing quiz category in d2l brightspace. returns a quizcategoryreaddata json block containing: - categoryid: the id of the category - name: the name of the category - sortorder: the sort order value requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:write available in api versions 1.75+ (lms v20.24.5+)

Parámetros de entrada

  • category_idintegerObligatorio

    ID of the quiz category to update

  • org_unit_idintegerObligatorio

    ID of the org unit containing the quiz category

  • category_dataobjectObligatorio

    Updated quiz category data

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update UserD2LBRIGHTSPACE_UPDATE_USERAcción

Updates an existing user entity in d2l brightspace. requires oauth2 scope: - users:userdata:update available in api versions 1.46+ (lms v20.24.3+) notes: - firstname and lastname update preferred names if set, otherwise update legal names - externalemail must be null or a valid email address - orgdefinedid must be unique across the organization if provided - pronouns: use empty string ("") to reset, null to keep existing value

Parámetros de entrada

  • user_idintegerObligatorio

    ID of the user to update

  • user_dataobjectObligatorio

    Updated data for the user

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not