Merge pull request #1050 from UiPath/feat/get-blob-file-access-uri

feat: add support to access attachment blob uri

Author: cristian-groza

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.2.43"
+version = "2.2.44"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

src/uipath/platform/attachments/__init__.py

@@ -3,9 +3,10 @@
 This module contains models related to UiPath Attachments service.
 """
 
-from .attachments import Attachment, AttachmentMode
+from .attachments import Attachment, AttachmentMode, BlobFileAccessInfo
 
 __all__ = [
     "Attachment",
     "AttachmentMode",
+    "BlobFileAccessInfo",
 ]

src/uipath/platform/attachments/attachments.py

@@ -1,6 +1,7 @@
 """Module defining the attachment model for attachments."""
 
 import uuid
+from dataclasses import dataclass
 from enum import Enum
 from typing import Optional
 
@@ -20,3 +21,18 @@ class Attachment(BaseModel):
     id: Optional[uuid.UUID] = Field(None, alias="ID")
     full_name: str = Field(..., alias="FullName")
     mime_type: str = Field(..., alias="MimeType")
+
+
+@dataclass
+class BlobFileAccessInfo:
+    """Information about blob file access for an attachment.
+
+    Attributes:
+        id: The unique identifier (UUID) of the attachment.
+        uri: The blob storage URI for accessing the file.
+        name: The name of the attachment file.
+    """
+
+    id: uuid.UUID
+    uri: str
+    name: str

src/uipath/platform/orchestrator/_attachments_service.py

@@ -15,7 +15,7 @@
 from ..._utils._ssl_context import get_httpx_client_kwargs
 from ..._utils.constants import TEMP_ATTACHMENTS_FOLDER
 from ...tracing import traced
-from ..attachments import Attachment, AttachmentMode
+from ..attachments import Attachment, AttachmentMode, BlobFileAccessInfo
 from ..common import BaseService, FolderContext, UiPathApiConfig, UiPathExecutionContext
 
 
@@ -709,6 +709,124 @@ async def main():
 
         return attachment_key
 
+    @traced(name="attachments_get_blob_uri", run_type="uipath")
+    def get_blob_file_access_uri(
+        self,
+        *,
+        key: uuid.UUID,
+        folder_key: str | None = None,
+        folder_path: str | None = None,
+    ) -> BlobFileAccessInfo:
+        """Get the BlobFileAccess information for an attachment.
+
+        This method retrieves the blob storage URI and filename for downloading
+        an attachment without actually downloading the file.
+
+        Args:
+            key (uuid.UUID): The key of the attachment.
+            folder_key (str | None): The key of the folder. Override the default one set in the SDK config.
+            folder_path (str | None): The path of the folder. Override the default one set in the SDK config.
+
+        Returns:
+            BlobFileAccessInfo: Object containing the blob storage URI and attachment name.
+
+        Raises:
+            Exception: If the attachment is not found or the request fails.
+
+        Examples:
+            ```python
+            from uipath.platform import UiPath
+
+            client = UiPath()
+
+            info = client.attachments.get_blob_file_access_uri(
+                key=uuid.UUID("123e4567-e89b-12d3-a456-426614174000")
+            )
+            print(f"Attachment ID: {info.id}")
+            print(f"Blob URI: {info.uri}")
+            print(f"File name: {info.name}")
+            ```
+        """
+        spec = self._retrieve_download_uri_spec(
+            key=key,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        )
+
+        result = self.request(
+            spec.method,
+            url=spec.endpoint,
+            params=spec.params,
+            headers=spec.headers,
+        ).json()
+
+        return BlobFileAccessInfo(
+            id=key,
+            uri=result["BlobFileAccess"]["Uri"],
+            name=result["Name"],
+        )
+
+    @traced(name="attachments_get_blob_uri", run_type="uipath")
+    async def get_blob_file_access_uri_async(
+        self,
+        *,
+        key: uuid.UUID,
+        folder_key: str | None = None,
+        folder_path: str | None = None,
+    ) -> BlobFileAccessInfo:
+        """Get the BlobFileAccess information for an attachment asynchronously.
+
+        This method asynchronously retrieves the blob storage URI and filename
+        for downloading an attachment without actually downloading the file.
+
+        Args:
+            key (uuid.UUID): The key of the attachment.
+            folder_key (str | None): The key of the folder. Override the default one set in the SDK config.
+            folder_path (str | None): The path of the folder. Override the default one set in the SDK config.
+
+        Returns:
+            BlobFileAccessInfo: Object containing the blob storage URI and attachment name.
+
+        Raises:
+            Exception: If the attachment is not found or the request fails.
+
+        Examples:
+            ```python
+            import asyncio
+            from uipath.platform import UiPath
+
+            client = UiPath()
+
+            async def main():
+                info = await client.attachments.get_blob_file_access_uri_async(
+                    key=uuid.UUID("123e4567-e89b-12d3-a456-426614174000")
+                )
+                print(f"Attachment ID: {info.id}")
+                print(f"Blob URI: {info.uri}")
+                print(f"File name: {info.name}")
+            ```
+        """
+        spec = self._retrieve_download_uri_spec(
+            key=key,
+            folder_key=folder_key,
+            folder_path=folder_path,
+        )
+
+        result = (
+            await self.request_async(
+                spec.method,
+                url=spec.endpoint,
+                params=spec.params,
+                headers=spec.headers,
+            )
+        ).json()
+
+        return BlobFileAccessInfo(
+            id=key,
+            uri=result["BlobFileAccess"]["Uri"],
+            name=result["Name"],
+        )
+
     @traced(name="attachments_delete", run_type="uipath")
     def delete(
         self,