SyncForce Digital Asset XML structure

Via Connect.SyncForce.IO API

1. XML structure

</DigitalAsset>

1.1. Explanation

UDAI

The Unique Digital Asset Identifier.

ReferenceNr

The reference nr from the digital asset

ChangeDate

The latest date this digital asset has been changed. This can be either the digital asset meta data (name, keywords, etc) or a new file revision. This datetime is CET (UTC+1).

TypeId

The type of digital asset, for example ‘Image’, ‘Document’, ‘Video’, etc.
The translations of the digital asset types can be found via https://connect.syncforce.io/metadata/digitalassets

SubTypeId

Within the digital asset type, the name of the subtype identifying the digital asset. For example ‘Packshot’, ‘Ambiance shot’, ‘Application shot’, ‘Specsheet’, etc.
The translations of the digital asset subtypes can be found via https://connect.syncforce.io/metadata/digitalassets

2. Translations

</Translations>

The digital asset has a name which can have a translation in every content language configured for the customer.

3. Keywords

</Translations>

</Keywords>

The digital asset can have keywords which are entered in 1 keywords field. The person filling in these keywords can decide if the keywords are separated by a character (, or | for example) or not.

4. Files

4.1. Structure digital asset without localizations

<Files>

</Files>

4.1.1. ExpiryUrl

The ExpiryUrl always directs to the file on the Live environment, even when the Digital asset REST API endpoint is used on the Cloud environment. This is because the file itself is not synchronized to the Cloud environment and is only available on the Live environment.

However, when the digital asset is ONLY created on the Cloud environment and does not exist on the Live environment, the ExpiryURL is created with the identifier of the file from the Cloud database and referring to the file on the Live server. However, this digital asset is not available on the live server and thus will return a 404.

The solution here is to create the digital assets on the Live environment as well. After that, do a restore from Live to Cloud to have the same digital assets.

Or in the situation that on the Cloud environment, a digital asset has been created and in the meanwhile another digital asset has been created on the Live environment with the same identifier, the ExpiryUrl will give the file from the Live environment. This can be a different file than expected (because on Cloud it’s a different digital asset).

The solution here is to restore the database from the Live environment to the Cloud environment. Any newly created digital assets on Cloud will be gone. To test the functionality for specific digital assets created on the Cloud environment, the digital assets can be uploaded on Cloud again. But pay attention to that the URLs from the digital asset endpoint cannot be used since these digital asset files are not available on the Live environment.

4.2. Structure digital asset with localizations

<Files>

<LanguageCode="en"/>

</Languages>

<CountryCode="NL"/>

</Countries>

</File>

<LanguageCode="nl"/>

</Languages>

<CountryCode="NL"/>

</Countries>

</File>

</Files>

The ‘SourceFileName’ is the filename of the file which is uploaded for this file revision. The ‘InitialSourceFileName’ is the filename of the file which was the first file revision for this file type and localization (if applicable).

4.2.1. ExpiryUrl

The same text regarding the ExpiryUrl as available in this paragraph applies here as well.

4.3. Explanation

All digital asset files, ordered in the ‘file type’ sort index configured for the SyncForce customer.

A digital asset can have multiple files. For example the thumbnail (max 128 x 128 px) and preview files (max 350 x 350 px), the full size high resolution file and a website specific PNG file.

A digital asset file is revisioned. So everytime a new file is uploaded, the file gets a new revision. The digital asset endpoint always outputs the latest file revision. Use the digital asset ChangeDate to know if the digital asset metadata has been updated or the files have been updated.

Every individual file also has a ChangeDate which indicates a new file revision and that the file needs to be downloaded again from SyncForce.

Per digital asset file:

Char:

The single character letter or number indicating what kind of file it is. See for example:

FileName:

For files belonging to digital assets without localizations:

The filename is a combination of the following information:

Character: always 1 position
Digital asset Id: always 7 positions, leading zeros are added
.
File extension

For files belonging to digital assets with localizations:

The filename is a combination of the following information:

Character: always 1 position
Digital asset Id: always 7 positions, leading zeros are added
_
Digital asset localization sequence nr: always 4 positions, leading zeros added.
.
File extension

The only thing that can change in the filename for a new revision is the file extension. The rest remains the same. A change in file extension is exceptional since a file type most often has 1 file extension assigned to it.

CID:

The Content Identifier of the digital asset file. This is a GUID and remains the same even if this file gets new file revisions.

Type:

The file listed as Type=”THUMBNAIL” is the thumbnail file. This file is a maximum of 128x128 pixels. Can be portrait, landscape or square.
The file listed as Type=”PREVIEW” is the preview file. This file is a maximum of 350x350 pixels. Can be portrait, landscape or square.
The file listed as Type=”HIGHRESOLUTION” is defined for this customer as the high resolution file. The size of the file is not predefined.
The files listed as Type=”OTHER” are not a thumbnail, preview or high resolution file. The size of the file is not predefined.

Url:

The public URL where this file revision is located. At the moment a file gets a new revision, this URL is updated. This new URL will be available after the product has been released for publication. This URL goes directly to the SyncForce Content Hub.
This URL will be only be outputted if available. This URL is rarely available.

ExpiryUrl:

The URL on which this file is available for download for 2 hours after the Digital Asset data is returned from the REST API. Only to be used to store the file in the own system and NOT to be used as a direct link to SyncForce.
This Url will always be listed in the Digital Asset output.

BREF:

The reference of the file type to be used for publication in data channels.

ChangeDate

The date on which this file is uploaded. When the file is uploaded after the date you've synced the data the last time, the file needs to be downloaded again from SyncForce. This datetime is UTC.

RevisionNr

The revision number of this file.

5. Segmentation

5.1. Structure

</TargetGroups>

</Brands>

</Languages>

</Market>

</Languages>

</Market>

</Markets>

</Segmentation>

5.2. Explanation

The availability of an item specified per:

Target group:

List of all target groups configured for the SyncForce customer.
Id: the SyncForce Id of the target group
Name: target group name (not translated)
FromDate: the date from which this digital asset is available for this target group.

When on ‘1900-1-1’ this digital asset is available as of the beginning of time for this target group
When on ‘9999-9-9’ this digital asset is not available for this target group

UntilDate: the date until which this digital asset is available for this target group.

When on ‘9999-9-9’ this digital asset is available until forever for this target group

Brand:

The list of brands actively in use by the SyncForce customer.
BrandName: the name of the brand
GBIN: the Global Brand Identification Number. A globally unique identifier for the brand. See www.gbin.info
OwnerName: the name of the company owning the brand
OwnerGLN: the Global Location Number of the company owning the brand
Reference: the external reference for this brand.

Market:

The list of markets where the digital asset is active.
See this ‘markets’ for details.

6. Attributes

6.1. Structure

<Units>

</Translations>

</Unit>

</Units>

</Translations>

</Translations>

</Value>

</Values>

</Attribute>

</Translations>

</Values>

</Attribute>

</Attributes>

6.2. Explanation

Digital assets can have attributes assigned. Which attributes are available for a digital asset is defined per digital asset type. The REST API output contains all digital asset attributes which are available for the digital asset based on its digital asset type. This is regardless of whether there is a value for this attribute.

Units

First all units are outputted which are configured for the customer for this digital asset type. Per unit:
Id: The Id of the unit. This UnitId is used in the Attribute Values node.
UnitBefore: For digital asset attributes this is always ‘FALSE’.
Translations: The translations of the unit.

Language code: The ISO language code (most often 2 letters, but can also be en-US for example) in which the translation is available
Label: The translation for the given language

Attribute

The attributes are ordered on the sort order as defined per digital asset type. Per attribute:
Id: The Id of the attribute. This is the same across all digital assets.
Type: there are a few types available:

String
SingleSelect
Double
Integer
Date

Translations: The translations of the attribute name. The language is only outputted if available.

Language code: The ISO language code (most often 2 letters, but can also be en-US for example) in which the translation is available
Label: The translation for the given language

Values:

If the values are not multilingual:

UnitId: Is only outputted if there is a unit
Content: This is the content

If the values are multilingual:

Content: This is the content in the customer base language
Translations: The translations of the attribute value. The language is only outputted if available.

Language code: The ISO language code (most often 2 letters, but can also be en-US for example) in which the translation is available
Label: The translation for the given language