GET POST | /RestApi/Sitefinity/packaging/add-on |
---|
"use strict";
export class AddonMessage {
/** @param {{Id?:string,IncludeContent?:boolean,Deactivate?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {boolean} */
IncludeContent;
/** @type {boolean} */
Deactivate;
}
/** @typedef {'Content'|'Template'|'Custom'|'Module'|'Form'|'Classification'|'WebService'} */
export var AddOnEntryType;
(function (AddOnEntryType) {
AddOnEntryType["Content"] = "Content"
AddOnEntryType["Template"] = "Template"
AddOnEntryType["Custom"] = "Custom"
AddOnEntryType["Module"] = "Module"
AddOnEntryType["Form"] = "Form"
AddOnEntryType["Classification"] = "Classification"
AddOnEntryType["WebService"] = "WebService"
})(AddOnEntryType || (AddOnEntryType = {}));
export class AddOnEntry {
/** @param {{DisplayName?:string,Count?:number,AddonEntryType?:AddOnEntryType}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
DisplayName;
/** @type {number} */
Count;
/** @type {AddOnEntryType} */
AddonEntryType;
}
export class AddonInfo {
/** @param {{Id?:string,Name?:string,IsActive?:boolean,Description?:string,IsDataImported?:boolean,Version?:string,Author?:string,DataImportedToSiteName?:string,Entries?:AddOnEntry[],HasErrorsOnContentImport?:boolean,HasErrorsOnStructureImport?:boolean,HasErrorsOnActivate?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Name;
/** @type {boolean} */
IsActive;
/** @type {string} */
Description;
/** @type {boolean} */
IsDataImported;
/** @type {string} */
Version;
/** @type {string} */
Author;
/** @type {string} */
DataImportedToSiteName;
/** @type {AddOnEntry[]} */
Entries;
/** @type {boolean} */
HasErrorsOnContentImport;
/** @type {boolean} */
HasErrorsOnStructureImport;
/** @type {boolean} */
HasErrorsOnActivate;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /RestApi/Sitefinity/packaging/add-on HTTP/1.1
Host: www.asg.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IncludeContent: False,
Deactivate: False
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Name: String, IsActive: False, Description: String, IsDataImported: False, Version: String, Author: String, DataImportedToSiteName: String, HasErrorsOnContentImport: False, HasErrorsOnStructureImport: False, HasErrorsOnActivate: False }