<back to all web services

SpecificListsGetRequest

The following routes are available for this service:
PUT/RestApi/lists-api/items
"use strict";
export class SpecificListsGetRequest {
    /** @param {{Ids?:string[],Provider?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    Ids;
    /** @type {string} */
    Provider;
}
export class Status {
    /** @param {{Text?:string,PrimaryProvider?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Text;
    /** @type {string} */
    PrimaryProvider;
}
export class WcfContentLifecycleStatus {
    /** @param {{IsPublished?:boolean,Message?:string,LockedByUsername?:string,IsAdmin?:boolean,IsLocked?:boolean,IsLockedByMe?:boolean,SupportsContentLifecycle?:boolean,ErrorMessage?:string,LockedSince?:string,LastModified?:string,LastModifiedBy?:string,PublicationDate?:string,WorkflowStatus?:string,HasLiveVersion?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    IsPublished;
    /** @type {string} */
    Message;
    /** @type {string} */
    LockedByUsername;
    /** @type {boolean} */
    IsAdmin;
    /** @type {boolean} */
    IsLocked;
    /** @type {boolean} */
    IsLockedByMe;
    /** @type {boolean} */
    SupportsContentLifecycle;
    /** @type {string} */
    ErrorMessage;
    /** @type {?string} */
    LockedSince;
    /** @type {?string} */
    LastModified;
    /** @type {string} */
    LastModifiedBy;
    /** @type {?string} */
    PublicationDate;
    /** @type {string} */
    WorkflowStatus;
    /** @type {boolean} */
    HasLiveVersion;
}
/** @typedef {'Button'|'Link'|'Label'} */
export var WorkflowVisualType;
(function (WorkflowVisualType) {
    WorkflowVisualType["Button"] = "Button"
    WorkflowVisualType["Link"] = "Link"
    WorkflowVisualType["Label"] = "Label"
})(WorkflowVisualType || (WorkflowVisualType = {}));
export class WorkflowVisualElement {
    /** @param {{Title?:string,OperationName?:string,ArgumentDialogName?:string,VisualType?:WorkflowVisualType,DecisionType?:string,PersistOnDecision?:boolean,ClosesForm?:boolean,ContentCommandName?:string,CssClass?:string,Ordinal?:number,WarningMessage?:string,RunAsUICommand?:boolean,Parameters?:Hashtable}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Title;
    /** @type {string} */
    OperationName;
    /** @type {string} */
    ArgumentDialogName;
    /** @type {WorkflowVisualType} */
    VisualType;
    /** @type {string} */
    DecisionType;
    /** @type {boolean} */
    PersistOnDecision;
    /** @type {boolean} */
    ClosesForm;
    /** @type {string} */
    ContentCommandName;
    /** @type {string} */
    CssClass;
    /** @type {number} */
    Ordinal;
    /** @type {string} */
    WarningMessage;
    /** @type {boolean} */
    RunAsUICommand;
    /** @type {Hashtable} */
    Parameters;
}
export class WcfItemBase {
    constructor(init) { Object.assign(this, init) }
}
export class WcfChange extends WcfItemBase {
    /** @param {{Id?:string,NextVersionNumber?:number,PrevVersionNumber?:number,ItemId?:string,VersionNumber?:number,Version?:string,Owner?:string,Comment?:string,Label?:string,ChangeType?:string,IsPublishedVersion?:boolean,IsLastPublishedVersion?:boolean,ChangeDescription?:string,LastModified?:string,DateCreated?:string,CreatedByUserName?:string,PreviousId?:string,NextId?:string,Metadata?:string,AdditionalInfo?:string,Culture?:string,AvailableLanguages?:IList<string>}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {number} */
    NextVersionNumber;
    /** @type {number} */
    PrevVersionNumber;
    /** @type {string} */
    ItemId;
    /** @type {number} */
    VersionNumber;
    /** @type {string} */
    Version;
    /** @type {string} */
    Owner;
    /** @type {string} */
    Comment;
    /** @type {string} */
    Label;
    /** @type {string} */
    ChangeType;
    /** @type {boolean} */
    IsPublishedVersion;
    /** @type {boolean} */
    IsLastPublishedVersion;
    /** @type {string} */
    ChangeDescription;
    /** @type {string} */
    LastModified;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    CreatedByUserName;
    /** @type {string} */
    PreviousId;
    /** @type {string} */
    NextId;
    /** @type {string} */
    Metadata;
    /** @type {string} */
    AdditionalInfo;
    /** @type {string} */
    Culture;
    /** @type {IList<string>} */
    AvailableLanguages;
}
export class WcfApprovalTrackingRecord {
    /** @param {{DateCreated?:string,Note?:string,Status?:string,UIStatus?:string,UserName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    Note;
    /** @type {string} */
    Status;
    /** @type {string} */
    UIStatus;
    /** @type {string} */
    UserName;
}
export class ContentViewModelBase {
    /** @param {{ParentUrl?:string,IsEditable?:boolean,IsDeletable?:boolean,IsUnlockable?:boolean,UIStatus?:string,AdditionalStatus?:Status,ItemsCount?:number,Id?:string,LiveContentId?:string,Title?:string,Owner?:string,Author?:string,DateCreated?:string,DateModified?:string,PublicationDate?:string,ProviderName?:string,ExpirationDate?:string,Status?:string,CommentsCount?:number,LifecycleStatus?:WcfContentLifecycleStatus,WorkflowOperations?:IList<WorkflowVisualElement>,VersionInfo?:WcfChange,DefaultPageId?:string,LastApprovalTrackingRecord?:WcfApprovalTrackingRecord,Version?:number,AvailableLanguages?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ParentUrl;
    /** @type {boolean} */
    IsEditable;
    /** @type {boolean} */
    IsDeletable;
    /** @type {boolean} */
    IsUnlockable;
    /** @type {string} */
    UIStatus;
    /** @type {Status} */
    AdditionalStatus;
    /** @type {number} */
    ItemsCount;
    /** @type {string} */
    Id;
    /** @type {?string} */
    LiveContentId;
    /** @type {string} */
    Title;
    /** @type {string} */
    Owner;
    /** @type {string} */
    Author;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    DateModified;
    /** @type {string} */
    PublicationDate;
    /** @type {string} */
    ProviderName;
    /** @type {string} */
    ExpirationDate;
    /** @type {string} */
    Status;
    /** @type {number} */
    CommentsCount;
    /** @type {WcfContentLifecycleStatus} */
    LifecycleStatus;
    /** @type {IList<WorkflowVisualElement>} */
    WorkflowOperations;
    /** @type {WcfChange} */
    VersionInfo;
    /** @type {?string} */
    DefaultPageId;
    /** @type {WcfApprovalTrackingRecord} */
    LastApprovalTrackingRecord;
    /** @type {number} */
    Version;
    /** @type {string[]} */
    AvailableLanguages;
}
export class HierarchicalContentViewModelBase extends ContentViewModelBase {
    /** @param {{Url?:string,ParentUrl?:string,IsEditable?:boolean,IsDeletable?:boolean,IsUnlockable?:boolean,UIStatus?:string,AdditionalStatus?:Status,ItemsCount?:number,Id?:string,LiveContentId?:string,Title?:string,Owner?:string,Author?:string,DateCreated?:string,DateModified?:string,PublicationDate?:string,ProviderName?:string,ExpirationDate?:string,Status?:string,CommentsCount?:number,LifecycleStatus?:WcfContentLifecycleStatus,WorkflowOperations?:IList<WorkflowVisualElement>,VersionInfo?:WcfChange,DefaultPageId?:string,LastApprovalTrackingRecord?:WcfApprovalTrackingRecord,Version?:number,AvailableLanguages?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Url;
}
export class ListViewModel extends HierarchicalContentViewModelBase {
    /** @param {{ListItemCount?:number,LastItemDate?:string,Url?:string,ParentUrl?:string,IsEditable?:boolean,IsDeletable?:boolean,IsUnlockable?:boolean,UIStatus?:string,AdditionalStatus?:Status,ItemsCount?:number,Id?:string,LiveContentId?:string,Title?:string,Owner?:string,Author?:string,DateCreated?:string,DateModified?:string,PublicationDate?:string,ProviderName?:string,ExpirationDate?:string,Status?:string,CommentsCount?:number,LifecycleStatus?:WcfContentLifecycleStatus,WorkflowOperations?:IList<WorkflowVisualElement>,VersionInfo?:WcfChange,DefaultPageId?:string,LastApprovalTrackingRecord?:WcfApprovalTrackingRecord,Version?:number,AvailableLanguages?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    ListItemCount;
    /** @type {?string} */
    LastItemDate;
}
/** @typedef ListViewModel {any} */
export class CollectionContext {
    /** @param {{TotalCount?:number,IsGeneric?:boolean,Context?:{ [index: string]: string; },Items?:ListViewModel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalCount;
    /** @type {boolean} */
    IsGeneric;
    /** @type {{ [index: string]: string; }} */
    Context;
    /** @type {ListViewModel[]} */
    Items;
}

JavaScript SpecificListsGetRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /RestApi/lists-api/items HTTP/1.1 
Host: www.asg.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Ids":["00000000-0000-0000-0000-000000000000"],"Provider":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TotalCount":0,"IsGeneric":false,"Items":[]}