Interface PublishLegacyDraft

interface PublishLegacyDraft {
    ancestors?: {
        id: string;
    }[];
    bodyStatus?: string;
    draftId: string;
    expand?: string[];
    space?: {
        key: string;
    };
    status?: string;
    title: string;
    type: string;
    version: {
        number: number;
    };
}

Hierarchy (view full)

Properties

ancestors? bodyStatus? draftId expand? space? status? title type version

Properties

Optional ancestors

ancestors?: {
    id: string;
}[]

The new ancestor (i.e. parent page) for the content. If you have specified an ancestor, you must also specify a space property in the request body for the space that the ancestor is in.

Note, if you specify more than one ancestor, the last ID in the array will be selected as the parent page for the content.

Type declaration

  • id: string

    The content ID of the ancestor.

Optional bodyStatus

bodyStatus?: string

draftId

draftId: string

The ID of the draft page that was created from a blueprint. You can find the draftId in the Confluence application by opening the draft page and checking the page URL.

Optional expand

expand?: string[]

A multi-value parameter indicating which properties of the content to expand.

Optional space

space?: {
    key: string;
}

The space for the content.

Type declaration

  • key: string

    The key of the space

Optional status

status?: string

The status of the content to be updated, i.e. the draft. This is set to 'draft' by default, so you shouldn't need to specify it.

title

title: string

The title of the content. If you don't want to change the title, set this to the current title of the draft.

type

type: string

The type of content. Set this to page.

version

version: {
    number: number;
}

The version for the new content.

Type declaration

  • number: number

    The version number. Set this to 1.

Settings

Member Visibility

Theme

On This Page

ancestorsbodyStatusdraftIdexpandspacestatustitletypeversion

Generated using TypeDoc v0.25.12