polarion_rest_api_client.open_api_client.api.pages package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.pages.delete_page module

async polarion_rest_api_client.open_api_client.api.pages.delete_page.asyncio(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client) Any | Errors | None

Deletes the specified Page.

Args:

project_id (str): space_id (str): page_name (str):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

async polarion_rest_api_client.open_api_client.api.pages.delete_page.asyncio_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client) Response[Any | Errors]

Deletes the specified Page.

Args:

project_id (str): space_id (str): page_name (str):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.delete_page.sync(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client) Any | Errors | None

Deletes the specified Page.

Args:

project_id (str): space_id (str): page_name (str):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

polarion_rest_api_client.open_api_client.api.pages.delete_page.sync_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client) Response[Any | Errors]

Deletes the specified Page.

Args:

project_id (str): space_id (str): page_name (str):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.delete_page_relationships module

async polarion_rest_api_client.open_api_client.api.pages.delete_page_relationships.asyncio(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) Any | Errors | None

Deletes a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipsListDeleteRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

async polarion_rest_api_client.open_api_client.api.pages.delete_page_relationships.asyncio_detailed(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) Response[Any | Errors]

Deletes a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipsListDeleteRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.delete_page_relationships.sync(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) Any | Errors | None

Deletes a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipsListDeleteRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

polarion_rest_api_client.open_api_client.api.pages.delete_page_relationships.sync_detailed(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) Response[Any | Errors]

Deletes a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipsListDeleteRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.get_all_pages module

async polarion_rest_api_client.open_api_client.api.pages.get_all_pages.asyncio(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of Pages from all Projects and Pages on the Repository level.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

async polarion_rest_api_client.open_api_client.api.pages.get_all_pages.asyncio_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of Pages from all Projects and Pages on the Repository level.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_all_pages.sync(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of Pages from all Projects and Pages on the Repository level.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

polarion_rest_api_client.open_api_client.api.pages.get_all_pages.sync_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of Pages from all Projects and Pages on the Repository level.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_global_pages module

async polarion_rest_api_client.open_api_client.api.pages.get_global_pages.asyncio(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of all Pages on the Repository level.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

async polarion_rest_api_client.open_api_client.api.pages.get_global_pages.asyncio_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of all Pages on the Repository level.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_global_pages.sync(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of all Pages on the Repository level.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

polarion_rest_api_client.open_api_client.api.pages.get_global_pages.sync_detailed(*, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of all Pages on the Repository level.

Args:

pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_page module

async polarion_rest_api_client.open_api_client.api.pages.get_page.asyncio(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesSingleGetResponse | None

Returns the specified Page.

Args:

project_id (str): space_id (str): page_name (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesSingleGetResponse

async polarion_rest_api_client.open_api_client.api.pages.get_page.asyncio_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesSingleGetResponse]

Returns the specified Page.

Args:

project_id (str): space_id (str): page_name (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesSingleGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_page.sync(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesSingleGetResponse | None

Returns the specified Page.

Args:

project_id (str): space_id (str): page_name (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesSingleGetResponse

polarion_rest_api_client.open_api_client.api.pages.get_page.sync_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesSingleGetResponse]

Returns the specified Page.

Args:

project_id (str): space_id (str): page_name (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesSingleGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_page_relationships module

async polarion_rest_api_client.open_api_client.api.pages.get_page_relationships.asyncio(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | RelationshipDataListResponse | RelationshipDataSingleResponse | None

Returns a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | RelationshipDataListResponse | RelationshipDataSingleResponse

async polarion_rest_api_client.open_api_client.api.pages.get_page_relationships.asyncio_detailed(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | RelationshipDataListResponse | RelationshipDataSingleResponse]

Returns a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | RelationshipDataListResponse | RelationshipDataSingleResponse]

polarion_rest_api_client.open_api_client.api.pages.get_page_relationships.sync(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | RelationshipDataListResponse | RelationshipDataSingleResponse | None

Returns a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | RelationshipDataListResponse | RelationshipDataSingleResponse

polarion_rest_api_client.open_api_client.api.pages.get_page_relationships.sync_detailed(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | RelationshipDataListResponse | RelationshipDataSingleResponse]

Returns a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | RelationshipDataListResponse | RelationshipDataSingleResponse]

polarion_rest_api_client.open_api_client.api.pages.get_pages module

async polarion_rest_api_client.open_api_client.api.pages.get_pages.asyncio(project_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of Pages from the Project context.

Args:

project_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

async polarion_rest_api_client.open_api_client.api.pages.get_pages.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of Pages from the Project context.

Args:

project_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_pages.sync(project_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of Pages from the Project context.

Args:

project_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

polarion_rest_api_client.open_api_client.api.pages.get_pages.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of Pages from the Project context.

Args:

project_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_repository_space_pages module

async polarion_rest_api_client.open_api_client.api.pages.get_repository_space_pages.asyncio(space_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of Pages in a given Space on the Repository level.

Args:

space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

async polarion_rest_api_client.open_api_client.api.pages.get_repository_space_pages.asyncio_detailed(space_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of Pages in a given Space on the Repository level.

Args:

space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_repository_space_pages.sync(space_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of Pages in a given Space on the Repository level.

Args:

space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

polarion_rest_api_client.open_api_client.api.pages.get_repository_space_pages.sync_detailed(space_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of Pages in a given Space on the Repository level.

Args:

space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset): revision (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_space_pages module

async polarion_rest_api_client.open_api_client.api.pages.get_space_pages.asyncio(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of Pages from a given Project Space.

Args:

project_id (str): space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

async polarion_rest_api_client.open_api_client.api.pages.get_space_pages.asyncio_detailed(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of Pages from a given Project Space.

Args:

project_id (str): space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.get_space_pages.sync(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Errors | PagesListGetResponse | None

Returns a list of Pages from a given Project Space.

Args:

project_id (str): space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListGetResponse

polarion_rest_api_client.open_api_client.api.pages.get_space_pages.sync_detailed(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, query: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) Response[Errors | PagesListGetResponse]

Returns a list of Pages from a given Project Space.

Args:

project_id (str): space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (str | Unset):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListGetResponse]

polarion_rest_api_client.open_api_client.api.pages.patch_page_relationships module

async polarion_rest_api_client.open_api_client.api.pages.patch_page_relationships.asyncio(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) Any | Errors | None

Updates a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

async polarion_rest_api_client.open_api_client.api.pages.patch_page_relationships.asyncio_detailed(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) Response[Any | Errors]

Updates a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.patch_page_relationships.sync(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) Any | Errors | None

Updates a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

polarion_rest_api_client.open_api_client.api.pages.patch_page_relationships.sync_detailed(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) Response[Any | Errors]

Updates a list of Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.patch_rich_page module

async polarion_rest_api_client.open_api_client.api.pages.patch_rich_page.asyncio(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PagesSinglePatchRequest) Any | Errors | None

Updates the specified Page.

Args:

project_id (str): space_id (str): page_name (str): body (PagesSinglePatchRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

async polarion_rest_api_client.open_api_client.api.pages.patch_rich_page.asyncio_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PagesSinglePatchRequest) Response[Any | Errors]

Updates the specified Page.

Args:

project_id (str): space_id (str): page_name (str): body (PagesSinglePatchRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.patch_rich_page.sync(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PagesSinglePatchRequest) Any | Errors | None

Updates the specified Page.

Args:

project_id (str): space_id (str): page_name (str): body (PagesSinglePatchRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

polarion_rest_api_client.open_api_client.api.pages.patch_rich_page.sync_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PagesSinglePatchRequest) Response[Any | Errors]

Updates the specified Page.

Args:

project_id (str): space_id (str): page_name (str): body (PagesSinglePatchRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.post_page_relationships module

async polarion_rest_api_client.open_api_client.api.pages.post_page_relationships.asyncio(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) Any | Errors | None

Creates a list of Rich Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

async polarion_rest_api_client.open_api_client.api.pages.post_page_relationships.asyncio_detailed(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) Response[Any | Errors]

Creates a list of Rich Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.post_page_relationships.sync(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) Any | Errors | None

Creates a list of Rich Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Any | Errors

polarion_rest_api_client.open_api_client.api.pages.post_page_relationships.sync_detailed(project_id: str, space_id: str, page_name: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) Response[Any | Errors]

Creates a list of Rich Page Relationships.

Args:

project_id (str): space_id (str): page_name (str): relationship_id (str): body (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.pages.post_pages module

async polarion_rest_api_client.open_api_client.api.pages.post_pages.asyncio(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, body: PagesListPostRequest) Errors | PagesListPostResponse | None

Creates a list of Pages.

Args:

project_id (str): space_id (str): body (PagesListPostRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListPostResponse

async polarion_rest_api_client.open_api_client.api.pages.post_pages.asyncio_detailed(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, body: PagesListPostRequest) Response[Errors | PagesListPostResponse]

Creates a list of Pages.

Args:

project_id (str): space_id (str): body (PagesListPostRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListPostResponse]

polarion_rest_api_client.open_api_client.api.pages.post_pages.sync(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, body: PagesListPostRequest) Errors | PagesListPostResponse | None

Creates a list of Pages.

Args:

project_id (str): space_id (str): body (PagesListPostRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Errors | PagesListPostResponse

polarion_rest_api_client.open_api_client.api.pages.post_pages.sync_detailed(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, body: PagesListPostRequest) Response[Errors | PagesListPostResponse]

Creates a list of Pages.

Args:

project_id (str): space_id (str): body (PagesListPostRequest):

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[Errors | PagesListPostResponse]