Skip to content
4HSE

EntityDep

Manage entity dependencies, which represent hierarchical or logical relationships between entities.
You can search for entity dependencies with advanced filtering and pagination.

Version
2.0.0
OpenAPI version
3.0.0

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/entity-dep/index

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

Request Body

Section titled “Request Body ”

Parameters for searching entity dependencies

object
filter
object
entity_id
string
entity_type
string
dep_id
string
dep_type
string
level
integer
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": {
    "entity_type": "PROJECT",
    "dep_type": "PARENT"
  },
  "per-page": 10,
  "page": 1,
  "sort": "entity_id"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of entity dependencies

Array<object>
object
entity_id
string
entity_type
string
dep_id
string
dep_type
string
level
integer
Example
{
  "entity_id": "ent-1",
  "entity_type": "PROJECT",
  "dep_id": "ent-2",
  "dep_type": "PARENT",
  "level": 1
}

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