Sign in

v1

latestOpenAPI 3.1.02026-07-2683111282.3 KB
Channel Component Operations

Create or update a channel component group

put/channels/{channel_id}/component_groups/{group_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

Headers

X-Resource-Versionstring

Resource's version. Must be used in any subsequent update requests of this resource. Can be obtained when GETting the resource

Request body

namestring required

identifying name of a catalog group for its channel; "base" is a reserved and predefined (system) group name

hiddenboolean

indicator if this catalog group (and its resources, e.g. components) will be available in the ChannelManager UI

systemboolean

indicator if this catalog group (and its resources, e.g. components) are protected; if true implies hidden is true

Response

OK

namestring required

identifying name of a catalog group for its channel; "base" is a reserved and predefined (system) group name

hiddenboolean

indicator if this catalog group (and its resources, e.g. components) will be available in the ChannelManager UI

systemboolean

indicator if this catalog group (and its resources, e.g. components) are protected; if true implies hidden is true