title	description	author	ms.localizationpriority	ms.subservice	doc_type
TableSort: apply	Perform a sort operation.	lumine2008	medium	excel	apiPageType

TableSort: apply

Namespace: microsoft.graph

Perform a sort operation.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

POST /me/drive/items/{id}/workbook/tables/{id|name}/sort/apply
POST /me/drive/root:/{item-path}:/workbook/tables/{id|name}/sort/apply
POST /me/drive/items/{id}/workbook/worksheets/{id|name}/tables/{id|name}/sort/apply
POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/tables/{id|name}/sort/apply

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Workbook-Session-Id	Workbook session Id that determines if changes are persisted or not. Optional.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter	Type	Description
fields	WorkbookSortField collection	The list of conditions to sort on.
matchCase	boolean	Optional. Whether to have the casing impact string ordering.
method	string	Optional. The ordering method used for Chinese characters. The possible values are: `PinYin`, `StrokeCount`.

Response

If successful, this method returns 200 OK response code. It doesn't return anything in the response body.

Example

Here is an example of how to call this API.

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/tables/{id|name}/sort/apply
Content-type: application/json

{
  "fields": [
    {
      "key": 99,
      "sortOn": "sortOn-value",
      "ascending": true,
      "color": "color-value",
      "dataOption": "dataOption-value",
      "icon": {
        "set": "set-value",
        "index": 99
      }
    }
  ],
  "matchCase": true,
  "method": "method-value"
}