Class ApiMetadata

An ApiDetail contains details such as the service it belongs to, the name of the api, the type of api, and the parameters of the api if it contains.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance
object
ApiMetadata
Inherited Members
Namespace: Oci.ApiaccesscontrolService.Models
Assembly: OCI.DotNetSDK.Apiaccesscontrol.dll
Syntax
public class ApiMetadata

Properties

ApiName

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

The name of the api to execute the api request.

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"}}

DisplayName

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

The operation Name of the api. The name must be unique.
Remarks

Required

EntityType

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

ResourceType to which the apiMetadata belongs to.

Fields

Declaration
[JsonProperty(PropertyName = "fields")]
public List<string> Fields { get; set; }
Property Value
Type Description
List<string>

List of the fields that is use while calling post or put for the data.

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 ApiDetail.
Remarks

Required

LifecycleDetails

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

A message that describes the current state of the ApiMetadata in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

LifecycleState

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

The current state of the ApiMetadata.
Remarks

Required

Path

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

rest path of the api.

ServiceName

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

The service Name to which the api belongs to.

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"}}

TimeCreated

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

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

Required

TimeDeleted

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

The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z

TimeUpdated

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

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