<back to all web services

SpecificListsGetRequest

The following routes are available for this service:
PUT/RestApi/lists-api/items
import java.math.*
import java.util.*
import net.servicestack.client.*


open class SpecificListsGetRequest
{
    var Ids:ArrayList<UUID>? = null
    var Provider:String? = null
}

@DataContract
open class CollectionContext<ListViewModel>
{
    @DataMember
    var TotalCount:Int? = null

    @DataMember
    var IsGeneric:Boolean? = null

    @DataMember
    var Context:HashMap<String,String> = HashMap<String,String>()

    @DataMember
    var Items:ArrayList<ListViewModel> = ArrayList<ListViewModel>()
}

open class ListViewModel : HierarchicalContentViewModelBase()
{
    @DataMember
    var ListItemCount:Int? = null

    @DataMember
    var LastItemDate:Date? = null
}

@DataContract
open class HierarchicalContentViewModelBase : ContentViewModelBase()
{
    @DataMember
    var Url:String? = null
}

@DataContract
open class ContentViewModelBase : ILocalizable
{
    @DataMember
    var ParentUrl:String? = null

    @DataMember
    var IsEditable:Boolean? = null

    @DataMember
    var IsDeletable:Boolean? = null

    @DataMember
    var IsUnlockable:Boolean? = null

    @DataMember
    var UIStatus:String? = null

    @DataMember
    var AdditionalStatus:Status? = null

    @DataMember
    var ItemsCount:Int? = null

    @DataMember
    var Id:UUID? = null

    @DataMember
    var LiveContentId:UUID? = null

    @DataMember
    var Title:String? = null

    @DataMember
    var Owner:String? = null

    @DataMember
    var Author:String? = null

    @DataMember
    var DateCreated:Date? = null

    @DataMember
    var DateModified:Date? = null

    @DataMember
    var PublicationDate:Date? = null

    @DataMember
    var ProviderName:String? = null

    @DataMember
    var ExpirationDate:Date? = null

    @DataMember
    var Status:String? = null

    @DataMember
    var CommentsCount:Int? = null

    @DataMember
    var LifecycleStatus:WcfContentLifecycleStatus? = null

    @DataMember
    var WorkflowOperations:IList<WorkflowVisualElement>? = null

    @DataMember
    var VersionInfo:WcfChange? = null

    @DataMember
    var DefaultPageId:UUID? = null

    @DataMember
    var LastApprovalTrackingRecord:WcfApprovalTrackingRecord? = null

    @DataMember
    var Version:Int? = null

    @DataMember
    var AvailableLanguages:ArrayList<String>? = null
}

@DataContract
open class Status
{
    @DataMember
    var Text:String? = null

    @DataMember
    var PrimaryProvider:String? = null
}

@DataContract
open class WcfContentLifecycleStatus
{
    @DataMember
    var IsPublished:Boolean? = null

    @DataMember
    var Message:String? = null

    @DataMember
    var LockedByUsername:String? = null

    @DataMember
    var IsAdmin:Boolean? = null

    @DataMember
    var IsLocked:Boolean? = null

    @DataMember
    var IsLockedByMe:Boolean? = null

    @DataMember
    var SupportsContentLifecycle:Boolean? = null

    @DataMember
    var ErrorMessage:String? = null

    @DataMember
    var LockedSince:Date? = null

    @DataMember
    var LastModified:Date? = null

    @DataMember
    var LastModifiedBy:String? = null

    @DataMember
    var PublicationDate:Date? = null

    @DataMember
    var WorkflowStatus:String? = null

    @DataMember
    var HasLiveVersion:Boolean? = null
}

@DataContract
open class WorkflowVisualElement
{
    @DataMember
    var Title:String? = null

    @DataMember
    var OperationName:String? = null

    @DataMember
    var ArgumentDialogName:String? = null

    @DataMember
    var VisualType:WorkflowVisualType? = null

    @DataMember
    var DecisionType:String? = null

    @DataMember
    var PersistOnDecision:Boolean? = null

    @DataMember
    var ClosesForm:Boolean? = null

    @DataMember
    var ContentCommandName:String? = null

    @DataMember
    var CssClass:String? = null

    @DataMember
    var Ordinal:Int? = null

    @DataMember
    var WarningMessage:String? = null

    @DataMember
    var RunAsUICommand:Boolean? = null

    @DataMember
    var Parameters:Hashtable? = null
}

enum class WorkflowVisualType
{
    Button,
    Link,
    Label,
}

@DataContract
open class WcfChange : WcfItemBase()
{
    @DataMember
    var Id:UUID? = null

    @DataMember
    var NextVersionNumber:Int? = null

    @DataMember
    var PrevVersionNumber:Int? = null

    @DataMember
    var ItemId:UUID? = null

    @DataMember
    var VersionNumber:Int? = null

    @DataMember
    var Version:String? = null

    @DataMember
    var Owner:UUID? = null

    @DataMember
    var Comment:String? = null

    @DataMember
    var Label:String? = null

    @DataMember
    var ChangeType:String? = null

    @DataMember
    var IsPublishedVersion:Boolean? = null

    @DataMember
    var IsLastPublishedVersion:Boolean? = null

    @DataMember
    var ChangeDescription:String? = null

    @DataMember
    var LastModified:Date? = null

    @DataMember
    var DateCreated:Date? = null

    @DataMember
    var CreatedByUserName:String? = null

    @DataMember
    var PreviousId:String? = null

    @DataMember
    var NextId:String? = null

    @DataMember
    var Metadata:String? = null

    @DataMember
    var AdditionalInfo:String? = null

    @DataMember
    var Culture:String? = null

    @DataMember
    var AvailableLanguages:IList<String>? = null
}

@DataContract
open class WcfItemBase
{
}

@DataContract
open class WcfApprovalTrackingRecord
{
    @DataMember
    var DateCreated:Date? = null

    @DataMember
    var Note:String? = null

    @DataMember
    var Status:String? = null

    @DataMember
    var UIStatus:String? = null

    @DataMember
    var UserName:String? = null
}

Kotlin SpecificListsGetRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	TotalCount: 0,
	IsGeneric: False,
	Items: []
}