Jump to

• Request
• Response
• Examples

List of Versions

get

/appstore/publisher

Get a list of all supported versions.

Request

Query Parameters

• 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/Version"
            }
        },
        "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 version

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

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : version

Type: object

Show Source

• buildVersion(optional): string
• latest(optional): boolean
  Default Value: false
• lifecycle(optional): string
• links(optional): array link
• predecessor(optional): string
• resourceList(optional): array resourceList
• successor(optional): string
• terminationDate(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string"
        },
        "latest":{
            "type":"boolean",
            "default":false
        },
        "lifecycle":{
            "type":"string"
        },
        "buildVersion":{
            "type":"string"
        },
        "terminationDate":{
            "type":"string"
        },
        "predecessor":{
            "type":"string"
        },
        "successor":{
            "type":"string"
        },
        "resourceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CatalogEntry"
            }
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"version"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : resourceList

Type: array

Show Source

• Array of: object catalogEntry

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

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

Nested Schema : catalogEntry

Type: object

Show Source

• allowedMethods(optional): array allowedMethods
• links(optional): array link
• root(optional): string

{
    "type":"object",
    "properties":{
        "root":{
            "type":"string"
        },
        "allowedMethods":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"catalogEntry"
    }
}

Nested Schema : allowedMethods

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

400 Response

Invalid Parameter Value

401 Response

Not Authorized

500 Response

System Error

Back to Top

Examples

The following example returns a collection of all the versions available for a partner REST API, by submitting a GET request on the REST resource using cURL.

cURL Example

curl -X GET -H "Authorization: Bearer Access-token" "https://ocm-apis.cloud.oracle.com/appstore/publisher"

Request Header

Authorization: Bearer Access-token

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

"items": [
   {
     "version": "v1",
     "latest": true,
     "lifecycle": "active",
      "buildVersion": ": OPCINFRA_APPSTORE.18.2.6_GENERIC_180705.2145"
   }
 ],
 "hasMore": false,
 "count": 1,
 "totalResults": 1,
 "links": [
   {
     "rel": "CANONICAL",
     "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher"
   },
   {
     "rel": "SELF",
     "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher"
   }
 ]
}

Back to Top