Получение списка карт

Процесс получения списка карт (проектов) аналогичен получению списка слоёв и таблиц. Для того, чтобы получить список доступных пользователю карт, необходимо выполнить GET-запрос с указанием параметров в строке URL:

GET {host}/projects

URL-параметры запроса:

  • filter - текстовый фильтр для поиска карт. Осуществляет поиск по системным именам и псевдонимам (alias);
    • Если перед текстом указать символ ^, будут возвращены карты, названия или псевдонимы которых начинаются с введённой строки;
    • Если перед текстом указать символ @, будут возвращены карты, названия или псевдонимы которых содержат введённую строку;
  • offset - количество первых записей, которые нужно скрыть из выдачи;
  • limit - максимальное количество описаний карт, которое будет возвращено. По умолчанию - 20;
  • group - фильтровать карты по типу доступа:
    • my - карты, принадлежащие текущему пользователю (по умолчанию);
    • role - карты других пользователей, доступные текущему пользователю.
    • public - карты в публичном доступе;
    • all - все типы;
  • names - список системных имён карт, информацию о которых необходимо получить. Список указывается через разделитель ,;
  • orderByField - значения, по которым необходимо отсортировать поисковую выдачу. Если перед названием переменной указать -, сортировка будет произведена в порядке убывания. Несколько переменных могут быть указаны с разделителем ,. Переменные для сортировки:
    • alias - сортировать по псевдониму;
    • changedDate - по дате и времени последнего изменения;
  • geometryFilter - фильтр карт по типу геометрии. Несколько типов можно указать с разделителем ,.

Если оставить все параметры запроса пустыми, то будет возвращён полный список доступных карт с учётом значений параметров по умолчанию. То есть, будут возвращены описания первых 20 карт, принадлежащих пользователю.

Пример

Получим список карт, принадлежащих текущему пользователю:

GET https://evergis.ru/sp/projects?group=my
Просмотреть ответ сервера
{
    "items": [
        {
            "layersCount": 3,
            "name": "username.t3r95mnrq4ze",
            "alias": "Демонстрационные данные",
            "owner": "username",
            "description": "",
            "preview": null,
            "createdDate": "2022-11-10T14:26:29.198612Z",
            "changedDate": "2023-11-20T18:30:12.080109Z",
            "permissions": "read,write,configure",
            "acl": {
                "data": [
                    {
                        "role": "__username",
                        "permissions": "read,write,configure"
                    }
                ]
            },
            "icon": null,
            "invisibleInCatalog": false
        },
        {
            "layersCount": 3,
            "name": "username.ev127jjjp799",
            "alias": "API TEST",
            "owner": "username",
            "description": "",
            "preview": null,
            "createdDate": "2023-11-28T20:34:02.313738Z",
            "changedDate": "2023-12-18T15:07:36.777624Z",
            "permissions": "read,write,configure",
            "acl": {
                "data": [
                    {
                        "role": "__username",
                        "permissions": "read,write,configure"
                    }
                ]
            },
            "icon": null,
            "invisibleInCatalog": false
        }
    ],
    "totalCount": 2,
    "offset": 0,
    "limit": 20
}