Dynamic tags for User Interface Integrations

{{asset.ext}}

{{asset.extension}}

File extension of the asset, not including the dot.

jpg

{{asset.name}}

{{asset.filename}}

File name of the asset, not including the folder path

{{asset.href}}

URL of the asset

The format of the URL is intentionally unspecified. No assumptions should be made about the format of URLs. URLs should not be parsed or generated by third-party applications.

The URL can be used by an API client to query the asset representation of the asset.

For more information, see The FotoWeb REST API.

{{asset:FIELD}}

{{asset.metadata:FIELD}}

Value of a metadata field of the asset.

The FIELD parameter must be the numeric ID of the metadata field. For a reference of standard field numbers, see the Fotoware default field code reference topic.

If the metadata field was changed interactively by the user entering a new value in an interactive metadata editor as part of running the action, then this tag returns the latest modified value.

If multiple metadata macros are run as part of the action, and they modify the same metadata field, then this tag returns the value of the field after applying all of the previous metadata macros in the order in which they are defined in the action configuration.

The order of metadata macros matters when determining the final value for the asset metadata field tag.

For example, if the user entered the value foo for field 5 in an interactive editor, then {{asset.metadata:5}} would return foo if used in the first metadata macro.

If the following metadata macro is used to set the value of field 120:

Title: {{asset.metadata:5}}

then in the next metadata macro, the tag

{{asset.metadata:120}}

returns:

Title: foo

{{oauth.token}}

OAuth token that can be used by the UII to make requests to the Fotoware API on behalf of the user.

https://external.com/app/1?token={{oauth.token}} passes token as a query parameter to the server serving the UII (needed if API requests are made from the server).

https://external.com/app/2#token={{oauth.token}} passes token as fragment parameter to the UII (preferred if the server serving the UII does not need the access token, i.e. if API requests are made directly from JavaScript)

An access token is only available if the user is logged into FotoWeb. Otherwise, this tag resolves to an empty string.

Making API requests directly from JavaScript requires CORS to be enabled for the UII.

An alternative way for a UII to obtain an access token is to require the user to log in with OAuth from within the UII (as a regular web integration would do). By using {{oauth.token}}, this additional login is not necessary. The user only needs to be logged in to FotoWeb.