WorkPlace

Manage work places, which represent specific locations or areas within an office or project.
You can create, update, delete, and search for work places with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/work-place/index

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

Request Body

Parameters for searching work places

object

filter

object

office_work_place_id

The unique identifier for the office work place.

string format: uuid

code

A code for identifying the office work place.

string

nullable

name

The name of the office work place.

string

description

A description of the office work place.

string

nullable

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

project_name

The name of the project associated with the office work place.

string

project_type

The type of the project associated with the office work place.

string

office_name

The name of the office associated with the office work place.

string

category

The category of the office work place, if available.

string

nullable

owned_active

Indicates if the office work place is owned and active.

boolean

parent_active

Indicates if the parent of the office work place is active.

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 place 1",
    "office_id": "off-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of work places

Array<object>

object

office_work_place_id

The unique identifier for the office work place.

string format: uuid

code

A code for identifying the office work place.

string

nullable

name

The name of the office work place.

string

description

A description of the office work place.

string

nullable

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

project_name

The name of the project associated with the office work place.

string

project_type

The type of the project associated with the office work place.

string

office_name

The name of the office associated with the office work place.

string

category

The category of the office work place, if available.

string

nullable

owned_active

Indicates if the office work place is owned and active.

boolean

parent_active

Indicates if the parent of the office work place is active.

boolean

Example

{
  "office_work_place_id": "wp-1",
  "code": "WP001",
  "name": "Work place 1",
  "description": "Main work place",
  "office_id": "off-1",
  "project_id": "proj-1",
  "office_name": "Main Office",
  "project_name": "Project X"
}

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-place/view/{id}

Retrieve a work place by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the work place to retrieve

Responses

200

Work place found

object

office_work_place_id

The unique identifier for the office work place.

string format: uuid

code

A code for identifying the office work place.

string

nullable

name

The name of the office work place.

string

description

A description of the office work place.

string

nullable

office_id

The unique identifier for the office.

string format: uuid

project_id

The unique identifier for the project.

string format: uuid

project_name

The name of the project associated with the office work place.

string

project_type

The type of the project associated with the office work place.

string

office_name

The name of the office associated with the office work place.

string

category

The category of the office work place, if available.

string

nullable

owned_active

Indicates if the office work place is owned and active.

boolean

parent_active

Indicates if the parent of the office work place is active.

boolean

Example

{
  "office_work_place_id": "wp-1",
  "code": "WP001",
  "name": "Work place 1",
  "description": "Main work place",
  "office_id": "off-1",
  "project_id": "proj-1",
  "office_name": "Main Office",
  "project_name": "Project X"
}

404

Work place not found