Paginate Entitites

Developing

POST

/api/public/v1/entities/paginate

Entity pagination request

This request retrieves all entities that the user has permissions to interact with.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

paginationSize

number

required

Number of items per page

>= 0

page

number

required

Requested page, starting at 0

>= 0

orderBy

required

Order by the specified field

orderDirection

boolean

required

If true, ordering is descending. Otherwise the ordering is ascending

string

optional

if provided, the query will match entities where any field contains the specified string. The matching is case sensitive

tenant

string

required

Tenant for the query

scope

string

required

Scope for the query

types

array[string]

optional

Array of datamodel types. Only entities of the provied types will be returned.

Example

{
  "orderBy": "entities.urn",
  "orderDirection": false,
  "page": 1,
  "paginate": true,
  "paginationSize": 10
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/public/v1/entities/paginate' \
--header 'Content-Type: application/json' \
--data-raw '{
  "orderBy": "entities.urn",
  "orderDirection": false,
  "page": 1,
  "paginate": true,
  "paginationSize": 10
}'

Responses

🟢200Success

application/json

Body

rows

array[object (EntitySchema) {9}]

required

integer

required

Entity unique id

name

string

required

Entity name

urn

string

required

Entity FIWARE URN

datamodel

string

required

Entity data model

scope

string

required

Entity scope name

scope_id

integer

required

Entity scope unique id

tenant

string

required

Entity tenant

tenant_id

integer

required

Entity tenant unique id

devices

array[integer]

required

Ids of the devices that are related to this entity

count

integer

required

Total rows

Example

{
  "rows": [
    {
      "id": 82,
      "name": "Device 001",
      "urn": "urn:ngsi-ld:Device:Device001",
      "datamodel": "Device",
      "scope": "/",
      "scope_id": 4,
      "tenant": "OrganizationA",
      "tenant_id": 4,
      "devices": [
        500
      ]
    },
    {
      "id": 84,
      "name": "Device 002",
      "urn": "urn:ngsi-ld:Device:Device002",
      "datamodel": "Device",
      "scope": "/",
      "scope_id": 4,
      "tenant": "OrganizationA",
      "tenant_id": 4,
      "devices": [
        507
      ]
    }
  ],
  "count": 10
}

Modified at 2025-03-24 11:31:43

Get Timeseries

Get entity latest data

Paginate Entitites

Entity pagination request#

Request

Request samples

Responses

Entity pagination request