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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UseActiveDefinition: False,
	Name: String,
	HeaderMarkdown: String,
	FieldsJson: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Token: String,
	ExpiresAt: 0001-01-01,
	TtlSeconds: 0,
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}