Data API — Activities
activity_by_id
sync(activity_id: UUID, client: AuthenticatedClient | Client) -> ActivityResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
activity_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ActivityResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
activity_delete
sync(activity_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
activity_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
activity_delete_file
sync(activity_id: UUID, reference_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
activity_id | UUID | required |
reference_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
activity_list
sync(client: AuthenticatedClient | Client, sort: list[ActivitySort] | Unset = UNSET, type_: list[ActivityTypeEnum] | Unset = UNSET, organization_id: UUID | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, last_modified_by_user_id: UUID | Unset = UNSET, name: str | Unset = UNSET, description: str | Unset = UNSET, thumbnail_ref: str | Unset = UNSET, image_ref: str | Unset = UNSET, version: int | Unset = UNSET, reference_id: int | Unset = UNSET, is_requestable: bool | Unset = UNSET, is_published: bool | Unset = UNSET, include_all_versions: bool | Unset = UNSET, version_group_id: UUID | Unset = UNSET, date_created: datetime.datetime | Unset = UNSET, date_last_modified: datetime.datetime | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ActivityListItemResponse] | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
sort | list[ActivitySort] | Unset | UNSET |
type_ | list[ActivityTypeEnum] | Unset | UNSET |
organization_id | UUID | Unset | UNSET |
created_by_user_id | UUID | Unset | UNSET |
last_modified_by_user_id | UUID | Unset | UNSET |
name | str | Unset | UNSET |
description | str | Unset | UNSET |
thumbnail_ref | str | Unset | UNSET |
image_ref | str | Unset | UNSET |
version | int | Unset | UNSET |
reference_id | int | Unset | UNSET |
is_requestable | bool | Unset | UNSET |
is_published | bool | Unset | UNSET |
include_all_versions | bool | Unset | UNSET |
version_group_id | UUID | Unset | UNSET |
date_created | datetime.datetime | Unset | UNSET |
date_last_modified | datetime.datetime | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ActivityListItemResponse] | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
activity_update_file
sync(activity_id: UUID, reference_id: UUID, client: AuthenticatedClient | Client, body: FileUpdateRequest | Unset = UNSET) -> FileReferenceResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
activity_id | UUID | required |
reference_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | FileUpdateRequest | Unset | UNSET |
- body — Update an existing file reference
Returns: FileReferenceResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
activity_upload_file
sync(activity_id: UUID, client: AuthenticatedClient | Client, body: ActivityUploadFileFilesBody | ActivityUploadFileJsonBody | Unset = UNSET) -> FileReferenceResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
activity_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | ActivityUploadFileFilesBody | ActivityUploadFileJsonBody | Unset | UNSET |
Returns: FileReferenceResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
step_description
sync(activity_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | StepDescriptionResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
activity_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | StepDescriptionResponse | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |