Jump to

• Request
• Response
• Examples

List of Products

get

/appstore/publisher/v1/products

Get a list of products that can be associated with applications and services.

Request

Query Parameters

• expands(optional): string
  It is a optional parameter and accepts categories, filters or both (comma-separated) as value. If it is mentioned, the api returns products and all categories and/or filters of that product.
• limit(optional): integer(int32)
  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).
• offset(optional): integer(int32)
  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).

Back to Top

Response

Supported Media Types

• application/json;qs=1
• application/xml;qs=.5

200 Response

Successful Operation

Body ()

Root Schema : collection

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
  Default Value: false
• items(optional): array items
• links(optional): array link
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "xml":{
                "name":"items",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Product"
            }
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"collection"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object product

{
    "type":"array",
    "xml":{
        "name":"items",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/Product"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "name":"link",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : product

Type: object

Show Source

• categories(optional): array categories
• code(optional): string
• filters(optional): array filters
• name(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProductFilter"
            }
        }
    },
    "xml":{
        "name":"product"
    }
}

Nested Schema : categories

Type: array

Show Source

• Array of: object Item

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Item"
    }
}

Nested Schema : filters

Type: array

Show Source

• Array of: object ProductFilter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProductFilter"
    }
}

Nested Schema : Item

Type: object

Show Source

• code(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : ProductFilter

Type: object

Show Source

• code(optional): string
• name(optional): string
• values(optional): array values

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object Item

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Item"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• rel(optional): string
  Allowed Values: [ "SELF", "CANONICAL", "NEXT", "TEMPLATE", "PREV" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "SELF",
                "CANONICAL",
                "NEXT",
                "TEMPLATE",
                "PREV"
            ]
        },
        "href":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

400 Response

Invalid Parameter Value

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

1.List of Products without expands queryparam

The following example returns a list of all the products associated with 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/products?limit=2&offset=2"

Request Header

X-Oracle-UserId: [e-mail]
Authorization: Bearer Access-token

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
  "items": [
    {
      "product": {
        "code": "compute",
        "name": "Compute Cloud"
      }
    }
  ],
  "hasMore": false,
  "count": 1,
  "totalResults": 3,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/products"
    },
    {
      "rel": "SELF",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/products?offset=2&limit=2"
    },
    {
      "rel": "PREV",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/products?limit=2"
    }
  ]
}

2.List of Products with expands queryparam

The following example returns a list of all the products and its categories , 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/products?expands=categories"

Request Header

X-Oracle-UserId: [e-mail]
Authorization: Bearer Access-token

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
   "items":[
      {
         "product":{
            "code":"compute",
            "name":"Compute Cloud",
            "categories":[
               {
                  "code":"CLOUD_MIGRATION",
                  "name":"Cloud Migration"
               },
               {
                  "code":"APPLICATIONS_UNLIMITED",
                  "name":"Applications Unlimited"
               },
               {
                  "code":"CLOUD_MANAGEMENT",
                  "name":"Cloud Management"
               },
               {
                  "code":"VIRTUAL_MACHINES",
                  "name":"Virtual Machines"
               },
               {
                  "code":"SAAS_ON_ORACLE_CLOUD_PLATFORM",
                  "name":"SaaS on Oracle Cloud Platform"
               },
               {
                  "code":"READY",
                  "name":"Ready"
               }
            ]
         }
      }
   ],
   "hasMore":false,
   "count":1,
   "totalResults":1,
   "links":[
      {
         "rel":"CANONICAL",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/products"
      },
      {
         "rel":"SELF",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/products?expands=categories"
      }
   ]
}

Back to Top