| Field | Type | Required | Description | Example |
|---|---|---|---|---|
xAccountId |
String | ✔️ | The account identifier | |
raw |
JsonNullable<Boolean> | ➖ | Indicates that the raw request result should be returned in addition to the mapped result (default value is false) | |
proxy |
Map<String, Object> | ➖ | Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key | |
fields |
JsonNullable<String> | ➖ | The comma separated list of fields that will be returned in the response (if empty, all fields are returned) | id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields |
filter |
JsonNullable<LmsListAssignmentsQueryParamFilter> | ➖ | LMS Assignment Filter | |
page |
JsonNullable<String> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The page number of the results to fetch |
|
pageSize |
JsonNullable<String> | ➖ | The number of results per page (default value is 25) | |
next |
JsonNullable<String> | ➖ | The unified cursor | |
updatedAfter |
OffsetDateTime | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Use a string with a date to only select results updated after that given date |
2020-01-01T00:00:00.000Z |
userId |
JsonNullable<String> | ➖ | The user ID associated with this assignment | c28xyrc55866bvuv |
remoteUserId |
JsonNullable<String> | ➖ | Provider's unique identifier of the user related to the assignment | e3cb75bf-aa84-466e-a6c1-b8322b257a48 |
prefer |
Optional<String> | ➖ | Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240) | heartbeat |