polarion_rest_api_client.open_api_client.api.linked_oslc_resources package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.delete_oslc_resources module

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.delete_oslc_resources.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListDeleteRequest) Any | Errors | None

Deletes a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListDeleteRequest):

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.linked_oslc_resources.delete_oslc_resources.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListDeleteRequest) Response[Any | Errors]

Deletes a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListDeleteRequest):

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.linked_oslc_resources.delete_oslc_resources.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListDeleteRequest) Any | Errors | None

Deletes a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListDeleteRequest):

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.linked_oslc_resources.delete_oslc_resources.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListDeleteRequest) Response[Any | Errors]

Deletes a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListDeleteRequest):

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.linked_oslc_resources.get_oslc_resources module

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources.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>, 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 | LinkedoslcresourcesListGetResponse | None

Returns a list of instances.

Args:

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

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources.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>, 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 | LinkedoslcresourcesListGetResponse]

Returns a list of instances.

Args:

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

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources.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>, 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 | LinkedoslcresourcesListGetResponse | None

Returns a list of instances.

Args:

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

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources.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>, 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 | LinkedoslcresourcesListGetResponse]

Returns a list of instances.

Args:

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

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources module

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListPostRequest) Errors | LinkedoslcresourcesListPostResponse | None

Creates a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListPostRequest):

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

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListPostRequest) Response[Errors | LinkedoslcresourcesListPostResponse]

Creates a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListPostRequest):

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

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListPostRequest) Errors | LinkedoslcresourcesListPostResponse | None

Creates a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListPostRequest):

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

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListPostRequest) Response[Errors | LinkedoslcresourcesListPostResponse]

Creates a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListPostRequest):

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