Show / Hide Table of Contents

Class ListListingsRequest

Inheritance
object
ListListingsRequest
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.MarketplaceService.Requests
Assembly: OCI.DotNetSDK.Marketplace.dll
Syntax
public class ListListingsRequest : IOciRequest
Examples

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

Properties

Category

Declaration
[HttpConverter(TargetEnum.Query, "category", CollectionFormatType.Multi)]
public List<string> Category { get; set; }
Property Value
Type Description
List<string>

Name of the product category or categories. If you specify multiple categories, then Marketplace returns any listing with one or more matching categories.

CompartmentId

Declaration
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The unique identifier for the compartment.

ImageId

Declaration
[HttpConverter(TargetEnum.Query, "imageId")]
public string ImageId { get; set; }
Property Value
Type Description
string

The image identifier of the listing.

IsFeatured

Declaration
[HttpConverter(TargetEnum.Query, "isFeatured")]
public bool? IsFeatured { get; set; }
Property Value
Type Description
bool?

Indicates whether to show only featured listings. If this is set to false or is omitted, then all listings will be returned.

Limit

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

How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.

ListingId

Declaration
[HttpConverter(TargetEnum.Query, "listingId")]
public string ListingId { get; set; }
Property Value
Type Description
string

The unique identifier for the listing.

ListingTypes

Declaration
[HttpConverter(TargetEnum.Query, "listingTypes", CollectionFormatType.Multi)]
public List<ListingType> ListingTypes { get; set; }
Property Value
Type Description
List<ListingType>

The type of the listing.

Name

Declaration
[HttpConverter(TargetEnum.Query, "name", CollectionFormatType.Multi)]
public List<string> Name { get; set; }
Property Value
Type Description
List<string>

The name of the listing.

OpcRequestId

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

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

OperatingSystems

Declaration
[HttpConverter(TargetEnum.Query, "operatingSystems", CollectionFormatType.Multi)]
public List<string> OperatingSystems { get; set; }
Property Value
Type Description
List<string>

The operating system of the listing.

PackageType

Declaration
[HttpConverter(TargetEnum.Query, "packageType")]
public string PackageType { get; set; }
Property Value
Type Description
string

A filter to return only packages that match the given package type exactly.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

The value of the opc-next-page response header from the previous "List" call.

Pricing

Declaration
[HttpConverter(TargetEnum.Query, "pricing", CollectionFormatType.Multi)]
public List<PricingTypeEnum> Pricing { get; set; }
Property Value
Type Description
List<PricingTypeEnum>

Name of the pricing type. If multiple pricing types are provided, then any listing with one or more matching pricing models will be returned.

PublisherId

Declaration
[HttpConverter(TargetEnum.Query, "publisherId")]
public string PublisherId { get; set; }
Property Value
Type Description
string

Limit results to just this publisher.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListListingsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListListingsRequest.SortByEnum?

The field to use to sort listed results. You can only specify one field to sort by. TIMERELEASED displays results in descending order by default. You can change your preference by specifying a different sort order.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListListingsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListListingsRequest.SortOrderEnum?

The sort order to use, either ASC or DESC.

Implements

IOciRequest
In this article
Back to top