EntityAttachment

Manage entity attachments, which represent the association between entities and files.
You can create, update, delete, and search for entity attachments with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/entity-attachment/index

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

Request Body

Parameters for searching entity attachments

object

filter

object

entity_attachment_id

string

entity_id

string

attachment_id

string

attachment_path

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

string

Allowed values: attachment_path

Example

{
  "filter": {
    "attachment_path": "list-dpi.xlsx"
  },
  "per-page": 50,
  "page": 2,
  "sort": "-attachment_path"
}

Responses

200

List of entity attachments

Array<object>

object

entity_attachment_id

required

string

entity_id

required

string

attachment_id

required

string

attachment_path

required

string

{
  "entity_attachment_id": "576331b6-fee8-4949-8bd9-d839202fb6e0",
  "entity_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "attachment_id": "452b7448dce72057574d59f93d456ed0",
  "attachment_path": "/projects/569bc3c7-ead1-41e8-85ab-fdccf7085c5f/list-dpi.xlsx"
}

Example

{
  "entity_attachment_id": "576331b6-fee8-4949-8bd9-d839202fb6e0",
  "entity_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "attachment_id": "452b7448dce72057574d59f93d456ed0",
  "attachment_path": "/projects/569bc3c7-ead1-41e8-85ab-fdccf7085c5f/list-dpi.xlsx"
}

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

Retrieve an entity attachment by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the entity attachment to retrieve

Responses

200

Entity attachment found

object

entity_attachment_id

required

string

entity_id

required

string

attachment_id

required

string

attachment_path

required

string

Example

{
  "entity_attachment_id": "576331b6-fee8-4949-8bd9-d839202fb6e0",
  "entity_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "attachment_id": "452b7448dce72057574d59f93d456ed0",
  "attachment_path": "/projects/569bc3c7-ead1-41e8-85ab-fdccf7085c5f/list-dpi.xlsx"
}

404

Entity attachment not found

create

POST

/v2/entity-attachment/create

Create a new entity attachment by providing the required details.

Request Body ^required

Entity attachment object to be created

object

entity_attachment_id

required

string

entity_id

required

string

attachment_id

required

string

attachment_path

required

string

Example

{
  "entity_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "attachment_id": "452b7448dce72057574d59f93d456ed0",
  "attachment_path": "/projects/569bc3c7-ead1-41e8-85ab-fdccf7085c5f/list-dpi.xlsx"
}

Responses

201

Entity attachment created successfully

object

entity_attachment_id

required

string

entity_id

required

string

attachment_id

required

string

attachment_path

required

string

Example

{
  "entity_attachment_id": "576331b6-fee8-4949-8bd9-d839202fb6e0",
  "entity_id": "db7d0826-e572-4f7b-b4a7-69e7534b1634",
  "attachment_id": "452b7448dce72057574d59f93d456ed0",
  "attachment_path": "/projects/569bc3c7-ead1-41e8-85ab-fdccf7085c5f/list-dpi.xlsx"
}

update

PUT

/v2/entity-attachment/update/{id}

Update an existing entity attachment by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the entity attachment to update

Request Body ^required

Entity attachment object with updated data

object

entity_attachment_id

required

string

entity_id

required

string

attachment_id

required

string

attachment_path

required

string

Example

{
  "attachment_path": "/projects/569bc3c7-ead1-41e8-85ab-fdccf7085c5f/updated-file.xlsx"
}

Responses

200

Entity attachment updated successfully

object

entity_attachment_id

required

string

entity_id

required

string

attachment_id

required

string

attachment_path

required

string

Example

{
  "entity_attachment_id": "576331b6-fee8-4949-8bd9-d839202fb6e0",
  "attachment_path": "/projects/569bc3c7-ead1-41e8-85ab-fdccf7085c5f/updated-file.xlsx"
}

404

Entity attachment not found

delete

DELETE

/v2/entity-attachment/delete/{id}

Delete an entity attachment by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the entity attachment to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Entity attachment 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