Groups

Список групп

get

Возвращает набор групп. Клиент может выбрать фильтрацию групп аналогично тому, как фильтруются рабочие пакеты. В дополнение к предоставленным фильтрам сервер сократит результирующий набор, чтобы он содержал только те группы, для которых запрашивающий клиент имеет достаточные разрешения (view_members, manage_members).

Authorizations

BasicAuth

AuthorizationstringRequired

Query parameters

sortBystringOptional

JSON, указывающий критерии сортировки. Принимает тот же формат, который возвращается конечной точкой queries. В настоящее время поддерживаются следующие виды сортировки:

• id: Сортировка по первичному ключу

• created_at: Сортировка по дате и времени создания группы

• updated_at: Сортировка по времени последнего обновления группы

Default: [["id", "asc"]]Example: [["id", "asc"]]

selectstringOptional

Список свойств, которые нужно включить, разделенный запятыми.

Example: total,elements/name,elements/self,self

Responses

200

OK

application/hal+json

Responseall ofExample: {"_type":"Collection","total":2,"count":2,"_links":{"self":{"href":"/api/v3/groups"}},"_embedded":{"elements":[{"_type":"Group","id":1337,"name":"Stormtroopers","createdAt":"2022-09-23T11:06:36.300Z","updatedAt":"2022-09-23T11:06:36.300Z","_links":{"self":{"href":"/api/v3/groups/9","title":"Stormtroopers"},"delete":{"href":"/api/v3/group/9","method":"delete"},"memberships":{"href":"/api/v3/memberships?filters=[{\"principal\":{\"operator\":\"=\",\"values\":[\"9\"]}}]","title":"Memberships"},"updateImmediately":{"href":"/api/v3/group/9","method":"patch"},"members":[{"href":"/api/v3/users/363","title":"ST-097E"},{"href":"/api/v3/users/60","title":"ST-C-334"}]}},{"_hint":"Group resource shortened for brevity","id":1338}]}}

403

Returned if the client does not have sufficient permissions.

Required permission: View members or manage members in any project

application/hal+json

get

/api/v3/groups

HTTPcURLJavaScriptPython

GET /op/api/v3/groups HTTP/1.1
Host: example.u-meteor.ru
Authorization: Basic username:password
Accept: */*

{
  "_type": "Collection",
  "total": 2,
  "count": 2,
  "_links": {
    "self": {
      "href": "/api/v3/groups"
    }
  },
  "_embedded": {
    "elements": [
      {
        "_type": "Group",
        "id": 1337,
        "name": "Stormtroopers",
        "createdAt": "2022-09-23T11:06:36.300Z",
        "updatedAt": "2022-09-23T11:06:36.300Z",
        "_links": {
          "self": {
            "href": "/api/v3/groups/9",
            "title": "Stormtroopers"
          },
          "delete": {
            "href": "/api/v3/group/9",
            "method": "delete"
          },
          "memberships": {
            "href": "/api/v3/memberships?filters=[{\"principal\":{\"operator\":\"=\",\"values\":[\"9\"]}}]",
            "title": "Memberships"
          },
          "updateImmediately": {
            "href": "/api/v3/group/9",
            "method": "patch"
          },
          "members": [
            {
              "href": "/api/v3/users/363",
              "title": "ST-097E"
            },
            {
              "href": "/api/v3/users/60",
              "title": "ST-C-334"
            }
          ]
        }
      },
      {
        "_hint": "Group resource shortened for brevity",
        "id": 1338
      }
    ]
  }
}

Создать группу

post

Создает новую группу, применяя атрибуты, указанные в тексте.

Authorizations

BasicAuth

AuthorizationstringRequired

Body

application/json

namestringOptional

Новое название группы.

Responses

201

Created

application/hal+json

400

Occurs when the client did not send a valid JSON object in the request body.

application/hal+json

403

Returned if the client does not have sufficient permissions.

Required permission: Administrator

application/hal+json

406

Occurs when the client did not send a Content-Type header

text/plain

415

Occurs when the client sends an unsupported Content-Type header.

application/hal+json

422

Returned if:

• a constraint for a property was violated (PropertyConstraintViolation)

application/hal+json

post

/api/v3/groups

HTTPcURLJavaScriptPython

POST /op/api/v3/groups HTTP/1.1
Host: example.u-meteor.ru
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "name": "Emperor's guard",
  "_links": {
    "members": [
      {
        "href": "/api/v3/users/42"
      },
      {
        "href": "/api/v3/users/43"
      },
      {
        "href": "/api/v3/users/44"
      }
    ]
  }
}

{
  "_type": "Group",
  "id": 1,
  "name": "text",
  "createdAt": "2025-12-11T12:49:26.163Z",
  "updatedAt": "2025-12-11T12:49:26.163Z",
  "_links": {
    "members": [
      {
        "href": "/api/v3/work_packages",
        "method": "POST"
      }
    ],
    "delete": {
      "href": "/api/v3/work_packages",
      "method": "POST"
    },
    "updateImmediately": {
      "href": "/api/v3/work_packages",
      "method": "POST"
    }
  },
  "_embedded": {
    "members": []
  }
}

Получить группу

get

Извлекает групповой ресурс.

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Идентификатор группы

Example: 1

Responses

200

OK

application/hal+json

Responseall of

404

Returned if the group does not exist or if the API user does not have permission to view them.

Required permission If the user has the manage members permission in at least one project the user will be able to query all groups. If not, the user will be able to query all groups which are members in projects, he has the view members permission in.

application/hal+json

get

/api/v3/groups/{id}

HTTPcURLJavaScriptPython

GET /op/api/v3/groups/{id} HTTP/1.1
Host: example.u-meteor.ru
Authorization: Basic username:password
Accept: */*

{
  "_type": "Group",
  "id": 26,
  "name": "Force Users",
  "createdAt": "2024-01-11T15:54:16.542Z",
  "updatedAt": "2024-01-11T15:58:02.237Z",
  "_embedded": {
    "members": [
      {
        "_hint": "Principal resource shortened for brevity",
        "_type": "User",
        "id": 23,
        "name": "Grogu Jarin"
      },
      {
        "_hint": "Principal resource shortened for brevity",
        "_type": "User",
        "id": 14,
        "name": "Mara Jade"
      },
      {
        "_hint": "Principal resource shortened for brevity",
        "_type": "User",
        "id": 3,
        "name": "Darth Vader"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/api/v3/groups/26",
      "title": "Force Users"
    },
    "memberships": {
      "href": "/api/v3/memberships?filters=%5B%7B%22principal%22%3A%7B%22operator%22%3A%22%3D%22%2C%22values%22%3A%5B%2226%22%5D%7D%7D%5D",
      "title": "Memberships"
    },
    "delete": {
      "href": "/api/v3/groups/26",
      "method": "delete"
    },
    "updateImmediately": {
      "href": "/api/v3/groups/26",
      "method": "patch"
    },
    "members": [
      {
        "href": "/api/v3/users/23",
        "title": "Grogu Jarin"
      },
      {
        "href": "/api/v3/users/14",
        "title": "Mara Jade"
      },
      {
        "href": "/api/v3/users/3",
        "title": "Darth Vader"
      }
    ]
  }
}

Удалить группу

delete

Удаляет группу.

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Идентификатор группы

Example: 1

Responses

202

Returned if the group was marked for deletion.

Note that the response body is empty as of now. In future versions of the API a body might be returned, indicating the progress of deletion.

403

Returned if the client does not have sufficient permissions.

Required permission: Administrator

application/hal+json

404

Returned if the group does not exist or the client does not have sufficient permissions to see it.

Required permission: Administrator

Note: A client without sufficient permissions shall not be able to test for the existence of a version. That's why a 404 is returned here, even if a 403 might be more appropriate.

application/hal+json

406

Occurs when the client did not send a Content-Type header

text/plain

415

Occurs when the client sends an unsupported Content-Type header.

application/hal+json

delete

/api/v3/groups/{id}

HTTPcURLJavaScriptPython

DELETE /op/api/v3/groups/{id} HTTP/1.1
Host: example.u-meteor.ru
Authorization: Basic username:password
Accept: */*

No content

Группа обновлений

patch

Обновляет данную группу, применяя атрибуты, указанные в тексте.

Пожалуйста, обратите внимание, что предоставленный массив members переопределит существующий набор элементов (аналогично PUT). Таким образом, клиент должен предоставить полный список участников, которые будут в группе после обновления, даже если будет добавлен только один участник.

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Идентификатор группы

Example: 1

Body

application/json

namestringOptional

Новое название группы.

Responses

200

OK

application/hal+json

Responseall of

400

Occurs when the client did not send a valid JSON object in the request body.

application/hal+json

403

Returned if the client does not have sufficient permissions.

Required permission: Administrator

application/hal+json

404

Returned if the group does not exist or the client does not have sufficient permissions to see it.

Required permission If the user has the manage members permission in at least one project the user will be able to query all groups. If not, the user will be able to query all groups which are members in projects, he has the view members permission in.

Note: A client without sufficient permissions shall not be able to test for the existence of a version. That's why a 404 is returned here, even if a 403 might be more appropriate.

application/hal+json

406

Occurs when the client did not send a Content-Type header

text/plain

415

Occurs when the client sends an unsupported Content-Type header.

application/hal+json

422

Returned if:

• a constraint for a property was violated (PropertyConstraintViolation)

application/hal+json

patch

/api/v3/groups/{id}

HTTPcURLJavaScriptPython

PATCH /op/api/v3/groups/{id} HTTP/1.1
Host: example.u-meteor.ru
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "name": "Emperor's guard",
  "_links": {
    "members": [
      {
        "href": "/api/v3/users/42"
      },
      {
        "href": "/api/v3/users/43"
      },
      {
        "href": "/api/v3/users/44"
      }
    ]
  }
}

{
  "_type": "Group",
  "id": 1,
  "name": "text",
  "createdAt": "2025-12-11T12:49:26.163Z",
  "updatedAt": "2025-12-11T12:49:26.163Z",
  "_links": {
    "members": [
      {
        "href": "/api/v3/work_packages",
        "method": "POST"
      }
    ],
    "delete": {
      "href": "/api/v3/work_packages",
      "method": "POST"
    },
    "updateImmediately": {
      "href": "/api/v3/work_packages",
      "method": "POST"
    }
  },
  "_embedded": {
    "members": []
  }
}