POST | /RestApi/sitefinity/inlineediting/containersInfo |
---|
"use strict";
export class LifecycleStatusModel {
/** @param {{DisplayStatus?:string,IsAdmin?:boolean,IsEditable?:boolean,IsStatusEditable?:boolean,IsLocked?:boolean,IsPublished?:boolean,IsLockedByMe?:boolean,LockedByUsername?:string,WorkflowStatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
DisplayStatus;
/** @type {boolean} */
IsAdmin;
/** @type {boolean} */
IsEditable;
/** @type {boolean} */
IsStatusEditable;
/** @type {boolean} */
IsLocked;
/** @type {boolean} */
IsPublished;
/** @type {boolean} */
IsLockedByMe;
/** @type {string} */
LockedByUsername;
/** @type {string} */
WorkflowStatus;
}
export class FieldModel {
/** @param {{Name?:string,Required?:string,MinDate?:string,MaxDate?:string,MinLength?:number,MaxLength?:number,Pattern?:string,MinValue?:Object,MaxValue?:Object,RequiredViolationMessage?:string,MinLengthViolationMessage?:string,MaxLengthViolationMessage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Required;
/** @type {string} */
MinDate;
/** @type {string} */
MaxDate;
/** @type {number} */
MinLength;
/** @type {number} */
MaxLength;
/** @type {string} */
Pattern;
/** @type {Object} */
MinValue;
/** @type {Object} */
MaxValue;
/** @type {string} */
RequiredViolationMessage;
/** @type {string} */
MinLengthViolationMessage;
/** @type {string} */
MaxLengthViolationMessage;
}
export class ContainerInfoModel {
/** @param {{ItemId?:string,ItemType?:string,DisplayType?:string,Provider?:string,ItemStatus?:LifecycleStatusModel,IsPageControl?:boolean,DetailsViewUrl?:string,Fields?:FieldModel[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ItemId;
/** @type {string} */
ItemType;
/** @type {string} */
DisplayType;
/** @type {string} */
Provider;
/** @type {LifecycleStatusModel} */
ItemStatus;
/** @type {boolean} */
IsPageControl;
/** @type {string} */
DetailsViewUrl;
/** @type {FieldModel[]} */
Fields;
}
export class ContainerInfoMessage {
/** @param {{PageId?:string,PageTitle?:string,ContainersInfo?:ContainerInfoModel[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PageId;
/** @type {string} */
PageTitle;
/** @type {ContainerInfoModel[]} */
ContainersInfo;
}
JavaScript ContainerInfoMessage DTOs
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/inlineediting/containersInfo HTTP/1.1
Host: www.asg.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
PageId: String,
PageTitle: String,
ContainersInfo:
[
{
ItemId: String,
ItemType: String,
DisplayType: String,
Provider: String,
ItemStatus:
{
DisplayStatus: String,
IsAdmin: False,
IsEditable: False,
IsStatusEditable: False,
IsLocked: False,
IsPublished: False,
IsLockedByMe: False,
LockedByUsername: String,
WorkflowStatus: String
},
IsPageControl: False,
DetailsViewUrl: String,
Fields:
[
{
Name: String,
Required: String,
MinDate: String,
MaxDate: String,
MinLength: 0,
MaxLength: 0,
Pattern: String,
MinValue: {},
MaxValue: {},
RequiredViolationMessage: String,
MinLengthViolationMessage: String,
MaxLengthViolationMessage: String
}
]
}
]
}