Ресурс

Workspace Notification Log

Logs of all workspace activities including messages, channel creation, user invitations, and button interactions for Slack and Microsoft Teams.

Модель Workspace Notification Log

Свойства

Имя
_id
Тип
Object ID
Описание
ID of this object
Имя
createdAt
Тип
Date
Описание
Date and Time when the object was created.
Имя
updatedAt
Тип
Date
Описание
Date and Time when the object was updated.
Имя
project
Тип
Project
Описание
Relation to Project Resource in which this object belongs
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of your Project in which this object belongs
Имя
workspaceType
Тип
TextОбязательно
Описание
Type of Workspace - Slack, Microsoft Teams
Имя
channelId
Тип
Text
Описание
Channel ID where the message was sent
Имя
channelName
Тип
Text
Описание
Channel Name where the message was sent
Имя
threadId
Тип
Text
Описание
Thread ID of the message in the channel (if any)
Имя
message
Тип
Very Long Text
Описание
Content of the message
Имя
statusMessage
Тип
Long Text
Описание
Status Message (if any)
Имя
status
Тип
TextОбязательно
Описание
Status of the message
Имя
actionType
Тип
TextОбязательно
Описание
Type of workspace action performed
Имя
incident
Тип
Incident
Описание
Incident associated with this message (if any)
Имя
incidentId
Тип
Object ID
Описание
ID of Incident associated with this message (if any)
Имя
user
Тип
User
Описание
User who initiated this workspace notification (if any)
Имя
userId
Тип
Object ID
Описание
ID of User who initiated this workspace notification (if any)
Имя
alert
Тип
Alert
Описание
Alert associated with this message (if any)
Имя
alertId
Тип
Object ID
Описание
ID of Alert associated with this message (if any)
Имя
monitor
Тип
Monitor
Описание
Monitor associated with this message (if any)
Имя
monitorId
Тип
Object ID
Описание
ID of Monitor associated with this message (if any)
Имя
alertEpisode
Тип
Alert Episode
Описание
Alert Episode associated with this message (if any)
Имя
alertEpisodeId
Тип
Object ID
Описание
ID of Alert Episode associated with this message (if any)
Имя
incidentEpisode
Тип
Incident Episode
Описание
Incident Episode associated with this message (if any)
Имя
incidentEpisodeId
Тип
Object ID
Описание
ID of Incident Episode associated with this message (if any)
Имя
scheduledMaintenance
Тип
Scheduled Maintenance Event
Описание
Scheduled Maintenance associated with this message (if any)
Имя
scheduledMaintenanceId
Тип
Object ID
Описание
ID of Scheduled Maintenance associated with this message (if any)
Имя
statusPage
Тип
Status Page
Описание
Status Page associated with this message (if any)
Имя
statusPageId
Тип
Object ID
Описание
ID of Status Page associated with this message (if any)
Имя
statusPageAnnouncement
Тип
Status Page Announcement
Описание
Status Page Announcement associated with this message (if any)
Имя
statusPageAnnouncementId
Тип
Object ID
Описание
ID of Status Page Announcement associated with this message (if any)
Имя
onCallDutyPolicy
Тип
On-Call Policy
Описание
On-Call Duty Policy associated with this message (if any)
Имя
onCallDutyPolicyId
Тип
Object ID
Описание
ID of On-Call Duty Policy associated with this message (if any)
Имя
onCallDutyPolicyEscalationRule
Тип
Escalation Rule
Описание
On-Call Duty Policy Escalation Rule associated with this message (if any)
Имя
onCallDutyPolicyEscalationRuleId
Тип
Object ID
Описание
ID of On-Call Duty Policy Escalation Rule associated with this message (if any)
Имя
onCallDutyPolicySchedule
Тип
On-Call Policy Schedule
Описание
On-Call Duty Policy Schedule associated with this message (if any)
Имя
onCallDutyPolicyScheduleId
Тип
Object ID
Описание
ID of On-Call Duty Policy Schedule associated with this message (if any)
Имя
team
Тип
Team
Описание
Team associated with this message (if any)
Имя
teamId
Тип
Object ID
Описание
ID of Team associated with this message (if any)

GETorPOST/api/workspace-notification-log/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Workspace Notification Log». По умолчанию на странице до десяти записей.

Необязательные query-параметры

limit
число
Сколько объектов вернуть. По умолчанию 10, максимум 100
skip
число
Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

query
Чтобы фильтровать Workspace Notification Log, укажите запрос здесь. Подробнее: написание запросов.
select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort
По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.

Запрос списка

POST

/api/workspace-notification-log/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "actionType": true,
    "projectId": true,
    "status": true,
    "workspaceType": true,
    "_id": true
  },
  "query": {
    "actionType": "Example action type"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "378037b0-28fe-11f1-b591-3fdcef396aba",
      "actionType": "Example action type",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "workspaceType": "Example workspace type"
    },
    {
      "_id": "378037b1-28fe-11f1-b591-3fdcef396aba",
      "actionType": "Example action type",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "workspaceType": "Example workspace type"
    },
    {
      "_id": "378037b2-28fe-11f1-b591-3fdcef396aba",
      "actionType": "Example action type",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "workspaceType": "Example workspace type"
    }
  ]
}

GETorPOST/api/workspace-notification-log/:id/get-item

Получить по ID

Возвращает объект «Workspace Notification Log» по идентификатору.

id
строка
ID объекта

Необязательное тело запроса

select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST

/api/workspace-notification-log/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "actionType": true,
    "projectId": true,
    "status": true,
    "workspaceType": true,
    "_id": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "actionType": "Example action type",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Example status",
  "workspaceType": "Example workspace type"
}

POST/api/workspace-notification-log/count

Количество

Возвращает количество ваших объектов «Workspace Notification Log».

Необязательное тело запроса

query
Чтобы фильтровать Workspace Notification Log, укажите запрос здесь. Подробнее: написание запросов.

Запрос количества

POST

/api/workspace-notification-log/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "actionType": "Example action type"
  }
}

Ответ

{
  "count": 107
}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Workspace Notification Log

Project Owner
Project Admin
Project Member
Read Workspace Notification Log
Read All Project Resources

Права на создание

Нужны для создания Workspace Notification Log

Ресурс нельзя создать через API

Права на обновление

Нужны для обновления Workspace Notification Log

Ресурс нельзя обновить через API

Права на удаление

Нужны для удаления Workspace Notification Log

Ресурс нельзя удалить через API