UpdateDescriptor

Updates existing descriptor 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.

Parameter	JSON type	Behavior
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.
label	string	Optional. When omitted, the existing label is unchanged. Sets the object’s label independently of user properties.
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	integer, 1 through 100000	Optional. Select using the other supplied selectors; see the selection rule above. Uses an earlier compatible Descriptor reference in this transaction; forward references, wrong types, and undeclared references are rejected.
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 results of an earlier AddDescriptor or FindDescriptor.

If the label parameter is present, the descriptor’s labels will be updated.

For more complex searches for objects to update, 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 UpdateDescriptor 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 descriptors with the “source” property equal to “open_face”, and remove the “year_created” property:

[{
    "UpdateDescriptor": {
        "constraints": ["$source", "==", "open_face"],
        "remove_props": ["year_created"]
    }
}]

Successful response:

[{
    "UpdateDescriptor": {
        "count": 1,
        "status": 0
    }
}]

Update the name property of the descriptors that are connected to an entity of the class “Dataset” with a property “name” equal to “Youtube”:

[{
    "FindEntity": {
        "with_class": "Dataset",
        "_ref": 1,
        "constraints": ["$name", "==", "Youtube"]
    }
}, {
    "FindDescriptor": {
        "_ref": 2,
        "is_connected_to": {
            "ref": 1,
            "connection_class": "in_dataset"
        }
    }
}, {
    "UpdateDescriptor": {
        "ref": 2,
        "properties": {
            "name": "Youtube8M"
        }
    }
}]

Successful response:

[{
    "FindEntity": {
        "returned": 0,
        "status": 0
    }
}, {
    "FindDescriptor": {
        "returned": 0,
        "status": 0
    }
}, {
    "UpdateDescriptor": {
        "count": 1,
        "status": 0
    }
}]