Skip to content
4HSE

WorkEnvironment

Manage work environments, which represent physical or logical areas within offices or projects.
You can create, update, delete, and search for work environments with advanced filtering and pagination.

Version
2.0.0
OpenAPI version
3.0.0

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/work-environment/index

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

Request Body

Section titled “Request Body ”

Parameters for searching work environments

object
filter
object
office_work_environment_id

The unique identifier for the office work environment.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
work_environment_id

The unique identifier for the work environment, if applicable.

string format: uuid
nullable
code

The code associated with the office work environment, if available.

string
nullable
name

The name of the office work environment.

string
description

A description of the office work environment, if available.

string
nullable
project_id

The unique identifier for the project associated with the office work environment.

string format: uuid
project_name

The name of the project, read-only.

string
project_type

The type of the project, read-only.

string
office_name

The name of the office, read-only.

string
category

The category of the office work environment, if available, read-only.

string
nullable
owned_active

Indicates whether the office work environment is active and owned, read-only.

boolean
parent_active

Indicates whether the parent office work environment is active, read-only.

boolean
per-page
integer
default: 100 >= 1
page
integer
default: 1 >= 1
sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string
history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean
Example
{
  "filter": {
    "name": "Work environment 1",
    "office_id": "off-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of work environments

Array<object>
object
office_work_environment_id

The unique identifier for the office work environment.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
work_environment_id

The unique identifier for the work environment, if applicable.

string format: uuid
nullable
code

The code associated with the office work environment, if available.

string
nullable
name

The name of the office work environment.

string
description

A description of the office work environment, if available.

string
nullable
project_id

The unique identifier for the project associated with the office work environment.

string format: uuid
project_name

The name of the project, read-only.

string
project_type

The type of the project, read-only.

string
office_name

The name of the office, read-only.

string
category

The category of the office work environment, if available, read-only.

string
nullable
owned_active

Indicates whether the office work environment is active and owned, read-only.

boolean
parent_active

Indicates whether the parent office work environment is active, read-only.

boolean
Example
{
  "office_work_environment_id": "we-1",
  "office_id": "off-1",
  "work_environment_id": "env-1",
  "code": "WE001",
  "name": "Work environment 1",
  "description": "Main production area",
  "project_id": "proj-1",
  "office_name": "Main Office",
  "project_name": "Project X"
}

Headers

Section titled “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”
POST
/v2/work-environment/create

Create a new work environment by providing the required details.

Request Body required

Section titled “Request Body required ”

Work environment object to be created

object
office_work_environment_id

The unique identifier for the office work environment.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
work_environment_id

The unique identifier for the work environment, if applicable.

string
nullable
code

The code associated with the office work environment, if available.

string
nullable
name

The name of the office work environment.

string
description

A description of the office work environment, if available.

string
nullable
project_id

The unique identifier for the project associated with the office work environment.

string format: uuid
Example
{
  "office_id": "off-2",
  "code": "WE002",
  "name": "Work environment 2",
  "description": "Secondary area",
  "project_id": "proj-2"
}

Responses

Section titled “ Responses ”
201
Section titled “201 ”

Work environment created successfully

object
office_work_environment_id

The unique identifier for the office work environment.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
work_environment_id

The unique identifier for the work environment, if applicable.

string
nullable
code

The code associated with the office work environment, if available.

string
nullable
name

The name of the office work environment.

string
description

A description of the office work environment, if available.

string
nullable
project_id

The unique identifier for the project associated with the office work environment.

string format: uuid
Example
{
  "office_work_environment_id": "we-2",
  "office_id": "off-2",
  "work_environment_id": "env-2",
  "code": "WE002",
  "name": "Work environment 2",
  "description": "Secondary area",
  "project_id": "proj-2"
}

view

Section titled “view”
GET
/v2/work-environment/view/{id}

Retrieve a work environment by its unique ID.

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the work environment to retrieve

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Work environment found

object
office_work_environment_id

The unique identifier for the office work environment.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
work_environment_id

The unique identifier for the work environment, if applicable.

string format: uuid
nullable
code

The code associated with the office work environment, if available.

string
nullable
name

The name of the office work environment.

string
description

A description of the office work environment, if available.

string
nullable
project_id

The unique identifier for the project associated with the office work environment.

string format: uuid
project_name

The name of the project, read-only.

string
project_type

The type of the project, read-only.

string
office_name

The name of the office, read-only.

string
category

The category of the office work environment, if available, read-only.

string
nullable
owned_active

Indicates whether the office work environment is active and owned, read-only.

boolean
parent_active

Indicates whether the parent office work environment is active, read-only.

boolean
Example
{
  "office_work_environment_id": "we-1",
  "office_id": "off-1",
  "work_environment_id": "env-1",
  "code": "WE001",
  "name": "Work environment 1",
  "description": "Main production area",
  "project_id": "proj-1",
  "office_name": "Main Office",
  "project_name": "Project X"
}
404
Section titled “404 ”

Work environment not found

delete

Section titled “delete”
DELETE
/v2/work-environment/delete/{id}

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

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the work environment to delete

Query Parameters

Section titled “Query Parameters ”
force
boolean

Force the deletion of the entity and all related entities

Responses

Section titled “ Responses ”
204
Section titled “204 ”

Work environment deleted successfully

400
Section titled “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

update

Section titled “update”
PUT
/v2/work-environment/update/{id}

Update an existing work environment by its unique ID.

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

ID of the work environment to update

Request Body required

Section titled “Request Body required ”

Work environment object with updated data

object
office_work_environment_id

The unique identifier for the office work environment.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
work_environment_id

The unique identifier for the work environment, if applicable.

string
nullable
code

The code associated with the office work environment, if available.

string
nullable
name

The name of the office work environment.

string
description

A description of the office work environment, if available.

string
nullable
project_id

The unique identifier for the project associated with the office work environment.

string format: uuid
Example
{
  "name": "Updated Work Environment",
  "description": "Updated description"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

Work environment updated successfully

object
office_work_environment_id

The unique identifier for the office work environment.

string format: uuid
office_id

The unique identifier for the office.

string format: uuid
work_environment_id

The unique identifier for the work environment, if applicable.

string
nullable
code

The code associated with the office work environment, if available.

string
nullable
name

The name of the office work environment.

string
description

A description of the office work environment, if available.

string
nullable
project_id

The unique identifier for the project associated with the office work environment.

string format: uuid
Example
{
  "office_work_environment_id": "we-1",
  "name": "Updated Work Environment",
  "description": "Updated description"
}
404
Section titled “404 ”

Work environment not found