GroupApi
extends AbstractApi
in package
Groups allow you to organize your projects based on specific characteristics
Table of Contents
Methods
- create() : Group|null
- Add Group
- delete() : mixed
- Delete Group
- get() : Group|null
- Get Group Info
- getManager() : GroupManager|null
- Get Group Manager
- getTeam() : GroupTeam|null
- Get Group Team
- list() : ModelCollection
- List Groups
- listManagers() : ModelCollection
- List Group Managers
- listTeams() : ModelCollection
- List Group Teams
- report() : Report|null
- Generate Group Report
- update() : Group|mixed
- Edit Group
- updateManagers() : ModelCollection
- Add or Remove Group Managers
- updateTeams() : ModelCollection
- Add or Remove Group Teams
Methods
create()
Add Group
public
create(array<string|int, mixed> $data) : Group|null
Parameters
- $data : array<string|int, mixed>
Tags
Return values
Group|null —string $data[name] required
integer $data[parentId]
string $data[description]
delete()
Delete Group
public
delete(int $groupID) : mixed
Parameters
- $groupID : int
Tags
get()
Get Group Info
public
get(int $groupID) : Group|null
Parameters
- $groupID : int
Tags
Return values
Group|nullgetManager()
Get Group Manager
public
getManager(int $groupId, int $userId) : GroupManager|null
Parameters
- $groupId : int
- $userId : int
Tags
Return values
GroupManager|nullgetTeam()
Get Group Team
public
getTeam(int $groupId, int $teamId) : GroupTeam|null
Parameters
- $groupId : int
- $teamId : int
Tags
Return values
GroupTeam|nulllist()
List Groups
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[parentId]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistManagers()
List Group Managers
public
listManagers(int $groupId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $groupId : int
- $params : array<string|int, mixed> = []
-
integer $params[teamIds]
integer $params[limit]
integer $params[offset]
string $params[orderBy]
Tags
Return values
ModelCollectionlistTeams()
List Group Teams
public
listTeams(int $groupId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $groupId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
string $params[orderBy]
Tags
Return values
ModelCollectionreport()
Generate Group Report
public
report(int $groupID, array<string|int, mixed> $data) : Report|null
Parameters
- $groupID : int
- $data : array<string|int, mixed>
-
string $data[name]
array $data[schema]
Tags
Return values
Report|nullupdate()
Edit Group
public
update(Group $group) : Group|mixed
Parameters
- $group : Group
Tags
Return values
Group|mixedupdateManagers()
Add or Remove Group Managers
public
updateManagers(int $groupId, array<string|int, mixed> $data) : ModelCollection
Parameters
- $groupId : int
- $data : array<string|int, mixed>
-
JSON Patch array with operations (add, remove)
Tags
Return values
ModelCollectionupdateTeams()
Add or Remove Group Teams
public
updateTeams(int $groupId, array<string|int, mixed> $data) : ModelCollection
Parameters
- $groupId : int
- $data : array<string|int, mixed>
-
JSON Patch array with operations (add, remove)