polarion_rest_api_client.open_api_client.api.plans package¶

Contains endpoint functions for accessing the API.

Submodules¶

polarion_rest_api_client.open_api_client.api.plans.delete_plan module¶

async polarion_rest_api_client.open_api_client.api.plans.delete_plan.asyncio(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Plan.

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

Deletes the specified Plan.

Args:: project_id (str): plan_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.plans.delete_plan.sync(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Plan.

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

Deletes the specified Plan.

Args:: project_id (str): plan_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.plans.delete_plan_relationship module¶

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

Removes the specific Relationship from the Plan.

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

Removes the specific Relationship from the Plan.

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

Removes the specific Relationship from the Plan.

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

Removes the specific Relationship from the Plan.

Args:: project_id (str): plan_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.plans.delete_plans module¶

async polarion_rest_api_client.open_api_client.api.plans.delete_plans.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: PlansListDeleteRequest) → Any | Errors | None¶

Deletes a list of Plans.

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

Deletes a list of Plans.

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

Deletes a list of Plans.

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

Deletes a list of Plans.

Args:: project_id (str): body (PlansListDeleteRequest):
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.plans.get_plan module¶

async polarion_rest_api_client.open_api_client.api.plans.get_plan.asyncio(project_id: str, plan_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>) → Errors | PlansSingleGetResponse | None¶

Returns the specified Plan.

Args:: project_id (str): plan_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[Errors, PlansSingleGetResponse]

async polarion_rest_api_client.open_api_client.api.plans.get_plan.asyncio_detailed(project_id: str, plan_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[Errors | PlansSingleGetResponse]¶

Returns the specified Plan.

Args:: project_id (str): plan_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[Errors, PlansSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.plans.get_plan.sync(project_id: str, plan_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>) → Errors | PlansSingleGetResponse | None¶

Returns the specified Plan.

Args:: project_id (str): plan_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[Errors, PlansSingleGetResponse]

polarion_rest_api_client.open_api_client.api.plans.get_plan.sync_detailed(project_id: str, plan_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[Errors | PlansSingleGetResponse]¶

Returns the specified Plan.

Args:: project_id (str): plan_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[Errors, PlansSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.plans.get_plan_relationship module¶

async polarion_rest_api_client.open_api_client.api.plans.get_plan_relationship.asyncio(project_id: str, plan_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 Plan Relationships.

Args:: project_id (str): plan_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.plans.get_plan_relationship.asyncio_detailed(project_id: str, plan_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 Plan Relationships.

Args:: project_id (str): plan_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.plans.get_plan_relationship.sync(project_id: str, plan_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 Plan Relationships.

Args:: project_id (str): plan_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.plans.get_plan_relationship.sync_detailed(project_id: str, plan_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 Plan Relationships.

Args:: project_id (str): plan_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.plans.get_plans module¶

async polarion_rest_api_client.open_api_client.api.plans.get_plans.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>, templates: ~polarion_rest_api_client.open_api_client.types.Unset | bool = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | PlansListGetResponse | None¶

Returns a list of Plans.

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]): templates (Union[Unset, bool]):
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, PlansListGetResponse]

async polarion_rest_api_client.open_api_client.api.plans.get_plans.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>, templates: ~polarion_rest_api_client.open_api_client.types.Unset | bool = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | PlansListGetResponse]¶

Returns a list of Plans.

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]): templates (Union[Unset, bool]):
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, PlansListGetResponse]]

polarion_rest_api_client.open_api_client.api.plans.get_plans.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>, templates: ~polarion_rest_api_client.open_api_client.types.Unset | bool = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | PlansListGetResponse | None¶

Returns a list of Plans.

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]): templates (Union[Unset, bool]):
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, PlansListGetResponse]

polarion_rest_api_client.open_api_client.api.plans.get_plans.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>, templates: ~polarion_rest_api_client.open_api_client.types.Unset | bool = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | PlansListGetResponse]¶

Returns a list of Plans.

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]): templates (Union[Unset, bool]):
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, PlansListGetResponse]]

polarion_rest_api_client.open_api_client.api.plans.patch_plan module¶

async polarion_rest_api_client.open_api_client.api.plans.patch_plan.asyncio(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client, body: PlansSinglePatchRequest) → Any | Errors | None¶

Updates the specified Plan.

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

Updates the specified Plan.

Args:: project_id (str): plan_id (str): body (PlansSinglePatchRequest):
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.plans.patch_plan.sync(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client, body: PlansSinglePatchRequest) → Any | Errors | None¶

Updates the specified Plan.

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

Updates the specified Plan.

Args:: project_id (str): plan_id (str): body (PlansSinglePatchRequest):
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.plans.patch_plan_relationships module¶

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

Updates a list of Plan Relationships.

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

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’}]}.
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.plans.patch_plan_relationships.asyncio_detailed(project_id: str, plan_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Updates a list of Plan Relationships.

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

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’}]}.
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.plans.patch_plan_relationships.sync(project_id: str, plan_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Any | Errors | None¶

Updates a list of Plan Relationships.

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

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’}]}.
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.plans.patch_plan_relationships.sync_detailed(project_id: str, plan_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Updates a list of Plan Relationships.

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

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’}]}.
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.plans.post_plan_relationships module¶

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

Creates the specific Relationships for the Plan.

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

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’}]}.
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.plans.post_plan_relationships.asyncio_detailed(project_id: str, plan_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Creates the specific Relationships for the Plan.

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

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’}]}.
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.plans.post_plan_relationships.sync(project_id: str, plan_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Any | Errors | None¶

Creates the specific Relationships for the Plan.

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

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’}]}.
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.plans.post_plan_relationships.sync_detailed(project_id: str, plan_id: str, relationship_id: str, *, client: AuthenticatedClient | Client, body: RelationshipDataListRequest | RelationshipDataSingleRequest) → Response[Any | Errors]¶

Creates the specific Relationships for the Plan.

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

generic contents Example: {‘data’: [{‘type’: ‘MyResourceType’, ‘id’: ‘MyProjectId/MyResourceId’}]}.
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.plans.post_plans module¶

async polarion_rest_api_client.open_api_client.api.plans.post_plans.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: PlansListPostRequest) → Errors | PlansListPostResponse | None¶

Creates a list of Plans.

Args:: project_id (str): body (PlansListPostRequest):
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, PlansListPostResponse]

async polarion_rest_api_client.open_api_client.api.plans.post_plans.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: PlansListPostRequest) → Response[Errors | PlansListPostResponse]¶

Creates a list of Plans.

Args:: project_id (str): body (PlansListPostRequest):
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, PlansListPostResponse]]

polarion_rest_api_client.open_api_client.api.plans.post_plans.sync(project_id: str, *, client: AuthenticatedClient | Client, body: PlansListPostRequest) → Errors | PlansListPostResponse | None¶

Creates a list of Plans.

Args:: project_id (str): body (PlansListPostRequest):
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, PlansListPostResponse]

polarion_rest_api_client.open_api_client.api.plans.post_plans.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: PlansListPostRequest) → Response[Errors | PlansListPostResponse]¶

Creates a list of Plans.

Args:: project_id (str): body (PlansListPostRequest):
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, PlansListPostResponse]]