ym88659208ym87991671
Запросы данных | Документация SmartMarket
Skip to main content

Запросы данных

Запросы данных выполняются с помощью ключевого слова query.

note

Список доступных запросов можно найти в разделе QUERIES, справочника DOCS.

query {
#Запрос возвращает массив elems со списком компаний
searchGiftVendor {
#Список полей, которые будет содержать ответ
elems {
#Идентификатор компании
id
name
}
}
}

Если вы работаете с несколькими запросами на одной вкладке редактора, после ключевого слова query следует указать название каждого из них.

query searchGiftVendor {
#Запрос возвращает массив elems со списком компаний
searchGiftVendor {
#Список полей, которые будет содержать ответ
elems {
#Идентификатор компании
id
name
}
}
}

С подробным описанием элемента "Запрос" схемы GraphQL можно ознакомиться в разделе Запрос статьи "Описание протокола GraphQL".


Подробное описание видов запросов приведено в разделе Виды запросов статьи "Описание протокола GraphQL".

Работа с историчными данными

При работе с историчными данными (когда для атрибута указан признак historical="true") возможны три вида запросов:

  • Запрос состояния на момент времени:

    query State {
    getStateVoucherSerie(
    id:"7067113783378706433"
    date: "2022-02-21T15:00:00Z"
    )
    {code}
    }
  • Запрос списка состояний:

    query States {
    getStatesVoucherSerie(
    id:"7067113783378706433"
    )
    {
    elems{
    code
    sysHistoryTime
    }
    }
    }
  • Запрос списка изменений:

    query History {
    getVoucherSerieHistory(
    id:"7067113783378706433"
    )
    {
    elems{
    code
    sysHistoryTime
    }
    }
    }

note

Под состоянием понимается получение значений для всех запрошенных историцируемых атрибутов, а под изменением понимается получение значений только для изменившихся в рамках транзакции историцируемых атрибутов.

Фильтрация результатов

Результаты запроса можно фильтровать.

Для этого опишите условия фильтрации в виде строки в параметре запроса cond.

query searchVouchers {
#Результат запроса будет содержать открытые ваучеры с кодом promo2
searchVoucher(cond: "it.code=='promo2' && it.statusForVoucherMain.code=='OPEN'") {
elems {
id
code
statusForVoucherMain{
code
name
}
gift{
entity{
type
vendor{
name
}
id
kind
}
}
serie {
id
startedAt
activeTo
}
}
}
}
Обновлено 20 апреля 2022

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней