/datamarts/{datamart}/entities/{entity}

Содержание раздела
  1. URL
  2. Заголовки запроса
  3. Тело запроса
  4. Примеры CURL-запросов
    1. Запрос без авторизационного токена
    2. Запрос с авторизационным токеном

GET-метод возвращает метаданные логической сущности {entity}.

URL

{baseUrl}/api/v1/datamarts/{datamart}/entities/{entity}

Параметры:

  • baseUrl — путь для подключения к серверу ноды Prostore (IP-адрес или доменное имя и номер порта);
  • datamart — имя логической базы данных, которой принадлежит логическая сущность;
  • entity — имя логической сущности, по которой запрашивается информация.

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

Поддерживаются следующие типы заголовков:

  • x-request-id (опциональный) — задает уникальный идентификатор HTTP-запроса. Если не указан, система генерирует UUID-значение и возвращает его в качестве идентификатора в ответе;
  • Authorization (опциональный) — задает тип аутентификации и авторизационный токен (JWT). Возможное значение типа аутентификации — Bearer.

Подробнее об аутентификации запросов см. в разделе Аутентификация.

Тело запроса

Тело запроса отсутствует.

Примеры CURL-запросов

Запрос без авторизационного токена 

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/marketing/entities/sales' \
  -H 'x-request-id: 3b8360c5-6c62-4a96-acf8-7a3724292ea5'

Запрос с авторизационным токеном 

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/marketing/entities/sales' \
  -H 'x-request-id: 3b8360c5-6c62-4a96-acf8-7a3724292ea5' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'