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

Example

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

Request Code 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

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 Code Samples

Responses

Entity pagination request