get_space¶
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceRequestPathParams(id: int = REQ)[source]¶
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceRequestQueryParams(description_format: str = OPT, include_icon: bool = OPT, include_operations: bool = OPT, include_properties: bool = OPT, include_permissions: bool = OPT, include_role_assignments: bool = OPT, include_labels: bool = OPT)[source]¶
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceRequest(path_params: ~sanhe_confluence_sdk.methods.space.get_space.GetSpaceRequestPathParams = <factory>, query_params: ~sanhe_confluence_sdk.methods.space.get_space.GetSpaceRequestQueryParams = <factory>, body_params: ~sanhe_confluence_sdk.methods.model.BodyParams = <factory>)[source]¶
See: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/#api-spaces-id-get
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseDescriptionPlain(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
BodyType schema for plain text representation.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseDescriptionView(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
BodyType schema for view (HTML) representation.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseDescription(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
SpaceDescription schema.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseIcon(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
SpaceIcon schema.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
SpaceLinks schema.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseLabel(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Label schema for space labels.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseLabelsLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Links for labels pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseLabelsMeta(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Meta information for labels pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseLabels(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Container for space labels with pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseProperty(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
SpaceProperty schema.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponsePropertiesLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Links for properties pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponsePropertiesMeta(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Meta information for properties pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseProperties(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Container for space properties with pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseOperation(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Operation schema.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseOperationsLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Links for operations pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseOperationsMeta(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Meta information for operations pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseOperations(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Container for space operations with pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponsePermissionSubject(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Subject for permission.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponsePermissionOperation(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Operation details for permission.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponsePermission(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
SpacePermission schema.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponsePermissionsLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Links for permissions pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponsePermissionsMeta(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Meta information for permissions pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponsePermissions(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Container for space permissions with pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseRoleAssignmentPrincipal(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Principal for role assignment.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseRoleAssignment(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
RoleAssignment schema.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseRoleAssignmentsLinks(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Links for role assignments pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseRoleAssignmentsMeta(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Meta information for role assignments pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponseRoleAssignments(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
Container for space role assignments with pagination.
- class sanhe_confluence_sdk.methods.space.get_space.GetSpaceResponse(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]¶
SpaceSingle schema - response for getting a single space by ID.
- property labels: GetSpaceResponseLabels¶
Available when include_labels=True.
- property properties: GetSpaceResponseProperties¶
Available when include_properties=True.
- property operations: GetSpaceResponseOperations¶
Available when include_operations=True.
- property permissions: GetSpaceResponsePermissions¶
Available when include_permissions=True.
- property roleAssignments: GetSpaceResponseRoleAssignments¶
Available when include_role_assignments=True. Only for RBAC EAP sites.