get_folder

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderRequestPathParams(id: int = REQ)

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderRequestQueryParams(include_collaborators: bool = OPT, include_direct_children: bool = OPT, include_operations: bool = OPT, include_properties: bool = OPT)

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderRequest(path_params: ~sanhe_confluence_sdk.methods.folder.get_folder.GetFolderRequestPathParams = <factory>, query_params: ~sanhe_confluence_sdk.methods.folder.get_folder.GetFolderRequestQueryParams = <factory>, body_params: ~sanhe_confluence_sdk.methods.model.BodyParams = <factory>)

See: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseVersion(_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.folder.get_folder.GetFolderResponseLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)

FolderLinks schema.

property webui: str

Web UI link of the content.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseOperation(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Operation schema.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseOperationsLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Links for operations pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseOperationsMeta(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Meta information for operations pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseOperations(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Container for folder operations with pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponsePropertyVersion(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Version schema for content property.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseProperty(_raw_data: Dict[str, Any], _http_res: Response | None = None)

ContentProperty schema.

property value: str

Value stored as JSON string.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponsePropertiesLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Links for properties pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponsePropertiesMeta(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Meta information for properties pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseProperties(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Container for folder properties with pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseChild(_raw_data: Dict[str, Any], _http_res: Response | None = None)

ChildrenResponse schema.

property type: str

Hierarchical content type (database/embed/folder/page/whiteboard).

property childPosition: int

Position relative to siblings within the content tree.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseDirectChildrenLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Links for direct children pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseDirectChildrenMeta(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Meta information for direct children pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponseDirectChildren(_raw_data: Dict[str, Any], _http_res: Response | None = None)

Container for folder direct children with pagination.

class sanhe_confluence_sdk.methods.folder.get_folder.GetFolderResponse(_raw_data: Dict[str, Any], _http_res: Response | None = None)

FolderSingle schema - response for getting a single folder by ID.

property id: str

ID of the folder.

property type: str

The content type of the object.

property status: str

ContentStatus enum: current, archived, deleted, trashed.

property title: str

Title of the folder.

property parentId: str

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

property parentType: str

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

property position: int

Position within parent tree.

property authorId: str

The account ID of the user who created this folder.

property ownerId: str

The account ID of the user who owns this folder.

property createdAt: str

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

property spaceId: str

ID of the space the folder is in.

property operations: GetFolderResponseOperations

Available when include_operations=True.

property properties: GetFolderResponseProperties

Available when include_properties=True.

property directChildren: GetFolderResponseDirectChildren

Available when include_direct_children=True.