WorkGroupSupplier

Questi contenuti non sono ancora disponibili nella tua lingua.

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

Version: 2.0.0
OpenAPI version: 3.0.0

Operations

index

POST

/v2/work-group-supplier/index

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

Request Body

Parameters for searching work group suppliers

object

filter

object

work_group_supplier_id

The unique identifier for the work group supplier.

string format: uuid

work_group_id

The unique identifier for the work group.

string format: uuid

supplier_office_id

The unique identifier for the supplier office.

string format: uuid

supplier_id

The unique identifier for the supplier.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

code

A code for identifying the entity.

string

<= 50 characters

name

The name of the work group supplier.

string

<= 255 characters

description

A description of the work group supplier.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier.

string

nullable <= 50 characters

region

The region where the supplier is located.

string

nullable <= 10 characters

locality

The locality of the supplier.

string

nullable <= 50 characters

country

The country where the supplier is located.

string

nullable <= 20 characters

tax_code

The tax code of the supplier.

string

nullable <= 20 characters

vat

The VAT number of the supplier.

string

nullable <= 20 characters

project_id

The unique identifier for the project.

string format: uuid

created_at

Timestamp of the create operation.

integer

updated_at

Timestamp of the last update operation.

integer

project_name

The name of the project associated with the work group supplier.

string

project_type

The type of the project associated with the work group supplier.

string

office_name

The name of the office associated with the work group supplier.

string

office_code

The code of the office associated with the work group supplier.

string

work_group_code

The code of the work group.

string

work_group_name

The name of the work group.

string

work_group_type

The type of the work group.

string

work_group_description

A description of the work group.

string

nullable

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 group supplier 1"
  },
  "per-page": 100,
  "page": 1,
  "sort": "name"
}

Responses

200

List of work group suppliers

Array<object>

object

work_group_supplier_id

The unique identifier for the work group supplier.

string format: uuid

work_group_id

The unique identifier for the work group.

string format: uuid

supplier_office_id

The unique identifier for the supplier office.

string format: uuid

supplier_id

The unique identifier for the supplier.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

code

A code for identifying the entity.

string

<= 50 characters

name

The name of the work group supplier.

string

<= 255 characters

description

A description of the work group supplier.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier.

string

nullable <= 50 characters

region

The region where the supplier is located.

string

nullable <= 10 characters

locality

The locality of the supplier.

string

nullable <= 50 characters

country

The country where the supplier is located.

string

nullable <= 20 characters

tax_code

The tax code of the supplier.

string

nullable <= 20 characters

vat

The VAT number of the supplier.

string

nullable <= 20 characters

project_id

The unique identifier for the project.

string format: uuid

created_at

Timestamp of the create operation.

integer

updated_at

Timestamp of the last update operation.

integer

project_name

The name of the project associated with the work group supplier.

string

project_type

The type of the project associated with the work group supplier.

string

office_name

The name of the office associated with the work group supplier.

string

office_code

The code of the office associated with the work group supplier.

string

work_group_code

The code of the work group.

string

work_group_name

The name of the work group.

string

work_group_type

The type of the work group.

string

work_group_description

A description of the work group.

string

nullable

Example

{
  "work_group_supplier_id": "wgs-1",
  "work_group_id": "wg-1",
  "supplier_office_id": "so-1",
  "name": "Work group supplier 1",
  "office_id": "off-1",
  "supplier_id": "sup-1",
  "project_id": "proj-1",
  "work_group_code": "GRP-001",
  "work_group_name": "My group",
  "office_name": "Main Office",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

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

POST

/v2/work-group-supplier/create

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

Request Body^required

Work group supplier object to be created

object

work_group_supplier_id

The unique identifier for the work group supplier.

string

work_group_id

The unique identifier for the work group.

string

supplier_office_id

The unique identifier for the supplier office associated with the work group.

string

Example

{
  "work_group_id": "wg-2",
  "supplier_office_id": "so-2",
  "name": "Work group supplier 2"
}

Responses

201

Work group supplier created successfully

object

work_group_supplier_id

The unique identifier for the work group supplier.

string

work_group_id

The unique identifier for the work group.

string

supplier_office_id

The unique identifier for the supplier office associated with the work group.

string

Example

{
  "work_group_supplier_id": "wgs-2",
  "work_group_id": "wg-2",
  "supplier_office_id": "so-2",
  "name": "Work group supplier 2"
}

view

GET

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

Retrieve a work group supplier by its unique ID.

Path Parameters

required

string format: uuid

ID of the work group supplier to retrieve

Responses

200

Work group supplier found

object

work_group_supplier_id

The unique identifier for the work group supplier.

string format: uuid

work_group_id

The unique identifier for the work group.

string format: uuid

supplier_office_id

The unique identifier for the supplier office.

string format: uuid

supplier_id

The unique identifier for the supplier.

string format: uuid

office_id

The unique identifier for the office.

string format: uuid

code

A code for identifying the entity.

string

<= 50 characters

name

The name of the work group supplier.

string

<= 255 characters

description

A description of the work group supplier.

string

nullable

street

The street address of the supplier.

string

nullable <= 255 characters

postal_code

The postal code of the supplier.

string

nullable <= 50 characters

region

The region where the supplier is located.

string

nullable <= 10 characters

locality

The locality of the supplier.

string

nullable <= 50 characters

country

The country where the supplier is located.

string

nullable <= 20 characters

tax_code

The tax code of the supplier.

string

nullable <= 20 characters

vat

The VAT number of the supplier.

string

nullable <= 20 characters

project_id

The unique identifier for the project.

string format: uuid

created_at

Timestamp of the create operation.

integer

updated_at

Timestamp of the last update operation.

integer

project_name

The name of the project associated with the work group supplier.

string

project_type

The type of the project associated with the work group supplier.

string

office_name

The name of the office associated with the work group supplier.

string

office_code

The code of the office associated with the work group supplier.

string

work_group_code

The code of the work group.

string

work_group_name

The name of the work group.

string

work_group_type

The type of the work group.

string

work_group_description

A description of the work group.

string

nullable

Example

{
  "work_group_supplier_id": "wgs-1",
  "work_group_id": "wg-1",
  "supplier_office_id": "so-1",
  "name": "Work group supplier 1",
  "office_id": "off-1",
  "supplier_id": "sup-1",
  "project_id": "proj-1",
  "work_group_code": "GRP-001",
  "work_group_name": "My group",
  "office_name": "Main Office",
  "created_at": 1700000000,
  "updated_at": 1700000001
}

404

Work group supplier not found

delete

DELETE

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

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

Path Parameters

required

string format: uuid

ID of the work group supplier to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Work group supplier 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

update

PUT

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

Update an existing work group supplier by its unique ID.

Path Parameters

required

string format: uuid

ID of the work group supplier to update

Request Body^required

Work group supplier object with updated data

object

work_group_supplier_id

The unique identifier for the work group supplier.

string

work_group_id

The unique identifier for the work group.

string

supplier_office_id

The unique identifier for the supplier office associated with the work group.

string

Example

{
  "name": "Updated supplier",
  "description": "Updated description"
}

Responses

200

Work group supplier updated successfully

object

work_group_supplier_id

The unique identifier for the work group supplier.

string

work_group_id

The unique identifier for the work group.

string

supplier_office_id

The unique identifier for the supplier office associated with the work group.

string

Example

{
  "work_group_supplier_id": "wgs-1",
  "name": "Updated supplier",
  "description": "Updated description"
}

404

Work group supplier not found

WorkGroupSupplier

Operations

index

Request Body

Example

Responses

200

Example

Headers

create

Request Body required

Example

Responses

201

Example

view

Path Parameters

Responses

200

Example

404

delete

Path Parameters

Query Parameters

Responses

204

400

update

Path Parameters

Request Body required

Example

Responses

200

Example

404

Request Body^required

Request Body^required