Function getForwardAttachment

getForwardAttachment<ThrowOnError extends boolean = true>(
    options: Options<GetForwardAttachmentData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                contentLength: number;
                contentType: string;
                name: string;
            };
            id: string;
            links: { related: string; self: string };
            relationships: {
                forward: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Get forward attachment Retrieves a forward attachment.

Pre-signed URL
When you request the resource, the response will include a related URL in the links section. You can use this URL to download the attachment file. This URL is a Pre-Signed URL from S3 and provides access for a limited duration to download a file.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetForwardAttachmentData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                contentLength: number;
                contentType: string;
                name: string;
            };
            id: string;
            links: { related: string; self: string };
            relationships: {
                forward: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:2720

Function getForwardAttachment

Pre-signed URL

Type Parameters

Parameters

Settings

On This Page