polarion_rest_api_client.open_api_client.api.collections package¶

Contains endpoint functions for accessing the API.

Submodules¶

polarion_rest_api_client.open_api_client.api.collections.close_collection module¶

async polarion_rest_api_client.open_api_client.api.collections.close_collection.asyncio(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Closes the specified Collection.

Args:: project_id (str): collection_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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.collections.close_collection.asyncio_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Closes the specified Collection.

Args:: project_id (str): collection_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.close_collection.sync(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Closes the specified Collection.

Args:: project_id (str): collection_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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.collections.close_collection.sync_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Closes the specified Collection.

Args:: project_id (str): collection_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.delete_collection module¶

async polarion_rest_api_client.open_api_client.api.collections.delete_collection.asyncio(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Collection.

Args:: project_id (str): collection_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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.collections.delete_collection.asyncio_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Deletes the specified Collection.

Args:: project_id (str): collection_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.delete_collection.sync(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Collection.

Args:: project_id (str): collection_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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.collections.delete_collection.sync_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Deletes the specified Collection.

Args:: project_id (str): collection_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.delete_collections module¶

async polarion_rest_api_client.open_api_client.api.collections.delete_collections.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: CollectionsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Collections.

Args:: project_id (str): body (CollectionsListDeleteRequest):
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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.collections.delete_collections.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: CollectionsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Collections.

Args:: project_id (str): body (CollectionsListDeleteRequest):
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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.delete_collections.sync(project_id: str, *, client: AuthenticatedClient | Client, body: CollectionsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Collections.

Args:: project_id (str): body (CollectionsListDeleteRequest):
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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.collections.delete_collections.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: CollectionsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Collections.

Args:: project_id (str): body (CollectionsListDeleteRequest):
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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.delete_collections_relationship module¶

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

Removes the specific Relationship from the Collection.

Args:: project_id (str): collection_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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.collections.delete_collections_relationship.asyncio_detailed(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) → Response[Any | Errors]¶

Removes the specific Relationship from the Collection.

Args:: project_id (str): collection_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.delete_collections_relationship.sync(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) → Any | Errors | None¶

Removes the specific Relationship from the Collection.

Args:: project_id (str): collection_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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.collections.delete_collections_relationship.sync_detailed(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipsListDeleteRequest) → Response[Any | Errors]¶

Removes the specific Relationship from the Collection.

Args:: project_id (str): collection_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.get_collection module¶

async polarion_rest_api_client.open_api_client.api.collections.get_collection.asyncio(project_id: str, collection_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → CollectionsSingleGetResponse | Errors | None¶

Returns the specified Collection.

Args:: project_id (str): collection_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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:: Union[CollectionsSingleGetResponse, Errors]

async polarion_rest_api_client.open_api_client.api.collections.get_collection.asyncio_detailed(project_id: str, collection_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[CollectionsSingleGetResponse | Errors]¶

Returns the specified Collection.

Args:: project_id (str): collection_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Union[CollectionsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.collections.get_collection.sync(project_id: str, collection_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → CollectionsSingleGetResponse | Errors | None¶

Returns the specified Collection.

Args:: project_id (str): collection_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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:: Union[CollectionsSingleGetResponse, Errors]

polarion_rest_api_client.open_api_client.api.collections.get_collection.sync_detailed(project_id: str, collection_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[CollectionsSingleGetResponse | Errors]¶

Returns the specified Collection.

Args:: project_id (str): collection_id (str): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Union[CollectionsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.collections.get_collections module¶

async polarion_rest_api_client.open_api_client.api.collections.get_collections.asyncio(project_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → CollectionsListGetResponse | Errors | None¶

Returns a list of Collections.

Args:: project_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (Union[Unset, str]): revision (Union[Unset, 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:: Union[CollectionsListGetResponse, Errors]

async polarion_rest_api_client.open_api_client.api.collections.get_collections.asyncio_detailed(project_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[CollectionsListGetResponse | Errors]¶

Returns a list of Collections.

Args:: project_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (Union[Unset, str]): revision (Union[Unset, 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[Union[CollectionsListGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.collections.get_collections.sync(project_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → CollectionsListGetResponse | Errors | None¶

Returns a list of Collections.

Args:: project_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (Union[Unset, str]): revision (Union[Unset, 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:: Union[CollectionsListGetResponse, Errors]

polarion_rest_api_client.open_api_client.api.collections.get_collections.sync_detailed(project_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[CollectionsListGetResponse | Errors]¶

Returns a list of Collections.

Args:: project_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (Union[Unset, str]): revision (Union[Unset, 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[Union[CollectionsListGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.collections.get_collections_relationship module¶

async polarion_rest_api_client.open_api_client.api.collections.get_collections_relationship.asyncio(project_id: str, collection_id: str, relationship_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | RelationshipDataListResponse | RelationshipDataSingleResponse | None¶

Returns a list of Collection Relationships.

Args:: project_id (str): collection_id (str): relationship_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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:: Union[Errors, Union[‘RelationshipDataListResponse’, ‘RelationshipDataSingleResponse’]]

async polarion_rest_api_client.open_api_client.api.collections.get_collections_relationship.asyncio_detailed(project_id: str, collection_id: str, relationship_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | RelationshipDataListResponse | RelationshipDataSingleResponse]¶

Returns a list of Collection Relationships.

Args:: project_id (str): collection_id (str): relationship_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Union[Errors, Union[‘RelationshipDataListResponse’, ‘RelationshipDataSingleResponse’]]]

polarion_rest_api_client.open_api_client.api.collections.get_collections_relationship.sync(project_id: str, collection_id: str, relationship_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | RelationshipDataListResponse | RelationshipDataSingleResponse | None¶

Returns a list of Collection Relationships.

Args:: project_id (str): collection_id (str): relationship_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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:: Union[Errors, Union[‘RelationshipDataListResponse’, ‘RelationshipDataSingleResponse’]]

polarion_rest_api_client.open_api_client.api.collections.get_collections_relationship.sync_detailed(project_id: str, collection_id: str, relationship_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | RelationshipDataListResponse | RelationshipDataSingleResponse]¶

Returns a list of Collection Relationships.

Args:: project_id (str): collection_id (str): relationship_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): revision (Union[Unset, 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[Union[Errors, Union[‘RelationshipDataListResponse’, ‘RelationshipDataSingleResponse’]]]

polarion_rest_api_client.open_api_client.api.collections.patch_collections module¶

async polarion_rest_api_client.open_api_client.api.collections.patch_collections.asyncio(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client, body: CollectionsSinglePatchRequest) → Any | Errors | None¶

Updates the specified Collection.

Args:: project_id (str): collection_id (str): body (CollectionsSinglePatchRequest):
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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.collections.patch_collections.asyncio_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client, body: CollectionsSinglePatchRequest) → Response[Any | Errors]¶

Updates the specified Collection.

Args:: project_id (str): collection_id (str): body (CollectionsSinglePatchRequest):
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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.patch_collections.sync(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client, body: CollectionsSinglePatchRequest) → Any | Errors | None¶

Updates the specified Collection.

Args:: project_id (str): collection_id (str): body (CollectionsSinglePatchRequest):
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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.collections.patch_collections.sync_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client, body: CollectionsSinglePatchRequest) → Response[Any | Errors]¶

Updates the specified Collection.

Args:: project_id (str): collection_id (str): body (CollectionsSinglePatchRequest):
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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.patch_collections_relationships module¶

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

Updates a list of Collection Relationships.

Args:: project_id (str): collection_id (str): relationship_id (str): body (Union[‘RelationshipDataListRequest’, ‘RelationshipDataSingleRequest’]): List of

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’, ‘revision’: ‘1234’}]}.
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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.collections.patch_collections_relationships.asyncio_detailed(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Updates a list of Collection Relationships.

Args:: project_id (str): collection_id (str): relationship_id (str): body (Union[‘RelationshipDataListRequest’, ‘RelationshipDataSingleRequest’]): List of

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’, ‘revision’: ‘1234’}]}.
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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.patch_collections_relationships.sync(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Any | Errors | None¶

Updates a list of Collection Relationships.

Args:: project_id (str): collection_id (str): relationship_id (str): body (Union[‘RelationshipDataListRequest’, ‘RelationshipDataSingleRequest’]): List of

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’, ‘revision’: ‘1234’}]}.
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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.collections.patch_collections_relationships.sync_detailed(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Updates a list of Collection Relationships.

Args:: project_id (str): collection_id (str): relationship_id (str): body (Union[‘RelationshipDataListRequest’, ‘RelationshipDataSingleRequest’]): List of

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’, ‘revision’: ‘1234’}]}.
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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.post_collections module¶

async polarion_rest_api_client.open_api_client.api.collections.post_collections.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: CollectionsListPostRequest) → CollectionsListPostResponse | Errors | None¶

Creates a list of Collections.

Args:: project_id (str): body (CollectionsListPostRequest):
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:: Union[CollectionsListPostResponse, Errors]

async polarion_rest_api_client.open_api_client.api.collections.post_collections.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: CollectionsListPostRequest) → Response[CollectionsListPostResponse | Errors]¶

Creates a list of Collections.

Args:: project_id (str): body (CollectionsListPostRequest):
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[Union[CollectionsListPostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.collections.post_collections.sync(project_id: str, *, client: AuthenticatedClient | Client, body: CollectionsListPostRequest) → CollectionsListPostResponse | Errors | None¶

Creates a list of Collections.

Args:: project_id (str): body (CollectionsListPostRequest):
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:: Union[CollectionsListPostResponse, Errors]

polarion_rest_api_client.open_api_client.api.collections.post_collections.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: CollectionsListPostRequest) → Response[CollectionsListPostResponse | Errors]¶

Creates a list of Collections.

Args:: project_id (str): body (CollectionsListPostRequest):
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[Union[CollectionsListPostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.collections.post_collections_relationships module¶

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

Creates the specific Relationships for the Collections.

Args:: project_id (str): collection_id (str): relationship_id (str): body (Union[‘RelationshipDataListRequest’, ‘RelationshipDataSingleRequest’]): List of

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’, ‘revision’: ‘1234’}]}.
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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.collections.post_collections_relationships.asyncio_detailed(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Creates the specific Relationships for the Collections.

Args:: project_id (str): collection_id (str): relationship_id (str): body (Union[‘RelationshipDataListRequest’, ‘RelationshipDataSingleRequest’]): List of

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’, ‘revision’: ‘1234’}]}.
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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.post_collections_relationships.sync(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Any | Errors | None¶

Creates the specific Relationships for the Collections.

Args:: project_id (str): collection_id (str): relationship_id (str): body (Union[‘RelationshipDataListRequest’, ‘RelationshipDataSingleRequest’]): List of

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’, ‘revision’: ‘1234’}]}.
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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.collections.post_collections_relationships.sync_detailed(project_id: str, collection_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Creates the specific Relationships for the Collections.

Args:: project_id (str): collection_id (str): relationship_id (str): body (Union[‘RelationshipDataListRequest’, ‘RelationshipDataSingleRequest’]): List of

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’, ‘revision’: ‘1234’}]}.
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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.reopen_collection module¶

async polarion_rest_api_client.open_api_client.api.collections.reopen_collection.asyncio(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Reopens the specified Collection.

Args:: project_id (str): collection_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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.collections.reopen_collection.asyncio_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Reopens the specified Collection.

Args:: project_id (str): collection_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.collections.reopen_collection.sync(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Reopens the specified Collection.

Args:: project_id (str): collection_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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.collections.reopen_collection.sync_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Reopens the specified Collection.

Args:: project_id (str): collection_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[Union[Any, Errors]]