1. REST API for Oracle Cloud Marketplace Publisher
  2. Tasks
  3. Generic Listing Resources

Get Listings/Listing Activities

get

/appstore/publisher/v1/listings

This api serves two purpose.
  • One is to get the list of all listings(both applications and services for the publisher.
  • other is to provide listingactivies report

It is the "groupby" query parameter which differentiates these two calls.If "groupby" query parameter is specified then it is considered as listingActivites call.

Request

Query Parameters
  • This query parameter is applicable only for listingActivites fetch call and it is used to get the result set created within the given date range.
  • This query parameter is applicable only for listingActivites fetch call and it is used to get the result set created after the given date.
  • This query parameter is present, then the api call is considered as listingactivities fetch call. Acceptable value is LISTING.
  • This is one of the filter options the supported languages.
  • Limit tells how many records to return (starting from the offset). Limit should be greater than zero and less than or equal to 100 (default=30).
  • This is a filter option used to get the result set with given name.
  • Offset and limit together determine how many records to return from the collection. Offset is the starting index of the records to return, which should be greater than or equal to zero (default=0).
  • This property sorts the result set. Acceptable values are NAME, LASTUPDATEDATE.
  • This property specifies the order in which to sort the result set. Acceptable values are ASC and DESC.
  • This parameter determines listing status (for example, NEW or PUBLISHED ...etc). Multiple values for this parameter is also supported. Please use comma-separated values when searching for listings corresponding to multiple statuses.
Back to Top

Response

Supported Media Types

200 Response

Successful Operation
Body ()
Root Schema : collection
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : genericListing
Type: object
Show Source
Nested Schema : Icon
Type: object
Show Source
Nested Schema : Item
Type: object
Show Source
Nested Schema : Progress
Type: object
Show Source

400 Response

Invalid Parameter Value/Bad Request

401 Response

Not Authorized

500 Response

System Error
Back to Top

Examples

This api serves two purpose.
1. Fetching Listing
2. Fetching Listing Activites

1.Fetching Leads

The following example returns the list of all listings(application and services) belonging to a partner by submitting a GET request on the REST resource using cURL.

cURL Example

curl -X GET -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/listings?limit=2"

Request Header

X-Oracle-UserId: fname.lname@oracle.com
Authorization: Bearer Access-token

Request Body

   None

HTTP Status Code:

200 OK

JSON Response:

{
    "items": [
            {
                "GenericListing": {
                "name": "QA-18.2.6-v1",
                "listingId": 2829370,
                "listingVersionId": 2829371,
                "type": {
                    "code": "APPLICATION",
                    "name": "Application"
                },
                "headline": "Powerful PIM designed to simplify management processes",
                "version": "1.4.18-0 on OL 6.7",
                "lastModifiedBy": "SaiGanesh Popuri",
                "lastModificationDate": "2018-07-04T11:33:18.869Z",
                "privateApp": false,
                "icon": {
                    "contentURL": "https://partner.cloudmarketplace.oracle.com/partner/content?contentId=2829443"
                },
                "status": {
                    "code": "NEW",
                    "name": "New"
                },
                "progress": {
                    "percentage": "80",
                    "message": "In Progress"
                },
                "packageStatus": {
                    "code": "NEW",
                    "name": "New"
                },
                "versionedListing": false,
                "isCloudReady": false
            }
        },
        {
            "GenericListing": {
                "name": "APS18.2.4REST-SI",
                "listingId": 2829825,
                "listingVersionId": 2829826,
                "type": {
                    "code": "SERVICE",
                    "name": "Service"
                },
                "headline": "tag line",
                "lastModifiedBy": "rest testing",
                "lastModificationDate": "2018-07-05T11:46:22.014Z",
                "privateApp": false,
                "icon": {
                    "contentURL": "https://partner.cloudmarketplace.oracle.com/partner/content?contentId=2829840"
                },
                "status": {
                    "code": "NEW",
                    "name": "New"
                },
                "progress": {
                    "percentage": "100",
                    "message": "Complete"
                },
                "versionedListing": false,
                "isCloudReady": false
            }
        }
],
    "hasMore": true,
    "count": 2,
    "totalResults": 814,
    "links": [
        {
            "rel": "CANONICAL",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/listings"
        },
        {
            "rel": "SELF",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/listings?limit=2"
        },
        {
            "rel": "NEXT",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/listings?offset=2&limit=2"
        }
    ]
}

1.Fetching Listing Activities

The following example fetches the listing activities by submitting a GET request on the REST resource using cURL.


It the "groupby" queryparam which differentiates the get listing call and get listingactivites call.
Accepted value is "listing"

cURL Example

curl -X GET -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/listings?groupby=listing"

Request Header

X-Oracle-UserId: fname.lname@oracle.com
Authorization: Bearer Access-token

Request Body

   None

HTTP Status Code:

200 OK

JSON Response:

{
    "items": [
        {
            "GenericListing": {
                "listingId": 8006556,
                "listingName": "Forceview",
                "appDetailCount": 2,
                "ratingCount": 0,
                "providerCount": 0,
                "demoCount": 0,
                "getAppCount": 2,
                "postedReviewCount": 0,
                "commentsCount": 0,
                "total": 4
            }
        },
        {
            "GenericListing": {
                "listingId": 8054788,
                "listingName": "CloudBerry Backup",
                "appDetailCount": 1,
                "ratingCount": 0,
                "providerCount": 0,
                "demoCount": 0,
                "getAppCount": 0,
                "postedReviewCount": 0,
                "commentsCount": 0,
                "total": 1
            }
        }
    ],
    "hasMore": false,
    "count": 2,
    "totalResults": 2,
    "links": [
        {
            "rel": "CANONICAL",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/listings"
        },
        {
            "rel": "SELF",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/listings?groupby=listing"
        }
    ]
}
Back to Top