---
title: "WorkGroupPerson"
url: "https://dev.4hse.com/api/workgroupperson"
---

# WorkGroupPerson

A **WorkGroupPerson** represents the assignment of a person to a work group. Links a PersonOffice (person-office assignment) to a WorkGroup.

Use this API to:

-   Assign a person to a job role, work phase, or homogeneous group
-   Find all people in a work group (filter by `work_group_id`)
-   Find all work groups a person belongs to (filter by `person_office_id`)

Optionally, exposure time can be recorded (`time_spent_measure` + `unit_of_measure_id`).

Supports historicization.

Version

2.0.0

OpenAPI version

3.0.0

## Authentication

[Section titled “ Authentication ”](#authentication)

### OAuth2

[Section titled “OAuth2 ”](#oauth2)

**Security scheme type:** oauth2

**Flow type:** password

**Token URL:** [https://auth.4hse.com/realms/4hse/protocol/openid-connect/token](https://auth.4hse.com/realms/4hse/protocol/openid-connect/token)

### AccessToken

[Section titled “AccessToken ”](#accesstoken)

**Security scheme type:** apiKey

**Query parameter name:** access-token

## Operations

[Section titled “Operations”](#operations)

### index

[Section titled “index”](#operation-indexWorkGroupPerson-post)

POST

/v2/work-group-person/index

-   

Returns a paginated list of person-work group assignments.

Most useful filters:

-   `work_group_id`: all people in a specific work group
-   `person_office_id`: all work groups a person belongs to
-   `person_last_name`: search by person name

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/workgroupperson/#oauth2)**
-   **[AccessToken](/api/workgroupperson/#accesstoken)**

#### Request Body

[Section titled “Request Body ”](#request-body)

Parameters for searching

Select media typeapplication/json

object

**filter**

object

**work\_group\_person\_id**

string format: uuid

**work\_group\_id**

string format: uuid

**person\_office\_id**

string format: uuid

**time\_spent\_measure**

string

**unit\_of\_measure\_id**

string format: uuid

**person\_id**

The person ID.

string format: uuid

**person\_code**

Employee code.

string

**person\_first\_name**

string

**person\_last\_name**

string

**person\_is\_employee**

boolean

**person\_is\_external**

boolean

**work\_group\_code**

string

**work\_group\_name**

string

**work\_group\_type**

string

Allowed values: WORK\_PLACE HGROUP JOB

**unit\_of\_measure\_code**

string

**unit\_of\_measure\_name**

string

**office\_id**

string format: uuid

**office\_name**

string

**office\_code**

string

**project\_id**

string format: uuid

**project\_name**

string

**project\_type**

string

Allowed values: safety template

**owned\_active**

Whether this assignment is currently active.

boolean

nullable

**parent\_active**

Whether the parent entities are currently active.

boolean

nullable

**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**

If true, includes historicized entries.

boolean

##### Example

```
{  "filter": {    "work_group_id": "3a4b5c6d-7e8f-9012-abcd-ef3456789012"  },  "per-page": 20,  "page": 1,  "sort": "person_last_name"}
```

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

List of person-work group assignments

Select media typeapplication/json

Array<object>

object

**work\_group\_person\_id**

string format: uuid

**work\_group\_id**

string format: uuid

**person\_office\_id**

string format: uuid

**time\_spent\_measure**

string

**unit\_of\_measure\_id**

string format: uuid

**person\_id**

The person ID.

string format: uuid

**person\_code**

Employee code.

string

**person\_first\_name**

string

**person\_last\_name**

string

**person\_is\_employee**

boolean

**person\_is\_external**

boolean

**work\_group\_code**

string

**work\_group\_name**

string

**work\_group\_type**

string

Allowed values: WORK\_PLACE HGROUP JOB

**unit\_of\_measure\_code**

string

**unit\_of\_measure\_name**

string

**office\_id**

string format: uuid

**office\_name**

string

**office\_code**

string

**project\_id**

string format: uuid

**project\_name**

string

**project\_type**

string

Allowed values: safety template

**owned\_active**

Whether this assignment is currently active.

boolean

nullable

**parent\_active**

Whether the parent entities are currently active.

boolean

nullable

#### Headers

[Section titled “Headers ”](#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

### create

[Section titled “create”](#operation-createWorkGroupPerson-post)

POST

/v2/work-group-person/create

-   

Assigns a person to a work group.

Requires `work_group_id` and `person_office_id`. The `work_group_person_id` is auto-generated if not provided.

The person must be assigned to the same office as the work group (via PersonOffice).

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/workgroupperson/#oauth2)**
-   **[AccessToken](/api/workgroupperson/#accesstoken)**

#### Request Body required

[Section titled “Request Body required ”](#request-body)

Assignment to create

Select media typeapplication/json

object

**work\_group\_person\_id**

Unique identifier. Auto-generated if not provided.

string format: uuid

**work\_group\_id**

required

The work group. Pass the `work_group_id` from the WorkGroup API.

string format: uuid

**person\_office\_id**

required

The person-office assignment. Pass the `person_office_id` from the PersonOffice API. The person must be assigned to the same office as the work group.

string format: uuid

**time\_spent\_measure**

Exposure time value. If specified, `unit_of_measure_id` is also required.

string

<= 255 characters

**unit\_of\_measure\_id**

Unit of measure for the exposure time. Required if `time_spent_measure` is set.

string format: uuid

#### Responses

[Section titled “ Responses ”](#responses)

##### 201

[Section titled “201 ”](#201)

Person assigned to work group successfully

Select media typeapplication/json

object

**work\_group\_person\_id**

Unique identifier. Auto-generated if not provided.

string format: uuid

**work\_group\_id**

required

The work group. Pass the `work_group_id` from the WorkGroup API.

string format: uuid

**person\_office\_id**

required

The person-office assignment. Pass the `person_office_id` from the PersonOffice API. The person must be assigned to the same office as the work group.

string format: uuid

**time\_spent\_measure**

Exposure time value. If specified, `unit_of_measure_id` is also required.

string

<= 255 characters

**unit\_of\_measure\_id**

Unit of measure for the exposure time. Required if `time_spent_measure` is set.

string format: uuid

### view

[Section titled “view”](#operation-viewWorkGroupPerson-get)

GET

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

-   

Retrieves a single assignment by its ID.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/workgroupperson/#oauth2)**
-   **[AccessToken](/api/workgroupperson/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The work\_group\_person\_id to retrieve.

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

Assignment found

Select media typeapplication/json

object

**work\_group\_person\_id**

string format: uuid

**work\_group\_id**

string format: uuid

**person\_office\_id**

string format: uuid

**time\_spent\_measure**

string

**unit\_of\_measure\_id**

string format: uuid

**person\_id**

The person ID.

string format: uuid

**person\_code**

Employee code.

string

**person\_first\_name**

string

**person\_last\_name**

string

**person\_is\_employee**

boolean

**person\_is\_external**

boolean

**work\_group\_code**

string

**work\_group\_name**

string

**work\_group\_type**

string

Allowed values: WORK\_PLACE HGROUP JOB

**unit\_of\_measure\_code**

string

**unit\_of\_measure\_name**

string

**office\_id**

string format: uuid

**office\_name**

string

**office\_code**

string

**project\_id**

string format: uuid

**project\_name**

string

**project\_type**

string

Allowed values: safety template

**owned\_active**

Whether this assignment is currently active.

boolean

nullable

**parent\_active**

Whether the parent entities are currently active.

boolean

nullable

##### 404

[Section titled “404 ”](#404)

Assignment not found

### update

[Section titled “update”](#operation-updateWorkGroupPerson-put)

PUT

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

-   

Updates an existing assignment.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/workgroupperson/#oauth2)**
-   **[AccessToken](/api/workgroupperson/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The work\_group\_person\_id to update.

#### Request Body required

[Section titled “Request Body required ”](#request-body)

Fields to update

Select media typeapplication/json

object

**work\_group\_person\_id**

Unique identifier. Auto-generated if not provided.

string format: uuid

**work\_group\_id**

required

The work group. Pass the `work_group_id` from the WorkGroup API.

string format: uuid

**person\_office\_id**

required

The person-office assignment. Pass the `person_office_id` from the PersonOffice API. The person must be assigned to the same office as the work group.

string format: uuid

**time\_spent\_measure**

Exposure time value. If specified, `unit_of_measure_id` is also required.

string

<= 255 characters

**unit\_of\_measure\_id**

Unit of measure for the exposure time. Required if `time_spent_measure` is set.

string format: uuid

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

Assignment updated successfully

Select media typeapplication/json

object

**work\_group\_person\_id**

Unique identifier. Auto-generated if not provided.

string format: uuid

**work\_group\_id**

required

The work group. Pass the `work_group_id` from the WorkGroup API.

string format: uuid

**person\_office\_id**

required

The person-office assignment. Pass the `person_office_id` from the PersonOffice API. The person must be assigned to the same office as the work group.

string format: uuid

**time\_spent\_measure**

Exposure time value. If specified, `unit_of_measure_id` is also required.

string

<= 255 characters

**unit\_of\_measure\_id**

Unit of measure for the exposure time. Required if `time_spent_measure` is set.

string format: uuid

##### 404

[Section titled “404 ”](#404)

Assignment not found

### delete

[Section titled “delete”](#operation-deleteWorkGroupPerson-delete)

DELETE

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

-   

Deletes a person-work group assignment.

If `force=false` (default), the response lists child entities. If `force=true`, the assignment and related entities are deleted.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

-   **[OAuth2](/api/workgroupperson/#oauth2)**
-   **[AccessToken](/api/workgroupperson/#accesstoken)**

#### Path Parameters

[Section titled “Path Parameters ”](#path-parameters)

**id**

required

string format: uuid

The work\_group\_person\_id to delete.

#### Query Parameters

[Section titled “Query Parameters ”](#query-parameters)

**force**

boolean

If true, deletes the assignment and all child entities.

#### Responses

[Section titled “ Responses ”](#responses)

##### 204

[Section titled “204 ”](#204)

Assignment deleted successfully

##### 400

[Section titled “400 ”](#400)

Preview of entities that would be deleted (returned when force=false)

This site is protected by reCAPTCHA and the Google [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms) apply.