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:: 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[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:: 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[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:: 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[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:: 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[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:: 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[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:: 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[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:: 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[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:: 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[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: 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>) → CollectionsSingleGetResponse | Errors | None¶

Returns the specified Collection.

Args:: project_id (str): collection_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:: CollectionsSingleGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.collections.get_collection.asyncio_detailed(project_id: str, collection_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[CollectionsSingleGetResponse | Errors]¶

Returns the specified Collection.

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

polarion_rest_api_client.open_api_client.api.collections.get_collection.sync(project_id: str, collection_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>) → CollectionsSingleGetResponse | Errors | None¶

Returns the specified Collection.

Args:: project_id (str): collection_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:: CollectionsSingleGetResponse | Errors

polarion_rest_api_client.open_api_client.api.collections.get_collection.sync_detailed(project_id: str, collection_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[CollectionsSingleGetResponse | Errors]¶

Returns the specified Collection.

Args:: project_id (str): collection_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[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: 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>) → CollectionsListGetResponse | Errors | None¶

Returns a list of Collections.

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:: CollectionsListGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.collections.get_collections.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[CollectionsListGetResponse | Errors]¶

Returns a list of Collections.

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

polarion_rest_api_client.open_api_client.api.collections.get_collections.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>) → CollectionsListGetResponse | Errors | None¶

Returns a list of Collections.

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:: CollectionsListGetResponse | Errors

polarion_rest_api_client.open_api_client.api.collections.get_collections.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[CollectionsListGetResponse | Errors]¶

Returns a list of Collections.

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[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: 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 Collection Relationships.

Args:: project_id (str): collection_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.collections.get_collections_relationship.asyncio_detailed(project_id: str, collection_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 Collection Relationships.

Args:: project_id (str): collection_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.collections.get_collections_relationship.sync(project_id: str, collection_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 Collection Relationships.

Args:: project_id (str): collection_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.collections.get_collections_relationship.sync_detailed(project_id: str, collection_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 Collection Relationships.

Args:: project_id (str): collection_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.collections.get_fields_metadata_for_collection module¶

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

Returns fields for the specified resource.

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:: Errors | FieldsMetadataActionResponseBody

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

Returns fields for the specified resource.

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

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

Returns fields for the specified resource.

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:: Errors | FieldsMetadataActionResponseBody

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

Returns fields for the specified resource.

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

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:: 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[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:: 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[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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’, ‘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:: 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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’, ‘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[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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’, ‘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:: 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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’, ‘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[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:: 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[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:: 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[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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’, ‘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:: 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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’, ‘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[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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’, ‘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:: 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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’, ‘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[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:: 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[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:: 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[Any | Errors]

polarion_rest_api_client.open_api_client.api.collections.reuse_collection module¶

async polarion_rest_api_client.open_api_client.api.collections.reuse_collection.asyncio(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client, body: ReuseCollectionRequestBody, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → CollectionsSinglePostResponse | Errors | None¶

Reuses the specified Collection.

Args:: project_id (str): collection_id (str): revision (str | Unset): body (ReuseCollectionRequestBody):
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:: CollectionsSinglePostResponse | Errors

async polarion_rest_api_client.open_api_client.api.collections.reuse_collection.asyncio_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client, body: ReuseCollectionRequestBody, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[CollectionsSinglePostResponse | Errors]¶

Reuses the specified Collection.

Args:: project_id (str): collection_id (str): revision (str | Unset): body (ReuseCollectionRequestBody):
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[CollectionsSinglePostResponse | Errors]

polarion_rest_api_client.open_api_client.api.collections.reuse_collection.sync(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client, body: ReuseCollectionRequestBody, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → CollectionsSinglePostResponse | Errors | None¶

Reuses the specified Collection.

Args:: project_id (str): collection_id (str): revision (str | Unset): body (ReuseCollectionRequestBody):
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:: CollectionsSinglePostResponse | Errors

polarion_rest_api_client.open_api_client.api.collections.reuse_collection.sync_detailed(project_id: str, collection_id: str, *, client: AuthenticatedClient | Client, body: ReuseCollectionRequestBody, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[CollectionsSinglePostResponse | Errors]¶

Reuses the specified Collection.

Args:: project_id (str): collection_id (str): revision (str | Unset): body (ReuseCollectionRequestBody):
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[CollectionsSinglePostResponse | Errors]