Class Term

Full term definition. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be stated at the term level. Nesting of terms to support a hierarchy is supported by default.

Inheritance

object

Term

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Models

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class Term

Properties

AssociatedObjectCount

Declaration

[JsonProperty(PropertyName = "associatedObjectCount")]
public int? AssociatedObjectCount { get; set; }

Property Value

Type	Description
int?	The number of objects tagged with this term

AssociatedObjects

Declaration

[JsonProperty(PropertyName = "associatedObjects")]
public List<TermAssociatedObject> AssociatedObjects { get; set; }

Property Value

Type	Description
List<TermAssociatedObject>	Array of objects associated to a term.

CreatedById

Declaration

[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created the term.

CustomPropertyMembers

Declaration

[JsonProperty(PropertyName = "customPropertyMembers")]
public List<CustomPropertyGetUsage> CustomPropertyMembers { get; set; }

Property Value

Type	Description
List<CustomPropertyGetUsage>	The list of customized properties along with the values for this object

Description

Declaration

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

Property Value

Type	Description
string	Detailed description of the term.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

GlossaryKey

Declaration

[JsonProperty(PropertyName = "glossaryKey")]
public string GlossaryKey { get; set; }

Property Value

Type	Description
string	Unique id of the parent glossary.

IsAllowedToHaveChildTerms

Declaration

[JsonProperty(PropertyName = "isAllowedToHaveChildTerms")]
public bool? IsAllowedToHaveChildTerms { get; set; }

Property Value

Type	Description
bool?	Indicates whether a term may contain child terms.

Key

Declaration

[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

Type	Description
string	Unique term key that is immutable.

Remarks

Required

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	The current state of the term.

Owner

Declaration

[JsonProperty(PropertyName = "owner")]
public string Owner { get; set; }

Property Value

Type	Description
string	OCID of the user who is the owner of this business terminology.

ParentTermKey

Declaration

[JsonProperty(PropertyName = "parentTermKey")]
public string ParentTermKey { get; set; }

Property Value

Type	Description
string	This terms parent term key. Will be null if the term has no parent term.

Path

Declaration

[JsonProperty(PropertyName = "path")]
public string Path { get; set; }

Property Value

Type	Description
string	Absolute path of the term.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the term was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The last time that any change was made to the term. An RFC3339 formatted datetime string.

UpdatedById

Declaration

[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who modified the term.

Uri

Declaration

[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }

Property Value

Type	Description
string	URI to the term instance in the API.

WorkflowStatus

Declaration

[JsonProperty(PropertyName = "workflowStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public TermWorkflowStatus? WorkflowStatus { get; set; }

Property Value

Type	Description
TermWorkflowStatus?	Status of the approval process workflow for this business term in the glossary.