Skip to main content
Version: 2025.11

Artifact

Description: Represents an artifact with associated file, model, and metadata.

Attributes

NameTypeDescription
idStrictStr
createddatetime.datetime
fileFile
commentsList[Comment]
archive_status_historyList[ResourceArchiveStatus]
created_by_idStrictStr
model_idOptional[StrictStr]
control_tagsOptional[List[ControlTag]]

Methods

NameDescription
to_strReturn the string representation of the model using field aliases.
to_jsonReturn the JSON string representation of the model using field aliases.
from_jsonCreate an instance of the model from a JSON string.
to_dictReturn the dictionary representation of the model using field aliases.
from_dictCreate an instance of the model from a dictionary.
update_propertiesUpdate one or more metadata fields on the underlying file.
update_descriptionUpdate the file’s description.
update_display_nameUpdate the file’s display name.
update_external_identifierUpdate the file’s external identifier.
update_version_nameUpdate the file’s version name.
read_bytesRead and return the raw byte contents of the associated file revision.
read_textRead the contents as decoded text.
copy_toCopy the contents to a local file.
read_jsonParse the contents as JSON.
cleanup_cacheClean up cached files if they exist.
get_cache_statsGet filesystem cache statistics.
create_accessCreate a new access relationship for a subject by ID.
create_access_by_emailCreate a new access relationship for a subject by email.
update_accessUpdate an existing access relationship for a subject.
remove_accessRemove an existing access relationship.
list_accessList all access relationships for this resource.
archiveArchive the current item using the client’s archive method for this resource type.
restoreRestore the current item using the client’s restore method for this resource type.