Cdn API - CPG Source

<back to all web services

CdnxApplicationDefinitionPreviewRequest

Cdn.Api

The following routes are available for this service:
POST/admin/applications/definition/preview
CdnxApplicationDefinitionPreviewRequest Parameters:
NameParameterData TypeRequiredDescription
UseActiveDefinitionbodyboolNo
NamebodystringNo
HeaderMarkdownbodystringNo
FieldsJsonbodystringNo
CdnxApplicationPreviewStashResponse Parameters:
NameParameterData TypeRequiredDescription
TokenformstringNo
ExpiresAtformDateTimeNo
TtlSecondsformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /admin/applications/definition/preview HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CdnxApplicationDefinitionPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <FieldsJson>String</FieldsJson>
  <HeaderMarkdown>String</HeaderMarkdown>
  <Name>String</Name>
  <UseActiveDefinition>false</UseActiveDefinition>
</CdnxApplicationDefinitionPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CdnxApplicationPreviewStashResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <Token>String</Token>
  <TtlSeconds>0</TtlSeconds>
</CdnxApplicationPreviewStashResponse>