app_catalog_listings

Creates, updates, deletes, gets or lists an app_catalog_listings resource.

Overview

Name	app_catalog_listings
Type	Resource
Id	oci.compute.app_catalog_listings

Fields

The following fields are returned by SELECT queries:

get

The listing was retrieved.

Name	Datatype	Description
contactUrl	string	Listing's contact URL.
description	string	Description of the listing.
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
listingId	string	The OCID of the listing.
publisherLogoUrl	string	Publisher's logo URL.
publisherName	string	Name of the publisher who published this listing.
summary	string	Summary of the listing.
timePublished	string (date-time)	Date and time the listing was published, in [RFC3339](https:​//tools.ietf.org/html/rfc3339) format. Example: 2018-03-20T12:32:53.532Z

list

A summary of a listing.

Name	Datatype	Description
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
listingId	string	the region free ocid of the listing resource.
publisherName	string	The name of the publisher who published this listing.
summary	string	The short summary for the listing.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	listingId, region		Gets the specified listing.
list	select	region	limit, page, sortOrder, publisherName, publisherType, displayName	Lists the published listings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
listingId	string	The OCID of the listing.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayName	string	A filter to return only resources that match the given display name exactly.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
publisherName	string	A filter to return only the publisher that matches the given publisher name exactly.
publisherType	string	A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples

get

Gets the specified listing.

SELECT
contactUrl,
description,
displayName,
listingId,
publisherLogoUrl,
publisherName,
summary,
timePublished
FROM oci.compute.app_catalog_listings
WHERE listingId = '{{ listingId }}' -- required
AND region = '{{ region }}' -- required
;

list

Lists the published listings.

SELECT
displayName,
listingId,
publisherName,
summary
FROM oci.compute.app_catalog_listings
WHERE region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND publisherName = '{{ publisherName }}'
AND publisherType = '{{ publisherType }}'
AND displayName = '{{ displayName }}'
;