Upload Branding Resource

Initiate an upload for the resources of this branding theme using the Transfer Service. A unique transfer service URL is returned where the plugin can be uploaded. The resources should be bundled in a zip, which may also contain a manifest.json describing the various resources bundled in this archive. Example manifest.json:

{
  Name: "cusome_name.zip",
  Description: "Autogenerated branding theme resources",
  Vendor: "Vmware",
  Version: 0.0.1
  Resources: {
    FavIcon: <name of the favIcon file>,
    Logo: <name of the logo file>,
    Background: <name of the background file>,
    Localizations: <name of the localization file>,
    CustomLinks: <name of the custom links file>,
    Styles: <name of the CSS file representing the overwritten styles>,
    PortalName: <id_of_localization_or_just_text_to_be_displayed>
  }
}

The resources in the zip should be organized in folders. The name of each folder represents a theme flavor, for ex. light or dark. If the archive does not contain a flavor folder matching the mainFlavor of the theme, the main flavor folder will be the root of the zip. The main flavor folder must contain all mandatory assets. Other flavor folders may override each asset. Mandatory assets not available in a non-main flavor will default to the ones from the main flavor. Not mandatory assets may or may not default, depending on each particular kind. All assets must have the same names under the different flavors.

Request

URI

PUT

https://{api_host}/cloudapi/vcf/brandingThemes/{brandingThemeId}/resources

COPY

Path Parameters

string

brandingThemeId

Required

branding theme URN or 'active' for the current active theme

Request Body

BrandingUploadSpec of type(s) application/json

Required

Show optional properties

{
    "fileName": "string",
    "size": 0,
    "favIcon": "example.ico",
    "logo": "example.png",
    "background": "example.png",
    "styles": "example.css",
    "portalName": "VCF Automation"
}

{
    "fileName": "string",
    "size": 0,
    "checksum": "string",
    "checksumAlgo": "string",
    "favIcon": "example.ico",
    "logo": "example.png",
    "background": "example.png",
    "styles": "example.css",
    "portalName": "VCF Automation",
    "localizations": "example.json",
    "customLinks": "example.json",
    "idpLoginButtons": "idpLoginButtons.json"
}

string As ^[ !@#$%^&*)(\w.-]+.zip$

fileName

Required

fileName

integer As int64 As int64

size

Required

size

string

checksum

Optional

checksum

string

checksumAlgo

Optional

Constraints: default: sha1

checksumAlgo

string As ^[\w.-]+$

favIcon

Required

organization icon file name

string As ^[\w.-]+$

logo

Required

organization logo file name

string As ^[\w.-]+$

background

Required

organization background file name

string As ^[\w.-]+$

styles

Required

css file name

string As ^[ \w.-]+$

portalName

Required

The name of the portal.

string

localizations

Optional

localizations file name

string As ^[\w.-]+$

customLinks

Optional

custom links file name

string As ^[\w.-]+$

idpLoginButtons

Optional

A json in the format of BrandingThemeResourceIdpButtons

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

400

Invalid configuration.

Returns Error of type(s) */*;version=40.0

"Error Object"

string

minorErrorCode

Required

minorErrorCode

string

message

Required

message

string

stackTrace

Optional

stackTrace

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"background:"string","favIcon:"string","fileName:"string","logo:"string","portalName:"string","size:"integer","styles:"string"}' https://{api_host}/cloudapi/vcf/brandingThemes/{brandingThemeId}/resources

Availability

Added in 41.0.0-alpha

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Branding Theme Operations