Method: courses.courseWork.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Affiche la liste des travaux de cours que le demandeur est autorisé à consulter.
Les élèves ne peuvent voir que les PUBLISHED devoirs du cours. Les enseignants du cours et les administrateurs du domaine peuvent consulter tous les devoirs du cours.
Cette méthode renvoie les codes d'erreur suivants:
PERMISSION_DENIED si l'utilisateur à l'origine de la demande n'est pas autorisé à accéder au cours demandé ou en cas d'erreurs d'accès.INVALID_ARGUMENT si la requête est incorrecte.NOT_FOUND si le cours demandé n'existe pas.
Requête HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
courseId |
string
Identifiant du cours. Cet identifiant peut être l'identifiant attribué par Classroom ou un alias.
|
Paramètres de requête
| Paramètres |
courseWorkStates[] |
enum (CourseWorkState)
Restriction concernant l'état de la tâche à renvoyer. Seuls les cours correspondants sont renvoyés. Si ce paramètre n'est pas spécifié, les éléments dont l'état de travail est PUBLISHED sont renvoyés.
|
orderBy |
string
Ordre de tri facultatif pour les résultats. Liste de champs séparés par une virgule avec un mot clé de tri facultatif. Les champs compatibles sont updateTime et dueDate. Les mots clés de direction acceptés sont asc et desc. Si aucune valeur n'est spécifiée, updateTime desc est le comportement par défaut. Exemples: dueDate asc,updateTime desc, updateTime,dueDate desc
|
pageSize |
integer
Nombre maximal d'éléments à renvoyer. Une valeur nulle ou non spécifiée indique que le serveur peut attribuer une valeur maximale. Le serveur peut renvoyer un nombre inférieur au nombre de résultats spécifié.
|
pageToken |
string
Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée. La requête list doit être identique à celle qui a généré ce jeton.
|
previewVersion |
enum (PreviewVersion)
Facultatif. Version preview de l'API. Ce paramètre doit être défini pour accéder aux nouvelles fonctionnalités d'API mises à la disposition des développeurs dans le programme Preview.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse lors de la liste des travaux de cours.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"courseWork": [
{
object (CourseWork)
}
],
"nextPageToken": string
} |
| Champs |
courseWork[] |
object (CourseWork)
Éléments de travaux de cours correspondant à la requête.
|
nextPageToken |
string
Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, aucun autre résultat n'est disponible.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/classroom.coursework.students.readonly
https://www.googleapis.com/auth/classroom.coursework.me.readonly
https://www.googleapis.com/auth/classroom.coursework.students
https://www.googleapis.com/auth/classroom.coursework.me
Pour en savoir plus, consultez le guide d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: courses.courseWork.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCourseWorkResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseWorkStates[]` | `enum (`[CourseWorkState](/workspace/classroom/reference/rest/v1/courses.courseWork#CourseWorkState)`)` Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. |\n| `orderBy` | `string` Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.courseWork/list#body.ListCourseWorkResponse.FIELDS.next_page_token) value returned from a previous `list` call, indicating that the subsequent page of results should be returned. The `list` request must be otherwise identical to the one that resulted in this token. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The preview version of the API. This must be set in order to access new API capabilities made available to developers in the Preview Program. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing course work.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"courseWork\": [ { object (/workspace/classroom/reference/rest/v1/courses.courseWork#CourseWork) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseWork[]` | `object (`[CourseWork](/workspace/classroom/reference/rest/v1/courses.courseWork#CourseWork)`)` Course work items that match the request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.coursework.students.readonly`\n- `\n https://www.googleapis.com/auth/classroom.coursework.me.readonly`\n- `\n https://www.googleapis.com/auth/classroom.coursework.students`\n- `\n https://www.googleapis.com/auth/classroom.coursework.me`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
