Status200
Ресурс

Project User Profile

Stores user profile data including custom fields for each user in a project.

Модель Project User Profile

Свойства

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

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

    ID of User this profile belongs to

  • Имя
    customFields
    Тип
    JSON
    Описание

    Custom Fields for this user in this project.

  • Имя
    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/project-user-profile/get-list

Список

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

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

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

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

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

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

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37782160-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
      "createdByUserId": "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "37782161-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
      "createdByUserId": "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "37782162-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
      "createdByUserId": "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}
GETorPOST/api/project-user-profile/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/project-user-profile/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "userId": true,
    "createdByUserId": true,
    "_id": true,
    "createdAt": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
  "createdByUserId": "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
  "createdAt": "2024-01-15T10:30:00.000Z"
}
POST/api/project-user-profile/count

Количество

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

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

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

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

Ответ

{
  "count": 107
}
POST/api/project-user-profile

Создать Project User Profile

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

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

POST
/api/project-user-profile
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
    "customFields": {
      "key": "value"
    },
    "project": "Example project",
    "user": "Example user"
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "userId": "b7e4d9f1-c3a5-4e8b-9d2f-3c4e5f6a7b8c",
  "createdByUserId": "a3f2b1c0-d9e8-4f5a-8b7c-6d5e4f3a2b1c",
  "createdAt": "2024-01-15T10:30:00.000Z"
}
PUT/api/project-user-profile/:id

Обновить по ID

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

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

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

POST/api/project-user-profile/:id/update-item
GET/api/project-user-profile/:id/update-item

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

PUT
/api/project-user-profile/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "customFields": {
      "key": "value"
    }
  }
}

Ответ

{}
DELETE/api/project-user-profile/:id

Удалить по ID

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

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

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

POST/api/project-user-profile/:id/delete-item
GET/api/project-user-profile/:id/delete-item

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

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

Ответ

{}

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

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

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

Нужны для чтения Project User Profile

  • Project Owner
  • Project Admin
  • Project Member
  • Read Team Member Custom Field
  • Read All Project Resources

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

Нужны для создания Project User Profile

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

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

Нужны для обновления Project User Profile

  • Project Owner
  • Project Admin
  • Logged in User

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

Нужны для удаления Project User Profile

  • Project Owner
  • Project Admin