Channel Operations

Get meta-data for a channel parameter

get/channels/{channel_id}/parameters/{parameter_name}

Request

Base URL
https://developers.bloomreach.io/delivery/site/v2/documents
Auth
none declared
TypeScript
https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0/docs/channels/:channel_id/parameters/:parameter_name/get.ts
A function with typed inputs. Its response is checked against the schema.

channel_idstring required

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

parameter_namestring required

Name of the parameter

namestring required

valueType'string' | 'calendar' | 'boolean' | 'integer' | 'number' required

requiredboolean

hiddenboolean

overlayboolean

defaultValueobject

displayNamestring

systemboolean

System readonly parameter

No recorded changes to this operation across all 1 revision of this API.