Status200
Ресурс

Team Compliance Setting

Compliance settings for your team

Модель Team Compliance Setting

Свойства

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

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

    Team this compliance setting belongs to.

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

    ID of Team this compliance setting belongs to.

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

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

    Type of compliance rule.

  • Имя
    enabled
    Тип
    Boolean
    Описание

    Whether this compliance rule is enabled.

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

    Additional options for this compliance rule.

GETorPOST/api/team-compliance-setting/get-list

Список

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

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

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

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

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

POST
/api/team-compliance-setting/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "ruleType": true,
    "teamId": true,
    "_id": true,
    "createdAt": true
  },
  "query": {
    "ruleType": "Example rule type"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377e62f0-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "ruleType": "Example rule type",
      "teamId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "377e62f1-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "ruleType": "Example rule type",
      "teamId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "377e62f2-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "ruleType": "Example rule type",
      "teamId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}
GETorPOST/api/team-compliance-setting/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/team-compliance-setting/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "ruleType": true,
    "teamId": true,
    "_id": true,
    "createdAt": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "ruleType": "Example rule type",
  "teamId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00.000Z"
}
POST/api/team-compliance-setting/count

Количество

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

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

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

POST
/api/team-compliance-setting/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "ruleType": "Example rule type"
  }
}

Ответ

{
  "count": 107
}
POST/api/team-compliance-setting

Создать Team Compliance Setting

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

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

POST
/api/team-compliance-setting
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "ruleType": "Example rule type",
    "teamId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUser": "Example created by user",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "ruleType": "Example rule type",
  "teamId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00.000Z"
}
PUT/api/team-compliance-setting/:id

Обновить по ID

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

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

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

POST/api/team-compliance-setting/:id/update-item
GET/api/team-compliance-setting/:id/update-item

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

PUT
/api/team-compliance-setting/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "ruleType": "Example rule type",
    "enabled": true,
    "options": {
      "key": "value"
    }
  }
}

Ответ

{}
DELETE/api/team-compliance-setting/:id

Удалить по ID

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

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

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

POST/api/team-compliance-setting/:id/delete-item
GET/api/team-compliance-setting/:id/delete-item

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

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

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Teams
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Edit Team

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

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

  • Project Owner
  • Project Admin
  • Edit Team

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

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

  • Project Owner
  • Project Admin
  • Edit Team