Jump to

• Request
• Response
• Examples

Delete Related Documents

delete

/appstore/publisher/v1/applications/{listingVersionId}/relateddocs/{id}

Delete a related document for an existing application.

Request

Path Parameters

• id: integer(int64)
  ID of the document to delete.
• listingVersionId: integer(int64)
  Listing ID for which to delete the document.

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

Root Schema : acknowledgement

Type: object

Show Source

• contentURL(optional): string
• entityId(optional): string
• message(optional): string
• name(optional): string
• uri(optional): string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "uri":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        }
    },
    "xml":{
        "name":"acknowledgement"
    }
}

400 Response

Bad Request

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example deletes a related document for an existing application belonging to a partner, by submitting a DELETE request on the REST resource using cURL.

cURL Example

curl -X DELETE -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" -H "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/applications/2908689/relateddocs/2916378"

Request Header

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

Request Body

   None

HTTP Status Code:

200 OK

JSON Response:

{
  "message": "Related Document with id = 291637 was deleted successfully.", 
  "entityId": "8422545",
}

Back to Top