Перейти к содержанию

title: "Общедоступные" summary: | Эндпоинты для просмотра общедоступных карточек и дашбордов. redirect_from: - /ru/docs/latest/api/public

Общедоступные

Эндпоинты для просмотра общедоступных карточек и дашбордов.

GET /api/public/action/:uuid

Получить общедоступное Действие. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid допустимый UUID.

GET /api/public/card/:uuid

Получить общедоступную карту с результатами запроса, а также с информацией о :card. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid допустимый UUID.

GET /api/public/card/:uuid/field/:field-id/remapping/:remapped-id

Получить переопределённые значения полей. То же самое, что GET /api/field/:id/remapping/:remapped-id, но только для публичных карточек.

Параметры:

  • uuid допустимый UUID.

  • field-id целое число больше нуля.

  • remapped-id целое число больше нуля.

  • value непустая строка.

GET /api/public/card/:uuid/field/:field-id/search/:search-field-id

Поиск значений поля, на которое ссылается общедоступная карточка.

Параметры:

  • uuid допустимый UUID.

  • field-id целое число больше нуля.

  • search-field-id целое число больше нуля.

  • value значение должно быть не пустой строкой.

  • limit целое число больше нуля или null.

GET /api/public/card/:uuid/field/:field-id/values

Получить значения поля FieldValues для поля, которое ссылается на публичную карточку.

Параметры:

  • uuid допустимый UUID.

  • field-id непустая строка.

GET /api/public/card/:uuid/query

Получить общедоступную карточку с результатами запроса, а также с информацией :card. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid допустимый UUID.

  • parameters допустимая строка JSON или null.

  • format_rows булевое значение или null.

  • pivot_results булевое значение или null.

GET /api/public/card/:uuid/query/:export-format

Получить общедоступную карточку и вернуть результаты запроса в указанном формате. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid допустимый UUID.

  • export-format значение должно быть одним из: csv, api, xlsx, json.

  • parameters допустимая строка JSON или null.

  • format_rows допустимая булевая строка ('true' или 'false') или null.

  • pivot_results допустимая булевая строка ('true' или 'false') или null.

GET /api/public/dashboard/:uuid

Получить общедоступный дашборд. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid допустимый UUID.

GET /api/public/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id

Получить результаты для карточки в общедоступном дашборде. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid

  • card-id

  • dashcard-id

  • parameters допустимая строка JSON или null.

POST /api/public/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id/:export-format

Получить результаты запуска общедоступной Карточки, принадлежащей Дашборду, и вернуть данные в одном из форматов экспорта. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid допустимый UUID.

  • card-id целое число больше нуля.

  • dashcard-id целое число больше нуля.

  • parameters допустимая строка JSON или null.

  • export-format значение должно быть одним из: csv, api, xlsx, json.

  • format_rows допустимая булевая строка ('true' или 'false') или null.

  • pivot_results допустимая булевая строка ('true' или 'false') или null.

GET /api/public/dashboard/:uuid/field/:field-id/remapping/:remapped-id

Получить переопределённые значения полей. То же самое, что GET /api/field/:id/remapping/:remapped-id, но используется только для публичных дашбордов.

Параметры:

  • uuid допустимый UUID.

  • field-id целое число больше нуля.

  • remapped-id целое число больше нуля.

  • value значение должно быть не пустой строкой.

GET /api/public/dashboard/:uuid/field/:field-id/search/:search-field-id

Найти значения поля, на которое ссылается карточка, на общедоступном дашборде.

Параметры:

  • uuid допустимый UUID.

  • field-id целое число больше нуля.

  • search-field-id целое число больше нуля.

  • value непустая строка.

  • limit целое число больше нуля или null.

GET /api/public/dashboard/:uuid/field/:field-id/values

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

Параметры:

  • uuid

  • field-id

GET /api/public/dashboard/:uuid/Параметры/:param-key/search/:query

Получить значения фильтра для параметра param-key дашборда, содержащего указанный query.

Параметры:

  • uuid

  • param-key

  • query

  • query-Параметры

GET /api/public/dashboard/:uuid/Параметры/:param-key/values

Получить значения фильтра для параметра дашборда param-key.

Параметры:

  • uuid допустимый UUID.

  • param-key непустая строка.

  • constraint-param-key->value

GET /api/public/oembed

Метод, используемый для извлечения кода внедрения и метаданных для (общедоступного) URL GlarusBI.

Параметры:

  • url значение должно быть не пустой строкой.

  • format один из json или null.

  • maxheight допустимое целое число или null.

  • maxwidth допустимое целое число или null.

GET /api/public/pivot/card/:uuid/query

Получить общедоступную карточку с результатами запроса, а также с информацией :card. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid допустимый UUID.

  • parameters допустимая строка JSON или null.

GET /api/public/pivot/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id

Получить результаты для карточки в общедоступном дашборде. Не требует авторизации. Общий доступ должен быть включен.

Параметры:

  • uuid

  • card-id

  • dashcard-id

  • parameters допустимая строка JSON или null.

POST /api/public/dashboard/:uuid/dashcard/:dashcard-id/execute

Выполнить связанное Действие в контексте Дашборда и Карточки дашборда, которая его включает.

Параметры:

  • uuid допустимый UUID.

  • dashcard-id целое число больше нуля.

  • parameters карта от <ключевое слово> к <любое значение> или null.

  • _body

<< Назад к разделу API