ICiconik

Update segment

<br/>status can only be AWAITED for a segment that was created AWAITED: changing<br/>any other segment to AWAITED is rejected with 400.<br/><br/>has_attachments is iconik_files' to set, when a comment<br/>gets its first attachment (true) or loses its last one (false).<br/>iconik_files reports its other attachment changes as a reindex of them.<br/>status can only be AWAITED for a segment that was created AWAITED: changing<br/>any other segment to AWAITED is rejected with 400.<br/><br/>has_attachments is iconik_files' to set, when a comment<br/>gets its first attachment (true) or loses its last one (false).<br/>iconik_files reports its other attachment changes as a reindex of them. Required roles:

  • can_write_segments
put/v1/assets/{asset_id}/segments/{segment_id}/

Request

Path parameters

asset_idstring required
segment_idstring required

Query parameters

generate_subclip_keyframesboolean

If the segment is a subclip, generate keyframes for it

index_immediatelyboolean

If true, the segment is indexed immediately

Headers

App-IDstring required
Auth-Tokenstring required

Request body

asset_idstring uuid
date_createdstring date-time
date_modifiedstring date-time
external_idstring nullable
has_attachmentsboolean
idstring uuid
is_internalboolean nullable

If set to true, the segment is only visible to internal iconik users

keyframe_idstring uuid nullable
metadataobject
metadata_view_idstring uuid nullable
parent_idstring uuid
pathstring
person_idstring uuid nullable
project_idstring uuid nullable

ID of a project if the segment is created from a project

segment_checkedboolean
segment_colorstring
segment_textstring nullable
segment_trackstring nullable
segment_type'MARKER' | 'QC' | 'GENERIC' | 'COMMENT' | 'TAG' | 'TRANSCRIPTION' | 'SCENE' | 'SHOT' | 'PERSON' | 'SEMANTIC_TRANSCRIPTION' required
share_idstring uuid nullable

ID of a share if the segment is created from a share

share_session_idstring uuid nullable
share_user_emailstring email nullable
status'ACTIVE' | 'DELETED' | 'AWAITED'
subclip_idstring uuid
time_end_millisecondsinteger nullable
time_start_millisecondsinteger nullable
top_levelboolean
transcription_idstring uuid nullable
user_first_namestring
user_idstring uuid
user_last_namestring
user_photostring
version_idstring uuid

Response

Returns an updated segment

asset_idstring uuid
date_createdstring date-time
date_modifiedstring date-time
external_idstring nullable
has_attachmentsboolean

Whether the comment has attachments in iconik_files

has_drawingboolean
idstring uuid
is_internalboolean nullable

If set to true, the segment is only visible to internal iconik users

keyframe_idstring uuid nullable
metadataobject
metadata_view_idstring uuid nullable
parent_idstring uuid
pathstring
person_idstring uuid nullable
project_idstring uuid nullable

ID of a project if the segment is created from a project

segment_checkedboolean
segment_colorstring
segment_textstring nullable
segment_trackstring nullable
segment_type'MARKER' | 'QC' | 'GENERIC' | 'COMMENT' | 'TAG' | 'TRANSCRIPTION' | 'SCENE' | 'SHOT' | 'PERSON' | 'SEMANTIC_TRANSCRIPTION' required
share_idstring uuid nullable

ID of a share if the segment is created from a share

share_session_idstring uuid nullable
share_user_emailstring email nullable
status'ACTIVE' | 'DELETED' | 'AWAITED'
subclip_idstring uuid
time_end_millisecondsinteger nullable
time_start_millisecondsinteger nullable
top_levelboolean
transcription_idstring uuid nullable
user_first_namestring
user_idstring uuid
user_last_namestring
user_photostring
version_idstring uuid

Changes

No recorded changes to this operation across all 1 revision of this API.