REST API OCST - Get Channel Details

Personal Library

https://support.intershop.com/kb/25B760

URI	/channels/<channelID>
Http Method	GET
Short Description	Returns a channel's detail information
Query Parameters
Example Requests	/channels/PrimeTech-PrimeTechSpecials Headers: Authorization=... or authentication-token=... UserOrganization =PrimeTech
HTTP Status Codes	200 404 if the channel cannot be found
Description	Returns the details for a channel. The current organization is supplied by the client using the header UserOrganization needed for the authentication.
Cartridge	app_sf_contactcenter_rest
Application	ContactCenter

Product Version	7.5.1
Product To Version
Status	New Labels

JSON

Request Data Format	n.a.
Request related java object	`com.intershop.application.contactcenter.capi.rest.resource.ChannelResource`
Request Example
Response Data Format	application/json
Response related java object	`com.intershop.application.contactcenter.capi.rest.resource.ChannelResource` `com.intershop.application.contactcenter.capi.rest.resourceobject.ChannelRO`
Response Example	{ "name": "PrimeTech Specials", "type": "Channel", "id": "PrimeTech-PrimeTechSpecials", "links": { "elements": [ { "type": "Link", "relation": "related", "title": "promotions", "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions" } ], "type": "ResourceCollection" } }

XML

XML Request Data Format	n.a.
XML Request Java Objects	`com.intershop.application.contactcenter.capi.rest.resource.ChannelResource`
XML Request Example
XML Response Data Format	text/xml
XML Response Java Objects	`com.intershop.application.contactcenter.capi.rest.resource.ChannelResource` `com.intershop.application.contactcenter.capi.rest.resourceobject.ChannelRO`
XML Response Example	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Channel name="PrimeTech Specials" type="Channel"> <id>PrimeTech-PrimeTechSpecials</id> <links type="ResourceCollection"> <elements> <Link type="Link"> <relation>related</relation> <title>promotions</title> <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/promotions</uri> </Link> </elements> </links> </Channel>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.