Update a Published Application Listing

You can update the content or data of an application listing or package by creating a new version of the listing.

Create Application Version

A published listing cannot be updated directly. The Create Application Version API creates a new version that you can update with API calls.

PATCH	/appstore/publisher/v1/applications/entityid/version

The entityId value is the application ID returned in the result of the Create Application API call.

After creating a new version of the application listing, you can use APIs to update the data as needed, like icon, related docs, screenshots, and package information. The new version of the listing needs to be submitted and published using the Create Application Version API.

Request Headers

Header Name	Data Type	Remarks	Sample Data
Authorization	String	Authorization token	Bearer access_token
X-Oracle-UserId	String	Partner login email	[e-mail]
Cache-Control	String		no-cache

Response

Response	Details
Headers	Content-Type, Content-Encoding, Location Status: 201, 400, 401, 403, 404, 405, 500 Status Codes describes when each of these HTTP status codes is returned.
Payload	{"message":"Application created.", "entityId":"3419671"} The entityId value is the application ID returned in the result of the Create Application API call.

Update Application

The Update Application API updates the listing information using the ID created in the Create Application Version API.

PUT	/appstore/publisher/v1/applications/appversionId

The appversionId value is the version returned in the result of the Create Application Version API call.

Request Headers

Header Name	Data Type	Remarks	Sample Data
Authorization	String	Authorization token	Bearer access_token
X-Oracle-UserId	String	Partner login email	[e-mail]
Content-Type	String	Content type allowed	application/json,application/xml
Cache-Control	String		no-cache

Request Payload

{
    "listingId": 3606012,
    "listingVersionId": 3606151,
    "name": "DocumentManager",
    "shortDescription": "DocumentManager is a simple solution for keeping all your photos organized.???",
    "longDescription": "You can use DocumentManager to keep all files, including media files, organized. It can search, organize, share, and synch files across devices too.",
    "versionDetails": {
        "versionNumber": "16.2.5",
        "description": "<a target=\"_blank\" href=\"https://DocumentManager.com/changelog.txt\">Change Log</a>",
        "releaseDate": "2016-07-03T07:00:00.000Z"
    },
    "systemRequirements": "Oracle Cloud<br/>Minimum profile: General OC3 | 1 OCPU, 7.5 Gb RAM, 60 GB Local Disk",
    "tagLine": "Document Manager",
    "tags": "documents, files, sharing data",
    "deviceType": {
        "code": "BROWSER"
    },
    "pricing": {
        "type": "PAYGO",
        "pricingRate": 0.28,
        "pricingStrategy": "PER_INSTANCE",
        "ociListing": true
    },
    "products": [
        {
            "code": "COMPUTE_CLOUD",
            "categories": [
                {
                    "code": "VIRTUAL_MACHINES"
                }
            ],
            "filters": []
        }
    ],
    "support": {
        "contacts": [
            {
                "email": "[e-mail]",
                "name": "DocumentManager Support Email",
                "subject": "Document Manager Application Information"
            }
        ],
        "links": [
            {
                "name": "Document Manager",
                "url": "https://support.documentmanager.com"
            }
        ]
    },
    "languages": [
        {
            "code": "US"
        }
    ]
}

The request payload should have all the fields.

Response

Response	Details
Headers	Content-Type, Content-Encoding, Location Status: 201, 400, 401, 403, 404, 405, 500 Status Codes describes when each of these HTTP status codes is returned.
Payload	{"entityId ":"3418646", "name":"DocumentManager"} The value of entityId is the version returned in the result of the Create Application Version API call.

Update Icon

The Update Icon API updates the listing icon that was created earlier.

PUT	/appstore/publisher/v1/applications/appversionid/icon

The appversionId value is the version returned in the result of the Create Application Version API call.

Request Headers

Header Name	Data Type	Remarks	Sample Data
Authorization	String	Authorization token	Bearer access_token
X-Oracle-UserId	String	Partner login email	[e-mail]
Content-Type	String	Content type allowed	Multipart/form-data
Cache-Control	String		no-cache

Request Payload

image=@/scratch/shkattam/Icon.png

Response

Response	Details
Headers	Content-Type, Content-Encoding, Location Status: 201, 400, 401, 403, 404, 405, 500 Status Codes describes when each of these HTTP status codes is returned.
Payload	{"message":"Icon upload was successful.","entityId":"3418551"} The value of entityId is the version returned in the result of the Create Application Version API call.

Update Screenshots or Videos

The Update Screenshot API updates a screenshot for an application.

PUT	/appstore/publisher/v1/applications/appversionid/screenshots/screenshotid

The appversionId value is the version returned in the result of the Create Application Version API call.

Request Headers

Header Name	Data Type	Remarks	Sample Data
Authorization	String	Authorization token	Bearer access_token
X-Oracle-UserId	String	Partner login email	[e-mail]
Content-Type	String	Content type allowed	Multipart/form-data
Cache-Control	String		no-cache

Request Payload

[      {         "name":"Screen Shot1",       "description":"Screen Shot1 description",       "fileName":"SC1Mod.png",       "sourceType":"INTERNAL"    } ]

Response

Response	Details
Headers	Content-Type, Content-Encoding, Location Status: 201, 400, 401, 403, 404, 405, 500 Status Codes describes when each of these HTTP status codes is returned.
Payload	{"entityId": "8434954", "name": "Screen Shot1"} The value of entityId is the version returned in the result of the Create Application Version API call.

Update Related Documents

The Update Related Docs API updates ...

The appversionId value is the version returned in the result of the Create Application Version API call.

Request Headers

Header Name	Data Type	Remarks	Sample Data
Authorization	String	Authorization token	Bearer access_token
X-Oracle-UserId	String	Partner login email	[e-mail]
Content-Type	String	Content type allowed	Multipart/form-data
Cache-Control	String		no-cache

Request Payload

json={ "name":"related_docs_2","description":"database-guide", 
"sourceType":"EXTERNAL","contentType":"USER_GUIDES ", 
"sourceURL":"https://docs.oracle.com/cd/E11882_01/server.112/e40540.pdf/" 
} 

Response

Response	Details
Headers	Content-Type, Content-Encoding, Location Status: 201, 400, 401, 403, 404, 405, 500 Status Codes describes when each of these HTTP status codes is returned.
Payload	{ "entityId": "3607191", "name": "related_docs_2"} The value of entityId is the version returned in the result of the Create Application Version API call.

Update Application Package

The Update Application Package API updates updates an existing package definition. This API creates a version of the package and updates it per the payload. The following example is for the Compute service. For other services, the package will be similar to the payload of the respective create APIs.

PUT	/appstore/publisher/v1/applications/appversionid/packages/packageId 

The appversionId value is the version returned in the result of the Create Application Version API call. The packageId value is the package ID returned in the result of the Create Application Package API call.

Request Headers

Header Name	Data Type	Remarks	Sample Data
Authorization	String	Authorization token	Bearer access_token
X-Oracle-UserId	String	Partner login email	[e-mail]
Content-Type	String	Content type allowed	Multipart/form-data
Cache-Control	String		no-cache

Request Payload for Compute

{ 
  "id":"3423248",
  "listingVersionId":"3423216",
  "version":"16.2.4",
  "description":"Document Manager Image",
  "type":"UNMANAGED",
  "status":"NEW",
  "dependentServices":[ 
    { 
      "tag":"Compute",
      "serviceName":"Compute"
    }
  ],
  "resources":[ 
    { 
      "tag":"documentmanager16.2.4.tar.gz",
      "location":"partnercontainer/mi/documentmanager16.2.4.tar.gz",
      "version":"16.2.4",
      "standardProperties":[ 
        { 
          "name":"imageName",
          "source":"BLUEPRINT_STATIC",
          "value":" documentmanager16.2.4.tar.gz"
        },
        { 
          "name":"defaultShape",
          "source":"BLUEPRINT_STATIC",
          "value":"oc3"
        },
        { 
          "name":"supportedShapes",
          "source":"BLUEPRINT_STATIC",
          "value":"oc4m,oc7,oc3m,oc5m,oc3,oc5,oc4,oc1m,oc2m,oc6"
        },
        { 
          "name":"size",
          "source":"BLUEPRINT_STATIC",
          "value":"496831871"
        },
        { 
          "name":"minimumDiskSize",
          "source":"BLUEPRINT_STATIC",
          "value":"10"
        }
      ],
      "customProperties":[ 

      ]
    }
  ],
  "actions":[ 
    { 
      "tag":"Create Machine Image",
      "dependentServiceTag":"Compute",
      "actionName":"createMachineImage",
      "type":"OUT_OF_THE_BOX_ACTION",
      "resourceMap":{ 
        "resourceTag":"IMAGE",
        "name":"documentmanager16.2.4.tar.gz"
      }
    },
    { 
      "tag":"Delete Machine Image",
      "dependentServiceTag":"Compute",
      "actionName":"deleteMachineImage",
      "type":"OUT_OF_THE_BOX_ACTION",
      "requestProperties":[ 
        { 
          "name":"imageName",
          "source":"BLUEPRINT_STATIC",
          "value":" documentmanager16.2.4.tar.gz"
        }
      ]
    }
  ],
  "operations":[ 
    { 
      "type":"INSTALL",
      "actionExecutionSequence":[ 
        { 
          "sequenceNumber":1,
          "actionTag":"Create Machine Image"
        }
      ]
    },
    { 
      "type":"UNINSTALL",
      "actionExecutionSequence":[ 
        { 
          "sequenceNumber":1,
          "actionTag":"Delete Machine Image"
        }
      ]
    }
  ]
}

Response

Response	Details
Headers	Content-Type, Content-Encoding, Location Content-Type, Content-Encoding Status: 201, 400, 401, 403, 404, 405, 500 Status Codes describes when each of these HTTP status codes is returned.
Payload	{"message": "Listing package saved with package version = 16.2.4 and packageVersionId = 3423248", "entityId": "3423248"} The value of entityId is the version returned in the result of the Create Application Version API call.

Validate Updated Package

The Validate Updated Package API validates the updated package.

PATCH	/appstore/publisher/v1/applications/appversionid/packages/packageid

The packageid value is the version returned in the result of the Create Application Version API call.

Request Headers

Header Name	Data Type	Remarks	Sample Data
Authorization	String	Authorization token	Bearer access_token
X-Oracle-UserId	String	Partner login email	[e-mail]
Cache-Control	String		no-cache
Content-Type	String		application/json,application/xml

Request Payload

{
  "action": "validate"
}

Response

Response	Details
Headers	Content-Type, Content-Encoding, Location Status: 201, 400, 401, 403, 404, 405, 500 Status Codes describes when each of these HTTP status codes is returned.
Payload	{"message":"ListingPackage validation was successful.", "entityId":"3358342"}

Note:

After the update and validation of a package, the listing needs to be submitted for approval and then published. See Create and Publish an Application Listing and Create and Publish an Application Listing with an Installer Package.