WorkGroupPerson

Manage work group persons, which represent the association between people and work groups.
You can create, update, delete, and search for work group persons with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/work-group-person/index

Returns a paginated and filterable list of work group persons.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching work group persons

object

filter

object

work_group_person_id

string format: uuid

work_group_id

string format: uuid

person_office_id

string format: uuid

work_group_code

string

work_group_name

string

work_group_type

string

person_id

string format: uuid

person_code

string

person_first_name

string

person_last_name

string

person_is_employee

boolean

person_is_external

boolean

project_id

string

project_name

string

project_type

string

office_id

string

office_name

string

office_code

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

string

Allowed values: work_group_code work_group_name work_group_type person_code person_first_name person_last_name

history

boolean

Example

{
  "filter": {
    "work_group_name": "My group"
  },
  "per-page": 50,
  "page": 2,
  "sort": "-work_group_name"
}

Responses

200

List of work group persons

Array<object>

object

work_group_person_id

string format: uuid

time_spent_measure

string

unit_of_measure_id

string format: uuid

work_group_id

string format: uuid

person_office_id

string format: uuid

work_group_code

string

work_group_name

string

work_group_type

string

person_id

string format: uuid

person_code

string

person_first_name

string

person_last_name

string

person_is_employee

boolean

person_is_external

boolean

unit_of_measure_code

string

unit_of_measure_name

string

project_id

string

project_name

string

project_type

string

office_id

string

office_name

string

office_code

string

owned_active

boolean

parent_active

boolean

Example

{
  "work_group_person_id": "wgp-1",
  "work_group_id": "wg-1",
  "person_office_id": "po-1",
  "work_group_code": "GRP-001",
  "work_group_name": "My group",
  "person_first_name": "Mario",
  "person_last_name": "Rossi",
  "office_id": "off-1",
  "office_name": "Main Office"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/work-group-person/view/{id}

Retrieve a work group person by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work group person to retrieve

Responses

200

Work group person found

object

work_group_person_id

required

string

time_spent_measure

string

unit_of_measure_id

string

work_group_id

required

string

person_office_id

required

string

Example

{
  "work_group_person_id": "wgp-1",
  "work_group_id": "wg-1",
  "person_office_id": "po-1",
  "work_group_code": "GRP-001",
  "work_group_name": "My group",
  "person_first_name": "Mario",
  "person_last_name": "Rossi",
  "office_id": "off-1",
  "office_name": "Main Office"
}

404

Work group person not found

create

POST

/v2/work-group-person/create

Create a new work group person by providing the required details.

Request Body ^required

Work group person object to be created

object

work_group_person_id

required

string

time_spent_measure

string

unit_of_measure_id

string

work_group_id

required

string

person_office_id

required

string

Example

{
  "work_group_id": "wg-2",
  "person_office_id": "po-2"
}

Responses

201

Work group person created successfully

object

work_group_person_id

required

string

time_spent_measure

string

unit_of_measure_id

string

work_group_id

required

string

person_office_id

required

string

Example

{
  "work_group_person_id": "wgp-2",
  "work_group_id": "wg-2",
  "person_office_id": "po-2"
}

update

PUT

/v2/work-group-person/update/{id}

Update an existing work group person by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work group person to update

Request Body ^required

Work group person object with updated data

object

work_group_person_id

required

string

time_spent_measure

string

unit_of_measure_id

string

work_group_id

required

string

person_office_id

required

string

Example

{
  "time_spent_measure": "8"
}

Responses

200

Work group person updated successfully

object

work_group_person_id

required

string

time_spent_measure

string

unit_of_measure_id

string

work_group_id

required

string

person_office_id

required

string

Example

{
  "work_group_person_id": "wgp-1",
  "time_spent_measure": "8"
}

404

Work group person not found

delete

DELETE

/v2/work-group-person/delete/{id}

Delete a work group person by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the work group person to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Work group person deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned