Function updateKlass

updateKlass<ThrowOnError extends boolean = true>(
    options: Options<UpdateKlassData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                appDisabled?: boolean;
                createdAt: string;
                displayName?: string;
                icon: string;
                mixins?: ("assignable" | "commentable" | "editable" | "creatable")[];
                name: string;
                status: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                kobjects: { links: { self: string } };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Update Klass by ID Updates Klass attributes based on the unique Klass ID.

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

Legacy Role Equivalent Permission Set Role

org.admin.klass.write org.permission.klass.update
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<UpdateKlassData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                appDisabled?: boolean;
                createdAt: string;
                displayName?: string;
                icon: string;
                mixins?: ("assignable" | "commentable" | "editable" | "creatable")[];
                name: string;
                status: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                kobjects: { links: { self: string } };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:3123

Function updateKlass

Type Parameters

Parameters

Settings