UpdateVideo =========== Updates existing Video objects that satisfy the specified constraints. Parameters ---------- At least one of ``ref`` or ``constraints`` is required. When both are present, the constraints further restrict the referenced objects. .. list-table:: :header-rows: 1 :widths: 15 25 60 * - Parameter - JSON type - Behavior * - :ref:`constraints ` - array expression - Optional. No property filter; the command-specific selector requirement still applies. Filters existing objects using the constraints expression language. When ref is supplied it filters that referenced set. * - :ref:`properties ` - object mapping property names to values - Optional. When omitted, existing user properties are unchanged except for keys listed in remove_props. Stores booleans, numbers, strings, supported arrays, or single-key _date, _blob, and _json wrappers. Bare null is rejected; property names and wrapped values are validated. See the properties reference for nested value rules. Replaces supplied property values without replacing the whole property map. * - :ref:`ref ` - integer, 1 through 100000 - Optional. Select using the other supplied selectors; see the selection rule above. Uses an earlier compatible Video reference in this transaction; forward references, wrong types, and undeclared references are rejected. * - :ref:`remove_props ` - array of strings - Optional. When omitted, no properties are removed. Removes named properties from selected objects; missing keys have no effect. A value also supplied in properties is stored after removal. Details ------- If the **ref** parameter is used, **constraints** will act as additional filters on the referenced result set. If the **ref** parameter is specified, it must refer to the search result of a previous FindVideo. If the **codec** parameter is specified, the videos will be re-encoded. Similarly, if **operations** are specified, the videos will be transformed using the specified operations unless these are remote videos. Remote videos are not updated and the query returns with an error. For more complex searches for objects to delete, a Find command must be used first within the transaction. Response and errors ------------------- An authenticated session with the objects update permission is required. The response is an object under ``UpdateVideo`` with integer ``status`` and, on success, integer ``count``. Status 0 means the mutation completed; count is the number of selected objects affected, including zero when none match. No output blobs are returned. Invalid field types, missing required fields, malformed expressions, and invalid references fail validation. Execution failures include a nonzero status and an ``info`` message; inspect the transaction response before assuming a mutation succeeded. This command updates metadata; it does not replace stored binary content. Examples -------- Find the videos with the "year_captured" property equal to 2007, and remove the "focal_length" property: .. TESTED_EXAMPLE: UpdateVideo_1 .. code-block:: json [{ "UpdateVideo": { "constraints": ["$year_captured", "==", 2007], "remove_props": ["focal_length"] } }] Successful response: .. TESTED_EXAMPLE: UpdateVideo_1_response .. code-block:: json [{ "UpdateVideo": { "count": 1, "status": 0 } }] Update the "focal_length_mm" property for the videos that are connected to an entity of the class "Dataset" and with a property "name" equal to "Youtube": .. TESTED_EXAMPLE: UpdateVideo_2 .. code-block:: json [{ "FindEntity": { "with_class": "Dataset", "_ref": 1, "constraints": ["$name", "==", "Youtube"] } }, { "FindVideo": { "_ref": 2, "is_connected_to": { "ref": 1, "connection_class": "in_dataset" }, "blobs": false } }, { "UpdateVideo": { "ref": 2, "properties": { "focal_length_mm": 55 } } }] Successful response: .. TESTED_EXAMPLE: UpdateVideo_2_response .. code-block:: json [{ "FindEntity": { "returned": 0, "status": 0 } }, { "FindVideo": { "returned": 0, "status": 0 } }, { "UpdateVideo": { "count": 1, "status": 0 } }]