Custom Fields

{
    //set allowUndefinedFields to true to allow custom fields which are not described in the CustomFieldsDescription
    allowUndefinedFields: false,

    fields: {
        episode_title: {
            userProperties: { // use for client-side only properties. The backend does nothing with these properties.
                prop1: 'value1',
                prop2: 'value2',
                prop3: 'value3'
            },
            order: 0.5,

            //The type is enforced by trying to cast/convert the values in the custom fields to the type denoted in the CustomFieldsDescription.
            // Available types are: STRING, TEXT, BOOLEAN, INTEGER, DATE, DOUBLE and LONG.
            type: 'STRING',

            //Value to display when the annotation has no value for this custom field
            defaultValue: 'no_episode',

            //Label to be shown in ui
            label: 'episode_title',

            //Description
            description: 'episode title',

            clipAllowed: true, // can this custom field exist on a MediaObjectAnnotation?
            subClipAllowed: true, // can this custom field exist on an annotation which is not a MediaObjectAnnotation?
            restrictedTo: [] // a list of funnels for which the custom field can exist. When empty, all funnels are allowed (that still respect clipAllowed / subClipAllowed).
        },
        clip_number: {
            userProperties: {
                prop1: 'value1'
            },
            order: 0.1,
            type: 'INTEGER',
            defaultValue: 1,
            label: 'clip_number',
            description: 'clip number',

            //A validation expression in the expression language (EL) is also available. Reference to the value itself is made by using #this.
            // If the validation fails, a 406 http status code is returned.
            validation: '#this > 0',
            clipAllowed: true,
            subClipAllowed: false
        },
        author: {
            description: 'Author',
            label: 'Author',
            skipWhiteListValidation: true,
            type: 'STRING',

			//It's possible to define blacklist and whitelist values, if the value isn't in the whitelist the the call will be rejected
			// unless the skipWhiteListValidation parameter is set. Whitelist validation will also be skipped when the array is empty.
            whiteList: [
                'Gimli'
            ],

			//When a value is added to the blacklist it's not possible to set the field to that value.
            blackList: [
                'Legolas'
            ],
            clipAllowed: false,
            subClipAllowed: true,
            restrictedTo: ['BookAnnotation', 'MagazineAnnotation'] // where BookAnnotation and MagazineAnnotation are funnels
        }
    }
}