Interface UploadJobInterface

Base entity interface for all platform resources

All entities in the Mosaia platform extend this interface to provide consistent base properties across all resource types. This ensures that all entities have common fields for identification, status, and integration capabilities.

Example

const entity: BaseEntity = {
  id: 'entity-123',
  active: true,
  external_id: 'external-system-id',
  extensors: {
    custom_field: 'custom_value'
  }
};
interface UploadJobInterface {
    active?: boolean;
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    drive: string;
    status: "PENDING" | "UPLOADING" | "COMPLETED" | "FAILED" | "CANCELLED";
    filename: string;
    original_filename?: string;
    s3_key?: string;
    size: number;
    mime_type: string;
    content_type_category?:
        | "IMAGE"
        | "VIDEO"
        | "AUDIO"
        | "DOCUMENT"
        | "ARCHIVE"
        | "CODE"
        | "DATA"
        | "OTHER";
    path?: string;
    file_type?: "FILE"
    | "FOLDER"
    | "SYMLINK";
    presigned_url?: string;
    presigned_url_expires_at: string | Date;
    etag?: string;
    s3_version_id?: string;
    started_at: string | Date;
    completed_at?: string | Date;
    error_summary?: string;
    failed_url?: string;
    status_url?: string;
    duration_ms?: number;
    formatted_duration?: string;
    formatted_size?: string;
    is_expired?: boolean;
}

Hierarchy (View Summary)

Properties

active? external_id? extensors? record_history? id? drive status filename original_filename? s3_key? size mime_type content_type_category? path? file_type? presigned_url? presigned_url_expires_at etag? s3_version_id? started_at completed_at? error_summary? failed_url? status_url? duration_ms? formatted_duration? formatted_size? is_expired?

Properties

Optionalactive

active?: boolean

Whether the entity is active

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

drive

drive: string

status

status: "PENDING" | "UPLOADING" | "COMPLETED" | "FAILED" | "CANCELLED"

filename

filename: string

Optionaloriginal_filename

original_filename?: string

Optionals3_key

s3_key?: string

size

size: number

mime_type

mime_type: string

Optionalcontent_type_category

content_type_category?:
    | "IMAGE"
    | "VIDEO"
    | "AUDIO"
    | "DOCUMENT"
    | "ARCHIVE"
    | "CODE"
    | "DATA"
    | "OTHER"

Optionalpath

path?: string

Optionalfile_type

file_type?: "FILE" | "FOLDER" | "SYMLINK"

Optionalpresigned_url

presigned_url?: string

presigned_url_expires_at

presigned_url_expires_at: string | Date

Optionaletag

etag?: string

Optionals3_version_id

s3_version_id?: string

started_at

started_at: string | Date

Optionalcompleted_at

completed_at?: string | Date

Optionalerror_summary

error_summary?: string

Optionalfailed_url

failed_url?: string

Optionalstatus_url

status_url?: string

Optionalduration_ms

duration_ms?: number

Optionalformatted_duration

formatted_duration?: string

Optionalformatted_size

formatted_size?: string

Optionalis_expired

is_expired?: boolean

Settings

Member Visibility

On This Page

Properties