Jump to

• Request
• Response
• Examples

Application Package - V2

get

/appstore/publisher/v2/applications/{listingVersionId}/packages

Get the package configured for the application. A package describes the resources and its properties required for the application.

Request

Path Parameters

• listingVersionId: integer(int64)
  Unique identifier of the application for which to return package details

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

Root Schema : Package

Type: object

Show Source

• description(optional): string
• links(optional): array link
• namespacePrefix(optional): string
• resources(optional): array resources
• serviceType(optional): string
• tncId(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "namespacePrefix":{
            "type":"string"
        },
        "tncId":{
            "type":"string"
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PackageResource"
            }
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : resources

Type: array

Show Source

• Array of: object PackageResource

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

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 : PackageResource

Type: object

Show Source

• properties(optional): array properties
• serviceType(optional): string
• type(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResourceProperty"
            }
        }
    }
}

Nested Schema : properties

Type: array

Show Source

• Array of: object ResourceProperty

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

Nested Schema : ResourceProperty

Type: object

Show Source

• name(optional): string
• value(optional): string

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

400 Response

Bad Request

401 Response

Not Authorized

500 Response

System Error

Back to Top

Examples

The following example returns a list of package for an application, 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/v2/applications/{listingVersionId}/packages"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
    "id": 148637028,
    "listingVersionId": 148637011,
    "serviceType": "JAVA",
    "description": "JCS - Self Service Portal is a pre-configured, ready to run image for running Self Service Application on Oracle Cloud.",
    "version": "16.2",
    "namespacePrefix": "Rest Package Snippet",
    "tncId": 2528849,
    "status": {
        "code": "NEW",
        "displayName": "New"
    },
    "referredByOtherListings": false,
    "resources": [
        {
            "id": 148637037,
            "type": "datasourcealias",
            "serviceType": "JAVA",
            "properties": [
                {
                    "name": "ALIAS_NAME",
                    "value": "productionDS"
                }
            ]
        },
        {
            "id": 148637040,
            "type": "datasourcealias",
            "serviceType": "JAVA",
            "properties": [
                {
                    "name": "ALIAS_NAME",
                    "value": "stagingDS"
                }
            ]
        },
        {
            "id": 148637033,
            "type": "applicationarchive",
            "serviceType": "JAVA",
            "properties": [
                {
                    "name": "APPLICATION_NAME",
                    "value": "Self Service Portal"
                },
                {
                    "name": "file",
                    "value": "Self_Service_Portal_V2.1_JCS.war"
                }
            ]
        }
    ]
}

Back to Top