REST API for Oracle Cloud Marketplace Publisher

Update Icon

put

/appstore/publisher/v1/services/{listingVersionId}/icon

Update the icon for the service.

Request

Supported Media Types

multipart/form-data

Path Parameters

listingVersionId: integer(int64)

Unique identifier of the listing for which to update the icon.

Upload the icon to be updated.

Root Schema : FormDataMultiPart

Type: object

Show Source

bodyParts(optional): array bodyParts
contentDisposition(optional): object ContentDisposition
entity(optional): object entity
fields(optional): object fields

Additional Properties Allowed: additionalProperties
headers(optional): object headers

Additional Properties Allowed: additionalProperties
mediaType(optional): object MediaType
parameterizedHeaders(optional): object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent(optional): object MultiPart
providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BodyPart"
            }
        },
        "fields":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/FormDataBodyPart"
                }
            }
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : bodyParts

Type: array

Show Source

Array of: object BodyPart

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

Nested Schema : ContentDisposition

Type: object

Show Source

creationDate(optional): string(date-time)
fileName(optional): string
modificationDate(optional): string(date-time)
parameters(optional): object parameters

Additional Properties Allowed: additionalProperties
readDate(optional): string(date-time)
size(optional): integer(int64)
type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : fields

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/FormDataBodyPart"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

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

Nested Schema : MediaType

Type: object

Show Source

parameters(optional): object parameters

Additional Properties Allowed: additionalProperties
subtype(optional): string
type(optional): string
wildcardSubtype(optional): boolean

Default Value: false
wildcardType(optional): boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean",
            "default":false
        },
        "wildcardSubtype":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : MultiPart

Type: object

Show Source

bodyParts(optional): array bodyParts
contentDisposition(optional): object ContentDisposition
entity(optional): object entity
headers(optional): object headers

Additional Properties Allowed: additionalProperties
mediaType(optional): object MediaType
parameterizedHeaders(optional): object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent(optional): object MultiPart
providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BodyPart"
            }
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : Providers

Type: object

Nested Schema : BodyPart

Type: object

Show Source

contentDisposition(optional): object ContentDisposition
entity(optional): object entity
headers(optional): object headers

Additional Properties Allowed: additionalProperties
mediaType(optional): object MediaType
parameterizedHeaders(optional): object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent(optional): object MultiPart
providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

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

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

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

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object ParameterizedHeader

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

Nested Schema : ParameterizedHeader

Type: object

Show Source

parameters(optional): object parameters

Additional Properties Allowed: additionalProperties
value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object FormDataBodyPart

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

Nested Schema : FormDataBodyPart

Type: object

Show Source

contentDisposition(optional): object ContentDisposition
entity(optional): object entity
formDataContentDisposition(optional): object FormDataContentDisposition
headers(optional): object headers

Additional Properties Allowed: additionalProperties
mediaType(optional): object MediaType
name(optional): string
parameterizedHeaders(optional): object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent(optional): object MultiPart
providers(optional): object Providers
simple(optional): boolean

Default Value: false
value(optional): string

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "simple":{
            "type":"boolean",
            "default":false
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "formDataContentDisposition":{
            "$ref":"#/definitions/FormDataContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : FormDataContentDisposition

Type: object

Show Source

creationDate(optional): string(date-time)
fileName(optional): string
modificationDate(optional): string(date-time)
name(optional): string
parameters(optional): object parameters

Additional Properties Allowed: additionalProperties
readDate(optional): string(date-time)
size(optional): integer(int64)
type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

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

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

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

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object ParameterizedHeader

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

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

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

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object ParameterizedHeader

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

Nested Schema : bodyParts

Type: array

Show Source

Array of: object BodyPart

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

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

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

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

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

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object ParameterizedHeader

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

Response

Supported Media Types

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

200 Response

Successful Operation

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

Examples

The following example updates the icon for an existing listing belonging to a partner, by submitting a PUT request on the REST resource using cURL.

cURL Example

curl -X PUT -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW " -F "image=@file-path" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/applications/2908689/icon"

Request Header

X-Oracle-UserId: fname.lname@oracle.com 
Authorization: Bearer Access-token

Request Body

[form-data]
image: File Upload

HTTP Status Code:

200 OK

JSON Response:

{
  "message": "Icon upload was successful.",
  "entityId": "2915754"
}