polarion_rest_api_client.open_api_client.api.metadata package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.metadata.get_global_fields_metadata module

async polarion_rest_api_client.open_api_client.api.metadata.get_global_fields_metadata.asyncio(*, client: AuthenticatedClient | Client, resource_type: str, target_type: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | FieldsMetadataActionResponseBody | None

Returns fields for the resource type and its target type in the Global context.

Args:

resource_type (str): target_type (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 | FieldsMetadataActionResponseBody

async polarion_rest_api_client.open_api_client.api.metadata.get_global_fields_metadata.asyncio_detailed(*, client: AuthenticatedClient | Client, resource_type: str, target_type: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | FieldsMetadataActionResponseBody]

Returns fields for the resource type and its target type in the Global context.

Args:

resource_type (str): target_type (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 | FieldsMetadataActionResponseBody]

polarion_rest_api_client.open_api_client.api.metadata.get_global_fields_metadata.sync(*, client: AuthenticatedClient | Client, resource_type: str, target_type: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | FieldsMetadataActionResponseBody | None

Returns fields for the resource type and its target type in the Global context.

Args:

resource_type (str): target_type (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 | FieldsMetadataActionResponseBody

polarion_rest_api_client.open_api_client.api.metadata.get_global_fields_metadata.sync_detailed(*, client: AuthenticatedClient | Client, resource_type: str, target_type: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | FieldsMetadataActionResponseBody]

Returns fields for the resource type and its target type in the Global context.

Args:

resource_type (str): target_type (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 | FieldsMetadataActionResponseBody]

polarion_rest_api_client.open_api_client.api.metadata.get_metadata module

async polarion_rest_api_client.open_api_client.api.metadata.get_metadata.asyncio(*, 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>) → Errors | MetadataSingleGetResponse | None

Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)

Args:

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:

Errors | MetadataSingleGetResponse

async polarion_rest_api_client.open_api_client.api.metadata.get_metadata.asyncio_detailed(*, 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[Errors | MetadataSingleGetResponse]

Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)

Args:

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

polarion_rest_api_client.open_api_client.api.metadata.get_metadata.sync(*, 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>) → Errors | MetadataSingleGetResponse | None

Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)

Args:

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:

Errors | MetadataSingleGetResponse

polarion_rest_api_client.open_api_client.api.metadata.get_metadata.sync_detailed(*, 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[Errors | MetadataSingleGetResponse]

Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)

Args:

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

polarion_rest_api_client.open_api_client.api.metadata.get_project_fields_metadata module

async polarion_rest_api_client.open_api_client.api.metadata.get_project_fields_metadata.asyncio(project_id: str, *, client: AuthenticatedClient | Client, resource_type: str, target_type: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | FieldsMetadataActionResponseBody | None

Returns fields for the resource type and its target type in the Project context.

Args:

project_id (str): resource_type (str): target_type (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 | FieldsMetadataActionResponseBody

async polarion_rest_api_client.open_api_client.api.metadata.get_project_fields_metadata.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, resource_type: str, target_type: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | FieldsMetadataActionResponseBody]

Returns fields for the resource type and its target type in the Project context.

Args:

project_id (str): resource_type (str): target_type (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 | FieldsMetadataActionResponseBody]

polarion_rest_api_client.open_api_client.api.metadata.get_project_fields_metadata.sync(project_id: str, *, client: AuthenticatedClient | Client, resource_type: str, target_type: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | FieldsMetadataActionResponseBody | None

Returns fields for the resource type and its target type in the Project context.

Args:

project_id (str): resource_type (str): target_type (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 | FieldsMetadataActionResponseBody

polarion_rest_api_client.open_api_client.api.metadata.get_project_fields_metadata.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, resource_type: str, target_type: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | FieldsMetadataActionResponseBody]

Returns fields for the resource type and its target type in the Project context.

Args:

project_id (str): resource_type (str): target_type (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 | FieldsMetadataActionResponseBody]