Virtual link calculation
GET /deviceinformationservice/api/v1/tenants/{tenantId}/virtual-link-calculation/{componentInstanceId}
Triggers virtual link calculation for all entities in a given tenant to initialize a single subscriber.
The subscriber initialization endpoint is used to trigger virtual link calculation for a single subscriber of the DIS change feed.
This process allows for the initial trigger of virtual link calculation for a subscriber.
To perform this operation, you must be authenticated by means of one of the following methods:
-
oauth2_authCode (scopes: PolicyAtLeastDisReader)
-
bearerAuth (scopes: PolicyAtLeastDisReader)
Parameters
|
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
tenantId |
path |
string (uuid) |
true |
A GUID that determines the customer tenant. |
|
componentInstanceId |
path |
string (uuid) |
true |
A GUID that determines the subscriber. |
Responses
|
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
|
202 |
Accepted |
An indication about the successful trigger of virtual link calculation. The end-to-end execution is asynchronous and therefore this endpoint does not wait for the completion and results of that. |
none |
|
401 |
Unauthorized |
Unauthorized. |
none |
|
403 |
Forbidden |
Forbidden. Required authority: PolicyAtLeastDisReader |
none |
|
429 |
Too Many Requests |
The request was rejected for this subscriber. Another virtual link calculation is currently being processed. Please wait for the previous calculation to complete before submitting a new request. |
none |