Get GClassroomCourseWork

Get-GClassroomCourseWork

SYNOPSIS

Returns one or more course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors.

• `INVALID_ARGUMENT` if the request is malformed.
• `NOT_FOUND` if the requested course or course work does not exist.

SYNTAX

one (Default)

Get-GClassroomCourseWork [-CourseId] <String> [-Id] <String> [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

list

Get-GClassroomCourseWork [-CourseId] <String> [[-CourseWorkStates] <CourseWorkStatesEnum>]
 [[-OrderBy] <String>] [[-PageSize] <Int32>] [-All] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Returns one or more course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors.

• `INVALID_ARGUMENT` if the request is malformed.
• `NOT_FOUND` if the requested course or course work does not exist.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Get-GClassroomCourseWork -CourseId $SomeCourseIdString -Id $SomeIdString

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

---------- EXAMPLE 2 ----------

PS C:\> Get-GClassroomCourseWork -CourseId $SomeCourseIdString -All

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-CourseId

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Id

Identifier of the course work.

Type: String
Parameter Sets: one
Aliases: 

Required: True
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CourseWorkStates

Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.

Possible values: COURSEWORKSTATEUNSPECIFIED, PUBLISHED, DRAFT, DELETED

Type: CourseWorkStatesEnum
Parameter Sets: list
Aliases: 
Accepted values: COURSEWORKSTATEUNSPECIFIED, PUBLISHED, DRAFT, DELETED

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OrderBy

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`

Type: String
Parameter Sets: list
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PageSize

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.

Type: Int32
Parameter Sets: list
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-All

A switch to list all results.

Type: SwitchParameter
Parameter Sets: list
Aliases: 

Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

System.String

Identifier of the course work.

Google.Apis.Classroom.v1.CoursesResource+CourseWorkResource+ListRequest+CourseWorkStatesEnum

Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.

System.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`

System.Int32

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.

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Classroom API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]