Class ListTermsRequest

Inheritance

object

ListTermsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Requests

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class ListTermsRequest : IOciRequest

Examples

Click here to see an example of how to use ListTerms request.

Properties

CatalogId

Declaration

[Required(ErrorMessage = "CatalogId is required.")]
[HttpConverter(TargetEnum.Path, "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	Unique catalog identifier.

Remarks

Required

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given. The match is not case sensitive.

DisplayNameContains

Declaration

[HttpConverter(TargetEnum.Query, "displayNameContains")]
public string DisplayNameContains { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

Fields

Declaration

[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<ListTermsRequest.FieldsEnum> Fields { get; set; }

Property Value

Type	Description
List<ListTermsRequest.FieldsEnum>	Specifies the fields to return in a term summary response.

GlossaryKey

Declaration

[Required(ErrorMessage = "GlossaryKey is required.")]
[HttpConverter(TargetEnum.Path, "glossaryKey")]
public string GlossaryKey { get; set; }

Property Value

Type	Description
string	Unique glossary key.

Remarks

Required

IsAllowedToHaveChildTerms

Declaration

[HttpConverter(TargetEnum.Query, "isAllowedToHaveChildTerms")]
public bool? IsAllowedToHaveChildTerms { get; set; }

Property Value

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

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

ParentTermKey

Declaration

[HttpConverter(TargetEnum.Query, "parentTermKey")]
public string ParentTermKey { get; set; }

Property Value

Type	Description
string	Unique key of the parent term.

Path

Declaration

[HttpConverter(TargetEnum.Query, "path")]
public string Path { get; set; }

Property Value

Type	Description
string	Full path of the resource for resources that support paths.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListTermsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListTermsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListTermsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListTermsRequest.SortOrderEnum?	The sort order to use, either 'asc' or 'desc'.

WorkflowStatus

Declaration

[HttpConverter(TargetEnum.Query, "workflowStatus")]
public TermWorkflowStatus? WorkflowStatus { get; set; }

Property Value

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

Implements

IOciRequest