polarion_rest_api_client.open_api_client.api.document_parts package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.document_parts.delete_document_parts module

async polarion_rest_api_client.open_api_client.api.document_parts.delete_document_parts.asyncio(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentPartsListDeleteRequest) → Any | Errors | None

Deletes a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentPartsListDeleteRequest):

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.document_parts.delete_document_parts.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentPartsListDeleteRequest) → Response[Any | Errors]

Deletes a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentPartsListDeleteRequest):

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.document_parts.delete_document_parts.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentPartsListDeleteRequest) → Any | Errors | None

Deletes a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentPartsListDeleteRequest):

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.document_parts.delete_document_parts.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentPartsListDeleteRequest) → Response[Any | Errors]

Deletes a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentPartsListDeleteRequest):

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.document_parts.get_document_part module

async polarion_rest_api_client.open_api_client.api.document_parts.get_document_part.asyncio(project_id: str, space_id: str, document_name: str, part_id: 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>) → DocumentPartsSingleGetResponse | Errors | None

Returns the specified Document Part.

Args:

project_id (str): space_id (str): document_name (str): part_id (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:

DocumentPartsSingleGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.document_parts.get_document_part.asyncio_detailed(project_id: str, space_id: str, document_name: str, part_id: 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[DocumentPartsSingleGetResponse | Errors]

Returns the specified Document Part.

Args:

project_id (str): space_id (str): document_name (str): part_id (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[DocumentPartsSingleGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_parts.get_document_part.sync(project_id: str, space_id: str, document_name: str, part_id: 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>) → DocumentPartsSingleGetResponse | Errors | None

Returns the specified Document Part.

Args:

project_id (str): space_id (str): document_name (str): part_id (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:

DocumentPartsSingleGetResponse | Errors

polarion_rest_api_client.open_api_client.api.document_parts.get_document_part.sync_detailed(project_id: str, space_id: str, document_name: str, part_id: 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[DocumentPartsSingleGetResponse | Errors]

Returns the specified Document Part.

Args:

project_id (str): space_id (str): document_name (str): part_id (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[DocumentPartsSingleGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_parts.get_document_parts module

async polarion_rest_api_client.open_api_client.api.document_parts.get_document_parts.asyncio(project_id: str, space_id: str, document_name: 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>) → DocumentPartsListGetResponse | Errors | None

Returns a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (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:

DocumentPartsListGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.document_parts.get_document_parts.asyncio_detailed(project_id: str, space_id: str, document_name: 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[DocumentPartsListGetResponse | Errors]

Returns a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (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[DocumentPartsListGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_parts.get_document_parts.sync(project_id: str, space_id: str, document_name: 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>) → DocumentPartsListGetResponse | Errors | None

Returns a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (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:

DocumentPartsListGetResponse | Errors

polarion_rest_api_client.open_api_client.api.document_parts.get_document_parts.sync_detailed(project_id: str, space_id: str, document_name: 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[DocumentPartsListGetResponse | Errors]

Returns a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (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[DocumentPartsListGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_parts.move_document_parts module

async polarion_rest_api_client.open_api_client.api.document_parts.move_document_parts.asyncio(project_id: str, space_id: str, document_name: str, part_id: str, *, client: AuthenticatedClient | Client, body: MoveDocumentPartRequestBody) → Any | Errors | None

Moves a Work Item Document Part.

Args:

project_id (str): space_id (str): document_name (str): part_id (str): body (MoveDocumentPartRequestBody):

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.document_parts.move_document_parts.asyncio_detailed(project_id: str, space_id: str, document_name: str, part_id: str, *, client: AuthenticatedClient | Client, body: MoveDocumentPartRequestBody) → Response[Any | Errors]

Moves a Work Item Document Part.

Args:

project_id (str): space_id (str): document_name (str): part_id (str): body (MoveDocumentPartRequestBody):

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.document_parts.move_document_parts.sync(project_id: str, space_id: str, document_name: str, part_id: str, *, client: AuthenticatedClient | Client, body: MoveDocumentPartRequestBody) → Any | Errors | None

Moves a Work Item Document Part.

Args:

project_id (str): space_id (str): document_name (str): part_id (str): body (MoveDocumentPartRequestBody):

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.document_parts.move_document_parts.sync_detailed(project_id: str, space_id: str, document_name: str, part_id: str, *, client: AuthenticatedClient | Client, body: MoveDocumentPartRequestBody) → Response[Any | Errors]

Moves a Work Item Document Part.

Args:

project_id (str): space_id (str): document_name (str): part_id (str): body (MoveDocumentPartRequestBody):

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.document_parts.overwrite_document_parts module

async polarion_rest_api_client.open_api_client.api.document_parts.overwrite_document_parts.asyncio(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: OverwriteDocumentPartsRequestBody) → Errors | OverwriteDocumentPartsResponseBody | None

Overwrites multiple Work Item Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (OverwriteDocumentPartsRequestBody):

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 | OverwriteDocumentPartsResponseBody

async polarion_rest_api_client.open_api_client.api.document_parts.overwrite_document_parts.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: OverwriteDocumentPartsRequestBody) → Response[Errors | OverwriteDocumentPartsResponseBody]

Overwrites multiple Work Item Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (OverwriteDocumentPartsRequestBody):

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 | OverwriteDocumentPartsResponseBody]

polarion_rest_api_client.open_api_client.api.document_parts.overwrite_document_parts.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: OverwriteDocumentPartsRequestBody) → Errors | OverwriteDocumentPartsResponseBody | None

Overwrites multiple Work Item Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (OverwriteDocumentPartsRequestBody):

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 | OverwriteDocumentPartsResponseBody

polarion_rest_api_client.open_api_client.api.document_parts.overwrite_document_parts.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: OverwriteDocumentPartsRequestBody) → Response[Errors | OverwriteDocumentPartsResponseBody]

Overwrites multiple Work Item Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (OverwriteDocumentPartsRequestBody):

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 | OverwriteDocumentPartsResponseBody]

polarion_rest_api_client.open_api_client.api.document_parts.post_document_parts module

async polarion_rest_api_client.open_api_client.api.document_parts.post_document_parts.asyncio(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentPartsListPostRequest) → DocumentPartsListPostResponse | Errors | None

Creates a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentPartsListPostRequest):

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:

DocumentPartsListPostResponse | Errors

async polarion_rest_api_client.open_api_client.api.document_parts.post_document_parts.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentPartsListPostRequest) → Response[DocumentPartsListPostResponse | Errors]

Creates a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentPartsListPostRequest):

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[DocumentPartsListPostResponse | Errors]

polarion_rest_api_client.open_api_client.api.document_parts.post_document_parts.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentPartsListPostRequest) → DocumentPartsListPostResponse | Errors | None

Creates a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentPartsListPostRequest):

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:

DocumentPartsListPostResponse | Errors

polarion_rest_api_client.open_api_client.api.document_parts.post_document_parts.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentPartsListPostRequest) → Response[DocumentPartsListPostResponse | Errors]

Creates a list of Document Parts.

Args:

project_id (str): space_id (str): document_name (str): body (DocumentPartsListPostRequest):

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[DocumentPartsListPostResponse | Errors]