get_content_definitions

List content definitions (entities) - useful to discover the right entity id by title.

get_content_definitions

List content definitions (entities) - useful to discover the right entity id by title.

List content definitions (entities), optionally sorted/paged. Use it to discover an entity id by its title when you don't already have it; once you have the id, read the full field list with get_content_definition.

Prefer the curated Entities table in reference/schema.md when you already know the entity - it is the canonical, offline source of entity ids.

Safety class: A · API type: admin · Min version: -

📘

Confinement

Class A: read-only metadata listing of global content definitions (no writes). Safe anywhere, including prod.

Signatures

def get_content_definitions(sdk, content_management_type=None, sort_column=None,
        is_desc=None, page_index=None, page_size=None):
    """List content definitions (entities); None on failure. All args optional."""
    return sdk.get_content_definitions(content_management_type, sort_column, is_desc,
        page_index, page_size)
export async function getContentDefinitions(sdk, contentManagementType = null,
        sortColumn = null, isDesc = null, pageIndex = null, pageSize = null) {
    // List content definitions (entities); null on failure. All args optional.
    return await sdk.getContentDefinitions(contentManagementType, sortColumn, isDesc,
        pageIndex, pageSize);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
content_management_typecontentManagementTypeint | Nonenooptional management-type filter; null for all
sort_columnsortColumnstr | Nonenoe.g. "name"
is_descisDescbool | Nonenoe.g. False
page_indexpageIndexint | Noneno0-based
page_sizepageSizeint | Nonenoe.g. 200

Returns

dict | None - a paged envelope of content definitions; None on failure. Match an entity by title, then read its id with get_content_definition. Prefer reference/schema.md (the Entities table) when you already know the entity.

Errors

  • 401 unauthenticated

See also: Python ↔ JS naming map · Return shapes.