polarion_rest_api_client.open_api_client.api.work_items package¶

Contains endpoint functions for accessing the API

Submodules¶

polarion_rest_api_client.open_api_client.api.work_items.delete_all_work_items module¶

async polarion_rest_api_client.open_api_client.api.work_items.delete_all_work_items.asyncio(*, client: AuthenticatedClient | Client, body: WorkitemsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Work Items from the Global context.

Args:: body (WorkitemsListDeleteRequest):
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.work_items.delete_all_work_items.asyncio_detailed(*, client: AuthenticatedClient | Client, body: WorkitemsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Work Items from the Global context.

Args:: body (WorkitemsListDeleteRequest):
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.work_items.delete_all_work_items.sync(*, client: AuthenticatedClient | Client, body: WorkitemsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Work Items from the Global context.

Args:: body (WorkitemsListDeleteRequest):
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.work_items.delete_all_work_items.sync_detailed(*, client: AuthenticatedClient | Client, body: WorkitemsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Work Items from the Global context.

Args:: body (WorkitemsListDeleteRequest):
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.work_items.delete_work_items module¶

async polarion_rest_api_client.open_api_client.api.work_items.delete_work_items.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Work Items.

Args:: project_id (str): body (WorkitemsListDeleteRequest):
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.work_items.delete_work_items.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Work Items.

Args:: project_id (str): body (WorkitemsListDeleteRequest):
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.work_items.delete_work_items.sync(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Work Items.

Args:: project_id (str): body (WorkitemsListDeleteRequest):
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.work_items.delete_work_items.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Work Items.

Args:: project_id (str): body (WorkitemsListDeleteRequest):
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.work_items.delete_work_items_relationship module¶

async polarion_rest_api_client.open_api_client.api.work_items.delete_work_items_relationship.asyncio(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.delete_work_items_relationship.asyncio_detailed(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.delete_work_items_relationship.sync(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.delete_work_items_relationship.sync_detailed(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.get_all_work_items module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_all_work_items.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 | WorkitemsListGetResponse | None¶

Returns a list of Work Items from all Projects.

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

async polarion_rest_api_client.open_api_client.api.work_items.get_all_work_items.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 | WorkitemsListGetResponse]¶

Returns a list of Work Items from all Projects.

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

polarion_rest_api_client.open_api_client.api.work_items.get_all_work_items.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 | WorkitemsListGetResponse | None¶

Returns a list of Work Items from all Projects.

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

polarion_rest_api_client.open_api_client.api.work_items.get_all_work_items.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 | WorkitemsListGetResponse]¶

Returns a list of Work Items from all Projects.

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

polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item.asyncio(project_id: str, work_item_id: str, field_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>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of available options for the requested field for the specified Work Item.

Args:: project_id (str): work_item_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | 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:: EnumOptionsActionResponseBody | Errors

async polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item.asyncio_detailed(project_id: str, work_item_id: str, field_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>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of available options for the requested field for the specified Work Item.

Args:: project_id (str): work_item_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | 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[EnumOptionsActionResponseBody | Errors]

polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item.sync(project_id: str, work_item_id: str, field_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>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of available options for the requested field for the specified Work Item.

Args:: project_id (str): work_item_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | 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:: EnumOptionsActionResponseBody | Errors

polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item.sync_detailed(project_id: str, work_item_id: str, field_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>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of available options for the requested field for the specified Work Item.

Args:: project_id (str): work_item_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | 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[EnumOptionsActionResponseBody | Errors]

polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item_type module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item_type.asyncio(project_id: str, field_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>, type_: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of available options for the requested field for the specified Work Item Type.

Args:: project_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | Unset): type_ (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:: EnumOptionsActionResponseBody | Errors

async polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item_type.asyncio_detailed(project_id: str, field_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>, type_: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of available options for the requested field for the specified Work Item Type.

Args:: project_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | Unset): type_ (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[EnumOptionsActionResponseBody | Errors]

polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item_type.sync(project_id: str, field_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>, type_: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of available options for the requested field for the specified Work Item Type.

Args:: project_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | Unset): type_ (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:: EnumOptionsActionResponseBody | Errors

polarion_rest_api_client.open_api_client.api.work_items.get_available_enum_options_for_work_item_type.sync_detailed(project_id: str, field_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>, type_: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of available options for the requested field for the specified Work Item Type.

Args:: project_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | Unset): type_ (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[EnumOptionsActionResponseBody | Errors]

polarion_rest_api_client.open_api_client.api.work_items.get_current_enum_options_for_work_item module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_current_enum_options_for_work_item.asyncio(project_id: str, work_item_id: str, field_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>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of selected options for the requested field for specific Work Item.

Args:: project_id (str): work_item_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | 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:: EnumOptionsActionResponseBody | Errors

async polarion_rest_api_client.open_api_client.api.work_items.get_current_enum_options_for_work_item.asyncio_detailed(project_id: str, work_item_id: str, field_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>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of selected options for the requested field for specific Work Item.

Args:: project_id (str): work_item_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | 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[EnumOptionsActionResponseBody | Errors]

polarion_rest_api_client.open_api_client.api.work_items.get_current_enum_options_for_work_item.sync(project_id: str, work_item_id: str, field_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>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of selected options for the requested field for specific Work Item.

Args:: project_id (str): work_item_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | 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:: EnumOptionsActionResponseBody | Errors

polarion_rest_api_client.open_api_client.api.work_items.get_current_enum_options_for_work_item.sync_detailed(project_id: str, work_item_id: str, field_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>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of selected options for the requested field for specific Work Item.

Args:: project_id (str): work_item_id (str): field_id (str): pagesize (int | Unset): pagenumber (int | 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[EnumOptionsActionResponseBody | Errors]

polarion_rest_api_client.open_api_client.api.work_items.get_fields_metadata_for_work_item module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_fields_metadata_for_work_item.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client) → Errors | FieldsMetadataActionResponseBody | None¶

Returns fields for the specified resource.

Args:: project_id (str): work_item_id (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:: Errors | FieldsMetadataActionResponseBody

async polarion_rest_api_client.open_api_client.api.work_items.get_fields_metadata_for_work_item.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client) → Response[Errors | FieldsMetadataActionResponseBody]¶

Returns fields for the specified resource.

Args:: project_id (str): work_item_id (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[Errors | FieldsMetadataActionResponseBody]

polarion_rest_api_client.open_api_client.api.work_items.get_fields_metadata_for_work_item.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client) → Errors | FieldsMetadataActionResponseBody | None¶

Returns fields for the specified resource.

Args:: project_id (str): work_item_id (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:: Errors | FieldsMetadataActionResponseBody

polarion_rest_api_client.open_api_client.api.work_items.get_fields_metadata_for_work_item.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client) → Response[Errors | FieldsMetadataActionResponseBody]¶

Returns fields for the specified resource.

Args:: project_id (str): work_item_id (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[Errors | FieldsMetadataActionResponseBody]

polarion_rest_api_client.open_api_client.api.work_items.get_work_item module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_work_item.asyncio(project_id: str, work_item_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>) → Errors | WorkitemsSingleGetResponse | None¶

Returns the specified Work Item.

Args:: project_id (str): work_item_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:: Errors | WorkitemsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.work_items.get_work_item.asyncio_detailed(project_id: str, work_item_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[Errors | WorkitemsSingleGetResponse]¶

Returns the specified Work Item.

Args:: project_id (str): work_item_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[Errors | WorkitemsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.work_items.get_work_item.sync(project_id: str, work_item_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>) → Errors | WorkitemsSingleGetResponse | None¶

Returns the specified Work Item.

Args:: project_id (str): work_item_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:: Errors | WorkitemsSingleGetResponse

polarion_rest_api_client.open_api_client.api.work_items.get_work_item.sync_detailed(project_id: str, work_item_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[Errors | WorkitemsSingleGetResponse]¶

Returns the specified Work Item.

Args:: project_id (str): work_item_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[Errors | WorkitemsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definition module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definition.asyncio(project_id: str, work_item_id: str, test_param_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>) → Errors | TestparameterDefinitionsSingleGetResponse | None¶

Returns the specified Test Parameter Definition for the specified Work Item.

Args:: project_id (str): work_item_id (str): test_param_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:: Errors | TestparameterDefinitionsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definition.asyncio_detailed(project_id: str, work_item_id: str, test_param_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[Errors | TestparameterDefinitionsSingleGetResponse]¶

Returns the specified Test Parameter Definition for the specified Work Item.

Args:: project_id (str): work_item_id (str): test_param_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[Errors | TestparameterDefinitionsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definition.sync(project_id: str, work_item_id: str, test_param_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>) → Errors | TestparameterDefinitionsSingleGetResponse | None¶

Returns the specified Test Parameter Definition for the specified Work Item.

Args:: project_id (str): work_item_id (str): test_param_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:: Errors | TestparameterDefinitionsSingleGetResponse

polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definition.sync_detailed(project_id: str, work_item_id: str, test_param_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[Errors | TestparameterDefinitionsSingleGetResponse]¶

Returns the specified Test Parameter Definition for the specified Work Item.

Args:: project_id (str): work_item_id (str): test_param_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[Errors | TestparameterDefinitionsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definitions module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definitions.asyncio(project_id: str, work_item_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 | TestparameterDefinitionsListGetResponse | None¶

Returns a list of Test Parameter Definitions for the specified Work Item.

Args:: project_id (str): work_item_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 | TestparameterDefinitionsListGetResponse

async polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definitions.asyncio_detailed(project_id: str, work_item_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 | TestparameterDefinitionsListGetResponse]¶

Returns a list of Test Parameter Definitions for the specified Work Item.

Args:: project_id (str): work_item_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 | TestparameterDefinitionsListGetResponse]

polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definitions.sync(project_id: str, work_item_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 | TestparameterDefinitionsListGetResponse | None¶

Returns a list of Test Parameter Definitions for the specified Work Item.

Args:: project_id (str): work_item_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 | TestparameterDefinitionsListGetResponse

polarion_rest_api_client.open_api_client.api.work_items.get_work_item_test_parameter_definitions.sync_detailed(project_id: str, work_item_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 | TestparameterDefinitionsListGetResponse]¶

Returns a list of Test Parameter Definitions for the specified Work Item.

Args:: project_id (str): work_item_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 | TestparameterDefinitionsListGetResponse]

polarion_rest_api_client.open_api_client.api.work_items.get_work_items module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_work_items.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 | WorkitemsListGetResponse | None¶

Returns a list of Work Items.

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

async polarion_rest_api_client.open_api_client.api.work_items.get_work_items.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 | WorkitemsListGetResponse]¶

Returns a list of Work Items.

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

polarion_rest_api_client.open_api_client.api.work_items.get_work_items.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 | WorkitemsListGetResponse | None¶

Returns a list of Work Items.

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

polarion_rest_api_client.open_api_client.api.work_items.get_work_items.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 | WorkitemsListGetResponse]¶

Returns a list of Work Items.

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

polarion_rest_api_client.open_api_client.api.work_items.get_work_items_relationships module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_work_items_relationships.asyncio(project_id: str, work_item_id: 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 Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.get_work_items_relationships.asyncio_detailed(project_id: str, work_item_id: 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 Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.get_work_items_relationships.sync(project_id: str, work_item_id: 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 Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.get_work_items_relationships.sync_detailed(project_id: str, work_item_id: 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 Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.get_workflow_actions_for_work_item module¶

async polarion_rest_api_client.open_api_client.api.work_items.get_workflow_actions_for_work_item.asyncio(project_id: str, work_item_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>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | WorkflowActionsActionResponseBody | None¶

Returns a list of Workflow Actions.

Args:: project_id (str): work_item_id (str): pagesize (int | Unset): pagenumber (int | 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 | WorkflowActionsActionResponseBody

async polarion_rest_api_client.open_api_client.api.work_items.get_workflow_actions_for_work_item.asyncio_detailed(project_id: str, work_item_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>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | WorkflowActionsActionResponseBody]¶

Returns a list of Workflow Actions.

Args:: project_id (str): work_item_id (str): pagesize (int | Unset): pagenumber (int | 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 | WorkflowActionsActionResponseBody]

polarion_rest_api_client.open_api_client.api.work_items.get_workflow_actions_for_work_item.sync(project_id: str, work_item_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>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | WorkflowActionsActionResponseBody | None¶

Returns a list of Workflow Actions.

Args:: project_id (str): work_item_id (str): pagesize (int | Unset): pagenumber (int | 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 | WorkflowActionsActionResponseBody

polarion_rest_api_client.open_api_client.api.work_items.get_workflow_actions_for_work_item.sync_detailed(project_id: str, work_item_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>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | WorkflowActionsActionResponseBody]¶

Returns a list of Workflow Actions.

Args:: project_id (str): work_item_id (str): pagesize (int | Unset): pagenumber (int | 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 | WorkflowActionsActionResponseBody]

polarion_rest_api_client.open_api_client.api.work_items.move_from_document module¶

async polarion_rest_api_client.open_api_client.api.work_items.move_from_document.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Moves the specified Work Item from the Document.

Args:: project_id (str): work_item_id (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.work_items.move_from_document.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Moves the specified Work Item from the Document.

Args:: project_id (str): work_item_id (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.work_items.move_from_document.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Moves the specified Work Item from the Document.

Args:: project_id (str): work_item_id (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.work_items.move_from_document.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Moves the specified Work Item from the Document.

Args:: project_id (str): work_item_id (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.work_items.move_to_document module¶

async polarion_rest_api_client.open_api_client.api.work_items.move_to_document.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: MoveWorkItemToDocumentRequestBody) → Any | Errors | None¶

Moves the specified Work Item to the Document.

Args:: project_id (str): work_item_id (str): body (MoveWorkItemToDocumentRequestBody):
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.work_items.move_to_document.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: MoveWorkItemToDocumentRequestBody) → Response[Any | Errors]¶

Moves the specified Work Item to the Document.

Args:: project_id (str): work_item_id (str): body (MoveWorkItemToDocumentRequestBody):
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.work_items.move_to_document.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: MoveWorkItemToDocumentRequestBody) → Any | Errors | None¶

Moves the specified Work Item to the Document.

Args:: project_id (str): work_item_id (str): body (MoveWorkItemToDocumentRequestBody):
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.work_items.move_to_document.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: MoveWorkItemToDocumentRequestBody) → Response[Any | Errors]¶

Moves the specified Work Item to the Document.

Args:: project_id (str): work_item_id (str): body (MoveWorkItemToDocumentRequestBody):
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.work_items.move_work_items_to_document module¶

async polarion_rest_api_client.open_api_client.api.work_items.move_work_items_to_document.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: MoveWorkItemsToDocumentRequestBody) → Any | Errors | None¶

Moves multiple Work Items to the Document.

Args:: project_id (str): body (MoveWorkItemsToDocumentRequestBody):
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.work_items.move_work_items_to_document.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: MoveWorkItemsToDocumentRequestBody) → Response[Any | Errors]¶

Moves multiple Work Items to the Document.

Args:: project_id (str): body (MoveWorkItemsToDocumentRequestBody):
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.work_items.move_work_items_to_document.sync(project_id: str, *, client: AuthenticatedClient | Client, body: MoveWorkItemsToDocumentRequestBody) → Any | Errors | None¶

Moves multiple Work Items to the Document.

Args:: project_id (str): body (MoveWorkItemsToDocumentRequestBody):
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.work_items.move_work_items_to_document.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: MoveWorkItemsToDocumentRequestBody) → Response[Any | Errors]¶

Moves multiple Work Items to the Document.

Args:: project_id (str): body (MoveWorkItemsToDocumentRequestBody):
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.work_items.patch_all_work_items module¶

async polarion_rest_api_client.open_api_client.api.work_items.patch_all_work_items.asyncio(*, client: AuthenticatedClient | Client, body: WorkitemsListPatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates a list of Work Items in the Global context.

Args:: workflow_action (str | Unset): body (WorkitemsListPatchRequest):
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.work_items.patch_all_work_items.asyncio_detailed(*, client: AuthenticatedClient | Client, body: WorkitemsListPatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates a list of Work Items in the Global context.

Args:: workflow_action (str | Unset): body (WorkitemsListPatchRequest):
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.work_items.patch_all_work_items.sync(*, client: AuthenticatedClient | Client, body: WorkitemsListPatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates a list of Work Items in the Global context.

Args:: workflow_action (str | Unset): body (WorkitemsListPatchRequest):
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.work_items.patch_all_work_items.sync_detailed(*, client: AuthenticatedClient | Client, body: WorkitemsListPatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates a list of Work Items in the Global context.

Args:: workflow_action (str | Unset): body (WorkitemsListPatchRequest):
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.work_items.patch_work_item module¶

async polarion_rest_api_client.open_api_client.api.work_items.patch_work_item.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsSinglePatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, change_type_to: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates the specified Work Item.

Args:: project_id (str): work_item_id (str): workflow_action (str | Unset): change_type_to (str | Unset): body (WorkitemsSinglePatchRequest):
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.work_items.patch_work_item.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsSinglePatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, change_type_to: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates the specified Work Item.

Args:: project_id (str): work_item_id (str): workflow_action (str | Unset): change_type_to (str | Unset): body (WorkitemsSinglePatchRequest):
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.work_items.patch_work_item.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsSinglePatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, change_type_to: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates the specified Work Item.

Args:: project_id (str): work_item_id (str): workflow_action (str | Unset): change_type_to (str | Unset): body (WorkitemsSinglePatchRequest):
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.work_items.patch_work_item.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsSinglePatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, change_type_to: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates the specified Work Item.

Args:: project_id (str): work_item_id (str): workflow_action (str | Unset): change_type_to (str | Unset): body (WorkitemsSinglePatchRequest):
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.work_items.patch_work_item_relationships module¶

async polarion_rest_api_client.open_api_client.api.work_items.patch_work_item_relationships.asyncio(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Any | Errors | None¶

Updates a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.patch_work_item_relationships.asyncio_detailed(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Updates a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.patch_work_item_relationships.sync(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Any | Errors | None¶

Updates a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.patch_work_item_relationships.sync_detailed(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Updates a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.patch_work_items module¶

async polarion_rest_api_client.open_api_client.api.work_items.patch_work_items.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListPatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, change_type_to: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates a list of Work Items.

Args:: project_id (str): workflow_action (str | Unset): change_type_to (str | Unset): body (WorkitemsListPatchRequest):
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.work_items.patch_work_items.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListPatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, change_type_to: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates a list of Work Items.

Args:: project_id (str): workflow_action (str | Unset): change_type_to (str | Unset): body (WorkitemsListPatchRequest):
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.work_items.patch_work_items.sync(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListPatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, change_type_to: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates a list of Work Items.

Args:: project_id (str): workflow_action (str | Unset): change_type_to (str | Unset): body (WorkitemsListPatchRequest):
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.work_items.patch_work_items.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListPatchRequest, workflow_action: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, change_type_to: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates a list of Work Items.

Args:: project_id (str): workflow_action (str | Unset): change_type_to (str | Unset): body (WorkitemsListPatchRequest):
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.work_items.post_work_item_relationships module¶

async polarion_rest_api_client.open_api_client.api.work_items.post_work_item_relationships.asyncio(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Any | Errors | None¶

Creates a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.post_work_item_relationships.asyncio_detailed(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Creates a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.post_work_item_relationships.sync(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Any | Errors | None¶

Creates a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.post_work_item_relationships.sync_detailed(project_id: str, work_item_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Creates a list of Work Item Relationships.

Args:: project_id (str): work_item_id (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.work_items.post_work_items module¶

async polarion_rest_api_client.open_api_client.api.work_items.post_work_items.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListPostRequest) → Errors | WorkitemsListPostResponse | None¶

Creates a list of Work Items.

Args:: project_id (str): body (WorkitemsListPostRequest):
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 | WorkitemsListPostResponse

async polarion_rest_api_client.open_api_client.api.work_items.post_work_items.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListPostRequest) → Response[Errors | WorkitemsListPostResponse]¶

Creates a list of Work Items.

Args:: project_id (str): body (WorkitemsListPostRequest):
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 | WorkitemsListPostResponse]

polarion_rest_api_client.open_api_client.api.work_items.post_work_items.sync(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListPostRequest) → Errors | WorkitemsListPostResponse | None¶

Creates a list of Work Items.

Args:: project_id (str): body (WorkitemsListPostRequest):
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 | WorkitemsListPostResponse

polarion_rest_api_client.open_api_client.api.work_items.post_work_items.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: WorkitemsListPostRequest) → Response[Errors | WorkitemsListPostResponse]¶

Creates a list of Work Items.

Args:: project_id (str): body (WorkitemsListPostRequest):
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 | WorkitemsListPostResponse]