REST API OCST - Get Channel Applications

URI

/channels/<channelID>/applications

Http Method

GET

Short Description

Returns a channel's applications

Query Parameters

type=<applicationTypeID> (optional)

Example Requests

/channels/<channelID>/applications?type=intershop.B2CWebShop

HTTP Status Codes

200 OK

401 if the user is not authenticated

404 if the channel is not found

Description

List all applications for this channel.

Cartridge

app_sf_contactcenter_rest
Application

ContactCenter

Product Version

7.5.1

Product To Version

Status

final

JSON

Request data format

n/a

Request related java object

com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource

Request data example

n/a

Response data format

application/json

Response related java object

com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource

Response data example

{
    "elements":
    [
        {
            "type": "Link",
            "description": "The storefront application for individual customers.",
            "title": "B2C Web Shop",
            "uri": "ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/applications/b2c-web-shop",
            "attributes":
            [
                {
                    "name": "applicationType",
                    "type": "String",
                    "value": "intershop.B2CWebShop"
                }
            ]
        }
    ],
    "type": "ResourceCollection",
    "name": "applications"
}

XML

Request data format

n/a

Request related java object

com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="applications" type="ResourceCollection">
  <elements>
    <Link type="Link">
      <attributes>
        <ResourceAttribute name="applicationType" type="String">
          <value>intershop.B2CWebShop</value>
        </ResourceAttribute>
      </attributes>
      <description>The storefront application for individual customers.</description>
      <title>B2C Web Shop</title>
      <uri>ContactCenter/-/channels/PrimeTech-PrimeTechSpecials/applications/b2c-web-shop</uri>
    </Link>
  </elements>
</ResourceCollection>

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets