/api/annotation/bulk

ПРИМЕЧАНИЕ: (Версия 2.1) Конечная точка bulk позволяет добавлять, обновлять или удалять несколько аннотаций в одном вызове. Обновления аннотаций должны отправляться с помощью PUT или POST в качестве данных содержимого. Запросы с параметрами запроса не поддерживаются для POST или GET. Каждая аннотация обрабатывается индивидуально и синхронизируется с сервером. Если у одной из аннотаций возникнет ошибка, например, отсутствует поле, будет возвращено исключение, и некоторые аннотации могут не быть записаны в хранилище. В таком случае некорректную аннотацию следует исправить, и все аннотации следует отправить снова.

Аннотации также могут быть удалены в пакетном режиме для указанного временного интервала. Если вы предоставите список одного или нескольких TSUIDs, аннотации с start time, который попадает в указанный временной интервал и относится к этим TSUIDs, будут удалены. В качестве альтернативы можно установить флаг global, и любые глобальные аннотации (те, которые не связаны с временным рядом) будут удалены в заданном диапазоне.

Глаголы

• POST - Создать или изменить аннотации
• PUT - Создать или заменить аннотации
• DELETE - Удалить аннотации в течение определенного временного интервала

Запросы

Поля для отправки или обновления аннотаций документированы в /api/annotation

Поля для запроса пакетного удаления определены ниже:

[
  {
  "startTime":"1369141261",
  "tsuid":"000001000001000001",
  "description": "Testing Annotations",
  "notes": "These would be details about the event, the description is just a summary",
  "custom": {
    "owner": "jdoe",
    "dept": "ops"
  }
  },
  {
  "startTime":"1369141261",
  "tsuid":"000001000001000002",
  "description": "Second annotation on different TSUID",
  "notes": "Additional details"
  }
]

/api/annotation/bulk?start_time=1d-ago&end_time=1h-ago&method_override=delete&tsuids=000001000001000001,000001000001000002

{
  "tsuids": [
    "000001000001000001",
    "000001000001000002"
  ],
  "global": false,
  "startTime": 1389740544690,
  "endTime": 1389823344698,
  "totalDeleted": 0
}

Ответ

Успешный ответ на запрос POST или PUT вернет список аннотаций после синхронизации (т. е. если вы выполняете вызов POST, существующие объекты будут объединены с новыми объектами). Запросы удаления вернут объект с запросом удаления и полем totalDeleted, содержащим целое число, отражающее общее количество удаленных аннотаций. Если были предоставлены некорректные данные, будет возвращена ошибка 400, а также конкретная аннотация, вызвавшая ошибку, в поле details объекта ошибки.

[
  {
    "tsuid": "000001000001000001",
    "description": "Testing Annotations",
    "notes": "These would be details about the event, the description is just a summary",
    "custom": {
      "owner": "jdoe",
      "dept": "ops"
    },
    "endTime": 0,
    "startTime": 1369141261
  },
  {
    "tsuid": "000001000001000002",
    "description": "Second annotation on different TSUID",
    "notes": "Additional details",
    "custom": null,
    "endTime": 0,
    "startTime": 1369141261
  }
]

{
  "tsuids": [
    "000001000001000001",
    "000001000001000002"
  ],
  "global": false,
  "startTime": 1389740544690,
  "endTime": 1389823344698,
  "totalDeleted": 42
}