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:: 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[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:: 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[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:: 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[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:: 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[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:: 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[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:: 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[Any | Errors]

polarion_rest_api_client.open_api_client.api.plans.get_fields_metadata_for_plan module¶

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

Returns fields for the specified resource.

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

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

Returns fields for the specified resource.

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

polarion_rest_api_client.open_api_client.api.plans.get_fields_metadata_for_plan.sync(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client) → Errors | FieldsMetadataActionResponseBody | None¶

Returns fields for the specified resource.

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

polarion_rest_api_client.open_api_client.api.plans.get_fields_metadata_for_plan.sync_detailed(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client) → Response[Errors | FieldsMetadataActionResponseBody]¶

Returns fields for the specified resource.

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

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: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | PlansSingleGetResponse | None¶

Returns the specified Plan.

Args:: project_id (str): plan_id (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | PlansSingleGetResponse

async polarion_rest_api_client.open_api_client.api.plans.get_plan.asyncio_detailed(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | PlansSingleGetResponse]¶

Returns the specified Plan.

Args:: project_id (str): plan_id (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | PlansSingleGetResponse]

polarion_rest_api_client.open_api_client.api.plans.get_plan.sync(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | PlansSingleGetResponse | None¶

Returns the specified Plan.

Args:: project_id (str): plan_id (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Errors | PlansSingleGetResponse

polarion_rest_api_client.open_api_client.api.plans.get_plan.sync_detailed(project_id: str, plan_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | PlansSingleGetResponse]¶

Returns the specified Plan.

Args:: project_id (str): plan_id (str): fields (SparseFields | Unset): include (str | Unset): revision (str | Unset):
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Errors | 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: 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 Plan Relationships.

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

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

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

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

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

Returns a list of Plans.

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): templates (bool | 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 | PlansListGetResponse

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

Returns a list of Plans.

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): templates (bool | 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 | PlansListGetResponse]

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

Returns a list of Plans.

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): templates (bool | 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 | PlansListGetResponse

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

Returns a list of Plans.

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

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

async polarion_rest_api_client.open_api_client.api.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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

polarion_rest_api_client.open_api_client.api.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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

async polarion_rest_api_client.open_api_client.api.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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Any | Errors

polarion_rest_api_client.open_api_client.api.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 (RelationshipDataListRequest | RelationshipDataSingleRequest): List of generic

contents Example: {‘data’: [{‘type’: ‘workitems’, ‘id’: ‘MyProjectId/WI-123’}]}.
Raises:: errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:: Response[Any | Errors]

polarion_rest_api_client.open_api_client.api.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:: 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[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:: 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[Errors | PlansListPostResponse]