Create a new segment

Comments are segments with segment_type set to COMMENT. A comment can be created directly with status AWAITED. When status is not specified the segment is created with status ACTIVE. An AWAITED comment is not posted yet: nobody is notified about it, and segment listings leave it out unless they filter on status, until it is updated to ACTIVE. On a subclip, time-based metadata segments (TAG, GENERIC, TRANSCRIPTION, SHOT, SEMANTIC_TRANSCRIPTION) are created on the subclip's original asset, under the version the subclip was cut from. A version_id, if given, must be that version or one of the subclip's own; any other is rejected with 400. Comments are segments with segment_type set to COMMENT. A comment can be created directly with status AWAITED. When status is not specified the segment is created with status ACTIVE. An AWAITED comment is not posted yet: nobody is notified about it, and segment listings leave it out unless they filter on status, until it is updated to ACTIVE. On a subclip, time-based metadata segments (TAG, GENERIC, TRANSCRIPTION, SHOT, SEMANTIC_TRANSCRIPTION) are created on the subclip's original asset, under the version the subclip was cut from. A version_id, if given, must be that version or one of the subclip's own; any other is rejected with 400. Required roles:

can_create_segments

post/v1/assets/{asset_id}/segments/

Request

Base URL
https://app.iconik.io/API/assets
Auth
none declared. Required headers: App-ID, Auth-Token
TypeScript
https://skmtc.dev/iconik/apis/iconik-assets/docs/v1/assets/:asset_id/segments/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

asset_idstring required

Query parameters

ignore_reindexingboolean

If true, the segment is not reindexed

should_reindex_assetsboolean

If false, the asset is not reindexed after the segment change

Headers

App-IDstring required

Auth-Tokenstring required

Share-User-Emailstring

This header is used for shares by URL to identify user. Only valid emails are allowed.

Request body

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

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 a created segment