Class DigitalTwinRelationship

A digital twin relationship represents an association between two digital twin instances. It can include properties to describe the nature and context of the association within the IoT domain.
To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

Inheritance
object
DigitalTwinRelationship
Inherited Members
Namespace: Oci.IotService.Models
Assembly: OCI.DotNetSDK.Iot.dll
Syntax
public class DigitalTwinRelationship

Properties

Content

Declaration
[JsonProperty(PropertyName = "content")]
public Dictionary<string, object> Content { get; set; }
Property Value
Type Description
Dictionary<string, object>

The value(s) of the relationship properties defined in the source digital twin model.

ContentPath

Declaration
[Required(ErrorMessage = "ContentPath is required.")]
[JsonProperty(PropertyName = "contentPath")]
public string ContentPath { get; set; }
Property Value
Type Description
string

Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A short description of the resource.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Remarks

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the resource.
Remarks

Required

IotDomainId

Declaration
[Required(ErrorMessage = "IotDomainId is required.")]
[JsonProperty(PropertyName = "iotDomainId")]
public string IotDomainId { get; set; }
Property Value
Type Description
string

The OCID of the IoT domain.
Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

The current state of the digital twin relationship.
Remarks

Required

SourceDigitalTwinInstanceId

Declaration
[Required(ErrorMessage = "SourceDigitalTwinInstanceId is required.")]
[JsonProperty(PropertyName = "sourceDigitalTwinInstanceId")]
public string SourceDigitalTwinInstanceId { get; set; }
Property Value
Type Description
string

The OCID of source digital twin instance.
Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TargetDigitalTwinInstanceId

Declaration
[Required(ErrorMessage = "TargetDigitalTwinInstanceId is required.")]
[JsonProperty(PropertyName = "targetDigitalTwinInstanceId")]
public string TargetDigitalTwinInstanceId { get; set; }
Property Value
Type Description
string

The OCID of target digital twin instance.
Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
Remarks

Required

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z