Download OpenAPI specification:
Сервис активностей и артефактов игр Берлоги.
Для передачи активности теперь обязательно нужно указывать версию приложения.
Если какие-то из указанных активностей не будут найдены, то они просто будут отсутствовать в ответе.
| ids required | Array of strings <uuid> [ 1 .. 50 ] items [ items <uuid > ] Идентификаторы активностей |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "context_id": "f31d7249-b7b1-4729-b3a4-ec0ba07b4686",
- "player_id": "f8b23bf6-c56d-4f96-b79c-96d80504663d",
- "app_version": "string",
- "scores": 0,
- "artefact_id": "string",
- "quarantine": "missing_artefact"
}
]Каждая из активностей опционально может иметь метрики и артефакт.
Запись активностей доступна в коротком и расширенном форматах.
Передается только массив активностей. Если они ссылаются на артефакты, эти артефакты должны быть предварительно загружены. Ответ на такой запрос тоже включает в себя только массив с активностями.
В этом формате передается объект, который должен содержать активности в массиве, аналогичном короткому формату, и опционально может включать в себя еще артефакты для создания. В ответе на такой запрос, аналогично, возвращается объект, содержащий те же ключи. В возвращаемом массиве артефактов будут ссылки, по которым эти артефакты должны быть загружены.
Ссылки имеют ограниченный срок жизни. Если данные артефакта не были загружены в рамках этого периода, то нужно запросить новую ссылку.
До тех пор, пока указанные в активности артефакты не будут загружены, эта активность с ее баллами не будет учитываться в прогрессе традиции игрока.
После загрузки данных артефакта по полученной ссылке, нужно подтвердить что загрузка завершена.
| X-Forwarded-For required | string |
| app_version required | string (ActivityAppVersion) Версия приложения, в которой была произведена активность. |
| context_id required | string <uuid> (ContextID) Идентификатор контекста активности. |
| artefact_id | string <uuid> (ArtefactID) Идентификатор артефакта. |
object [ 1 .. 30 ] properties |
[ ][ ]Обязательно указание либо tradition_id, либо context_ids; эти параметры взаимоисключающие.
| tradition_id | integer <int32> Идентификатор традиции |
| context_ids | Array of strings <uuid> (ContextID) [ 1 .. 50 ] items [ items <uuid > ] Список идентификаторов контекстов |
| player_ids | Array of strings <uuid> (PlayerID) [ 1 .. 50 ] items [ items <uuid > ] Список игроков, активности которых попадут в выборку. Параметр доступен только при использовании авторизации |
0Артефакт предварительно загружается для передачи его в активности.
| X-Artefact-Type required | integer <int32> ID типа артефакта из справочника. |
| X-Checksum required | string SHA-1 контрольная сумма |
| X-Forwarded-For required | string |
Содержимое артефакта. Поддерживаемые типы:
"497f6eca-6276-4993-bfeb-53cbbbba6f08"Ссылка для загрузки данных артефактом имеет ограниченный срок жизни. После его завершения, если данные артефакта еще не были успешно загружены, нужно запрашивать новую ссылку. Загрузку данных по ссылке нужно выполнять методом PUT.
| artefact_id required | string <uuid> (ArtefactID) Идентификатор артефакта. |
"string"При использовании аутентификации
TalentOAuthтребуется наличие у пользователя прав на выполнение этой операции.
Необходимо указать параметры выбора контекстов.
Это могут быть либо идентификаторы конкретных контекстов context_ids.
Либо набор фильтров context_property и/или ID приложения application_id.
| offset | integer <int32> Default: 0 |
| limit | integer <int32> <= 1000 Default: 100 |
| descend | boolean Default: false Сортировка результатов в обратном порядке, возвращая сначала самые новые активности. |
| application_id | string <uuid> ID приложения для фильтрации контекстов. |
| context_property | Array of strings [ 1 .. 3 ] items Свойства контекстов приложения.
Заполняются в формате имени и значения объединенных пробелом (кодируется как |
| context_ids | Array of strings <uuid> (ContextID) [ 1 .. 20 ] items [ items <uuid > ] Список идентификаторов контекстов. |
| since | string <date-time> |
| until | string <date-time> |
| player_ids | Array of strings <uuid> (PlayerID) [ 1 .. 50 ] items [ items <uuid > ] Список игроков, активности которых попадут в выборку. |
[- {
- "activity_id": "98dae057-958f-4b2f-9ed4-41f109afdc3f",
- "created_at": "2019-08-24T14:15:22Z",
- "player_id": "f8b23bf6-c56d-4f96-b79c-96d80504663d",
- "app_version": "string",
- "context_id": "f31d7249-b7b1-4729-b3a4-ec0ba07b4686",
- "context_description": "string",
- "artefact_id": "string",
- "metrics": {
- "property1": 0,
- "property2": 0
}
}
]Обязательно указание либо tradition_id, либо context_ids; эти параметры взаимоисключающие.
| tradition_id | integer <int32> Идентификатор традиции |
| context_ids | Array of strings <uuid> (ContextID) [ 1 .. 50 ] items [ items <uuid > ] Список идентификаторов контекстов |
| player_ids | Array of strings <uuid> (PlayerID) [ 1 .. 50 ] items [ items <uuid > ] Список игроков, активности которых попадут в выборку. Параметр доступен только при использовании авторизации |
0| activity_id required | string <uuid> (ActivityID) Идентификатор активности. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "context_id": "f31d7249-b7b1-4729-b3a4-ec0ba07b4686",
- "player_id": "f8b23bf6-c56d-4f96-b79c-96d80504663d",
- "app_version": "string",
- "scores": 0,
- "artefact_id": "string",
- "quarantine": "missing_artefact",
- "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
- "tradition_id": 0,
- "context_properties": {
- "property1": {
- "value_string": "string",
- "value_number": 0
}, - "property2": {
- "value_string": "string",
- "value_number": 0
}
}, - "metrics": {
- "property1": 0,
- "property2": 0
}
}| offset | integer <int32> Default: 0 |
| limit | integer <int32> <= 100 Default: 20 |
| id | Array of strings <uuid> [ items <uuid > ] Фильтрация по ID контекстов. |
| t_id | Array of integers <int32> [ items <int32 > ] Фильтрация по ID традиций. |
| app_id | Array of strings <uuid> [ items <uuid > ] Фильтрация по ID приложения. |
| desc | string Фильтрация по вхождению подстроки в описание контекста. |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
- "tradition_id": 0,
- "activity_type_id": 0,
- "description": "string"
}
]Идентификаторы контекстов выбранные по тому же принципу что и в ActivitiesMetricsList.
Обязательно указание либо application_id, либо property. Допускаются оба параметра.
| application_id | string <uuid> Фильтрация по ID приложения. |
| property | Array of strings [ 1 .. 5 ] items Фильтрация контекстов по свойствам. Свойство и его значение разделяются пробелом ( |
[- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]Импортируемая таблица должна содержать колонки id и description.
Содержащие в ячейках идентификатор (UUID) и описание контекста соответственно.
Оставшиеся колонки таблицы будут восприняты как свойства контекстов. Тип значения для свойства определяется на основе значений в ячейках колонки. Если все значения можно интерпретировать как числовые, то тип значения у свойства будет числовой. Если хоть одно значение не приводится к числу, то тип значения определяется как строковый.
В заголовках запроса так же необходимо указать ID приложения с контекстами которого будет выполнятся работа.
| X-Application required | string <uuid> ID приложения, для которого импортируются контексты. |
Таблица контекстов для импорта.
{- "error_message": "string"
}