Skip to content
CCS Files Docs

UploadRequest

Defined in: libs/ccs-files-client/src/types.ts:505

Properties

Section titled “Properties”

name

Section titled “name”

name: string

Defined in: libs/ccs-files-client/src/types.ts:506

size

Section titled “size”

size: number

Defined in: libs/ccs-files-client/src/types.ts:507

mime_type

Section titled “mime_type”

mime_type: string

Defined in: libs/ccs-files-client/src/types.ts:508

folder_id?

Section titled “folder_id?”

optional folder_id?: string

Defined in: libs/ccs-files-client/src/types.ts:510

Root by default; "root" is accepted.

content_sha256?

Section titled “content_sha256?”

optional content_sha256?: string

Defined in: libs/ccs-files-client/src/types.ts:512

Hex SHA-256; verified by the store on single PUT and by the worker afterwards.

title?

Section titled “title?”

optional title?: string

Defined in: libs/ccs-files-client/src/types.ts:513

description?

Section titled “description?”

optional description?: string

Defined in: libs/ccs-files-client/src/types.ts:514

category?

Section titled “category?”

optional category?: string

Defined in: libs/ccs-files-client/src/types.ts:515

department?

Section titled “department?”

optional department?: string

Defined in: libs/ccs-files-client/src/types.ts:516

tags?

Section titled “tags?”

optional tags?: string[]

Defined in: libs/ccs-files-client/src/types.ts:517

custom?

Section titled “custom?”

optional custom?: Record<string, unknown>

Defined in: libs/ccs-files-client/src/types.ts:518

status?

Section titled “status?”

optional status?: FileStatus

Defined in: libs/ccs-files-client/src/types.ts:519

visibility?

Section titled “visibility?”

optional visibility?: Visibility

Defined in: libs/ccs-files-client/src/types.ts:520

policy?

Section titled “policy?”

optional policy?: string

Defined in: libs/ccs-files-client/src/types.ts:522

The name of an entry of settings.upload_policies; unknown names fall back to the default.

owner_id?

Section titled “owner_id?”

optional owner_id?: string

Defined in: libs/ccs-files-client/src/types.ts:524

Machine only: the member the file belongs to. Defaults to acting_user_id, else the client.

acting_user_id?

Section titled “acting_user_id?”

optional acting_user_id?: string

Defined in: libs/ccs-files-client/src/types.ts:526

Machine only: the member recorded on the audit row.

entries?

Section titled “entries?”

optional entries?: AccessEntryInput[]

Defined in: libs/ccs-files-client/src/types.ts:527

inherit?

Section titled “inherit?”

optional inherit?: boolean

Defined in: libs/ccs-files-client/src/types.ts:528

external_ref?

Section titled “external_ref?”

optional external_ref?: string

Defined in: libs/ccs-files-client/src/types.ts:530

Your own id for the file, at most 200 characters; a list and search filter.

notify_user_ids?

Section titled “notify_user_ids?”

optional notify_user_ids?: string[]

Defined in: libs/ccs-files-client/src/types.ts:532

Who gets file.ready besides the owner.

on_name_conflict?

Section titled “on_name_conflict?”

optional on_name_conflict?: "fail" | "rename"

Defined in: libs/ccs-files-client/src/types.ts:537

A sibling with the same name: fail (default) answers 409 name_conflict; rename lets the service pick a free name such as IMG_5913 (1).jpg.