polarion_rest_api_client.open_api_client.api.custom_fields package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.custom_fields.delete_global_custom_fields module

async polarion_rest_api_client.open_api_client.api.custom_fields.delete_global_custom_fields.asyncio(resource_type: str, target_type: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Custom Field configuration from the Global context.

Args:

resource_type (str): target_type (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.custom_fields.delete_global_custom_fields.asyncio_detailed(resource_type: str, target_type: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Custom Field configuration from the Global context.

Args:

resource_type (str): target_type (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.custom_fields.delete_global_custom_fields.sync(resource_type: str, target_type: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Custom Field configuration from the Global context.

Args:

resource_type (str): target_type (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.custom_fields.delete_global_custom_fields.sync_detailed(resource_type: str, target_type: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Custom Field configuration from the Global context.

Args:

resource_type (str): target_type (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.custom_fields.delete_project_custom_fields module

async polarion_rest_api_client.open_api_client.api.custom_fields.delete_project_custom_fields.asyncio(project_id: str, resource_type: str, target_type: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Custom Field configuration from the Project context.

Args:

project_id (str): resource_type (str): target_type (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.custom_fields.delete_project_custom_fields.asyncio_detailed(project_id: str, resource_type: str, target_type: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Custom Field configuration from the Project context.

Args:

project_id (str): resource_type (str): target_type (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.custom_fields.delete_project_custom_fields.sync(project_id: str, resource_type: str, target_type: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Custom Field configuration from the Project context.

Args:

project_id (str): resource_type (str): target_type (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.custom_fields.delete_project_custom_fields.sync_detailed(project_id: str, resource_type: str, target_type: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Custom Field configuration from the Project context.

Args:

project_id (str): resource_type (str): target_type (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.custom_fields.get_global_custom_fields module

async polarion_rest_api_client.open_api_client.api.custom_fields.get_global_custom_fields.asyncio(resource_type: str, target_type: 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>) → CustomfieldsSingleGetResponse | Errors | None

Returns the defined Custom Fields for the resource type and target type in the Global context.

Args:

resource_type (str): target_type (str): fields (SparseFields | Unset): include (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:

CustomfieldsSingleGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.custom_fields.get_global_custom_fields.asyncio_detailed(resource_type: str, target_type: 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>) → Response[CustomfieldsSingleGetResponse | Errors]

Returns the defined Custom Fields for the resource type and target type in the Global context.

Args:

resource_type (str): target_type (str): fields (SparseFields | Unset): include (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[CustomfieldsSingleGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.custom_fields.get_global_custom_fields.sync(resource_type: str, target_type: 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>) → CustomfieldsSingleGetResponse | Errors | None

Returns the defined Custom Fields for the resource type and target type in the Global context.

Args:

resource_type (str): target_type (str): fields (SparseFields | Unset): include (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:

CustomfieldsSingleGetResponse | Errors

polarion_rest_api_client.open_api_client.api.custom_fields.get_global_custom_fields.sync_detailed(resource_type: str, target_type: 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>) → Response[CustomfieldsSingleGetResponse | Errors]

Returns the defined Custom Fields for the resource type and target type in the Global context.

Args:

resource_type (str): target_type (str): fields (SparseFields | Unset): include (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[CustomfieldsSingleGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.custom_fields.get_project_custom_fields module

async polarion_rest_api_client.open_api_client.api.custom_fields.get_project_custom_fields.asyncio(project_id: str, resource_type: str, target_type: 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>) → CustomfieldsSingleGetResponse | Errors | None

Returns the defined Custom Fields for the resource type and target type in the Project context.

Args:

project_id (str): resource_type (str): target_type (str): fields (SparseFields | Unset): include (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:

CustomfieldsSingleGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.custom_fields.get_project_custom_fields.asyncio_detailed(project_id: str, resource_type: str, target_type: 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>) → Response[CustomfieldsSingleGetResponse | Errors]

Returns the defined Custom Fields for the resource type and target type in the Project context.

Args:

project_id (str): resource_type (str): target_type (str): fields (SparseFields | Unset): include (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[CustomfieldsSingleGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.custom_fields.get_project_custom_fields.sync(project_id: str, resource_type: str, target_type: 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>) → CustomfieldsSingleGetResponse | Errors | None

Returns the defined Custom Fields for the resource type and target type in the Project context.

Args:

project_id (str): resource_type (str): target_type (str): fields (SparseFields | Unset): include (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:

CustomfieldsSingleGetResponse | Errors

polarion_rest_api_client.open_api_client.api.custom_fields.get_project_custom_fields.sync_detailed(project_id: str, resource_type: str, target_type: 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>) → Response[CustomfieldsSingleGetResponse | Errors]

Returns the defined Custom Fields for the resource type and target type in the Project context.

Args:

project_id (str): resource_type (str): target_type (str): fields (SparseFields | Unset): include (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[CustomfieldsSingleGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.custom_fields.patch_custom_field module

async polarion_rest_api_client.open_api_client.api.custom_fields.patch_custom_field.asyncio(project_id: str, resource_type: str, target_type: str, *, client: AuthenticatedClient | Client, body: CustomfieldsSinglePatchRequest) → Any | Errors | None

Updates the specified Custom Fields in the Project context.

Args:

project_id (str): resource_type (str): target_type (str): body (CustomfieldsSinglePatchRequest):

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.custom_fields.patch_custom_field.asyncio_detailed(project_id: str, resource_type: str, target_type: str, *, client: AuthenticatedClient | Client, body: CustomfieldsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Custom Fields in the Project context.

Args:

project_id (str): resource_type (str): target_type (str): body (CustomfieldsSinglePatchRequest):

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.custom_fields.patch_custom_field.sync(project_id: str, resource_type: str, target_type: str, *, client: AuthenticatedClient | Client, body: CustomfieldsSinglePatchRequest) → Any | Errors | None

Updates the specified Custom Fields in the Project context.

Args:

project_id (str): resource_type (str): target_type (str): body (CustomfieldsSinglePatchRequest):

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.custom_fields.patch_custom_field.sync_detailed(project_id: str, resource_type: str, target_type: str, *, client: AuthenticatedClient | Client, body: CustomfieldsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Custom Fields in the Project context.

Args:

project_id (str): resource_type (str): target_type (str): body (CustomfieldsSinglePatchRequest):

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.custom_fields.patch_global_custom_fields module

async polarion_rest_api_client.open_api_client.api.custom_fields.patch_global_custom_fields.asyncio(resource_type: str, target_type: str, *, client: AuthenticatedClient | Client, body: CustomfieldsSinglePatchRequest) → Any | Errors | None

Updates the specified Custom Fields in the Global context.

Args:

resource_type (str): target_type (str): body (CustomfieldsSinglePatchRequest):

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.custom_fields.patch_global_custom_fields.asyncio_detailed(resource_type: str, target_type: str, *, client: AuthenticatedClient | Client, body: CustomfieldsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Custom Fields in the Global context.

Args:

resource_type (str): target_type (str): body (CustomfieldsSinglePatchRequest):

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.custom_fields.patch_global_custom_fields.sync(resource_type: str, target_type: str, *, client: AuthenticatedClient | Client, body: CustomfieldsSinglePatchRequest) → Any | Errors | None

Updates the specified Custom Fields in the Global context.

Args:

resource_type (str): target_type (str): body (CustomfieldsSinglePatchRequest):

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.custom_fields.patch_global_custom_fields.sync_detailed(resource_type: str, target_type: str, *, client: AuthenticatedClient | Client, body: CustomfieldsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Custom Fields in the Global context.

Args:

resource_type (str): target_type (str): body (CustomfieldsSinglePatchRequest):

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.custom_fields.post_global_custom_fields module

async polarion_rest_api_client.open_api_client.api.custom_fields.post_global_custom_fields.asyncio(*, client: AuthenticatedClient | Client, body: CustomfieldsListPostRequest) → CustomfieldsListPostResponse | Errors | None

Creates a list of Custom Fields in the Global context.

Args:

body (CustomfieldsListPostRequest):

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:

CustomfieldsListPostResponse | Errors

async polarion_rest_api_client.open_api_client.api.custom_fields.post_global_custom_fields.asyncio_detailed(*, client: AuthenticatedClient | Client, body: CustomfieldsListPostRequest) → Response[CustomfieldsListPostResponse | Errors]

Creates a list of Custom Fields in the Global context.

Args:

body (CustomfieldsListPostRequest):

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

polarion_rest_api_client.open_api_client.api.custom_fields.post_global_custom_fields.sync(*, client: AuthenticatedClient | Client, body: CustomfieldsListPostRequest) → CustomfieldsListPostResponse | Errors | None

Creates a list of Custom Fields in the Global context.

Args:

body (CustomfieldsListPostRequest):

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:

CustomfieldsListPostResponse | Errors

polarion_rest_api_client.open_api_client.api.custom_fields.post_global_custom_fields.sync_detailed(*, client: AuthenticatedClient | Client, body: CustomfieldsListPostRequest) → Response[CustomfieldsListPostResponse | Errors]

Creates a list of Custom Fields in the Global context.

Args:

body (CustomfieldsListPostRequest):

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

polarion_rest_api_client.open_api_client.api.custom_fields.post_project_custom_fields module

async polarion_rest_api_client.open_api_client.api.custom_fields.post_project_custom_fields.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: CustomfieldsListPostRequest) → CustomfieldsListPostResponse | Errors | None

Creates a list of Custom Fields in the Project context.

Args:

project_id (str): body (CustomfieldsListPostRequest):

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:

CustomfieldsListPostResponse | Errors

async polarion_rest_api_client.open_api_client.api.custom_fields.post_project_custom_fields.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: CustomfieldsListPostRequest) → Response[CustomfieldsListPostResponse | Errors]

Creates a list of Custom Fields in the Project context.

Args:

project_id (str): body (CustomfieldsListPostRequest):

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

polarion_rest_api_client.open_api_client.api.custom_fields.post_project_custom_fields.sync(project_id: str, *, client: AuthenticatedClient | Client, body: CustomfieldsListPostRequest) → CustomfieldsListPostResponse | Errors | None

Creates a list of Custom Fields in the Project context.

Args:

project_id (str): body (CustomfieldsListPostRequest):

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:

CustomfieldsListPostResponse | Errors

polarion_rest_api_client.open_api_client.api.custom_fields.post_project_custom_fields.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: CustomfieldsListPostRequest) → Response[CustomfieldsListPostResponse | Errors]

Creates a list of Custom Fields in the Project context.

Args:

project_id (str): body (CustomfieldsListPostRequest):

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