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

Webservice Functions - ResourceItemAddWithPreview

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.

Declaration

public string ResourceItemAddWithPreview ( string apiKey, string resourceName, string newName, string folderPath, string xml, string fileData, string previewFileData, string previewExtension, bool isPermanentPreview );

Arguments

Name

Type

Description

apiKey

apiKey

The API key previously generated by calling the GenerateApiKey function

resourceName

resourceName

The resource name

newName

itemName

The name of the new resource item

folderPath

folderPath

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

xml

xmlString

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

fileData

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

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

string

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

isPermanentPreview

bool

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

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