projects

class pyatlassian.atlassian_jira.projects.ProjectsMixin[source]

For detailed API document, see: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/#api-group-projects

get_projects_paginated(start_at: int = _NOTHING(), max_results: int = _NOTHING(), order_by: Literal['category', '-category', '+category', 'key', '-key', '+key', 'name', '-name', '+name', 'owner', '-owner', '+owner', 'issueCount', '-issueCount', '+issueCount', 'lastIssueUpdatedDate', '-lastIssueUpdatedDate', '+lastIssueUpdatedDate', 'archivedDate', '+archivedDate', '-archivedDate', 'deletedDate', '+deletedDate', '-deletedDate'] = _NOTHING(), id: List[int] = _NOTHING(), keys: List[str] = _NOTHING(), query: str = _NOTHING(), type_key: str = _NOTHING(), category_id: int = _NOTHING(), action: Literal['view', 'browse', 'edit', 'create'] = _NOTHING(), expand: str = _NOTHING(), status: List[Literal['live', 'archived', 'deleted']] = _NOTHING(), properties: List[str] = _NOTHING(), property_query: str = _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/jira/platform/rest/v3/api-group-projects/#api-rest-api-3-project-search-get

Parameters:

req_kwargs – additional requests.request() kwargs

pagi_get_projects_paginated(start_at: int = _NOTHING(), max_results: int = _NOTHING(), order_by: Literal['category', '-category', '+category', 'key', '-key', '+key', 'name', '-name', '+name', 'owner', '-owner', '+owner', 'issueCount', '-issueCount', '+issueCount', 'lastIssueUpdatedDate', '-lastIssueUpdatedDate', '+lastIssueUpdatedDate', 'archivedDate', '+archivedDate', '-archivedDate', 'deletedDate', '+deletedDate', '-deletedDate'] = _NOTHING(), id: List[int] = _NOTHING(), keys: List[str] = _NOTHING(), query: str = _NOTHING(), type_key: str = _NOTHING(), category_id: int = _NOTHING(), action: Literal['view', 'browse', 'edit', 'create'] = _NOTHING(), expand: str = _NOTHING(), status: List[Literal['live', 'archived', 'deleted']] = _NOTHING(), properties: List[str] = _NOTHING(), property_query: str = _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/jira/platform/rest/v3/api-group-projects/#api-rest-api-3-project-search-get

Parameters:

  • req_kwargs – additional requests.request() kwargs

  • total_max_results – total max results to fetch in all response

get_all_status_for_project(project_id_or_key: str, req_kwargs: Dict[str, Any] | None = None) → Dict[str, Any][source]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/#api-rest-api-3-project-projectidorkey-statuses-get

Parameters:

req_kwargs – additional requests.request() kwargs