Update an asset's information - Fluid Topics

Update an asset's information - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category

Reference Guides

Audience

public

Version

Latest

This web service allows PORTAL_ADMIN and ADMIN users to update an asset's information.

Method	Endpoint
`PUT`	`/api/admin/portal/assets/{alias}`

Path parameter	Type	Description
`{alias}`	String	The image or font file's identifier. Users can get a file's `alias` by calling the List assets web service (restricted to `PORTAL_ADMIN` and `ADMIN` users).

It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.

Request example

The following lines show an example of a JSON request body for an image asset:

{
  "displayName": "The new Fluid Topics logo",
  "imageAltText": "A circular logo with a purple background featuring a stylized white lowercase 'f' and 't' combined to form the shape of a dolphin at the center.",
  "visibility": "PUBLIC"
}

The following lines show an example of a JSON request body for a font file asset:

{
  "displayName": "Helvetica",
  "visibility": "PORTAL"
}

Field	Type	Required?	Description
`displayName`	String	No	The display name of a file.
`imageAltText`	String	No	The alt text for an image asset.
`visibility`	String	No	Can be `PUBLIC` or `PORTAL`. When set to `PUBLIC`, all users can access an asset through its URL, even when the portal requires authentication. When set to `PORTAL`, unauthenticated users cannot access an asset through its URL when the portal requires authentication.