get_pages

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesRequestQueryParams(id: list[int] = OPT, space_id: list[int] = OPT, sort: str = OPT, status: list[str] = OPT, title: str = OPT, body_format: str = OPT, subtype: str = OPT, cursor: str = OPT, limit: int = OPT)

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesRequest(path_params: ~sanhe_confluence_sdk.methods.model.PathParams = <factory>, query_params: ~sanhe_confluence_sdk.methods.page.get_pages.GetPagesRequestQueryParams = <factory>, body_params: ~sanhe_confluence_sdk.methods.model.BodyParams = <factory>)

See: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-get

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesResponseResultBodyStorage(_raw_data: Dict[str, Any], _http_res: Response | None = None)

BodyType schema for storage representation.

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesResponseResultBodyAtlasDocFormat(_raw_data: Dict[str, Any], _http_res: Response | None = None)

BodyType schema for atlas_doc_format representation.

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesResponseResultBody(_raw_data: Dict[str, Any], _http_res: Response | None = None)

BodyBulk schema - contains fields for each representation type requested.

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesResponseResultVersion(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Version schema.

property createdAt: str

Date and time when the version was created. ISO 8601 format.

property message: str

Message associated with the current version.

property number: int

The version number.

property minorEdit: bool

Describes if this version is a minor version.

property authorId: str

The account ID of the user who created this version.

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesResponseResultLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)

AbstractPageLinks schema.

property webui: str

Web UI link of the content.

property editui: str

Edit UI link of the content.

property tinyui: str

Tiny UI link of the content.

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesResponseResult(_raw_data: Dict[str, Any], _http_res: Response | None = None)

PageBulk schema - represents a single page in the results array.

property id: str

ID of the page.

property status: str

ContentStatus enum: current, draft, archived, historical, trashed, deleted, any.

property title: str

Title of the page.

property spaceId: str

ID of the space the page is in.

property parentId: str

ID of the parent page, or null if there is no parent page.

property parentType: str

ParentContentType enum: page, whiteboard, database, embed, folder.

property position: int

Position of child page within the given parent page tree.

property authorId: str

The account ID of the user who created this page originally.

property ownerId: str

The account ID of the user who owns this page.

property lastOwnerId: str

The account ID of the user who owned this page previously, or null.

property subtype: str

The subtype of the page.

property createdAt: str

Date and time when the page was created. ISO 8601 format.

class sanhe_confluence_sdk.methods.page.get_pages.GetPagesResponse(_raw_data: Dict[str, Any], _http_res: Response | None = None)

MultiEntityResult<PageBulk> schema - top level response.