v1

latestOpenAPI 3.1.02026-07-2683111282.3 KB

Channel Component Operations

Get a component within a component group

get/channels/{channel_id}/component_groups/{group_name}/components/{component_name}

Path parameters

channel_idstring required

Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId

group_namestring required

Name of group

component_namestring required

Name of component

Query parameters

inheritedboolean

Whether to include inherited types

Response

idstring required

identifier of this component definition: {group}/{name}

extendsstring required

{group}/{name} id of the component definition this definition extends from

hiddenboolean

indicator if this component definition is configurable in the ChannelManager UI

systemboolean

indicator if this a protected (system) component definition; if true, implies hidden is true

xtypestring

frontend layout type

ctypestring

frontend component type

contentTypestring

contentType for cases where the component should also create content: when putting, the contentType must be an existing document compound type, otherwise the request is not executed. The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:titleandtext

labelstring

default display name of this component definition in the ChannelManager UI

iconstring

base64 representation of the icon for this component definition in the ChannelManager UI