Annotations in the SOLR search index

When working against search endpoints, the results returned by the Limecraft Flow REST API are search result documents from the SOLR search index instead of Annotation objects. The search index will contain information from several objects, merged together in one flattened document. There is one document in the search index per Annotation.

Full Example

The following example represents a ReviewComment annotation, returned as a search result.

---
{
    "id": "Annotation_884481",
    "type": null,
    "lastUpdated": 1680010253000,
    "created": 1680010095779,
    "objectId": 884481,
    "objectType": "ClipAnnotation",
    "createdBy": "REST",
    "version": 1,
    "creatorId": 3,
    "annotation_type": "ClipAnnotation",
    "start": 11640,
    "end": 11641,
    "funnel": "ReviewComment",
    "annotation_productionId": 719,
    "mediaObjectId": 470672,
    "description": [
        "test hello @{27,karel500} this is a #{tag with spaces} and some more plain text"
    ],
    "rating": 0,
    "isDeleted": false,
    "threadGroupId": 884481,
    "spatial": "xywh=percent:20.1,9.7,1,1",
    "tags": [
        "tag with spaces"
    ],
    "autocomplete": [
        "tag with spaces!!!THIS_IS_MY_DELIMITER!!!tags",
        "VIDEO!!!THIS_IS_MY_DELIMITER!!!mediaObjectType",
        "sintel-2048-surround.mp4!!!THIS_IS_MY_DELIMITER!!!mediaObjectName"
    ],
    "lc_autocomplete": [
        "tag with spaces!!!THIS_IS_MY_DELIMITER!!!tags",
        "video!!!THIS_IS_MY_DELIMITER!!!mediaObjectType",
        "sintel-2048-surround.mp4!!!THIS_IS_MY_DELIMITER!!!mediaObjectName"
    ],
    "mediaObjectIsDeleted": false,
    "packageGroup": 470672,
    "productionId": 719,
    "mediaObjectCreator": 3,
    "mediaObjectCreated": 1610098255996,
    "mediaObjectType": "VIDEO",
    "lc_mediaObjectType": "VIDEO",
    "mediaObjectCreatedBy": "5031820b-33bf-4bb5-a73b-be6bd8c51561",
    "samplerate_denum": 1,
    "samplerate_num": 24,
    "samplerate_drop_frame": false,
    "samplerate_human": "24.00",
    "mediaObjectName": "sintel-2048-surround.mp4",
    "lc_mediaObjectName": "sintel-2048-surround.mp4",
    "growing": false,
    "ui_location": "xywh=percent:48.4,44.3,1,1",
    "mediaObjectAnnotationId": 497927,
    "global_rating": 0,
    "circled": false,
    "lc_circled": "false",
    "nonPreferred": false,
    "lc_nonPreferred": "false",
    "loggingStatus": "EDITING",
    "transcriptionStatus": "AUTOMATIC_COMPLETED",
    "subtitlingStatus": "EDITING",
    "flipHorizontal": false,
    "flipVertical": false,
    "rotate": 0,
    "groupIdLabel": "null!!!THIS_IS_MY_DELIMITER!!!null",
    "technical_s_probe_version": "12.1.0",
    "technical_l_duration_frames": 21312,
    "technical_d_duration_seconds": 888,
    "technical_l_length": 0,
    "technical_l_timeCode": 0,
    "technical_l_creationTime": 0,
    "moiInfo": [
        "{\"id\":563606,\"type\":\"RAW\",\"mimetype\":\"video/mp4\",\"width\":2048,\"height\":872,\"quality\":\"HIGH\"}",
        "{\"id\":564252,\"type\":\"STITCH\",\"width\":0,\"height\":0,\"quality\":\"MEDIUM\"}",
        "{\"id\":564256,\"type\":\"THUMB\",\"width\":0,\"height\":0,\"quality\":\"LOW\"}",
        "{\"id\":564259,\"type\":\"THUMB_SIXTY\",\"width\":0,\"height\":0,\"quality\":\"LOW\"}",
        "{\"id\":564251,\"type\":\"STITCH\",\"width\":0,\"height\":0,\"quality\":\"HIGH\"}",
        "{\"id\":564255,\"type\":\"THUMB\",\"width\":0,\"height\":0,\"quality\":\"MEDIUM\"}",
        "{\"id\":564258,\"type\":\"THUMB_SIXTY\",\"width\":0,\"height\":0,\"quality\":\"MEDIUM\"}",
        "{\"id\":564254,\"type\":\"THUMB\",\"width\":0,\"height\":0,\"quality\":\"HIGH\"}",
        "{\"id\":564253,\"type\":\"STITCH\",\"width\":0,\"height\":0,\"quality\":\"LOW\"}",
        "{\"id\":564257,\"type\":\"THUMB_SIXTY\",\"width\":0,\"height\":0,\"quality\":\"HIGH\"}",
        "{\"id\":564312,\"type\":\"PROXY\",\"mimetype\":\"video/mp4\",\"width\":768,\"height\":328,\"quality\":\"LOW\",\"profile\":\"web\"}",
        "{\"id\":564313,\"type\":\"PROXY\",\"mimetype\":\"video/mp4\",\"width\":1280,\"height\":546,\"quality\":\"HIGH\",\"profile\":\"web\"}",
        "{\"id\":564314,\"type\":\"THUMB_SHOT\",\"width\":0,\"height\":0,\"quality\":\"HIGH\"}",
        "{\"id\":564315,\"type\":\"THUMB_SHOT\",\"width\":0,\"height\":0,\"quality\":\"MEDIUM\"}",
        "{\"id\":564316,\"type\":\"THUMB_SHOT\",\"width\":0,\"height\":0,\"quality\":\"LOW\"}",
        "{\"id\":617233,\"type\":\"AUDIO_MONO\",\"mimetype\":\"audio/x-wav\",\"width\":0,\"height\":0,\"quality\":\"LOW\",\"profile\":\"audio_mono\"}",
        "{\"id\":617234,\"type\":\"VOLDEMORT_XML\",\"width\":0,\"height\":0,\"quality\":\"HIGH\",\"profile\":\"voldemort_3_en\"}"
    ],
    "materialComplete": [
        "RAW;undefined;HIGH",
        "STITCH;undefined;MEDIUM",
        "THUMB;undefined;LOW",
        "THUMB_SIXTY;undefined;LOW",
        "STITCH;undefined;HIGH",
        "THUMB;undefined;MEDIUM",
        "THUMB_SIXTY;undefined;MEDIUM",
        "THUMB;undefined;HIGH",
        "STITCH;undefined;LOW",
        "THUMB_SIXTY;undefined;HIGH",
        "PROXY;web;LOW",
        "PROXY;web;HIGH",
        "THUMB_SHOT;undefined;HIGH",
        "THUMB_SHOT;undefined;MEDIUM",
        "THUMB_SHOT;undefined;LOW",
        "AUDIO_MONO;audio_mono;LOW",
        "VOLDEMORT_XML;voldemort_3_en;HIGH"
    ],
    "materialInfo_flag_shouldBeOnFlow": [
        "RAW;undefined;HIGH",
        "STITCH;undefined;MEDIUM",
        "THUMB;undefined;LOW",
        "THUMB_SIXTY;undefined;LOW",
        "STITCH;undefined;HIGH",
        "THUMB;undefined;MEDIUM",
        "THUMB_SIXTY;undefined;MEDIUM",
        "THUMB;undefined;HIGH",
        "STITCH;undefined;LOW",
        "THUMB_SIXTY;undefined;HIGH",
        "PROXY;web;LOW",
        "PROXY;web;HIGH",
        "THUMB_SHOT;undefined;HIGH",
        "THUMB_SHOT;undefined;MEDIUM",
        "THUMB_SHOT;undefined;LOW",
        "AUDIO_MONO;audio_mono;LOW",
        "VOLDEMORT_XML;voldemort_3_en;HIGH"
    ],
    "materialInfo_flag_shouldBeOnBackup": [
        "RAW;undefined;HIGH"
    ],
    "materialInfo_flag_online": [
        "RAW;undefined;HIGH",
        "STITCH;undefined;MEDIUM",
        "THUMB;undefined;LOW",
        "THUMB_SIXTY;undefined;LOW",
        "STITCH;undefined;HIGH",
        "THUMB;undefined;MEDIUM",
        "THUMB_SIXTY;undefined;MEDIUM",
        "THUMB;undefined;HIGH",
        "STITCH;undefined;LOW",
        "THUMB_SIXTY;undefined;HIGH",
        "PROXY;web;LOW",
        "PROXY;web;HIGH",
        "THUMB_SHOT;undefined;HIGH",
        "THUMB_SHOT;undefined;MEDIUM",
        "THUMB_SHOT;undefined;LOW",
        "AUDIO_MONO;audio_mono;LOW",
        "VOLDEMORT_XML;voldemort_3_en;HIGH"
    ],
    "materialInfo_flag_onFlow": [
        "RAW;undefined;HIGH",
        "STITCH;undefined;MEDIUM",
        "THUMB;undefined;LOW",
        "THUMB_SIXTY;undefined;LOW",
        "STITCH;undefined;HIGH",
        "THUMB;undefined;MEDIUM",
        "THUMB_SIXTY;undefined;MEDIUM",
        "THUMB;undefined;HIGH",
        "STITCH;undefined;LOW",
        "THUMB_SIXTY;undefined;HIGH",
        "PROXY;web;LOW",
        "PROXY;web;HIGH",
        "THUMB_SHOT;undefined;HIGH",
        "THUMB_SHOT;undefined;MEDIUM",
        "THUMB_SHOT;undefined;LOW",
        "AUDIO_MONO;audio_mono;LOW",
        "VOLDEMORT_XML;voldemort_3_en;HIGH"
    ],
    "materialInfo_size_RAW_undefined_HIGH": [
        310674005
    ],
    "unknownWorkflowStarted": 1610098391199,
    "ingestWorkflowStarted": 1610098391289,
    "workflowReport": "[{\"workflowCompleted\":1610100508453,\"workflowStarted\":1610098391289,\"workflowType\":\"Ingest\",\"errorReports\":[],\"taskReports\":[{\"duration\":1,\"start\":1610098392622,\"end\":1610098392623,\"status\":\"SUCCESS\",\"objectType\":\"TaskReport\",\"taskReferenceName\":\"audioAnalyzerTask\",\"taskName\":\"AUDIOANALYZE\",\"type\":\"AUTO\",\"created\":1610098392407,\"lastHeartBeat\":0,\"progress\":0.0,\"priority\":0,\"loopIndex\":-1},{\"duration\":3573,\"start\":1610098392591,\"end\":1610098396164,\"status\":\"SUCCESS\",\"objectType\":\"TaskReport\",\"taskReferenceName\":\"servicetaskMediaAnalyzer\",\"taskName\":\"MEDIAANALYZE\",\"type\":\"AUTO\",\"created\":1610098392401,\"lastHeartBeat\":0,\"progress\":0.0,\"priority\":0,\"loopIndex\":-1},{\"duration\":2115244,\"start\":1610098393074,\"end\":1610100508318,\"status\":\"SUCCESS\",\"objectType\":\"TaskReport\",\"taskReferenceName\":\"serviceTaskTranscoder2\",\"taskName\":\"TRANSCODE\",\"output\":{},\"type\":\"AUTO\",\"created\":1610098392394,\"lastHeartBeat\":0,\"progress\":0.0,\"priority\":0,\"loopIndex\":-1},{\"duration\":1750237,\"start\":1610098392715,\"end\":1610100142952,\"status\":\"SUCCESS\",\"objectType\":\"TaskReport\",\"taskReferenceName\":\"serviceTaskTranscoder1\",\"taskName\":\"TRANSCODE\",\"output\":{},\"type\":\"AUTO\",\"created\":1610098392388,\"lastHeartBeat\":0,\"progress\":0.0,\"priority\":0,\"loopIndex\":-1},{\"duration\":18,\"start\":1610098392332,\"end\":1610098392350,\"status\":\"SUCCESS\",\"objectType\":\"TaskReport\",\"taskReferenceName\":\"allocateResourceTask\",\"taskName\":\"ALLOCATE_RESOURCE\",\"type\":\"AUTO\",\"created\":1610098392280,\"lastHeartBeat\":0,\"progress\":0.0,\"priority\":0,\"loopIndex\":-1},{\"duration\":841,\"start\":1610098391385,\"end\":1610098392226,\"status\":\"SUCCESS\",\"objectType\":\"TaskReport\",\"taskReferenceName\":\"serviceTaskMediaProbe\",\"taskName\":\"MEDIAPROBE\",\"type\":\"AUTO\",\"created\":1610098391325,\"lastHeartBeat\":0,\"progress\":0.0,\"priority\":0,\"loopIndex\":-1},{\"duration\":1206778,\"start\":1610098392538,\"end\":1610099599316,\"status\":\"SUCCESS\",\"objectType\":\"TaskReport\",\"taskReferenceName\":\"serviceTaskShotDetect\",\"taskName\":\"FEATURE_EXTRACT\",\"output\":{},\"type\":\"AUTO\",\"created\":1610098392379,\"lastHeartBeat\":0,\"progress\":0.0,\"priority\":0,\"loopIndex\":-1}],\"transcoder1Completed\":1610100142952,\"transcoder2Completed\":1610100508318,\"mediaAnalyzerCompleted\":1610098396164,\"audioAnalyzerCompleted\":1610098392623}]",
    "technical_s_mimeType": "video/mp4",
    "technical_s_scanType": "Progressive",
    "technical_s_fileName": "sintel-2048-surround.mp4",
    "technical_s_reelName": "sintel-2048-surround",
    "technical_s_compatible_brands": "isomiso2avc1mp41",
    "technical_s_copyright": "(c) copyright Blender Foundation | durian.blender.org",
    "technical_s_creation_time": "1970-01-01T00:00:00.000000Z",
    "technical_s_description": "Sintel open movie project",
    "technical_s_encoder": "Lavf52.78.5",
    "technical_s_major_brand": "isom",
    "technical_s_minor_version": "512",
    "technical_s_title": "Sintel",
    "technical_s_track_0_codingFormat": "h264",
    "technical_i_track_0_0_fps_num": 24,
    "technical_i_track_0_0_fps_denum": 1,
    "technical_d_track_0_0_fps": 24,
    "technical_s_track_0_0_fps_s": "24",
    "technical_s_fps_s": "24",
    "technical_s_fps_human_s": "24",
    "technical_i_track_0_0_height": 872,
    "technical_i_track_0_0_width": 2048,
    "technical_s_resolution": "2048x872",
    "technical_s_track_0_0_resolution": "2048x872",
    "technical_d_track_0_0_kbitrate": 2352.698,
    "technical_i_track_0_0_channels": 0,
    "technical_i_track_0_0_bitsPerSample": 8,
    "technical_i_track_0_0_samplingFrequency": 0,
    "technical_s_track_0_0_subsampling": "4:2:0",
    "technical_s_track_0_0_type": "VIDEO",
    "technical_s_track_0_0_fileName": "sintel-2048-surround.mp4",
    "technical_s_track_0_0_tape": "sintel-2048-surround",
    "technical_s_track_0_0_codingProfile": "High",
    "technical_s_track_1_codingFormat": "aac",
    "technical_d_track_0_1_kbitrate": 440.754,
    "technical_i_track_0_1_channels": 6,
    "technical_i_track_0_1_bitsPerSample": 0,
    "technical_i_track_0_1_samplingFrequency": 48000,
    "technical_s_track_0_1_type": "AUDIO",
    "technical_s_track_0_1_fileName": "sintel-2048-surround.mp4",
    "technical_s_track_0_1_tape": "sintel-2048-surround",
    "technical_s_track_0_1_codingProfile": "LC",
    "unknownWorkflowCompleted": 1610098396071,
    "moiTypes": [
        "STITCH;undefined;MEDIUM",
        "THUMB;undefined;LOW",
        "THUMB_SIXTY;undefined;LOW",
        "STITCH;undefined;HIGH",
        "THUMB;undefined;MEDIUM",
        "THUMB_SIXTY;undefined;MEDIUM",
        "THUMB;undefined;HIGH",
        "STITCH;undefined;LOW",
        "THUMB_SIXTY;undefined;HIGH",
        "PROXY;web;LOW",
        "PROXY;web;HIGH",
        "THUMB_SHOT;undefined;HIGH",
        "THUMB_SHOT;undefined;MEDIUM",
        "THUMB_SHOT;undefined;LOW",
        "AUDIO_MONO;audio_mono;LOW",
        "VOLDEMORT_XML;voldemort_3_en;HIGH"
    ],
    "materialInfo_size_STITCH_undefined_MEDIUM": [
        7022831
    ],
    "materialInfo_size_THUMB_undefined_LOW": [
        3473042
    ],
    "materialInfo_size_THUMB_SIXTY_undefined_LOW": [
        50290
    ],
    "materialInfo_size_STITCH_undefined_HIGH": [
        19936279
    ],
    "materialInfo_size_THUMB_undefined_MEDIUM": [
        18485440
    ],
    "materialInfo_size_THUMB_SIXTY_undefined_MEDIUM": [
        253374
    ],
    "materialInfo_size_THUMB_undefined_HIGH": [
        18485440
    ],
    "materialInfo_size_STITCH_undefined_LOW": [
        2188964
    ],
    "materialInfo_size_THUMB_SIXTY_undefined_HIGH": [
        253374
    ],
    "tinythumb": "/9j/4AAQSkZJRgABAQECIgIhAAD//gAPTGF2YzU4LjU0LjEwMP/bAEMAGxIUFxQRGxcWFx4cGyAoQisoJSUoUTo9MEJgVWVkX1VdW2p4mYFqcZBzW12FtYaQnqOrratngLzJuqbHmairpP/bAEMBHB4eKCMoTisrTqRuXW6kpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpKSkpP/AABEIAA0AHgMBIgACEQEDEQH/xAAXAAEBAQEAAAAAAAAAAAAAAAADAQIE/8QAHhABAAICAwADAAAAAAAAAAAAAQACAxESEyFRUoH/xAAVAQEBAAAAAAAAAAAAAAAAAAAAAf/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AGw4ziW7LJ+S5XPWp1avre+RJjyLGLMqDMwVOywOvRqmphtS3tGt9/VjWszmsg7KgvwQP//Z",
    "materialInfo_size_PROXY_web_LOW": [
        132871374
    ],
    "materialInfo_size_PROXY_web_HIGH": [
        187281909
    ],
    "ingestTranscoder2Completed": 1610100508318,
    "ingestAudioAnalyzerCompleted": 1610098392623,
    "ingestTranscoder1Completed": 1610100142952,
    "ingestWorkflowCompleted": 1610100508453,
    "ingestMediaAnalyzerCompleted": 1610098396164,
    "shot_detectionWorkflowStarted": 1610100508507,
    "materialInfo_size_THUMB_SHOT_undefined_HIGH": [
        2770824
    ],
    "materialInfo_size_THUMB_SHOT_undefined_MEDIUM": [
        2770824
    ],
    "materialInfo_size_THUMB_SHOT_undefined_LOW": [
        595154
    ],
    "shot_detectionWorkflowCompleted": 1610100865532,
    "cf_label_dd": "Date",
    "cf_multivalued_dd": false,
    "cf_t_value_dd": 1626732000000,
    "lc_cf_t_value_dd": "2021-07-19T22:00:00.000Z",
    "technical_l_size": 0,
    "voldemort_speech_3WorkflowStarted": 1635494297265,
    "transcriptionStatus_en": "AUTOMATIC_COMPLETED",
    "transcriptionLanguages": [
        "en"
    ],
    "transcriptionStatusTags": [
        "AUTOMATIC_COMPLETED;en"
    ],
    "materialInfo_size_AUDIO_MONO_audio_mono_LOW": [
        28418204
    ],
    "sf_label_transcriptionJobId": "Transcript Job Id",
    "sf_multivalued_transcriptionJobId": false,
    "sf_s_value_transcriptionJobId": "nb2pr67ipj",
    "materialInfo_size_VOLDEMORT_XML_voldemort_3_en_HIGH": [
        33675
    ],
    "voldemort_speech_3WorkflowCompleted": 1635494452874,
    "clipHasAttachedEditorialObjectId": [
        "177353",
        "177354",
        "177359",
        "177360",
        "177361"
    ],
    "clipOrSubclipHasAttachedEditorialObjectId": [
        "177353",
        "177354",
        "177359",
        "177360",
        "177361"
    ],
    "clipHasAttachedEditorialObjectInfo": [
        "EditorialObject;SelectionShare;177353",
        "EditorialObject;SelectionShare;177354",
        "EditorialObject;SelectionShare;177359",
        "EditorialObject;SelectionShare;177360",
        "EditorialObject;SelectionShare;177361"
    ],
    "clipOrSubclipHasAttachedEditorialObjectInfo": [
        "EditorialObject;SelectionShare;177353",
        "EditorialObject;SelectionShare;177354",
        "EditorialObject;SelectionShare;177359",
        "EditorialObject;SelectionShare;177360",
        "EditorialObject;SelectionShare;177361"
    ],
    "reviewStatus": "APPROVED",
    "lc_reviewStatus": "APPROVED",
    "lastTouched": 1680010253017,
    "categoryId": [
        2968
    ],
    "_version_": 1761707016149008400,
    "href": "https://labs.limecraft.com/api/production/719/an/884481",
    "hrefs": {
        "thumb": "https://labs.limecraft.com/api/production/719/an/884481/thumb.jpg",
        "systemFields": "https://labs.limecraft.com/api/production/719/an/884481/sf",
        "share": "https://labs.limecraft.com/api/production/719/an/884481/share"
    },
    "systemFields": {},
    "customFields": {},
    "clipMetadata": {
        "flipHorizontal": false,
        "flipVertical": false,
        "multicamStart": 0,
        "placeholder": false,
        "rotate": 0
    }
}
---

Field mapping

The search result contains more information than only from the Annotation itself.

Basic information

Field Mapping Notes

created

created

lastUpdated

lastUpdated

objectId

id

The annotation id

objectType

objectType

funnel

funnel

version

version

creatorId

creatorId

start

start

end

end

description

description

rating

rating

spatial

spatial

ui_location

ui_location

tags

tags

threadGroupId

related_to

autocomplete

Deprecated.

lc_autocomplete

Deprecated.

id

id in the Solr index. A concatenation of "Annotation_" and the annotation id.

productionId

id of the Production this annotation belongs to

circled

circled

lc_circled

lc_circled

Lowercased version of circled

growing

MediaObject.growing

packageGroup

Id of the MediaObject which is the package leader

nonPreferred

lc_nonPreferred

isDeleted

isDeleted

groupIdLabel

Concatenation of groupId and label. Divided by "!!!THIS_IS_MY_DELIMITER!!!". Example "145!!!THIS_IS_MY_DELIMITER!!!My group".

tinythumb

A base64 encoded data string representing a (tiny) thumb of the annotation. Can be used to render the first visual preview of the annotation without having to load an image.

Information from the MediaObject

Field Mapping Notes

mediaObjectId

MediaObject.id

mediaObjectCreator

MediaObject.creator

mediaObjectCreated

MediaObject.created

mediaObjectIsDeleted

MediaObject.isDeleted

mediaObjectType

MediaObject.type

mediaObjectName

MediaObject.name

lc_mediaObjectName

Lowercased version of mediaObjectName

mediaObjectCreatedBy

MediaObject.createdBy

lc_mediaObjectType

Lowercased version of mediaObjectType

samplerate_denum

MediaObject.sampleRate.denumerator

samplerate_num

MediaObject.sampleRate.numerator

samplerate_drop_frame

MediaObject.sampleRate.drop_frame

samplerate_human

Human readable representation of the frame rate. E.g. "24.00".

Information from workflows

Field Mapping Notes

workflowReport

Contents of the clip’s ingest workflow report.

ingestWorkflowStarted

The time when the INGEST workflow for the MediaObject started. Dynamic field, also exists for other workflows on the MediaObject.

ingestWorkflowCompleted

The time when the INGEST workflow for the MediaObject completed. E.g. 1610098396071. Dynamic field, also exists for other workflows on the MediaObject.

ingestTranscoder2Completed

The time when the Transcoder2 task of the INGEST workflow last completed. Note that this is a dynamic field and just an example for the Transcoder2 task.

Information from the MediaObjectAnnotation

Field Mapping Notes

mediaObjectAnnotationId

MediaObjectAnnotation.id

flipHorizontal

MediaObjectAnnotation.clipMetadata.flipHorizontal

flipVertical

MediaObjectAnnotation.clipMetadata.flipVertical

global_rating

MediaObjectAnnotation.rating

rotate

MediaObjectAnnotation.clipMetadata.rotate

loggingStatus

MediaObjectAnnotation.loggingStatus

reviewStatus

MediaObjectAnnotation.reviewStatus

lc_reviewStatus

Lowercased version of reviewStatus

transcriptionStatus_en

MediaObjectAnnotation.transcriptionStatuses.en

Note that the key is dynamic, and this is an example for the language "en". The value is e.g. "AUTOMATIC_COMPLETED". See also Transcription status of a clip.

transcriptionLanguages

Languages for which there is a transcriptionStatuses entry on the MediaObjectAnnotation. E.g. ["en"]

transcriptionStatusTags

Representation which combines the language with the transcription status of this language.

[
    "AUTOMATIC_COMPLETED;en"
]

technical_l_duration_frames

MediaObjectAnnotation.frames

technical_d_duration_seconds

MediaObjectAnnotation.duration

technical_s_fileName

MediaObjectAnnotation.structuredDescription.fileName

Information from the structuredDescription is available using dynamic keys starting with technical_, then a type (e.g. "s" for string), then the key. We won’t list them all here.

technical_s_mimeType

E.g. "video/mp4"

technical_s_scanType

E.g. "Progressive"

clipMetadata

MediaObjectAnnotation.clipMetadata

Note that this information is also available in flattened form in other fields. This is a reconstruction by the search API, and is not always available.

Custom fields and System fields of the MediaObjectAnnotation

See also the page about Custom Fields.

Per custom field, three fields exist in the search index:

  • cf_<type:s|b|i|l|d|t|x>_values_<key> contains custom fields set on the MediaObjectAnnotation and is copied to all other annotations of the same MediaObject.

  • scf_<type:s|b|i|l|d|t|x>_values_<key> contains custom fields set on the Annotation and is not copied to other annotations.

  • mcf_<type:s|b|i|l|d|t|x>_values_<key> contains the merge of cf and scf fields.

Types: s = string, x = text, b = boolean, i = integer, l = long, d = double and t = tdate.

If the field is configured as single-valued, there is also a single-valued field created in the SOLR index (replace 'values' with 'value' in the above field names). This is needed if you want to use the field for sorting or grouping.

A lot more fields are created in the search index, which contain the label etc. There are also lc_* fields which represent the lowercased variant (used for autocomplete). The lc_ variant does not exist for the Text (x) type.

Example:

{
    "customFields": {
        "author": {
          "type": "String",
          "values": [
            "Gimli"
          ],
          "label": "Author"
        }
    }
}

is stored as:

cf_s_value_author: "Gimli"
cf_label_author: "Author"
Field Mapping Notes

customFields

customFields

Note that this information is also available in flattened form in other fields. This is a reconstruction by the search API, and is not always available.

systemFields

systemFields

Note that this information is also available in flattened form in other fields. This is a reconstruction by the search API, and is not always available.

cf_label_myField

MediaObjectAnnotation.customFields.myField.label

Note this is a dynamic field, this is just an example key.

cf_multivalued_myField

MediaObjectAnnotation.customFields.myField.multiValued

Note this is a dynamic field, this is just an example key.

cf_t_value_myField

MediaObjectAnnotation.customFields.myField.value

Note this is a dynamic field, this is just an example key. The t is depending on the type, according to this mapping:

{
    STRING: 's',
    LONG: 'l',
    INTEGER: 'i',
    BOOLEAN: 'b',
    DOUBLE: 'd',
    DATE: 't',
    TEXT: 'x',
    FRAME: 'fr'
}

lc_cf_t_value_myField

lowercased cf_t_value_myField

sf_s_value_xyz

System fields are indexed similarly to custom fields.

Information from the MediaObjectInstances and attached MaterialInstances

Field Mapping Notes

moiInfo

Information on the MediaObjectInstances of the MediaObject of this Annotation. For each MediaObjectInstance, there is an entry with JSON stringified info in it.

[
        "{\"id\":563606,\"type\":\"RAW\",\"mimetype\":\"video/mp4\",\"width\":2048,\"height\":872,\"quality\":\"HIGH\"}",
        "{\"id\":564257,\"type\":\"THUMB_SIXTY\",\"width\":0,\"height\":0,\"quality\":\"HIGH\"}",
        "{\"id\":564312,\"type\":\"PROXY\",\"mimetype\":\"video/mp4\",\"width\":768,\"height\":328,\"quality\":\"LOW\",\"profile\":\"web\"}",
        "{\"id\":564313,\"type\":\"PROXY\",\"mimetype\":\"video/mp4\",\"width\":1280,\"height\":546,\"quality\":\"HIGH\",\"profile\":\"web\"}",
        "{\"id\":564314,\"type\":\"THUMB_SHOT\",\"width\":0,\"height\":0,\"quality\":\"HIGH\"}",
        "{\"id\":617233,\"type\":\"AUDIO_MONO\",\"mimetype\":\"audio/x-wav\",\"width\":0,\"height\":0,\"quality\":\"LOW\",\"profile\":\"audio_mono\"}",
        "{\"id\":617234,\"type\":\"VOLDEMORT_XML\",\"width\":0,\"height\":0,\"quality\":\"HIGH\",\"profile\":\"voldemort_3_en\"}"
    ]

materialComplete

Deprecated, use materialInfo_xyz fields instead.

List of descriptor strings for which the material is available.

[
    "RAW;undefined;HIGH",
    "THUMB_SIXTY;undefined;LOW",
    "PROXY;web;LOW",
    "PROXY;web;HIGH",
    "THUMB_SHOT;undefined;HIGH",
    "AUDIO_MONO;audio_mono;LOW",
    "VOLDEMORT_XML;voldemort_3_en;HIGH"
]

materialInfo_flag_shouldBeOnFlow

List of descriptor strings for which the flag shouldBeOnFlow is true.

[
    "RAW;undefined;HIGH",
    "THUMB_SIXTY;undefined;LOW",
    "PROXY;web;LOW",
    "PROXY;web;HIGH",
    "THUMB_SHOT;undefined;HIGH",
    "AUDIO_MONO;audio_mono;LOW",
    "VOLDEMORT_XML;voldemort_3_en;HIGH"
]

materialInfo_flag_shouldBeOnBackup

List of descriptor strings for which the flag shouldBeOnBackup is true.

[
    "RAW;undefined;HIGH"
]

materialInfo_flag_online

List of descriptor strings for which the flag online is true.

[
    "RAW;undefined;HIGH",
    "THUMB_SIXTY;undefined;LOW",
    "PROXY;web;LOW",
    "PROXY;web;HIGH",
    "THUMB_SHOT;undefined;HIGH",
    "AUDIO_MONO;audio_mono;LOW",
    "VOLDEMORT_XML;voldemort_3_en;HIGH"
]

materialInfo_flag_onFlow

List of descriptor strings for which the flag onFlow is true.

[
    "RAW;undefined;HIGH",
    "THUMB_SIXTY;undefined;LOW",
    "PROXY;web;LOW",
    "PROXY;web;HIGH",
    "THUMB_SHOT;undefined;HIGH",
    "AUDIO_MONO;audio_mono;LOW",
    "VOLDEMORT_XML;voldemort_3_en;HIGH"
]

materialInfo_flag_onVolume_123

List of descriptor strings for which a volume location is on the volume with id 123.

materialInfo_verificationStatus_volume_123

A field with values which are a concatenation of the verificationStatus and the descriptor strings. Separated by two underscores __.

[
    "VERIFIED__RAW;undefined;HIGH",
    "REJECTED__RAW;undefined;HIGH"
]

materialInfo_transferStatus_volume_123

A field with values which are a concatenation of the verificationStatus and the descriptor strings. Separated by two underscores __.

[
    "Completed__RAW;undefined;HIGH",
    "Failed__RAW;undefined;HIGH"
]

materialInfo_size_RAW_undefined_HIGH

Sizes of the MediaObjectInstances matching the descriptor string "RAW_undefined_HIGH". E.g. [310674005]. Note that this is a dynamic field, and similar fields exist for other MediaObjectInstances their descriptor strings.

moiTypes

List of descriptor strings for which a MediaObjectInstance exists.

[
    "RAW;undefined;HIGH",
    "THUMB_SIXTY;undefined;LOW",
    "PROXY;web;LOW",
    "PROXY;web;HIGH",
    "THUMB_SHOT;undefined;HIGH",
    "AUDIO_MONO;audio_mono;LOW",
    "VOLDEMORT_XML;voldemort_3_en;HIGH"
]

Information from associated EditorialObjects

Field Mapping Notes

clipHasAttachedEditorialObjectId

The MediaObjectAnnotation is attached to an EditorialObject with these ids. E.g.

[
    "177353",
    "177354",
    "177359",
    "177360",
    "177361"
]

clipOrSubclipHasAttachedEditorialObjectId

The MediaObjectAnnotation, or this Annotation itself, it attached to an EditorialObject with these ids.

clipHasAttachedEditorialObjectInfo

Contains the objectType, funnel and id of the EditorialObjects the MediaObjectAnnotation is attached to. Separated with ;.

[
    "EditorialObject;SelectionShare;177353",
    "EditorialObject;SelectionShare;177354",
    "EditorialObject;SelectionShare;177359",
    "EditorialObject;SelectionShare;177360",
    "EditorialObject;SelectionShare;177361"
]

clipOrSubclipHasAttachedEditorialObjectInfo

Similar to clipHasAttachedEditorialObjectInfo but for EditorialObjects the MediaObjectAnnotation, or this Annotation itself, it attached to.

categoryId

Ids of the categories that have an EditorialObject where this Annotation is attached to.