get_page¶

class sanhe_confluence_sdk.methods.page.get_page.GetPageRequestPathParams(id: int = REQ)[source]¶

class sanhe_confluence_sdk.methods.page.get_page.GetPageRequestQueryParams(body_format: str = OPT, get_draft: bool = OPT, status: list[str] = OPT, version: int = OPT, include_labels: bool = OPT, include_properties: bool = OPT, include_operations: bool = OPT, include_likes: bool = OPT, include_versions: bool = OPT, include_version: bool = OPT, include_favorited_by_current_user_status: bool = OPT, include_webresources: bool = OPT, include_collaborators: bool = OPT, include_direct_children: bool = OPT)[source]¶

class sanhe_confluence_sdk.methods.page.get_page.GetPageRequest(path_params: ~sanhe_confluence_sdk.methods.page.get_page.GetPageRequestPathParams = <factory>, query_params: ~sanhe_confluence_sdk.methods.page.get_page.GetPageRequestQueryParams = <factory>, body_params: ~sanhe_confluence_sdk.methods.model.BodyParams = <factory>)[source]¶: See: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseBodyStorage(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶: BodyType schema for storage representation.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseBodyAtlasDocFormat(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶: BodyType schema for atlas_doc_format representation.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseBodyView(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶: BodyType schema for view representation.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseBody(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶: BodySingle schema - contains fields for each representation type.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseVersion(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

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_page.GetPageResponseLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

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_page.GetPageResponseLabel(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

Label schema.

property id: str¶: ID of the label.

property name: str¶: Name of the label.

property prefix: str¶: Prefix of the label.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseLabels(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶: Labels with metadata schema.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseProperty(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

ContentProperty schema.

property id: str¶: ID of the property.

property key: str¶: Key of the property.

property value: str¶: Value of the property.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseProperties(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶: Properties with metadata schema.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseOperation(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

Operation schema.

property operation: str¶: Name of the operation.

property targetType: str¶: The type of entity the operation acts on.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseOperations(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶: Operations with metadata schema.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseLike(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

Like schema.

property accountId: str¶: Account ID of the user who liked.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseLikes(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

Likes with metadata schema.

property count: int¶: Count of likes.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponseVersionsResult(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

Version schema for versions array.

property createdAt: str¶: Date and time when the version was created. ISO 8601 format.

property message: str¶: Message associated with this 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_page.GetPageResponseVersions(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶: Versions with metadata schema.

class sanhe_confluence_sdk.methods.page.get_page.GetPageResponse(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶

PageSingle schema - response for getting a single page.

property id: str¶: ID of the page.

property status: str¶: ContentStatus enum: current, draft, archived, historical, trashed, deleted.

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.

property isFavoritedByCurrentUser: bool¶: Whether the current user has favorited this page.

property labels: GetPageResponseLabels¶: Labels associated with the page. Only available when include-labels=true.

property properties: GetPageResponseProperties¶: Properties associated with the page. Only available when include-properties=true.

property operations: GetPageResponseOperations¶: Permitted operations for the page. Only available when include-operations=true.

property likes: GetPageResponseLikes¶: Likes on the page. Only available when include-likes=true.

property versions: GetPageResponseVersions¶: Version history. Only available when include-versions=true.