Status200
Ресурс

Workspace Notification Rule

Notification Rule for Third Party Workspaces

Модель Workspace Notification Rule

Свойства

  • Имя
    _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

  • Имя
    name
    Тип
    Long TextОбязательно
    Описание

    Name of the Notification Rule

  • Имя
    description
    Тип
    Long Text
    Описание

    Description of the Notification Rule

  • Имя
    notificationRule
    Тип
    JSONОбязательно
    Описание

    Notification Rules for the Workspace

  • Имя
    eventType
    Тип
    TextОбязательно
    Описание

    Event Type for the Workspace like Incident Created, Monitor Status Updated, etc.

  • Имя
    workspaceType
    Тип
    Long TextОбязательно
    Описание

    Type of Workspace - slack, microsoft teams etc.

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

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

Список

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

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

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

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

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

POST
/api/workspace-notification-rule/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "eventType": true,
    "name": true,
    "notificationRule": true,
    "projectId": true,
    "workspaceType": true
  },
  "query": {
    "eventType": "Example workspace event type"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37805ec0-28fe-11f1-b591-3fdcef396aba",
      "eventType": "Example workspace event type",
      "name": "Example rule name",
      "notificationRule": {
        "key": "value"
      },
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "workspaceType": "Example workspace type"
    },
    {
      "_id": "37805ec1-28fe-11f1-b591-3fdcef396aba",
      "eventType": "Example workspace event type",
      "name": "Example rule name",
      "notificationRule": {
        "key": "value"
      },
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "workspaceType": "Example workspace type"
    },
    {
      "_id": "37805ec2-28fe-11f1-b591-3fdcef396aba",
      "eventType": "Example workspace event type",
      "name": "Example rule name",
      "notificationRule": {
        "key": "value"
      },
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "workspaceType": "Example workspace type"
    }
  ]
}
GETorPOST/api/workspace-notification-rule/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/workspace-notification-rule/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "eventType": true,
    "name": true,
    "notificationRule": true,
    "projectId": true,
    "workspaceType": true
  }
}

Ответ

{
  "_id": "37805ec0-28fe-11f1-b591-3fdcef396aba",
  "eventType": "Example workspace event type",
  "name": "Example rule name",
  "notificationRule": {
    "key": "value"
  },
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "workspaceType": "Example workspace type"
}
POST/api/workspace-notification-rule/count

Количество

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

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

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

POST
/api/workspace-notification-rule/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "eventType": "Example workspace event type"
  }
}

Ответ

{
  "count": 107
}
POST/api/workspace-notification-rule

Создать Workspace Notification Rule

Создаёт новый объект.

Запрос создания

POST
/api/workspace-notification-rule
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "eventType": "Example workspace event type",
    "name": "Example rule name",
    "notificationRule": {
      "key": "value"
    },
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "workspaceType": "Example workspace type"
  }
}

Ответ

{
  "_id": "37805ec0-28fe-11f1-b591-3fdcef396aba",
  "eventType": "Example workspace event type",
  "name": "Example rule name",
  "notificationRule": {
    "key": "value"
  },
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "workspaceType": "Example workspace type"
}
PUT/api/workspace-notification-rule/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/workspace-notification-rule/:id/update-item
GET/api/workspace-notification-rule/:id/update-item

Запрос обновления

PUT
/api/workspace-notification-rule/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "eventType": "Example workspace event type",
    "name": "Example rule name",
    "notificationRule": {
      "key": "value"
    }
  }
}

Ответ

{}
DELETE/api/workspace-notification-rule/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/workspace-notification-rule/:id/delete-item
GET/api/workspace-notification-rule/:id/delete-item

Запрос удаления

DELETE
/api/workspace-notification-rule/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

  • Project Admin
  • Project Owner
  • Project Member
  • Read Workspace Notification Rule
  • Read All Project Resources

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

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

  • Project Admin
  • Project Owner
  • Project Member
  • Create Workspace Notification Rule

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

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

  • Project Admin
  • Project Owner
  • Project Member
  • Edit Workspace Notification Rule

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

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

  • Project Admin
  • Project Owner
  • Project Member
  • Delete Workspace Notification Rule