RangeSort: apply

Пространство имен: microsoft.graph

Выполняет сортировку.

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Files.ReadWrite	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Files.ReadWrite	Недоступно.
Для приложений	Не поддерживается.	Не поддерживается.

HTTP-запрос

POST /me/drive/items/{id}/workbook/names/{name}/range/sort/apply
POST /me/drive/root:/{item-path}:/workbook/names/{name}/range/sort/apply
POST /me/drive/items/{id}/workbook/worksheets/{id|name}/range(address='<address>')/sort/apply
POST /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/range(address='<address>')/sort/apply
POST /me/drive/items/{id}/workbook/tables/{id|name}/columns/{id|name}/range/sort/apply
POST /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/range/sort/apply

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Workbook-Session-Id	Идентификатор сеанса работы с книгой, определяющий, сохраняются ли изменения. Необязательный параметр.

Текст запроса

В тексте запроса предоставьте JSON-объект с указанными ниже параметрами.

Параметр	Тип	Описание
fields	Коллекция WorkbookSortField	Список условий для сортировки.
matchCase	Boolean	Необязательное свойство. Определяется ли упорядочение строк в регистре.
hasHeaders	Boolean	Необязательное свойство. Указывает, есть ли у диапазона заголовок.
orientation	string	Необязательный параметр. Указывает направление сортировки: по строкам или по столбцам. Возможные значения: Rows, Columns.
метод	string	Необязательный параметр. Метод сортировки, используемый для китайских символов. Возможные значения: PinYin, StrokeCount.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK. Он не возвращает ничего в теле ответа.

Пример

Ниже приведен пример вызова этого API.

Запрос

Ниже показан пример запроса.

HTTP

POST https://graph.microsoft.com/v1.0/me/drive/items/{id}/workbook/names/{name}/range/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,
  "hasHeaders": true,
  "orientation": "orientation-value",
  "method": "method-value"
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const apply = {
  fields: [
    {
      key: 99,
      sortOn: 'sortOn-value',
      ascending: true,
      color: 'color-value',
      dataOption: 'dataOption-value',
      icon: {
        set: 'set-value',
        index: 99
      }
    }
  ],
  matchCase: true,
  hasHeaders: true,
  orientation: 'orientation-value',
  method: 'method-value'
};

await client.api('/me/drive/items/{id}/workbook/names/{name}/range/sort/apply')
	.post(apply);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже приводится пример отклика.

HTTP/1.1 200 OK