page

class pyatlassian.atlassian_confluence.page.PageMixin

For detailed API document, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-group-page

get_pages_for_label(id: int, space_id: list[int] = _NOTHING(), body_format: Literal['storage', 'atlas_doc_format', 'view', 'export_view', 'anonymous_export_view', 'styled_view', 'editor'] = _NOTHING(), sort: Literal['id', '-id', 'title', '-title', 'created-date', '-created-date', 'modified-date', '-modified-date'] = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, _url: str = None) → Dict[str, Any]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-labels-id-pages-get

Parameters:

req_kwargs – additional requests.request() kwargs

pagi_get_pages_for_label(id: int, space_id: list[int] = _NOTHING(), body_format: Literal['storage', 'atlas_doc_format', 'view', 'export_view', 'anonymous_export_view', 'styled_view', 'editor'] = _NOTHING(), sort: Literal['id', '-id', 'title', '-title', 'created-date', '-created-date', 'modified-date', '-modified-date'] = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, total_max_results: int = 9999) → Iterable[Dict[str, Any]]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-labels-id-pages-get

Parameters:

• req_kwargs – additional requests.request() kwargs

• total_max_results – total max results to fetch in all response

get_pages(id: list[int] = _NOTHING(), space_id: list[int] = _NOTHING(), sort: Literal['id', '-id', 'title', '-title', 'created-date', '-created-date', 'modified-date', '-modified-date'] = _NOTHING(), status: list[Literal['current', 'archived', 'deleted', 'trashed']] = _NOTHING(), title: str = _NOTHING(), body_format: Literal['storage', 'atlas_doc_format', 'view', 'export_view', 'anonymous_export_view', 'styled_view', 'editor'] = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, _url: str = None) → Dict[str, Any]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-get

Parameters:

• paginate – If True, automatically handle pagination

• max_results – Maximum number of total results to return when paginate = True

• req_kwargs – additional requests.request() kwargs

pagi_get_pages(id: list[int] = _NOTHING(), space_id: list[int] = _NOTHING(), sort: Literal['id', '-id', 'title', '-title', 'created-date', '-created-date', 'modified-date', '-modified-date'] = _NOTHING(), status: list[Literal['current', 'archived', 'deleted', 'trashed']] = _NOTHING(), title: str = _NOTHING(), body_format: Literal['storage', 'atlas_doc_format', 'view', 'export_view', 'anonymous_export_view', 'styled_view', 'editor'] = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, total_max_results: int = 9999) → Iterable[Dict[str, Any]]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-get

Parameters:

• req_kwargs – additional requests.request() kwargs

• total_max_results – total max results to fetch in all response

get_page_by_id(id: int, body_format: Literal['storage', 'atlas_doc_format', 'view', 'export_view', 'anonymous_export_view', 'styled_view', 'editor'] = _NOTHING(), get_draft: bool = _NOTHING(), status: list[Literal['current', 'archived', 'trashed', 'deleted', 'historical', 'draft']] = _NOTHING(), version: int = _NOTHING(), include_labels: bool = _NOTHING(), include_properties: bool = _NOTHING(), include_operations: bool = _NOTHING(), include_likes: bool = _NOTHING(), include_versions: bool = _NOTHING(), include_version: bool = _NOTHING(), include_favorited_by_current_user_status: bool = _NOTHING(), req_kwargs: Dict[str, Any] | None = None)

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get

Parameters:

req_kwargs – additional requests.request() kwargs

get_pages_in_space(id: int, depth: str = _NOTHING(), sort: str = _NOTHING(), status: list[Literal['current', 'archived', 'trashed', 'deleted']] = _NOTHING(), title: str = _NOTHING(), body_format: Literal['storage', 'atlas_doc_format', 'view', 'export_view', 'anonymous_export_view', 'styled_view', 'editor'] = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, _url: str = None) → Dict[str, Any]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-spaces-id-pages-get

Parameters:

req_kwargs – additional requests.request() kwargs

pagi_get_pages_in_space(id: int, depth: str = _NOTHING(), sort: str = _NOTHING(), status: list[Literal['current', 'archived', 'trashed', 'deleted']] = _NOTHING(), title: str = _NOTHING(), body_format: Literal['storage', 'atlas_doc_format', 'view', 'export_view', 'anonymous_export_view', 'styled_view', 'editor'] = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, total_max_results: int = 9999) → Iterable[Dict[str, Any]]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-spaces-id-pages-get

Parameters:

• req_kwargs – additional requests.request() kwargs

• total_max_results – total max results to fetch in all response