tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > BinariesService > uploadMultimediaComponent

BinariesService.uploadMultimediaComponent() method

Uploads a single binary file and creates a multimedia component. This operation returns an instance of ‘Component’ type.

The method doesn’t support creating of the component based on the multimedia schema having required metadata fields with no default values.

Signature:

static uploadMultimediaComponent({ file, escapedFolderId, title, multimediaSchemaId, }: {
        file: Blob;
        escapedFolderId: string;
        title?: string;
        multimediaSchemaId?: string;
    }): CancelablePromise<Component>;

Parameters

Parameter	Type	Description
{ file, escapedFolderId, title, multimediaSchemaId, }	{ file: Blob; escapedFolderId: string; title?: string; multimediaSchemaId?: string; }

Returns:

CancelablePromise<Component>

Component The request has completed and has resulted in one or more new resources being created.

Exceptions

ApiError