Ресурс

Probe User Owner

Add users as owners to your probes.

Модель Probe User Owner

Свойства

Имя
_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
Имя
user
Тип
User
Описание
User that is the owner. This user will receive notifications.
Имя
userId
Тип
Object IDОбязательно
Описание
ID of your User in which this object belongs
Имя
probe
Тип
Probe
Описание
Relation to Probe Resource in which this object belongs
Имя
probeId
Тип
Object IDОбязательно
Описание
ID of your Probe in which this object belongs
Имя
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/probe-owner-user/get-list

Список

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

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

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

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

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

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

POST

/api/probe-owner-user/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "probeId": true,
    "projectId": true,
    "userId": true,
    "createdByUser": true,
    "createdByUserId": true
  },
  "query": {},
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3777fa53-28fe-11f1-b591-3fdcef396aba",
      "probeId": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
      "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
    },
    {
      "_id": "3777fa54-28fe-11f1-b591-3fdcef396aba",
      "probeId": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
      "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
    },
    {
      "_id": "3777fa55-28fe-11f1-b591-3fdcef396aba",
      "probeId": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
      "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
    }
  ]
}

GETorPOST/api/probe-owner-user/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/probe-owner-user/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "probeId": true,
    "projectId": true,
    "userId": true,
    "createdByUser": true,
    "createdByUserId": true
  }
}

Ответ

{
  "_id": "3777fa53-28fe-11f1-b591-3fdcef396aba",
  "probeId": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "userId": "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
  "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
}

POST/api/probe-owner-user/count

Количество

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

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

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

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

POST

/api/probe-owner-user/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {}
}

Ответ

{
  "count": 107
}

POST/api/probe-owner-user

Создать Probe User Owner

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

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

POST

/api/probe-owner-user

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "probeId": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "userId": "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
    "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
    "createdByUserId": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
  }
}

Ответ

{
  "_id": "3777fa53-28fe-11f1-b591-3fdcef396aba",
  "probeId": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "userId": "e5f6a7b8-c9d0-1234-ef56-ab78cd901234",
  "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
}

PUT/api/probe-owner-user/:id

Обновить по ID

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

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

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

POST/api/probe-owner-user/:id/update-item

GET/api/probe-owner-user/:id/update-item

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

PUT

/api/probe-owner-user/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {}
}

Ответ

{}

DELETE/api/probe-owner-user/:id

Удалить по ID

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

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

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

POST/api/probe-owner-user/:id/delete-item

GET/api/probe-owner-user/:id/delete-item

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

DELETE

/api/probe-owner-user/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения Probe User Owner

Project Owner
Project Admin
Project Member
Read Probe Owner User
Read All Project Resources

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

Нужны для создания Probe User Owner

Project Owner
Project Admin
Project Member
Create Probe Owner User

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

Нужны для обновления Probe User Owner

Project Owner
Project Admin
Project Member
Edit Probe Owner User

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

Нужны для удаления Probe User Owner

Project Owner
Project Admin
Project Member
Delete Probe Owner User