Twins

The Twins endpoints enable creating, updating, and fetching one or more twins at a time. When receiving twins, there are also options to include relationships in the same response.

Operations

List twins

Request

Security

oauth2

Bodyapplication/jsonrequired

Instance of GetTwinsRequest.

modelFilterobject(RequestModelFilter)

Model Filter Class for Get Twins Request.

relationshipFilterobject(RequestRelationshipFilter)

Get Twins Request Relationship Filter

locationFilterobject(RequestLocationFilter)

Location Filter Class for Get Twins Request.

dateFilterobject(RequestDateFilter)

Date Filter Class for Get Twins Request.

propertyFilterobject(RequestPropertyFilter)

Represents a group of filter specifications. Contains a list of individual filter specifications.

includeobject(RequestIncludeOption)

Include Option Class for Get Twins Request.

pageSizeinteger, (int32), [ 1 .. 1000 ]

Maximum number of twins to return per request. Minimum is 1 and Maximum is 1000.

continuationTokennull or string

Continuation Token for subsequent requests. Set the Continuation token for the initial request.

POST

/twins

{
  "modelFilter": {
    "modelIds": [ … ],
    "exactModelMatch": true
  },
  "relationshipFilter": {
    "relationshipDirection": "Incoming",
    "relationshipNames": null,
    "relatedModelFilter": { … }
  },
  "locationFilter": {
    "locationId": null
  },
  "dateFilter": {
    "lastUpdatedAfter": null,
    "lastUpdatedBefore": null
  },
  "propertyFilter": {
    "field": null,
    "operator": null,
    "value": null,
    "filterConditionOperator": "And",
    "filters": [ … ]
  },
  "ModelFilter": {
    "ModelIds": [ … ],
    "ExactModelMatch": true
  },
  "RelationshipFilter": {
    "RelationshipDirection": "Outgoing",
    "RelationshipNames": [ … ],
    "RelatedModelFilter": { … }
  },
  "LocationFilter": {
    "LocationId": null
  },
  "DateFilter": {
    "LastUpdatedAfter": "2024-09-23T15:16:03.405Z",
    "LastUpdatedBefore": "2024-09-23T15:16:03.405Z"
  },
  "PropertyFilter": {
    "Filters": [ … ],
    "FilterConditionOperator": "and"
  },
  "Include": {
    "OutgoingRelationships": true,
    "IncomingRelationships": true
  },
  "PageSize": 101,
  "ContinuationToken": null
}

Responses

Page`1.

Bodyapplication/json

contentArray of objects(DigitalTwinWithRelationships)

Gets or sets the collection of items contained in the response.

Example:

[
  {
    "id": "TW-DD-II-L01",
    "modelId": "dtmi:com:willowinc:Level;1",
    "lastUpdateTime": "2024-08-30T03:49:30.4062816+00:00",
    "contents": { … },
    "incomingRelationships": [ … ],
    "outgoingRelationships": [ … ]
  }
]

continuationTokennull or string

Gets or sets the continuation token used to retrieve the next page of results in a paginated operation.

Response

{
  "content": [
    { … }
  ],
  "continuationToken": null
}

Twins

List twins

Request

Responses

Was this helpful?