Attachments Module API

API reference for attachment upload and management helpers.

BriteCore v2 Attachments API endpoint wrappers.

This module provides wrappers for attachment folder management, file metadata, listing, uploads, moves, renames, and removals in the BriteCore v2 attachments API.

britecore_sdk.api.api_calls.v2.attachments.create_folder_in_user_folder(folder_name=None, parent_folder_id=None, reference_id=None, reference_type=None, **kwargs)[source]

Create a folder inside a user folder.

POST /api/v2/attachments/create_folder_in_user_folder

Parameters:

  • folder_name (str | None)

  • parent_folder_id (str | None)

  • reference_id (str | None)

  • reference_type (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.delete_photo(file_id=None, **kwargs)[source]

Delete an attachment photo by file identifier.

POST /api/v2/attachments/delete_photo

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.get_attachments_file_list(ascending=None, folder_id=None, include_forms=None, order_by=None, page=None, reference_id=None, reference_type=None, **kwargs)[source]

Retrieve a paginated attachment file list for a reference.

POST /api/v2/attachments/get_attachments_file_list

Parameters:

  • ascending (bool | None)

  • folder_id (str | None)

  • include_forms (bool | None)

  • order_by (str | None)

  • page (int | None)

  • reference_id (str | None)

  • reference_type (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.get_file_metadata(file_id=None, **kwargs)[source]

Retrieve metadata for a specific file.

POST /api/v2/attachments/get_file_metadata

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.get_resource_photos(reference_id=None, **kwargs)[source]

Retrieve photos associated with a resource.

POST /api/v2/attachments/get_resource_photos

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.move_user_file(file_id=None, to_folder_id=None, **kwargs)[source]

Move a file to a different folder.

POST /api/v2/attachments/move_user_file

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.remove_attachments(attachment_ids=None, **kwargs)[source]

Remove attachments by identifier list.

POST /api/v2/attachments/remove_attachments

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.rename_user_file(file_id=None, file_name=None, **kwargs)[source]

Rename an existing user file.

POST /api/v2/attachments/rename_user_file

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.retrieve_attachments(ascending=None, folder_id=None, list_view=None, order_by=None, page=None, page_size=None, reference_id=None, reference_type=None, search_string=None, **kwargs)[source]

Retrieve attachments for a reference with filtering and pagination.

POST /api/v2/attachments/retrieve_attachments

Parameters:

  • ascending (bool | None)

  • folder_id (str | None)

  • list_view (bool | None)

  • order_by (str | None)

  • page (int | None)

  • page_size (int | None)

  • reference_id (str | None)

  • reference_type (str | None)

  • search_string (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.upload_attachment_to_user_folder(file_data_base64=None, file_name=None, file_type=None, folder_id=None, reference_id=None, reference_type=None, **kwargs)[source]

Upload a file to a user folder.

POST /api/v2/attachments/upload_attachment_to_user_folder

Parameters:

  • file_data_base64 (str | None)

  • file_name (str | None)

  • file_type (str | None)

  • folder_id (str | None)

  • reference_id (str | None)

  • reference_type (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.upload_attachment_unified(file_data_base64=None, file_name=None, file_type=None, folder_id=None, reference_id=None, reference_type=None, revision_id=None, **kwargs)[source]

Upload a file with the unified attachment endpoint.

POST /api/v2/attachments/upload_attachment_unified

Parameters:

  • file_data_base64 (str | None)

  • file_name (str | None)

  • file_type (str | None)

  • folder_id (str | None)

  • reference_id (str | None)

  • reference_type (str | None)

  • revision_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.attachments.edit_attachment(attachment=None, **kwargs)[source]

Edit Attachment.

POST /api/v2/attachments/edit_attachment

Parameters:
Return type:

Any