Status200
Ресурс

Team Member

This model connects users and teams

Модель Team Member

Свойства

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

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

    Team this permission belongs in.

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

    ID of Team this user belongs to.

  • Имя
    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 who belongs to this team.

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

    ID of User who belongs to this team

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

    Has this team member accepted invitation

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

    When did this team member accept invitation

GETorPOST/api/team-member/get-list

Список

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

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

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

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

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

POST
/api/team-member/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "hasAcceptedInvitation": true,
    "projectId": true,
    "userId": true,
    "invitationAcceptedAt": true,
    "project": true
  },
  "query": {},
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377e62f3-28fe-11f1-b591-3fdcef396aba",
      "hasAcceptedInvitation": true,
      "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
      "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
      "invitationAcceptedAt": "2024-01-15T10:30:00Z",
      "project": "My Production Project"
    },
    {
      "_id": "377e62f4-28fe-11f1-b591-3fdcef396aba",
      "hasAcceptedInvitation": true,
      "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
      "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
      "invitationAcceptedAt": "2024-01-15T10:30:00Z",
      "project": "My Production Project"
    },
    {
      "_id": "377e62f5-28fe-11f1-b591-3fdcef396aba",
      "hasAcceptedInvitation": true,
      "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
      "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
      "invitationAcceptedAt": "2024-01-15T10:30:00Z",
      "project": "My Production Project"
    }
  ]
}
GETorPOST/api/team-member/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/team-member/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "hasAcceptedInvitation": true,
    "projectId": true,
    "userId": true,
    "invitationAcceptedAt": true,
    "project": true
  }
}

Ответ

{
  "_id": "377e62f3-28fe-11f1-b591-3fdcef396aba",
  "hasAcceptedInvitation": true,
  "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
  "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
  "invitationAcceptedAt": "2024-01-15T10:30:00Z",
  "project": "My Production Project"
}
POST/api/team-member/count

Количество

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

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

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

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

Ответ

{
  "count": 107
}
POST/api/team-member

Создать Team Member

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

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

POST
/api/team-member
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "hasAcceptedInvitation": true,
    "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
    "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
    "invitationAcceptedAt": "2024-01-15T10:30:00Z",
    "project": "My Production Project"
  }
}

Ответ

{
  "_id": "377e62f3-28fe-11f1-b591-3fdcef396aba",
  "hasAcceptedInvitation": true,
  "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
  "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
  "invitationAcceptedAt": "2024-01-15T10:30:00Z",
  "project": "My Production Project"
}
PUT/api/team-member/:id

Обновить по ID

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

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

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

POST/api/team-member/:id/update-item
GET/api/team-member/:id/update-item

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

PUT
/api/team-member/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "hasAcceptedInvitation": true,
    "invitationAcceptedAt": "2024-01-15T10:30:00Z"
  }
}

Ответ

{}
DELETE/api/team-member/:id

Удалить по ID

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

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

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

POST/api/team-member/:id/delete-item
GET/api/team-member/:id/delete-item

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

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

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Teams
  • Logged in User

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

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

  • Project Owner
  • Project Admin
  • Project Admin
  • Create Team
  • Invite New Members

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

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

  • Project Owner
  • Invite New Members
  • Edit Team
  • Logged in User

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

Нужны для удаления Team Member

  • Project Owner
  • Project Admin
  • Delete Team
  • Logged in User