Status200
Ресурс

Status Page Header Link

Manage header links on your status page

Модель Status Page Header Link

Свойства

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

  • Имя
    statusPage
    Тип
    Status Page
    Описание

    Relation to Status Page Resource in which this object belongs

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

    ID of your Status Page resource where this object belongs

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

    Title of this resource

  • Имя
    link
    Тип
    Short URLОбязательно
    Описание

    URL to a website or any other resource on the internet

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

  • Имя
    order
    Тип
    Number
    Описание

    Order / Priority of this resource

GETorPOST/api/status-page-header-link/get-list

Список

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

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

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

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

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

POST
/api/status-page-header-link/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "link": true,
    "projectId": true,
    "statusPageId": true,
    "title": true,
    "createdByUserId": true
  },
  "query": {
    "title": "Documentation"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377c6723-28fe-11f1-b591-3fdcef396aba",
      "link": "https://docs.example.com",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "title": "Documentation",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc"
    },
    {
      "_id": "377c6724-28fe-11f1-b591-3fdcef396aba",
      "link": "https://docs.example.com",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "title": "Documentation",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc"
    },
    {
      "_id": "377c6725-28fe-11f1-b591-3fdcef396aba",
      "link": "https://docs.example.com",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
      "title": "Documentation",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc"
    }
  ]
}
GETorPOST/api/status-page-header-link/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/status-page-header-link/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "link": true,
    "projectId": true,
    "statusPageId": true,
    "title": true,
    "createdByUserId": true
  }
}

Ответ

{
  "_id": "377c6723-28fe-11f1-b591-3fdcef396aba",
  "link": "https://docs.example.com",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
  "title": "Documentation",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc"
}
POST/api/status-page-header-link/count

Количество

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

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

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

POST
/api/status-page-header-link/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "title": "Documentation"
  }
}

Ответ

{
  "count": 107
}
POST/api/status-page-header-link

Создать Status Page Header Link

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

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

POST
/api/status-page-header-link
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "link": "https://docs.example.com",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
    "title": "Documentation",
    "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc"
  }
}

Ответ

{
  "_id": "377c6723-28fe-11f1-b591-3fdcef396aba",
  "link": "https://docs.example.com",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "statusPageId": "b2c3d4e5-f6a7-8901-bcde-f1234567890a",
  "title": "Documentation",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc"
}
PUT/api/status-page-header-link/:id

Обновить по ID

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

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

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

POST/api/status-page-header-link/:id/update-item
GET/api/status-page-header-link/:id/update-item

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

PUT
/api/status-page-header-link/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "link": "https://docs.example.com",
    "title": "Documentation",
    "order": 100
  }
}

Ответ

{}
DELETE/api/status-page-header-link/:id

Удалить по ID

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

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

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

POST/api/status-page-header-link/:id/delete-item
GET/api/status-page-header-link/:id/delete-item

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

DELETE
/api/status-page-header-link/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения Status Page Header Link

  • Project Owner
  • Project Admin
  • Project Member
  • Read Header Link
  • Read All Project Resources

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

Нужны для создания Status Page Header Link

  • Project Owner
  • Project Admin
  • Project Member
  • Create Header Link

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

Нужны для обновления Status Page Header Link

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Header Link

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

Нужны для удаления Status Page Header Link

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Header Link