Interface PutPromptLockParams

Parameters for the putPromptLock operation.

interface PutPromptLockParams {
    force?: boolean;
    headers?: OutgoingHttpHeaders;
    lockType?: string;
    locked: boolean;
    lockedBy?: string;
    projectId?: string;
    promptId: string;
    signal?: AbortSignal;
    spaceId?: string;
}

Hierarchy (view full)

Properties

force? headers? lockType? locked lockedBy? projectId? promptId signal? spaceId?

Properties

Optional force

force?: boolean

Override a lock if it is currently taken.

Optional headers

headers?: OutgoingHttpHeaders

Optional lockType

lockType?: string

Lock type: 'edit' for working on prompts/templates or 'governance'. Can only be supplied in PUT /lock requests.

locked

locked: boolean

True if the prompt is currently locked.

Optional lockedBy

lockedBy?: string

Locked by is computed by the server and shouldn't be passed.

Optional projectId

projectId?: string

[REQUIRED] Specifies the project ID as the target. One target must be supplied per request.

promptId

promptId: string

Prompt ID.

Optional signal

signal?: AbortSignal

Optional spaceId

spaceId?: string

[REQUIRED] Specifies the space ID as the target. One target must be supplied per request.

Settings

Member Visibility

Theme

On This Page

forceheaderslockTypelockedlockedByprojectIdpromptIdsignalspaceId