REST API OCST - Get Channel Application Details

URI

/channels/<channelID>/applications/<applicationURLID>

Http Method

GET

Short Description

Get detail information on an application, including the REST API's URI

Query Parameters

Example Requests

/channels/PrimeTech-PrimeTechSpecials/applications/b2c-web-shop

HTTP Status Codes

200 OK

401 if the user is not authenticated

404 if no application exists for this applicationURLID

Description

This call can be used to find out the REST API's URI for a given channel application, e.g., to access the WebShop REST API for a channel.

Cartridge

app_sf_contactcenter_rest
Application

ContactCenter

Product Version

7.5.1

Product To Version

Status

final

JSON

Request data format

Request related java object

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

Request data example

Response data format

application/json

Response related java object

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

com.intershop.application.contactcenter.capi.rest.resourceobject.ApplicationRO

Response data example

{
    "name": "b2c-web-shop",
    "type": "Application",
    "displayName": "B2C Web Shop",
    "applicationType": "intershop.B2CWebShop",
    "restAPI":
    {
        "type": "Link",
        "title": "rest-api",
        "uri": "http://localhost/INTERSHOP/rest/WFS/PrimeTech-PrimeTechSpecials-Site/b2c-web-shop"
    }
}

XML

Request data format

Request related java object

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

Request data example

Response data format

text/xml

Response related java object

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

com.intershop.application.contactcenter.capi.rest.resourceobject.ApplicationRO

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Application name="b2c-web-shop" type="Application">
  <applicationType>intershop.B2CWebShop</applicationType>
  <displayName>B2C Web Shop</displayName>
  <restAPI type="Link">
    <title>rest-api</title>
    <uri>http://localhost/INTERSHOP/rest/WFS/PrimeTech-PrimeTechSpecials-Site/b2c-web-shop</uri>
  </restAPI>
</Application>

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