Skip to content

ComponentArtworkFileState ​

Type: Object

A reference linking a component to an artwork file (or external URI) it uses

Fields ​

NameTypeArgsDescriptionDeprecated
componentComponentStateParent component. Requires component:read permission.
componentIdComponentID!Parent component ID
createdAtString!Creation timestamp (ISO8601)
descriptionStringHuman-readable description of this file's role
externalUriStringExternal URI for artwork not tracked in the file store
fileFileStateThe referenced file record. Requires file:read permission.
fileIdFileIDReferenced file ID (nil when using externalUri)
idComponentArtworkFileID!Unique identifier
pageCountIntNumber of pages contributed by this file
pageRangeStringPage range within the file to use (e.g. '1-32' or 'all')
sortOrderInt!Sort order within the component's artwork references
updatedAtString!Last update timestamp (ISO8601)
usageRoleComponentFileUsageRole!Role this file plays for the component (artwork / template / data / path / other)

Relationships ​

Connect machines, automate workflows, and build custom apps for print production.