polarion_rest_api_client.open_api_client.api.documents package¶

Contains endpoint functions for accessing the API.

Submodules¶

polarion_rest_api_client.open_api_client.api.documents.branch_document module¶

async polarion_rest_api_client.open_api_client.api.documents.branch_document.asyncio(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.branch_document_request_body.BranchDocumentRequestBody, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → DocumentsSinglePostResponse | Errors | None¶

Creates a Branch of the Document.

Args:: project_id (str): space_id (str): document_name (str): revision (Union[Unset, str]): body (BranchDocumentRequestBody):
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[DocumentsSinglePostResponse, Errors]

async polarion_rest_api_client.open_api_client.api.documents.branch_document.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.branch_document_request_body.BranchDocumentRequestBody, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[DocumentsSinglePostResponse | Errors]¶

Creates a Branch of the Document.

Args:: project_id (str): space_id (str): document_name (str): revision (Union[Unset, str]): body (BranchDocumentRequestBody):
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[DocumentsSinglePostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.documents.branch_document.sync(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.branch_document_request_body.BranchDocumentRequestBody, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → DocumentsSinglePostResponse | Errors | None¶

Creates a Branch of the Document.

Args:: project_id (str): space_id (str): document_name (str): revision (Union[Unset, str]): body (BranchDocumentRequestBody):
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[DocumentsSinglePostResponse, Errors]

polarion_rest_api_client.open_api_client.api.documents.branch_document.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.branch_document_request_body.BranchDocumentRequestBody, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[DocumentsSinglePostResponse | Errors]¶

Creates a Branch of the Document.

Args:: project_id (str): space_id (str): document_name (str): revision (Union[Unset, str]): body (BranchDocumentRequestBody):
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[DocumentsSinglePostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.documents.branch_documents module¶

async polarion_rest_api_client.open_api_client.api.documents.branch_documents.asyncio(*, client: AuthenticatedClient | Client, body: BranchDocumentsRequestBody) → Errors | JobsSinglePostResponse | None¶

Creates Branches of Documents.

Args:: body (BranchDocumentsRequestBody):
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, JobsSinglePostResponse]

async polarion_rest_api_client.open_api_client.api.documents.branch_documents.asyncio_detailed(*, client: AuthenticatedClient | Client, body: BranchDocumentsRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Creates Branches of Documents.

Args:: body (BranchDocumentsRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.documents.branch_documents.sync(*, client: AuthenticatedClient | Client, body: BranchDocumentsRequestBody) → Errors | JobsSinglePostResponse | None¶

Creates Branches of Documents.

Args:: body (BranchDocumentsRequestBody):
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, JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.documents.branch_documents.sync_detailed(*, client: AuthenticatedClient | Client, body: BranchDocumentsRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Creates Branches of Documents.

Args:: body (BranchDocumentsRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.documents.copy_document module¶

async polarion_rest_api_client.open_api_client.api.documents.copy_document.asyncio(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.copy_document_request_body.CopyDocumentRequestBody, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → DocumentsSinglePostResponse | Errors | None¶

Creates a copy of the Document.

Args:: project_id (str): space_id (str): document_name (str): revision (Union[Unset, str]): body (CopyDocumentRequestBody):
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[DocumentsSinglePostResponse, Errors]

async polarion_rest_api_client.open_api_client.api.documents.copy_document.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.copy_document_request_body.CopyDocumentRequestBody, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[DocumentsSinglePostResponse | Errors]¶

Creates a copy of the Document.

Args:: project_id (str): space_id (str): document_name (str): revision (Union[Unset, str]): body (CopyDocumentRequestBody):
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[DocumentsSinglePostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.documents.copy_document.sync(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.copy_document_request_body.CopyDocumentRequestBody, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → DocumentsSinglePostResponse | Errors | None¶

Creates a copy of the Document.

Args:: project_id (str): space_id (str): document_name (str): revision (Union[Unset, str]): body (CopyDocumentRequestBody):
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[DocumentsSinglePostResponse, Errors]

polarion_rest_api_client.open_api_client.api.documents.copy_document.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.copy_document_request_body.CopyDocumentRequestBody, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[DocumentsSinglePostResponse | Errors]¶

Creates a copy of the Document.

Args:: project_id (str): space_id (str): document_name (str): revision (Union[Unset, str]): body (CopyDocumentRequestBody):
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[DocumentsSinglePostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document module¶

async polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document.asyncio(project_id: str, space_id: str, document_name: str, field_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>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of available options for the requested field in the specified Document.

Args:: project_id (str): space_id (str): document_name (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]):
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[EnumOptionsActionResponseBody, Errors]

async polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document.asyncio_detailed(project_id: str, space_id: str, document_name: str, field_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>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of available options for the requested field in the specified Document.

Args:: project_id (str): space_id (str): document_name (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]):
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[EnumOptionsActionResponseBody, Errors]]

polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document.sync(project_id: str, space_id: str, document_name: str, field_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>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of available options for the requested field in the specified Document.

Args:: project_id (str): space_id (str): document_name (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]):
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[EnumOptionsActionResponseBody, Errors]

polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document.sync_detailed(project_id: str, space_id: str, document_name: str, field_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>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of available options for the requested field in the specified Document.

Args:: project_id (str): space_id (str): document_name (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]):
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[EnumOptionsActionResponseBody, Errors]]

polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document_type module¶

async polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document_type.asyncio(project_id: str, field_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>, type_: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of available options for the requested field for the specified Document type.

Args:: project_id (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): type_ (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[EnumOptionsActionResponseBody, Errors]

async polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document_type.asyncio_detailed(project_id: str, field_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>, type_: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of available options for the requested field for the specified Document type.

Args:: project_id (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): type_ (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[EnumOptionsActionResponseBody, Errors]]

polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document_type.sync(project_id: str, field_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>, type_: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of available options for the requested field for the specified Document type.

Args:: project_id (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): type_ (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[EnumOptionsActionResponseBody, Errors]

polarion_rest_api_client.open_api_client.api.documents.get_available_enum_options_for_document_type.sync_detailed(project_id: str, field_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>, type_: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of available options for the requested field for the specified Document type.

Args:: project_id (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): type_ (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[EnumOptionsActionResponseBody, Errors]]

polarion_rest_api_client.open_api_client.api.documents.get_current_enumeration_options_for_document module¶

async polarion_rest_api_client.open_api_client.api.documents.get_current_enumeration_options_for_document.asyncio(project_id: str, space_id: str, document_name: str, field_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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of selected options for the requested field in the specified Document.

Args:: project_id (str): space_id (str): document_name (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): 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[EnumOptionsActionResponseBody, Errors]

async polarion_rest_api_client.open_api_client.api.documents.get_current_enumeration_options_for_document.asyncio_detailed(project_id: str, space_id: str, document_name: str, field_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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of selected options for the requested field in the specified Document.

Args:: project_id (str): space_id (str): document_name (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): 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[EnumOptionsActionResponseBody, Errors]]

polarion_rest_api_client.open_api_client.api.documents.get_current_enumeration_options_for_document.sync(project_id: str, space_id: str, document_name: str, field_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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → EnumOptionsActionResponseBody | Errors | None¶

Returns a list of selected options for the requested field in the specified Document.

Args:: project_id (str): space_id (str): document_name (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): 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[EnumOptionsActionResponseBody, Errors]

polarion_rest_api_client.open_api_client.api.documents.get_current_enumeration_options_for_document.sync_detailed(project_id: str, space_id: str, document_name: str, field_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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[EnumOptionsActionResponseBody | Errors]¶

Returns a list of selected options for the requested field in the specified Document.

Args:: project_id (str): space_id (str): document_name (str): field_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): 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[EnumOptionsActionResponseBody, Errors]]

polarion_rest_api_client.open_api_client.api.documents.get_document module¶

async polarion_rest_api_client.open_api_client.api.documents.get_document.asyncio(project_id: str, space_id: str, document_name: 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>) → DocumentsSingleGetResponse | Errors | None¶

Returns the specified Document.

Args:: project_id (str): space_id (str): document_name (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[DocumentsSingleGetResponse, Errors]

async polarion_rest_api_client.open_api_client.api.documents.get_document.asyncio_detailed(project_id: str, space_id: str, document_name: 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[DocumentsSingleGetResponse | Errors]¶

Returns the specified Document.

Args:: project_id (str): space_id (str): document_name (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[DocumentsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.documents.get_document.sync(project_id: str, space_id: str, document_name: 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>) → DocumentsSingleGetResponse | Errors | None¶

Returns the specified Document.

Args:: project_id (str): space_id (str): document_name (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[DocumentsSingleGetResponse, Errors]

polarion_rest_api_client.open_api_client.api.documents.get_document.sync_detailed(project_id: str, space_id: str, document_name: 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[DocumentsSingleGetResponse | Errors]¶

Returns the specified Document.

Args:: project_id (str): space_id (str): document_name (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[DocumentsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.documents.merge_document_from_master module¶

async polarion_rest_api_client.open_api_client.api.documents.merge_document_from_master.asyncio(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: MergeDocumentRequestBody) → Errors | JobsSinglePostResponse | None¶

Merges Master Work Item changes to the specified Branched Document.

Args:: project_id (str): space_id (str): document_name (str): body (MergeDocumentRequestBody):
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, JobsSinglePostResponse]

async polarion_rest_api_client.open_api_client.api.documents.merge_document_from_master.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: MergeDocumentRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Merges Master Work Item changes to the specified Branched Document.

Args:: project_id (str): space_id (str): document_name (str): body (MergeDocumentRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.documents.merge_document_from_master.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: MergeDocumentRequestBody) → Errors | JobsSinglePostResponse | None¶

Merges Master Work Item changes to the specified Branched Document.

Args:: project_id (str): space_id (str): document_name (str): body (MergeDocumentRequestBody):
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, JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.documents.merge_document_from_master.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: MergeDocumentRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Merges Master Work Item changes to the specified Branched Document.

Args:: project_id (str): space_id (str): document_name (str): body (MergeDocumentRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.documents.merge_document_to_master module¶

async polarion_rest_api_client.open_api_client.api.documents.merge_document_to_master.asyncio(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: MergeDocumentRequestBody) → Errors | JobsSinglePostResponse | None¶

Merges Work Item changes from specified Branched Document to Master.

Args:: project_id (str): space_id (str): document_name (str): body (MergeDocumentRequestBody):
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, JobsSinglePostResponse]

async polarion_rest_api_client.open_api_client.api.documents.merge_document_to_master.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: MergeDocumentRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Merges Work Item changes from specified Branched Document to Master.

Args:: project_id (str): space_id (str): document_name (str): body (MergeDocumentRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.documents.merge_document_to_master.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: MergeDocumentRequestBody) → Errors | JobsSinglePostResponse | None¶

Merges Work Item changes from specified Branched Document to Master.

Args:: project_id (str): space_id (str): document_name (str): body (MergeDocumentRequestBody):
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, JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.documents.merge_document_to_master.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: MergeDocumentRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Merges Work Item changes from specified Branched Document to Master.

Args:: project_id (str): space_id (str): document_name (str): body (MergeDocumentRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.documents.patch_document module¶

async polarion_rest_api_client.open_api_client.api.documents.patch_document.asyncio(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.documents_single_patch_request.DocumentsSinglePatchRequest, workflow_action: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates the specified Document.

Args:: project_id (str): space_id (str): document_name (str): workflow_action (Union[Unset, str]): body (DocumentsSinglePatchRequest):
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.documents.patch_document.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.documents_single_patch_request.DocumentsSinglePatchRequest, workflow_action: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates the specified Document.

Args:: project_id (str): space_id (str): document_name (str): workflow_action (Union[Unset, str]): body (DocumentsSinglePatchRequest):
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.documents.patch_document.sync(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.documents_single_patch_request.DocumentsSinglePatchRequest, workflow_action: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates the specified Document.

Args:: project_id (str): space_id (str): document_name (str): workflow_action (Union[Unset, str]): body (DocumentsSinglePatchRequest):
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.documents.patch_document.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, body: ~polarion_rest_api_client.open_api_client.models.documents_single_patch_request.DocumentsSinglePatchRequest, workflow_action: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates the specified Document.

Args:: project_id (str): space_id (str): document_name (str): workflow_action (Union[Unset, str]): body (DocumentsSinglePatchRequest):
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.documents.post_documents module¶

async polarion_rest_api_client.open_api_client.api.documents.post_documents.asyncio(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, body: DocumentsListPostRequest) → DocumentsListPostResponse | Errors | None¶

Creates a list of Documents.

Args:: project_id (str): space_id (str): body (DocumentsListPostRequest):
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[DocumentsListPostResponse, Errors]

async polarion_rest_api_client.open_api_client.api.documents.post_documents.asyncio_detailed(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, body: DocumentsListPostRequest) → Response[DocumentsListPostResponse | Errors]¶

Creates a list of Documents.

Args:: project_id (str): space_id (str): body (DocumentsListPostRequest):
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[DocumentsListPostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.documents.post_documents.sync(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, body: DocumentsListPostRequest) → DocumentsListPostResponse | Errors | None¶

Creates a list of Documents.

Args:: project_id (str): space_id (str): body (DocumentsListPostRequest):
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[DocumentsListPostResponse, Errors]

polarion_rest_api_client.open_api_client.api.documents.post_documents.sync_detailed(project_id: str, space_id: str, *, client: AuthenticatedClient | Client, body: DocumentsListPostRequest) → Response[DocumentsListPostResponse | Errors]¶

Creates a list of Documents.

Args:: project_id (str): space_id (str): body (DocumentsListPostRequest):
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[DocumentsListPostResponse, Errors]]