label

class pyatlassian.atlassian_confluence.label.LabelMixin[source]

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

get_labels(label_id: List[int] = _NOTHING(), prefix: List[str] = _NOTHING(), sort: str = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, _url: str = None) Dict[str, Any][source]

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

Parameters:

req_kwargs – additional requests.request() kwargs

pagi_get_labels(label_id: List[int] = _NOTHING(), prefix: List[str] = _NOTHING(), sort: str = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, total_max_results: int = 9999) Iterable[Dict[str, Any]][source]

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

Parameters:
  • req_kwargs – additional requests.request() kwargs

  • total_max_results – total max results to fetch in all response