Merge pull request #24842 from microsoftgraph/v-rmanda/201594/update_supported_properties_information_for_

Lauragra · web-flow · commit 00678d0928ba · 2024-08-29T17:47:48.000-07:00
v-rmanda/201594/update_supported_properties_information_for_$orderby
diff --git a/api-reference/beta/api/educationassignment-get.md b/api-reference/beta/api/educationassignment-get.md
@@ -33,7 +33,9 @@ Choose the permission or permissions marked as least privileged for this API. Us
 GET /education/classes/{id}/assignments/{id}
 ```
 ## Optional query parameters
-This method supports the `$select` and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports the `$select`, `$orderby`, and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+You can use `$orderby` with the following properties of the [educationAssignment](../resources/educationassignment.md) resource: **assignDateTime**, **assignedDateTime**, **closeDateTime**, **createdDateTime**, **displayName**, **dueDateTime**, **lastModifiedDateTime**, **moduleUrl**, and **status**.
 
 The following `$expand` options are available for this method: `categories`, `resources`, `rubric`, `submissions`, `gradingScheme`, `gradingCategory`, and `*`. `*` specifies all the previous options.
 
diff --git a/api-reference/beta/api/educationcategory-get.md b/api-reference/beta/api/educationcategory-get.md
@@ -33,7 +33,9 @@ GET /education/classes/{id}/assignmentCategories/{id}
 
 ## Optional query parameters
 
-This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports the `$select` and `$orderby` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+You can use `$orderby` with the **displayName** property of the [educationCategory](../resources/educationcategory.md) resource.
 
 ## Request headers
 | Header        | Value                     |
diff --git a/api-reference/beta/api/educationsubmission-get.md b/api-reference/beta/api/educationsubmission-get.md
@@ -39,7 +39,9 @@ GET /education/classes/{class-id}/assignments/{assignment-id}/submissions/{submi
 
 ## Optional query parameters
 
-This method supports the `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports the `$select` and `$orderby` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+You can use `$orderby` with the following properties of the [educationSubmission](../resources/educationsubmission.md) resource: **excusedDateTime**, **reassignedDateTime**, **returnedDateTime**, **status**, **submittedDateTime**, and **unsubmittedDateTime**.
 
 ## Request headers
 | Header       | Value |
diff --git a/api-reference/beta/api/educationsubmission-reassign.md b/api-reference/beta/api/educationsubmission-reassign.md
@@ -102,6 +102,7 @@ The following is an example of the response when `Prefer: include-unknown-enum-m
 
 <!-- {
   "blockType": "response",
+  "truncated": true,
   "@odata.type": "microsoft.graph.educationSubmission"
 } -->
 ```http
@@ -213,7 +214,8 @@ Prefer: include-unknown-enum-members
 The following is an example of the response when `Prefer: include-unknown-enum-members` is provided in the request header and the submission hasn't been returned before.
 
 <!-- {
-  "blockType": "response",
+  "blockType": "response",  
+  "truncated": true,
   "@odata.type": "microsoft.graph.educationSubmission"
 } -->
 ```http
diff --git a/api-reference/beta/api/educationuser-list-assignments.md b/api-reference/beta/api/educationuser-list-assignments.md
@@ -45,7 +45,9 @@ This method supports the `$top`, `$filter`, `$orderby`, and `$select` OData quer
 
 The following `$expand` options are available for this method: `categories`, `resources`, `gradingCategory`, `rubric`, `submissions`, and `*`, which includes all the previous options.
 
-All [properties](../resources/educationassignment.md#properties) are supported for the query parameters `$filter` and `$orderby`.
+All [properties](../resources/educationassignment.md#properties) are supported by the `$filter` query parameter.
+
+You can use `$orderby` with the following properties of the [educationAssignment](../resources/educationassignment.md) resource: **assignDateTime**, **assignedDateTime**, **closeDateTime**, **createdDateTime**, **displayName**, **dueDateTime**, **lastModifiedDateTime**, and **status**.
 
 ## Request headers
 
diff --git a/api-reference/beta/resources/educationsubmission.md b/api-reference/beta/resources/educationsubmission.md
@@ -40,18 +40,20 @@ If [setUpResourcesFolder](../api/educationsubmission-setupResourcesFolder.md) ha
 ## Properties
 | Property	   | Type	|Description|
 |:---------------|:--------|:----------|
+|excusedBy|[identitySet](identityset.md)|The user that marked the submission as excused.|
+|excusedDateTime|DateTimeOffset|Moment in time when the submission was moved to the excused state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
 |id|String|Unique identifier for the submission.|
+|reassignedBy|[identitySet](identityset.md)|User who moved the status of this submission to reassigned.|
+|reassignedDateTime|DateTimeOffset|Moment in time when the submission was reassigned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
 |recipient|[educationSubmissionRecipient](educationsubmissionrecipient.md)|Who this submission is assigned to.|
+|resourcesFolderUrl|String|Folder where all file resources for this submission need to be stored.|
 |returnedBy|[identitySet](identityset.md)|User who moved the status of this submission to returned.|
 |returnedDateTime|DateTimeOffset|Moment in time when the submission was returned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
-|resourcesFolderUrl|String|Folder where all file resources for this submission need to be stored.|
 |status|educationSubmissionStatus| Read-only. Possible values are: `working`, `submitted`, `returned`, `unknownFutureValue`, `reassigned`, and `excused`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `reassigned`, and `excused`.|
 |submittedBy|[identitySet](identityset.md)|User who moved the resource into the submitted state.|
 |submittedDateTime|DateTimeOffset|Moment in time when the submission was moved into the submitted state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
 |unsubmittedBy|[identitySet](identityset.md)|User who moved the resource from submitted into the working state.|
 |unsubmittedDateTime|DateTimeOffset|Moment in time when the submission was moved from submitted into the working state. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
-|reassignedBy|[identitySet](identityset.md)|User who moved the status of this submission to reassigned.|
-|reassignedDateTime|DateTimeOffset|Moment in time when the submission was reassigned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
 |webUrl|String| The deep link URL for the given submission.|
 
 ## Relationships
@@ -76,6 +78,8 @@ The following JSON representation shows the resource type.
 
 ```json
 {
+  "excusedBy": {"@odata.type":"microsoft.graph.identitySet"},
+  "excusedDateTime": "String (timestamp)", 
   "id": "String (identifier)",
   "reassignedBy": {"@odata.type":"microsoft.graph.identitySet"},
   "reassignedDateTime": "String (timestamp)",
diff --git a/api-reference/v1.0/api/educationassignment-get.md b/api-reference/v1.0/api/educationassignment-get.md
@@ -33,7 +33,9 @@ GET /education/classes/{id}/assignments/{id}
 ```
 
 ## Optional query parameters
-This method supports the `$select` and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports the `$select`, `$orderby`, and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+You can use `$orderby` with the following properties of the [educationAssignment](../resources/educationassignment.md) resource: **assignDateTime**, **assignedDateTime**, **closeDateTime**, **createdDateTime**, **displayName**, **dueDateTime**, **lastModifiedDateTime**, **moduleUrl**, and **status**.
 
 You can use `$expand` with the following navigation properties of the [educationAssignment](../resources/educationassignment.md) resource: **categories**, **resources**, **rubric**, **submissions**, and **gradingCategory**. You can also use `*` to specify all the navigation properties.
 
diff --git a/api-reference/v1.0/api/educationcategory-get.md b/api-reference/v1.0/api/educationcategory-get.md
@@ -31,7 +31,9 @@ GET /education/classes/{id}/assignmentCategories/{id}
 
 ## Optional query parameters
 
-This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports the `$select` and `$orderby` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+You can use `$orderby` with the **displayName** property of the [educationCategory](../resources/educationcategory.md) resource.
 
 ## Request headers
 | Header        | Value                     |
diff --git a/api-reference/v1.0/api/educationsubmission-get.md b/api-reference/v1.0/api/educationsubmission-get.md
@@ -35,7 +35,9 @@ GET /education/classes/{class-id}/assignments/{assignment-id}/submissions/{submi
 
 ## Optional query parameters
 
-This method supports the `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+This method supports the `$select` and `$orderby` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
+
+You can use `$orderby` with the following properties of the [educationSubmission](../resources/educationsubmission.md) resource: **excusedDateTime**, **reassignedDateTime**, **returnedDateTime**, **status**, **submittedDateTime**, and **unsubmittedDateTime**.
 
 ## Request headers
 | Header       | Value |
diff --git a/api-reference/v1.0/api/educationsubmission-reassign.md b/api-reference/v1.0/api/educationsubmission-reassign.md
@@ -100,7 +100,8 @@ POST https://graph.microsoft.com/v1.0/education/classes/37d99af7-cfc5-4e3b-8566-
 The following is an example of the response when `Prefer: include-unknown-enum-members` isn't provided in the request header and the submission hasn't been returned before.
 
 <!-- {
-  "blockType": "response",
+  "blockType": "response",  
+  "truncated": true,
   "@odata.type": "microsoft.graph.educationSubmission"
 } -->
 ```http
@@ -214,6 +215,7 @@ The following is an example of the response when `Prefer: include-unknown-enum-m
 
 <!-- {
   "blockType": "response",
+  "truncated": true,
   "@odata.type": "microsoft.graph.educationSubmission"
 } -->
 ```http
diff --git a/api-reference/v1.0/api/educationuser-list-assignments.md b/api-reference/v1.0/api/educationuser-list-assignments.md
@@ -42,7 +42,9 @@ GET /education/users/{user-id}/assignments
 
 This method supports the `$top`, `$filter`, `$orderby`, and `$select` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
 
-All [properties](../resources/educationassignment.md#properties) are supported for the query parameters `$filter` and `$orderby`.
+All [properties](../resources/educationassignment.md#properties) are supported by the `$filter` query parameter.
+
+You can use `$orderby` with the following properties of the [educationAssignment](../resources/educationassignment.md) resource: **assignDateTime**, **assignedDateTime**, **closeDateTime**, **createdDateTime**, **displayName**, **dueDateTime**, **lastModifiedDateTime**, and **status**.
 
 ## Request headers
 
diff --git a/api-reference/v1.0/resources/educationsubmission.md b/api-reference/v1.0/resources/educationsubmission.md
@@ -38,9 +38,9 @@ If [setUpResourcesFolder](../api/educationsubmission-setupResourcesFolder.md) ha
 ## Properties
 | Property	   | Type	|Description|
 |:---------------|:--------|:----------|
-|id|String|Unique identifier for the submission.|
 |excusedBy|[identitySet](identityset.md)| The user that marked the submission as excused.|
 |excusedDateTime|DateTimeOffset|The time that the submission was excused. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
+|id|String|Unique identifier for the submission.|
 |reassignedBy|[identitySet](identityset.md)|User who moved the status of this submission to reassigned.|
 |reassignedDateTime|DateTimeOffset|Moment in time when the submission was reassigned. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
 |recipient|[educationSubmissionRecipient](educationsubmissionrecipient.md)|Who this submission is assigned to.|
@@ -77,6 +77,8 @@ The following JSON representation shows the resource type.
 
 ```json
 {
+  "excusedBy": {"@odata.type":"microsoft.graph.identitySet"},
+  "excusedDateTime": "String (timestamp)",
   "id": "String (identifier)",
   "reassignedBy": {"@odata.type":"microsoft.graph.identitySet"},
   "reassignedDateTime": "String (timestamp)",
diff --git a/changelog/Microsoft.EducationAssignment.json b/changelog/Microsoft.EducationAssignment.json
@@ -2287,6 +2287,90 @@
       "CreatedDateTime": "2024-03-20T17:22:42.5007887Z",
       "WorkloadArea": "Education",
       "SubArea": "Assignment"
-    }    
+    },
+    {
+      "ChangeList": [
+        {
+          "Id": "b249ed76-039f-4c37-a0b4-946cfcc15d5b",
+          "ApiChange": "Parameter",
+          "ChangedApiName": "GET",
+          "ChangeType": "Addition",
+          "Description": "Enabled the `$orderby` query parameter for the [Get educationAssignment](https://learn.microsoft.com/en-us/graph/api/educationassignment-get?view=graph-rest-beta) method.",
+          "Target": "educationAssignment"
+        },
+        {
+          "Id": "b249ed76-039f-4c37-a0b4-946cfcc15d5b",
+          "ApiChange": "Parameter",
+          "ChangedApiName": "GET",
+          "ChangeType": "Addition",
+          "Description": "Enabled the `$orderby` query parameter for the [Get educationCategory](https://learn.microsoft.com/en-us/graph/api/educationcategory-get?view=graph-rest-beta) method.",
+          "Target": "educationCategory"
+        },
+        {
+          "Id": "b249ed76-039f-4c37-a0b4-946cfcc15d5b",
+          "ApiChange": "Parameter",
+          "ChangedApiName": "GET",
+          "ChangeType": "Addition",
+          "Description": "Enabled the `$orderby` query parameter for the [Get educationSubmission](https://learn.microsoft.com/en-us/graph/api/educationsubmission-get?view=graph-rest-beta) method.",
+          "Target": "educationSubmission"
+        },
+        {
+          "Id": "b249ed76-039f-4c37-a0b4-946cfcc15d5b",
+          "ApiChange": "Parameter",
+          "ChangedApiName": "LIST",
+          "ChangeType": "Change",
+          "Description": "Reduced support for the `$orderby` query parameter in the [List assignments of a user](https://learn.microsoft.com/en-us/graph/api/educationuser-list-assignments?view=graph-rest-beta) method to a subset of the properties in the [educationAssignment](https://learn.microsoft.com/en-us/graph/api/resources/educationAssignment?view=graph-rest-beta) resource.",
+          "Target": "educationAssignment"
+        }
+      ],
+      "Id": "b249ed76-039f-4c37-a0b4-946cfcc15d5b",
+      "Cloud": "Prod",
+      "Version": "beta",
+      "CreatedDateTime": "2024-08-29T17:22:42.5007887Z",
+      "WorkloadArea": "Education",
+      "SubArea": ""
+    },
+    {
+      "ChangeList": [
+        {
+          "Id": "c20a06da-3621-4338-a6a0-da64f35c5103",
+          "ApiChange": "Parameter",
+          "ChangedApiName": "GET",
+          "ChangeType": "Addition",
+          "Description": "Enabled the `$orderby` query parameter for the [Get educationAssignment](https://learn.microsoft.com/en-us/graph/api/educationassignment-get?view=graph-rest-1.0) method.",
+          "Target": "educationAssignment"
+        },
+        {
+          "Id": "c20a06da-3621-4338-a6a0-da64f35c5103",
+          "ApiChange": "Parameter",
+          "ChangedApiName": "GET",
+          "ChangeType": "Addition",
+          "Description": "Enabled the `$orderby` query parameter for the [Get educationCategory](https://learn.microsoft.com/en-us/graph/api/educationcategory-get?view=graph-rest-1.0) method.",
+          "Target": "educationCategory"
+        },
+        {
+          "Id": "c20a06da-3621-4338-a6a0-da64f35c5103",
+          "ApiChange": "Parameter",
+          "ChangedApiName": "GET",
+          "ChangeType": "Addition",
+          "Description": "Enabled the `$orderby` query parameter for the [Get educationSubmission](https://learn.microsoft.com/en-us/graph/api/educationsubmission-get?view=graph-rest-1.0) method.",
+          "Target": "educationSubmission"
+        },
+        {
+          "Id": "c20a06da-3621-4338-a6a0-da64f35c5103",
+          "ApiChange": "Parameter",
+          "ChangedApiName": "LIST",
+          "ChangeType": "Change",
+          "Description": "Reduced support for the `$orderby` query parameter in the [List assignments of a user](https://learn.microsoft.com/en-us/graph/api/educationuser-list-assignments?view=graph-rest-1.0) method to a subset of the properties in the [educationAssignment](https://learn.microsoft.com/en-us/graph/api/resources/educationAssignment?view=graph-rest-1.0) resource.",
+          "Target": "educationAssignment"
+        }
+      ],
+      "Id": "c20a06da-3621-4338-a6a0-da64f35c5103",
+      "Cloud": "Prod",
+      "Version": "v1.0",
+      "CreatedDateTime": "2024-08-29T17:22:42.5007887Z",
+      "WorkloadArea": "Education",
+      "SubArea": ""
+    }
   ]
 }
diff --git a/concepts/whats-new-overview.md b/concepts/whats-new-overview.md
@@ -18,6 +18,14 @@ For details about previous updates to Microsoft Graph, see [Microsoft Graph what
 
 ## August 2024: New and generally available
 
+### Education
+
+- Enabled the `$orderby` query parameter for the following methods:
+  - [Get educationAssignment](/graph/api/educationassignment-get)
+  - [Get educationCategory](/graph/api/educationcategory-get)
+  - [Get educationSubmission](/graph/api/educationsubmission-get)
+- Reduced support for the `$orderby` query parameter in the [List assignments of a user](/graph/api/educationuser-list-assignments) method to a subset of the properties in the [educationAssignment](/graph/api/resources/educationassignment) resource.  
+
 ### Employee experience | Employee engagement
 
 Introduced the general availability of the Viva Engage API in Microsoft Graph. A Viva Engage community is a central place for conversations, files, events, and updates for people sharing a common interest or goal. Use the Viva Engage API for the following scenarios:
@@ -57,6 +65,14 @@ Enabled the `Spain` and `Mexico` values as supported regions for the **region**
 - Use the **crossRegionDisasterRecoverySetting** property on [cloudPcUserSetting](/graph/api/resources/cloudpcusersetting?view=graph-rest-beta&preserve-view=true) to define cross-region disaster recovery settings.
 - Deprecated the `noLicensesAvailable` member on [frontlineCloudPcAccessState](/graph/api/resources/cloudpc?view=graph-rest-beta&preserve-view=true#frontlinecloudpcaccessstate-values).
 
+### Education
+
+- Enabled the `$orderby` query parameter for the following methods:
+  - [Get educationAssignment](/graph/api/educationassignment-get?view=graph-rest-beta&preserve-view=true)
+  - [Get educationCategory](/graph/api/educationcategory-get?view=graph-rest-beta&preserve-view=true)
+  - [Get educationSubmission](/graph/api/educationsubmission-get?view=graph-rest-beta&preserve-view=true)
+- Reduced support for the `$orderby` query parameter in the [List assignments of a user](/graph/api/educationuser-list-assignments?view=graph-rest-beta&preserve-view=true) method to a subset of the properties in the [educationAssignment](/graph/api/resources/educationassignment?view=graph-rest-beta&preserve-view=true) resource. 
+
 ### Teamwork and communications | Calls and online meetings
 
 - Use the **settings** property on [virtualEventTownhall](/graph/api/resources/virtualeventtownhall?view=graph-rest-beta&preserve-view=true) and [virtualEventWebinar](/graph/api/resources/virtualeventwebinar?view=graph-rest-beta&preserve-view=true) to get or set whether attendees receive email notifications for a town hall or webinar.
