Update format information

Required roles:

can_write_formats

patch/v1/assets/{asset_id}/formats/{format_id}/

Request

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

Path parameters

asset_idstring required

format_idstring required

Query parameters

sync_componentsboolean

If true update component_ids for matching file sets

Headers

App-IDstring required

Auth-Tokenstring required

Request body

archive_status'NOT_ARCHIVED' | 'ARCHIVING' | 'FAILED_TO_ARCHIVE' | 'ARCHIVED'

asset_idstring uuid

date_createdstring date-time

date_deletedstring date-time

date_modifiedstring date-time

deleted_by_userstring uuid

idstring uuid

is_onlineboolean

metadataobject[]

Sequence cannot have more than 10000. Excess values will be stripped

namestring required

status'ACTIVE' | 'DELETED'

storage_methodsstring[]

user_idstring uuid

version_idstring uuid

warningsstring[]

Response

Returns a format that was updated