Information Classification: External Restricted.
See https://www.chili-publish.com/security

POST - resources/{resourceName}/items/preview

Adds a ResourceItem to a Resource, and returns its definition XML.
To prevent previews from being generated automatically while you intend to supply an override file, this function allows you to pass both at the same time.

URI

resources/{resourceName}/items/preview

HTTP Method

Post

Request parameters

Name

Location

Type

Description

API-KEY

http header

apiKey

The API key previously generated by calling the GenerateApiKey function

resourceName

uri

resourceName

The resource name

newName

query

itemName

The name of the new resource item

folderPath

query

folderPath

The relative path of the resource item in the resource's tree (for resources of type directory_object or directory_file)

xml

body

xmlString

The underlying XML of the resource (for resources of type list or directory_object)

fileData

body

fileOrData

The path to the file, or its base64 encoded data, for the resource item (for resources of type directory_object or directory_file)

previewFileData

body

fileOrData

The path to the preview file, or its base64 encoded data, for the resource item (for resources of type directory_object or directory_file)

previewExtension

query

string

The extension of the preview file. If previewFileData contains a path, the extension is optional

isPermanentPreview

query

bool

If true, the preview override remains valid even after the resource item is modified

HTTP Return Status

Created

Returns

resourceItemXML

Definition XML of the ResourceItem

Security rights needed

  • Add

Apply on resource

Resource from function parameter resourceName

All information on this page must be treated as External Restricted, or more strict. https://www.chili-publish.com/security