update_annotation

Update an existing annotation on an asset.

update_annotation

Update an existing annotation on an asset.

Safety class: A · API type: portal · Min version: —

📘
Confinement
asset_id must be within your run-root anchor.

Signatures

def update_annotation(sdk, asset_id, annotation_id, start_time_code=None,
                      end_time_code=None, title=None, summary=None, description=None):
    """Update an existing annotation on asset_id; return the updated annotation."""
    return sdk.update_annotation(asset_id, annotation_id, start_time_code,
                                 end_time_code, title, summary, description)

export async function updateAnnotation(sdk, assetId, annotationId, startTimeCode = null,
                                       endTimeCode = null, title = null, summary = null, description = null) {
    // Update an existing annotation on assetId.
    return await sdk.updateAnnotation(assetId, annotationId, startTimeCode, endTimeCode, title, summary, description);
}

Parameters

Parameter (Python)	Parameter (JS)	Type	Required	Notes
`sdk`	`sdk`	Nomad_SDK	yes
`asset_id`	`assetId`	str	yes	e.g. `<asset-uuid>`
`annotation_id`	`annotationId`	str	yes	e.g. `<annotation-uuid>`
`start_time_code`	`startTimeCode`	str \| null	no	e.g. `00:00:00;00`
`end_time_code`	`endTimeCode`	str \| null	no	e.g. `00:00:02;00`
`title`	`title`	str \| null	no
`summary`	`summary`	str \| null	no
`description`	`description`	str \| null	no

Returns

dict | None — the updated annotation. None on failure.

Errors

401 unauthenticated
404 asset or annotation not found