Function getMediabyId

getMediabyId<ThrowOnError extends boolean = true>(
    options: Options<GetMediabyIdData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                contentLength: number;
                contentType: string;
                context: string;
                createdAt: string;
                name: string;
                redacted: boolean;
                updatedAt: string;
                uploaded: boolean;
            };
            id: string;
            links: { self: string };
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
        meta: {
            provider: string;
            upload: {
                fields: {
                    acl: string;
                    bucket: string;
                    "Content-Type": string;
                    key: string;
                    Policy: string;
                    "X-Amz-Algorithm": string;
                    "X-Amz-Credential": string;
                    "X-Amz-Date": string;
                    "X-Amz-Meta-Attachment-Id": string;
                    "X-Amz-Signature": string;
                };
                url: string;
            };
        };
    },
    unknown,
    ThrowOnError,
>

Get media by ID Retrieves a media object that matches the unique ID or an array of media objects (if multiple IDs are given).

Any one of the following roles is required for this endpoint:

Legacy Role	Equivalent Permission Set Role
org.user.media.read	org.permission.kb.read
org.user.setting.read
org.user.content.kb.read
org.user.kb.read
org.admin.content.kb.read
org.admin.kb.read

Type Parameters

ThrowOnError extends boolean = true

Parameters

options: Options<GetMediabyIdData, ThrowOnError>

Returns RequestResult<
    {
        data: {
            attributes: {
                contentLength: number;
                contentType: string;
                context: string;
                createdAt: string;
                name: string;
                redacted: boolean;
                updatedAt: string;
                uploaded: boolean;
            };
            id: string;
            links: { self: string };
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
        meta: {
            provider: string;
            upload: {
                fields: {
                    acl: string;
                    bucket: string;
                    "Content-Type": string;
                    key: string;
                    Policy: string;
                    "X-Amz-Algorithm": string;
                    "X-Amz-Credential": string;
                    "X-Amz-Date": string;
                    "X-Amz-Meta-Attachment-Id": string;
                    "X-Amz-Signature": string;
                };
                url: string;
            };
        };
    },
    unknown,
    ThrowOnError,
>

Function getMediabyId

Type Parameters

Parameters

Settings