Change detection

Copy 
GET /deviceinformationservice/api/v1/tenants/{tenantId}/entity-attribute-changes

Supports systems that are using a Pull-based approach for synchronization.

The change detection endpoint supports systems using the pull method for synchronization. It allows other systems to keep themselves up-to-date with DIS by polling for changes within a sliding time window. By making a request to this endpoint, the system retrieves any changes that have occurred within the specified frame.

The pull-base synchronization mechanism uses a sliding time window to find overlaps with:

  • last modification time stamps - to detect recent modifications in entity relations or attribute sets.

  • effective time ranges of relationships or attribute sets - to detect changes in effective (actual) values.

To perform this operation, you must be authenticated by means of one of the following methods:

  • oauth2_implicit (scopes: PolicyAtLeastDisReader)

  • bearerAuth (scopes: PolicyAtLeastDisReader)

Parameters

Table 76 

Name

In

Type

Required

Description

tenantId

path

string (uuid)

true

A GUID that determines the customer tenant.

entityClasses

query

array [string]

false

An array of entity classes to narrow down the entities being retrieved and watched for changes. Optional. Default: All entity classes.

attributeTypes

query

array [string]

false

An array of attribute types to narrow down the attributes retrieved and being watched for changes. Optional. Default: All attribute types.

start

query

string

false

Point in time that determines the earliest change event to be included. Optional. Default: Beginning of time.

end

query

string

false

Point in time that determines the latest change event to be included. Optional. Default: End of time.

Authorization

header

string

false

JWT access token obtained from the Identity Server. Such as "Bearer: xyz".

Responses

Table 77 

Status

Meaning

Description

Schema

200

OK

An array of entities that had a change in their attribute values or relationships within the specified time window. The returned entities always include the entire history if their parent relations and attribute sets.

get entities response

401

Unauthorized

Unauthorized

none

403

Forbidden

Forbidden. Required authority: PolicyAtLeastDisReader

none