application

application

Application_CRUD_Error

Application_CRUD_Error(
    operation: str,
    entity_id: str | None = None,
    res: ResponseGetData | None = None,
    message: str | None = None,
    **kwargs
)

Bases: RouteError

Raised when application create, update, or delete operations fail.

This exception is used for failures during application job creation, modification, or execution operations.

Source code in src/crew_dcs/routes/application.py

def __init__(
    self,
    operation: str,
    entity_id: str | None = None,
    res: rgd.ResponseGetData | None = None,
    message: str | None = None,
    **kwargs,
):
    if not message:
        if entity_id:
            message = f"Application {operation} failed for application {entity_id}"
        else:
            message = f"Application {operation} operation failed"

    super().__init__(
        message=message,
        entity_id=entity_id,
        res=res,
        **kwargs,
    )

Application_GET_Error

Application_GET_Error(
    entity_id: str | None = None,
    res: ResponseGetData | None = None,
    message: str | None = None,
    **kwargs
)

Bases: RouteError

Raised when application retrieval operations fail.

This exception is used for failures during GET operations on applications, including API errors and unexpected response formats.

Source code in src/crew_dcs/routes/application.py

def __init__(
    self,
    entity_id: str | None = None,
    res: rgd.ResponseGetData | None = None,
    message: str | None = None,
    **kwargs,
):
    if not message:
        if entity_id:
            message = f"Failed to retrieve application {entity_id}"
        else:
            message = "Failed to retrieve applications"

    super().__init__(message=message, entity_id=entity_id, res=res, **kwargs)

SearchApplication_NotFound_Error

SearchApplication_NotFound_Error(
    search_criteria: str,
    res: ResponseGetData | None = None,
    **kwargs
)

Bases: RouteError

Raised when application search operations return no results.

This exception is used when searching for specific applications that don't exist or when search criteria match no applications.

Source code in src/crew_dcs/routes/application.py

def __init__(
    self,
    search_criteria: str,
    res: rgd.ResponseGetData | None = None,
    **kwargs,
):
    message = f"No applications found matching: {search_criteria}"
    super().__init__(
        message=message,
        res=res,
        **kwargs,
    )

get_application_by_id async

get_application_by_id(
    auth: DomoAuth,
    application_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve a specific application by its ID.

Fetches details for a single application identified by its unique ID.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing instance and credentials	required
application_id	str	Unique identifier for the application to retrieve	required
return_raw	bool	Return raw API response without processing	False
context	RouteContext | None	Optional RouteContext for request configuration	None
**context_kwargs		Additional context parameters (session, debug_api, etc.)	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the specific application data

Raises:

Type	Description
Application_GET_Error	If application retrieval fails

SearchApplication_NotFound_Error: If no application with the specified ID exists

Example

app_response = await get_application_by_id(auth, "app-123") app_data = app_response.response print(f"Application Name: {app_data['name']}")

Source code in src/crew_dcs/routes/application.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_application_by_id(
    auth: DomoAuth,
    application_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve a specific application by its ID.

    Fetches details for a single application identified by its unique ID.

    Args:
        auth: Authentication object containing instance and credentials
        application_id: Unique identifier for the application to retrieve
        return_raw: Return raw API response without processing
        context: Optional RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing the specific application data

    Raises:
        Application_GET_Error: If application retrieval fails
    SearchApplication_NotFound_Error: If no application with the specified ID exists

    Example:
        >>> app_response = await get_application_by_id(auth, "app-123")
        >>> app_data = app_response.response
        >>> print(f"Application Name: {app_data['name']}")
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/executor/v1/applications/{application_id}"

    if context and context.debug_api:
        print(url)

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        if res.status == 404:
            raise SearchApplication_NotFound_Error(
                search_criteria=f"ID: {application_id}",
                res=res,
            )

        raise Application_GET_Error(
            entity_id=application_id,
            res=res,
        )

    return res

get_applications async

get_applications(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve all applications for the authenticated instance.

Fetches a list of all applications in the current Domo instance. Applications are containers for scheduled jobs that perform automated tasks.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing instance and credentials	required
return_raw	bool	Return raw API response without processing	False
context	RouteContext | None	Optional RouteContext for request configuration	None
**context_kwargs		Additional context parameters (session, debug_api, etc.)	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing list of applications

Raises:

Type	Description
Application_GET_Error	If application retrieval fails or API returns an error

Example

apps_response = await get_applications(auth) for app in apps_response.response: ... print(f"Application: {app['name']}")

Source code in src/crew_dcs/routes/application.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_applications(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve all applications for the authenticated instance.

    Fetches a list of all applications in the current Domo instance.
    Applications are containers for scheduled jobs that perform automated tasks.

    Args:
        auth: Authentication object containing instance and credentials
        return_raw: Return raw API response without processing
        context: Optional RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing list of applications

    Raises:
        Application_GET_Error: If application retrieval fails or API returns an error

    Example:
        >>> apps_response = await get_applications(auth)
        >>> for app in apps_response.response:
        ...     print(f"Application: {app['name']}")
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/executor/v1/applications/"

    if context and context.debug_api:
        print(url)

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise Application_GET_Error(res=res)

    return res