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: AuthenticatedClient | Client, body: BranchDocumentRequestBody, revision: str | Unset = <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 (str | Unset): 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:: 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: AuthenticatedClient | Client, body: BranchDocumentRequestBody, revision: str | Unset = <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 (str | Unset): 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[DocumentsSinglePostResponse | Errors]

polarion_rest_api_client.open_api_client.api.documents.branch_document.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: BranchDocumentRequestBody, revision: str | Unset = <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 (str | Unset): 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:: 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: AuthenticatedClient | Client, body: BranchDocumentRequestBody, revision: str | Unset = <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 (str | Unset): 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[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:: 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[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:: 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[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: AuthenticatedClient | Client, body: CopyDocumentRequestBody, revision: str | Unset = <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 (str | Unset): 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:: 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: AuthenticatedClient | Client, body: CopyDocumentRequestBody, revision: str | Unset = <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 (str | Unset): 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[DocumentsSinglePostResponse | Errors]

polarion_rest_api_client.open_api_client.api.documents.copy_document.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: CopyDocumentRequestBody, revision: str | Unset = <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 (str | Unset): 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:: 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: AuthenticatedClient | Client, body: CopyDocumentRequestBody, revision: str | Unset = <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 (str | Unset): 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[DocumentsSinglePostResponse | Errors]

polarion_rest_api_client.open_api_client.api.documents.get_all_documents module¶

async polarion_rest_api_client.open_api_client.api.documents.get_all_documents.asyncio(*, 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>) → DocumentsListGetResponse | Errors | None¶

Returns a list of Documents from all Projects.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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:: DocumentsListGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.documents.get_all_documents.asyncio_detailed(*, 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>) → Response[DocumentsListGetResponse | Errors]¶

Returns a list of Documents from all Projects.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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[DocumentsListGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.documents.get_all_documents.sync(*, 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>) → DocumentsListGetResponse | Errors | None¶

Returns a list of Documents from all Projects.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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:: DocumentsListGetResponse | Errors

polarion_rest_api_client.open_api_client.api.documents.get_all_documents.sync_detailed(*, 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>) → Response[DocumentsListGetResponse | Errors]¶

Returns a list of Documents from all Projects.

Args:: pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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[DocumentsListGetResponse | 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: 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>) → 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 (int | Unset): pagenumber (int | 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:: 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: 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>) → 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 (int | Unset): pagenumber (int | 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[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: 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>) → 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 (int | Unset): pagenumber (int | 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:: 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: 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>) → 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 (int | Unset): pagenumber (int | 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[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: 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>, type_: str | Unset = <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 (int | Unset): pagenumber (int | Unset): 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:: 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: 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>, type_: str | Unset = <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 (int | Unset): pagenumber (int | Unset): 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[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: 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>, type_: str | Unset = <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 (int | Unset): pagenumber (int | Unset): 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:: 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: 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>, type_: str | Unset = <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 (int | Unset): pagenumber (int | Unset): 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[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: 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | 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:: 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: 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | 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[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: 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | 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:: 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: 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | 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[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: 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>) → DocumentsSingleGetResponse | Errors | None¶

Returns the specified Document.

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

Returns the specified Document.

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

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

Returns the specified Document.

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

Returns the specified Document.

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

polarion_rest_api_client.open_api_client.api.documents.get_documents module¶

async polarion_rest_api_client.open_api_client.api.documents.get_documents.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>) → DocumentsListGetResponse | Errors | None¶

Returns a list of Documents from the Project context.

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):
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:: DocumentsListGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.documents.get_documents.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>) → Response[DocumentsListGetResponse | Errors]¶

Returns a list of Documents from the Project context.

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

polarion_rest_api_client.open_api_client.api.documents.get_documents.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>) → DocumentsListGetResponse | Errors | None¶

Returns a list of Documents from the Project context.

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):
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:: DocumentsListGetResponse | Errors

polarion_rest_api_client.open_api_client.api.documents.get_documents.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>) → Response[DocumentsListGetResponse | Errors]¶

Returns a list of Documents from the Project context.

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

polarion_rest_api_client.open_api_client.api.documents.get_fields_metadata_for_document module¶

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

Returns fields for the specified resource.

Args:: project_id (str): space_id (str): document_name (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.documents.get_fields_metadata_for_document.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client) → Response[Errors | FieldsMetadataActionResponseBody]¶

Returns fields for the specified resource.

Args:: project_id (str): space_id (str): document_name (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.documents.get_fields_metadata_for_document.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client) → Errors | FieldsMetadataActionResponseBody | None¶

Returns fields for the specified resource.

Args:: project_id (str): space_id (str): document_name (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.documents.get_fields_metadata_for_document.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client) → Response[Errors | FieldsMetadataActionResponseBody]¶

Returns fields for the specified resource.

Args:: project_id (str): space_id (str): document_name (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.documents.get_space_documents module¶

async polarion_rest_api_client.open_api_client.api.documents.get_space_documents.asyncio(project_id: str, space_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>) → DocumentsListGetResponse | Errors | None¶

Returns a list of Documents from a given Project Space.

Args:: project_id (str): space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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:: DocumentsListGetResponse | Errors

async polarion_rest_api_client.open_api_client.api.documents.get_space_documents.asyncio_detailed(project_id: str, space_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>) → Response[DocumentsListGetResponse | Errors]¶

Returns a list of Documents from a given Project Space.

Args:: project_id (str): space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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[DocumentsListGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.documents.get_space_documents.sync(project_id: str, space_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>) → DocumentsListGetResponse | Errors | None¶

Returns a list of Documents from a given Project Space.

Args:: project_id (str): space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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:: DocumentsListGetResponse | Errors

polarion_rest_api_client.open_api_client.api.documents.get_space_documents.sync_detailed(project_id: str, space_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>) → Response[DocumentsListGetResponse | Errors]¶

Returns a list of Documents from a given Project Space.

Args:: project_id (str): space_id (str): pagesize (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): query (str | Unset): sort (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[DocumentsListGetResponse | Errors]

polarion_rest_api_client.open_api_client.api.documents.import_word_document module¶

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

Imports a Word document to create a new Polarion Document.

Args:: project_id (str): space_id (str): body (ImportWordDocumentRequestBody): Request body for importing a Word document
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 | JobsSinglePostResponse

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

Imports a Word document to create a new Polarion Document.

Args:: project_id (str): space_id (str): body (ImportWordDocumentRequestBody): Request body for importing a Word document
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 | JobsSinglePostResponse]

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

Imports a Word document to create a new Polarion Document.

Args:: project_id (str): space_id (str): body (ImportWordDocumentRequestBody): Request body for importing a Word document
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 | JobsSinglePostResponse

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

Imports a Word document to create a new Polarion Document.

Args:: project_id (str): space_id (str): body (ImportWordDocumentRequestBody): Request body for importing a Word document
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 | JobsSinglePostResponse]

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 | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → 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 | 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 | 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 | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → 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 | 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 | 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 | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → 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 | 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 | 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 | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → 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 | 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 | 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 | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → 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 | 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 | 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 | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → 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 | 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 | 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 | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → 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 | 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 | 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 | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → 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 | 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 | 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: AuthenticatedClient | Client, body: DocumentsSinglePatchRequest, workflow_action: str | Unset = <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 (str | Unset): 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:: 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: AuthenticatedClient | Client, body: DocumentsSinglePatchRequest, workflow_action: str | Unset = <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 (str | Unset): 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[Any | Errors]

polarion_rest_api_client.open_api_client.api.documents.patch_document.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: DocumentsSinglePatchRequest, workflow_action: str | Unset = <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 (str | Unset): 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:: 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: AuthenticatedClient | Client, body: DocumentsSinglePatchRequest, workflow_action: str | Unset = <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 (str | Unset): 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[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:: 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[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:: 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[DocumentsListPostResponse | Errors]