Status200
Ресурс

Exception

List of all Telemetry Exceptions created for the telemetry service for this project and it's status.

Модель Exception

Свойства

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

  • Имя
    service
    Тип
    Service
    Описание

    Relation to Service Resource in which this object belongs

  • Имя
    serviceId
    Тип
    Object IDОбязательно
    Описание

    ID of your Service resource where this object belongs

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

    Exception message that was thrown by the telemetry service

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

    Stack trace of the exception that was thrown by the telemetry service

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

    Type of the exception that was thrown by the telemetry service

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

    Finger print of the exception that was thrown by the telemetry service

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

  • Имя
    markedAsResolvedAt
    Тип
    Date
    Описание

    When did this team member accept invitation

  • Имя
    markedAsArchivedAt
    Тип
    Date
    Описание

    When did this team member accept invitation

  • Имя
    firstSeenAt
    Тип
    Date
    Описание

    When did this team member accept invitation

  • Имя
    lastSeenAt
    Тип
    Date
    Описание

    When did this team member accept invitation

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

    Relation to User who this exception is assigned to.

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

    User ID who this exception is assigned to.

  • Имя
    assignToTeam
    Тип
    Team
    Описание

    Relation to Team who this exception is assigned to.

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

    Team ID who this exception is assigned to.

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

    Mark as resolved by User who marked this exception as resolved.

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

    User ID who marked this exception as resolved.

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

    Mark as archived by User

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

    User ID who marked this exception as archived.

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

    Is this exception resolved?

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

    Is this exception archived?

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

    Number of times this exception has occurred

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

    The service version / release in which this exception was first observed

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

    The most recent service version / release in which this exception was observed

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

    Deployment environment from deployment.environment resource attribute

GETorPOST/api/telemetry-exception/get-list

Список

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

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

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

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

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

POST
/api/telemetry-exception/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "isArchived": true,
    "isResolved": true,
    "occuranceCount": true,
    "projectId": true,
    "serviceId": true
  },
  "query": {
    "environment": "production"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376e5d60-28fe-11f1-b591-3fdcef396aba",
      "isArchived": false,
      "isResolved": false,
      "occuranceCount": 42,
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "serviceId": "d4e5f6a7-b8c9-0123-def1-234567890123"
    },
    {
      "_id": "376e8470-28fe-11f1-b591-3fdcef396aba",
      "isArchived": false,
      "isResolved": false,
      "occuranceCount": 42,
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "serviceId": "d4e5f6a7-b8c9-0123-def1-234567890123"
    },
    {
      "_id": "376e8471-28fe-11f1-b591-3fdcef396aba",
      "isArchived": false,
      "isResolved": false,
      "occuranceCount": 42,
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "serviceId": "d4e5f6a7-b8c9-0123-def1-234567890123"
    }
  ]
}
GETorPOST/api/telemetry-exception/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/telemetry-exception/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "isArchived": true,
    "isResolved": true,
    "occuranceCount": true,
    "projectId": true,
    "serviceId": true
  }
}

Ответ

{
  "_id": "376e5d60-28fe-11f1-b591-3fdcef396aba",
  "isArchived": false,
  "isResolved": false,
  "occuranceCount": 42,
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "serviceId": "d4e5f6a7-b8c9-0123-def1-234567890123"
}
POST/api/telemetry-exception/count

Количество

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

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

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

POST
/api/telemetry-exception/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "environment": "production"
  }
}

Ответ

{
  "count": 107
}
POST/api/telemetry-exception

Создать Exception

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

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

POST
/api/telemetry-exception
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "isArchived": false,
    "isResolved": false,
    "occuranceCount": 42,
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "serviceId": "d4e5f6a7-b8c9-0123-def1-234567890123"
  }
}

Ответ

{
  "_id": "376e5d60-28fe-11f1-b591-3fdcef396aba",
  "isArchived": false,
  "isResolved": false,
  "occuranceCount": 42,
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "serviceId": "d4e5f6a7-b8c9-0123-def1-234567890123"
}
PUT/api/telemetry-exception/:id

Обновить по ID

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

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

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

POST/api/telemetry-exception/:id/update-item
GET/api/telemetry-exception/:id/update-item

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

PUT
/api/telemetry-exception/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "isArchived": false,
    "isResolved": false,
    "occuranceCount": 42
  }
}

Ответ

{}
DELETE/api/telemetry-exception/:id

Удалить по ID

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

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

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

POST/api/telemetry-exception/:id/delete-item
GET/api/telemetry-exception/:id/delete-item

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

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

Ответ

{}

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

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

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

Нужны для чтения Exception

  • Project Owner
  • Project Admin
  • Project Member
  • Read Telemetry Service Exception
  • Read All Project Resources

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

Нужны для создания Exception

  • Project Owner
  • Project Admin
  • Create Telemetry Service Exception

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

Нужны для обновления Exception

  • Project Owner
  • Project Admin
  • Edit Telemetry Service Exception

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

Нужны для удаления Exception

  • Project Owner
  • Project Admin
  • Delete Telemetry Service Exception