Фильтры событий
ВНИМАНИЕ!
Все описанные ниже запросы доступны по ссылке http://$DOMAIN/event-service/graphql.
Создать фильтр событий
Запрос createEventFilters()
позволяет создать фильтр событий.
Входные параметры:
- eventFiltersInput: EventFiltersInput!:
- in: ConditionFields!: // Условие фильтрации:
- cameraIds
- По списку идентификаторов камер
- Тип данных: List[ID]
- agentIds
- По списку идентификаторов агентов
- Тип данных: List[ID]
- profileGroupIds
- По списку идентификаторов списков наблюдения
- Тип данных: List[ID]
- eventTypes
- По списку типов событий
- Тип данных: List[String]
- cameraIds
- in: ConditionFields!: // Условие фильтрации:
- name
- Имя фильтра событий
- Тип данных: String
- endpointIds
- Список идентификаторов эндпоинтов
- Тип данных: List[ID]
Выходные параметры:
- id
- Идентификатор фильтра событий
- Тип данных: ID
- creationDate
- Дата создания фильтра событий
- Формат данных: Дата и время в формате ISO.
- lastModified
- Дата последнего изменения фильтра событий
- Формат данных: Дата и время в формате ISO.
- meta
- Метаданные фильтра событий
- Тип данных: JSON
- name
- Имя фильтра событий
- Тип данных: String
- workspaceId
- Идентификатор воркспейса
- Тип данных: ID
- endpoints
- Список прикрепленных эндпоинтов
- Тип данных: EndpointOutput
Пример запроса:
mutation {
createEventFilters(
eventFiltersInput: {
in: {
profileGroupIds: ["06119cec-b17c-4e07-8db8-70478e8302f9"],
eventTypes: ["identification"],
cameraIds: ["9a607355-848a-42dc-9d6e-9982f5121a92"],
agentIds: ["e24c9d1e-f0bb-468d-9e25-6d7d8ce92514"]
}
}
name: "MyEventFilters"
endpointIds: ["357fe643-2396-4919-bd9e-a30f0ac28818", "52c6548d-3e17-4b9b-9268-ce51d6900530"]
) {
id
lastModified
meta
name
workspaceId
creationDate
endpoints {
creationDate
id
lastModified
meta
name
type
workspaceId
}
}
}
Пример ответа:
API возвращает следующий результат:
{
"data": {
"createEventFilters": {
"id": "452cb352-1315-44d1-95d0-15eb9a7760fb",
"lastModified": "2024-05-22T10:27:31.653576+00:00",
"meta": {
"agent_ids__in": [
"e24c9d1e-f0bb-468d-9e25-6d7d8ce92514"
],
"camera_ids__in": [
"9a607355-848a-42dc-9d6e-9982f5121a92"
],
"event_types__in": [
"identification"
],
"profile_group_ids__in": [
"06119cec-b17c-4e07-8db8-70478e8302f9"
]
},
"name": "MyEventFilters",
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16",
"creationDate": "2024-05-22T10:27:31.653576+00:00",
"endpoints": [
{
"creationDate": "2024-05-22T08:55:23.460103+00:00",
"id": "52c6548d-3e17-4b9b-9268-ce51d6900530",
"lastModified": "2024-05-22T08:55:23.460103+00:00",
"meta": {},
"name": "MyEndpoint",
"type": "WEB_SOCKET",
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16"
},
{
"creationDate": "2024-05-22T09:00:03.005626+00:00",
"id": "357fe643-2396-4919-bd9e-a30f0ac28818",
"lastModified": "2024-05-22T09:00:03.005626+00:00",
"meta": {
"url": "https://web-hook.server.com",
"method": "POST"
},
"name": "My Endpoint",
"type": "WEB_HOOK",
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16"
}
]
}
}
}
Получить фильтры событий
Запрос eventsFilters()
позволяет получить список фильтров событий.
Входные параметры:
- filters:
- id:
- exact:
- Идентификатор эндпоинта
- Тип данных: ID
- exact:
- id:
- order:
- creation_date (Сортировка списка эндпоинтов по дате создания):
- ASC: от самого раннего к самому позднему
- DESC: от самого позднего к самому раннему
- last_modified (Сортировка списка эндпоинтов по дате последнего изменения):
- ASC: от самого раннего к самому позднему
- DESC: от самого позднего к самому раннему
- creation_date (Сортировка списка эндпоинтов по дате создания):
- pagination:
- offset
- Позволяет удалить последние n эндпоинтов из списка.
- Тип данных: Int
- limit
- Позволяет получить последние n эндпоинтов из списка.
- Тип данных: Int
- offset
Выходные параметры:
- totalCount
- Общее количество найденных фильтров событий
- Тип данных: Int.
- collectionItems: EventFiltersOutput!:
- id
- Идентификатор фильтра событий
- Тип данных: ID
- creationDate
- Дата создания фильтра событий
- Формат данных: Дата и время в формате ISO.
- lastModified
- Дата последнего изменения фильтра событий
- Формат данных: Дата и время в формате ISO.
- meta
- Метаданные фильтра событий
- Тип данных: JSON
- workspaceId
- Идентификатор воркспейса
- Тип данных: ID
- endpoints
- Список прикрепленных эндпоинтов
- Тип данных: EndpointOutput
- name
- Имя фильтра событий
- Тип данных: String
- id
Пример запроса:
query MyQuery {
eventsFilters(
filters: {id: {exact: "452cb352-1315-44d1-95d0-15eb9a7760fb"}}
) {
totalCount
collectionItems {
endpoints {
workspaceId
type
name
meta
lastModified
id
creationDate
}
workspaceId
name
meta
lastModified
id
creationDate
}
}
}
Пример ответа:
API возвращает следующий результат:
{
"data": {
"eventsFilters": {
"totalCount": 1,
"collectionItems": [
{
"endpoints": [
{
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16",
"type": "WEB_SOCKET",
"name": "MyEndpoint",
"meta": {},
"lastModified": "2024-05-22T08:55:23.460103+00:00",
"id": "52c6548d-3e17-4b9b-9268-ce51d6900530",
"creationDate": "2024-05-22T08:55:23.460103+00:00"
},
{
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16",
"type": "WEB_HOOK",
"name": "My Endpoint",
"meta": {
"url": "https://web-hook.server.com",
"method": "POST"
},
"lastModified": "2024-05-22T09:00:03.005626+00:00",
"id": "357fe643-2396-4919-bd9e-a30f0ac28818",
"creationDate": "2024-05-22T09:00:03.005626+00:00"
}
],
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16",
"name": "asdasd",
"meta": {
"agent_ids__in": [
"e24c9d1e-f0bb-468d-9e25-6d7d8ce92514"
],
"camera_ids__in": [
"9a607355-848a-42dc-9d6e-9982f5121a92"
],
"event_types__in": [
"identification"
],
"profile_group_ids__in": [
"06119cec-b17c-4e07-8db8-70478e8302f9"
]
},
"lastModified": "2024-05-22T10:27:31.653576+00:00",
"id": "452cb352-1315-44d1-95d0-15eb9a7760fb",
"creationDate": "2024-05-22T10:27:31.653576+00:00"
}
]
}
}
}
Удаление фильтров событий
Мутация deleteEventsFilters()
позволяет удалить список фильтров событий.
Входные параметры:
- ids!
- Список идентификаторов фильтров событий
- Тип данных: List[ID]
Выходные параметры:
- ok!
- Флаг об успешном завершении операции
- Тип данных: Boolean
Пример запроса:
mutation {
deleteEventsFilters(ids: ["2eff291d-8c8c-4325-8953-5a70b31bc63e", "29bcfb3a-3a26-4544-9def-d5d44bbd3be4"]) {
ok
}
}
Пример ответа:
API возвращает следующий результат:
{
"data": {
"deleteEventsFilters": {
"ok": true
}
}
}
Обновить фильтры событий
Запрос updateEventFilters()
позволяет обновлять фильтры событий.
Входные параметры:
- eventFiltersInput: EventFiltersInput:
- in: ConditionFields!:
- cameraIds
- Список идентификаторов камер
- Тип данных: List[ID]
- agentIds
- Список идентификаторов агентов
- Тип данных: List[ID]
- profileGroupIds
- Список идентификаторов списков наблюдения
- Тип данных: List[ID]
- eventTypes
- Список типов событий
- Тип данных: List[String]
- cameraIds
- in: ConditionFields!:
- name
- Имя фильтра событий
- Тип данных: String
- eventFiltersId!
- Идентификатор фильтра событий
- Тип данных: ID
Выходные параметры:
- id
- Идентификатор фильтра событий
- Тип данных: ID
- creationDate
- Дата создания фильтра событий
- Формат данных: Дата и время в формате ISO.
- lastModified
- Дата последнего изменения фильтра событий
- Формат данных: Дата и время в формате ISO.
- meta
- Метаданные фильтра событий
- Тип данных: JSON
- name
- Имя фильтра событий
- Тип данных: String
- workspaceId
- Идентификатор воркспейса
- Тип данных: ID
- endpoints
- Список прикрепленных эндпоинтов
- Тип данных: EndpointOutput
Пример запроса:
mutation {
updateEventFilters(
eventFiltersInput: {
in: {
profileGroupIds: ["06119cec-b17c-4e07-8db8-70478e8302f9"],
eventTypes: ["identification", "non_identification"],
cameraIds: ["9a607355-848a-42dc-9d6e-9982f5121a92"],
agentIds: ["e24c9d1e-f0bb-468d-9e25-6d7d8ce92514"]
}
}
name: "MyEventFiltersExtend"
eventFiltersId: "452cb352-1315-44d1-95d0-15eb9a7760fb"
) {
id
lastModified
meta
name
workspaceId
creationDate
endpoints {
creationDate
id
lastModified
meta
name
type
workspaceId
}
}
}
Пример ответа:
API возвращает следующий результат:
{
"data": {
"createEventFilters": {
"id": "452cb352-1315-44d1-95d0-15eb9a7760fb",
"lastModified": "2024-05-22T10:27:31.653576+00:00",
"meta": {
"agent_ids__in": [
"e24c9d1e-f0bb-468d-9e25-6d7d8ce92514"
],
"camera_ids__in": [
"9a607355-848a-42dc-9d6e-9982f5121a92"
],
"event_types__in": [
"identification",
"non_identification"
],
"profile_group_ids__in": [
"06119cec-b17c-4e07-8db8-70478e8302f9"
]
},
"name": "MyEventFiltersExtend",
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16",
"creationDate": "2024-05-22T10:27:31.653576+00:00",
"endpoints": [
{
"creationDate": "2024-05-22T08:55:23.460103+00:00",
"id": "52c6548d-3e17-4b9b-9268-ce51d6900530",
"lastModified": "2024-05-22T08:55:23.460103+00:00",
"meta": {},
"name": "MyEndpoint",
"type": "WEB_SOCKET",
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16"
},
{
"creationDate": "2024-05-22T09:00:03.005626+00:00",
"id": "357fe643-2396-4919-bd9e-a30f0ac28818",
"lastModified": "2024-05-22T09:00:03.005626+00:00",
"meta": {
"url": "https://web-hook.server.com",
"method": "POST"
},
"name": "My Endpoint",
"type": "WEB_HOOK",
"workspaceId": "c641ff9c-67df-4c03-8fa6-ee2eabffdc16"
}
]
}
}
}