get_content_definition

Read a single content definition (entity) including its field list, for live mapping discovery.

Read one content definition (entity) by id, including its contentFields[] list. This is the
discovery call an importer makes first: it returns the entity's field names
(propertyName) and type labels (fieldId.description), so a mapping from spreadsheet
columns to entity fields can be built and printed for review before any write.

content_definition_id is the entity id from the entity map (reference/schema.md); the
generic event entity is 412a30e3-73ee-4eae-b739-e1fc87601c7d.

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

📘

Confinement

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

Signatures

def get_content_definition(sdk, content_definition_id):
    """Read a content definition (entity) incl. its contentFields list; None on failure."""
    return sdk.get_content_definition(content_definition_id)

export async function getContentDefinition(sdk, contentDefinitionId) {
    // Read a content definition (entity) incl. its contentFields list; null on failure.
    return await sdk.getContentDefinition(contentDefinitionId);
}

Parameters

Returns

dict | None - the content definition; None on failure. Top keys: contentDefinitionId, properties, contentFields[] (each {contentFieldId, properties{title, propertyName, fieldId{description,id}, isRequired,...}}). The field-by-field mapping source for an import.

Errors

• 401 unauthenticated
• 404 content definition not found

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