---
title: "WorkGroupSupplier"
url: "https://dev.4hse.com/api/workgroupsupplier"
---

# WorkGroupSupplier

A **WorkGroupSupplier** represents the assignment of a supplier to a work group. Links a Unit (supplier) to a WorkGroup.

Use this API to:

-   Assign suppliers to a job role, work phase, or homogeneous group
-   Find all suppliers in a work group (filter by `work_group_id`)
-   Find all work groups a supplier belongs to (filter by `unit_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-indexWorkGroupSupplier-post)

POST

/v2/work-group-supplier/index

-   

Returns a paginated list of supplier-work group assignments.

Most useful filters:

-   `work_group_id`: all suppliers in a specific work group
-   `unit_id`: all work groups a supplier belongs to

## Authorizations

[Section titled “Authorizations ”](#authorizations)

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

#### Request Body

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

Parameters for searching

Select media typeapplication/json

object

**filter**

object

**work\_group\_supplier\_id**

string format: uuid

**work\_group\_id**

string format: uuid

**unit\_id**

string format: uuid

**code**

Supplier code.

string

**name**

Supplier name.

string

**created\_at**

Creation timestamp.

integer

**updated\_at**

Last modification timestamp.

integer

**work\_group\_code**

string

**work\_group\_name**

string

**work\_group\_type**

string

Allowed values: WORK\_PLACE HGROUP JOB

**work\_group\_description**

string

nullable

**office\_name**

string

**office\_code**

string

**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: name code work\_group\_name work\_group\_code

**history**

If true, includes historicized entries.

boolean

##### Example

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

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

List of supplier-work group assignments

Select media typeapplication/json

Array<object>

object

**work\_group\_supplier\_id**

string format: uuid

**work\_group\_id**

string format: uuid

**unit\_id**

string format: uuid

**code**

Supplier code.

string

**name**

Supplier name.

string

**created\_at**

Creation timestamp.

integer

**updated\_at**

Last modification timestamp.

integer

**work\_group\_code**

string

**work\_group\_name**

string

**work\_group\_type**

string

Allowed values: WORK\_PLACE HGROUP JOB

**work\_group\_description**

string

nullable

**office\_name**

string

**office\_code**

string

**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-createWorkGroupSupplier-post)

POST

/v2/work-group-supplier/create

-   

Assigns a supplier to a work group.

Requires `work_group_id` and `unit_id`. The `work_group_supplier_id` is auto-generated if not provided.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

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

#### Request Body required

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

Assignment to create

Select media typeapplication/json

object

**work\_group\_supplier\_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

**unit\_id**

required

The supplier. Pass the `unit_id` from the Unit API.

string format: uuid

#### Responses

[Section titled “ Responses ”](#responses)

##### 201

[Section titled “201 ”](#201)

Supplier assigned to work group successfully

Select media typeapplication/json

object

**work\_group\_supplier\_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

**unit\_id**

required

The supplier. Pass the `unit_id` from the Unit API.

string format: uuid

### view

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

GET

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

-   

Retrieves a single assignment by its ID.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

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

#### Path Parameters

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

**id**

required

string format: uuid

The work\_group\_supplier\_id to retrieve.

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

Assignment found

Select media typeapplication/json

object

**work\_group\_supplier\_id**

string format: uuid

**work\_group\_id**

string format: uuid

**unit\_id**

string format: uuid

**code**

Supplier code.

string

**name**

Supplier name.

string

**created\_at**

Creation timestamp.

integer

**updated\_at**

Last modification timestamp.

integer

**work\_group\_code**

string

**work\_group\_name**

string

**work\_group\_type**

string

Allowed values: WORK\_PLACE HGROUP JOB

**work\_group\_description**

string

nullable

**office\_name**

string

**office\_code**

string

**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-updateWorkGroupSupplier-put)

PUT

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

-   

Updates an existing assignment.

## Authorizations

[Section titled “Authorizations ”](#authorizations)

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

#### Path Parameters

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

**id**

required

string format: uuid

The work\_group\_supplier\_id to update.

#### Request Body required

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

Fields to update

Select media typeapplication/json

object

**work\_group\_supplier\_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

**unit\_id**

required

The supplier. Pass the `unit_id` from the Unit API.

string format: uuid

#### Responses

[Section titled “ Responses ”](#responses)

##### 200

[Section titled “200 ”](#200)

Assignment updated successfully

Select media typeapplication/json

object

**work\_group\_supplier\_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

**unit\_id**

required

The supplier. Pass the `unit_id` from the Unit API.

string format: uuid

##### 404

[Section titled “404 ”](#404)

Assignment not found

### delete

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

DELETE

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

-   

Deletes a supplier-work group assignment.

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

## Authorizations

[Section titled “Authorizations ”](#authorizations)

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

#### Path Parameters

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

**id**

required

string format: uuid

The work\_group\_supplier\_id to delete.

#### Query Parameters

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

**force**

boolean

If true, deletes the assignment.

#### 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.