publish_content

publish_content

Read-only (GET) routes under /api/publish/v2/publications/contents/{publicationId}/.

Sibling of :mod:crew_dcs.routes.publish. Each function issues one GET and raises :class:GET_PublishContent_Error on a non-2xx response unless return_raw=True. The endpoint list comes from the Domo Product APIs Postman collection ("Domo Everywhere/Publication Content"); response bodies are returned untouched and have not been verified against a live instance.

GET_PublishContent_Error

GET_PublishContent_Error(
    res: ResponseGetData, message: str | None = None
)

Bases: RouteError

Raised when a publication-content GET returns a non-2xx response.

Build the error from the failed response.

Parameters:

Name	Type	Description	Default
res	ResponseGetData	The failed response.	required
message	str | None	Optional message overriding the default.	None

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

def __init__(self, res: rgd.ResponseGetData, message: str | None = None) -> None:
    """Build the error from the failed response.

    Args:
        res: The failed response.
        message: Optional message overriding the default.
    """
    super().__init__(
        res=res,
        message=message or f"publication content GET failed (HTTP {res.status})",
    )

get_publication_app_collections async

get_publication_app_collections(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Domo App Collections (GET .../contents/{publicationId}/card/app/collections).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_app_collections(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Domo App Collections (``GET .../contents/{publicationId}/card/app/collections``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="card/app/collections",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_app_templates async

get_publication_app_templates(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Domo App Template (GET .../contents/{publicationId}/card/app/templates).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_app_templates(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Domo App Template (``GET .../contents/{publicationId}/card/app/templates``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="card/app/templates",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_beastmode_templates async

get_publication_beastmode_templates(
    auth: DomoAuth,
    publication_id: str,
    data_source_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Beast Mode Template (GET .../contents/{publicationId}/datasources/{dataSourceId}/beastmodes/templates).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
data_source_id	str	ID of the data source.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_beastmode_templates(
    auth: DomoAuth,
    publication_id: str,
    data_source_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Beast Mode Template (``GET .../contents/{publicationId}/datasources/{dataSourceId}/beastmodes/templates``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        data_source_id: ID of the data source.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix=f"datasources/{data_source_id}/beastmodes/templates",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_card_calc_dspub_map async

get_publication_card_calc_dspub_map(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Card Calc Ds Pub Map (GET .../contents/{publicationId}/card/calc-dspub-map).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_card_calc_dspub_map(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Card Calc Ds Pub Map (``GET .../contents/{publicationId}/card/calc-dspub-map``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="card/calc-dspub-map",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_card_union async

get_publication_card_union(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Card Union V2 (GET .../contents/{publicationId}/card).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_card_union(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Card Union V2 (``GET .../contents/{publicationId}/card``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="card",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_card_union_v2 async

get_publication_card_union_v2(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Card Union V2 (v2 path) (GET .../contents/{publicationId}/card/v2).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_card_union_v2(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Card Union V2 (v2 path) (``GET .../contents/{publicationId}/card/v2``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="card/v2",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_chart_color_palettes async

get_publication_chart_color_palettes(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Chart Color Palette (GET .../contents/{publicationId}/chart-color-palettes).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_chart_color_palettes(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Chart Color Palette (``GET .../contents/{publicationId}/chart-color-palettes``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="chart-color-palettes",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_custom_map async

get_publication_custom_map(
    auth: DomoAuth,
    publication_id: str,
    custom_map_name: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Custom Map (GET .../contents/{publicationId}/custom-maps/{customMapName}).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
custom_map_name	str	Name of the custom map.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_custom_map(
    auth: DomoAuth,
    publication_id: str,
    custom_map_name: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Custom Map (``GET .../contents/{publicationId}/custom-maps/{customMapName}``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        custom_map_name: Name of the custom map.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix=f"custom-maps/{custom_map_name}",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_custom_roles async

get_publication_custom_roles(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Custom Role (GET .../contents/{publicationId}/custom-roles).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_custom_roles(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Custom Role (``GET .../contents/{publicationId}/custom-roles``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="custom-roles",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_datasource async

get_publication_datasource(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Publication Data Source Info (GET .../contents/{publicationId}/datasource).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_datasource(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Publication Data Source Info (``GET .../contents/{publicationId}/datasource``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="datasource",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_doc_preview_file async

get_publication_doc_preview_file(
    auth: DomoAuth,
    publication_id: str,
    data_file_id: str,
    revision_id: str,
    image_type: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Doc Card Preview File (GET .../contents/{publicationId}/card/doc-previews/{dataFileId}/{revisionId}/{imageType}).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
data_file_id	str	Data file ID of the document.	required
revision_id	str	Revision ID of the document.	required
image_type	str	Preview image type.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_doc_preview_file(
    auth: DomoAuth,
    publication_id: str,
    data_file_id: str,
    revision_id: str,
    image_type: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Doc Card Preview File (``GET .../contents/{publicationId}/card/doc-previews/{dataFileId}/{revisionId}/{imageType}``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        data_file_id: Data file ID of the document.
        revision_id: Revision ID of the document.
        image_type: Preview image type.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix=f"card/doc-previews/{data_file_id}/{revision_id}/{image_type}",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_doc_preview_metadata async

get_publication_doc_preview_metadata(
    auth: DomoAuth,
    publication_id: str,
    data_file_id: str,
    revision_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Doc Card Preview Metadata (GET .../contents/{publicationId}/card/doc-previews/{dataFileId}/{revisionId}/metadata).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
data_file_id	str	Data file ID of the document.	required
revision_id	str	Revision ID of the document.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_doc_preview_metadata(
    auth: DomoAuth,
    publication_id: str,
    data_file_id: str,
    revision_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Doc Card Preview Metadata (``GET .../contents/{publicationId}/card/doc-previews/{dataFileId}/{revisionId}/metadata``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        data_file_id: Data file ID of the document.
        revision_id: Revision ID of the document.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix=f"card/doc-previews/{data_file_id}/{revision_id}/metadata",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_orchestration_entity async

get_publication_orchestration_entity(
    auth: DomoAuth,
    publication_id: str,
    entity_type: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Orchestration Entity (GET .../contents/{publicationId}/content-orchestration/entity/{entityType}).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
entity_type	str	Orchestration entity type.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_orchestration_entity(
    auth: DomoAuth,
    publication_id: str,
    entity_type: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Orchestration Entity (``GET .../contents/{publicationId}/content-orchestration/entity/{entityType}``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        entity_type: Orchestration entity type.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix=f"content-orchestration/entity/{entity_type}",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )

get_publication_shared_beastmode_map async

get_publication_shared_beastmode_map(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get Data Source Shared Beast Mode Map (GET .../contents/{publicationId}/datasource/shared-beastmode-map).

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	Return the response even when it is not a success.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context settings (for example debug_api).	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_PublishContent_Error	If the response is not a success and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_shared_beastmode_map(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get Data Source Shared Beast Mode Map (``GET .../contents/{publicationId}/datasource/shared-beastmode-map``).

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: Return the response even when it is not a success.
        context: Optional route context.
        **context_kwargs: Extra context settings (for example ``debug_api``).

    Returns:
        The response from Domo.

    Raises:
        GET_PublishContent_Error: If the response is not a success and
            ``return_raw`` is False.
    """
    return await _get_content(
        auth=auth,
        publication_id=publication_id,
        suffix="datasource/shared-beastmode-map",
        timeout=timeout,
        return_raw=return_raw,
        context=context,
    )