<back to all web services

SpecificListsGetRequest

The following routes are available for this service:
PUT/RestApi/lists-api/items
SpecificListsGetRequest Parameters:
NameParameterData TypeRequiredDescription
IdsbodyGuid[]No
ProviderbodystringNo
CollectionContext<ListViewModel> Parameters:
NameParameterData TypeRequiredDescription
TotalCountformintNo
IsGenericformboolNo
ContextformIDictionary<string, string>No
ItemsformIEnumerable<ListViewModel>No
ListViewModel Parameters:
NameParameterData TypeRequiredDescription
ListItemCountformintNo
LastItemDateformDateTime?No
HierarchicalContentViewModelBase Parameters:
NameParameterData TypeRequiredDescription
UrlformstringNo
ContentViewModelBase Parameters:
NameParameterData TypeRequiredDescription
ParentUrlformstringNo
IsEditableformboolNo
IsDeletableformboolNo
IsUnlockableformboolNo
UIStatusformstringNo
AdditionalStatusformStatusNo
ItemsCountformintNo
IdformGuidNo
LiveContentIdformGuid?No
TitleformstringNo
OwnerformstringNo
AuthorformstringNo
DateCreatedformDateTimeNo
DateModifiedformDateTimeNo
PublicationDateformDateTimeNo
ProviderNameformstringNo
ExpirationDateformDateTimeNo
StatusformstringNo
CommentsCountformintNo
LifecycleStatusformWcfContentLifecycleStatusNo
WorkflowOperationsformIList<WorkflowVisualElement>No
VersionInfoformWcfChangeNo
DefaultPageIdformGuid?No
LastApprovalTrackingRecordformWcfApprovalTrackingRecordNo
VersionformintNo
AvailableLanguagesformstring[]No
Status Parameters:
NameParameterData TypeRequiredDescription
TextformstringNo
PrimaryProviderformstringNo
WcfContentLifecycleStatus Parameters:
NameParameterData TypeRequiredDescription
IsPublishedformboolNo
MessageformstringNo
LockedByUsernameformstringNo
IsAdminformboolNo
IsLockedformboolNo
IsLockedByMeformboolNo
SupportsContentLifecycleformboolNo
ErrorMessageformstringNo
LockedSinceformDateTime?No
LastModifiedformDateTime?No
LastModifiedByformstringNo
PublicationDateformDateTime?No
WorkflowStatusformstringNo
HasLiveVersionformboolNo
WorkflowVisualElement Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
OperationNameformstringNo
ArgumentDialogNameformstringNo
VisualTypeformWorkflowVisualTypeNo
DecisionTypeformstringNo
PersistOnDecisionformboolNo
ClosesFormformboolNo
ContentCommandNameformstringNo
CssClassformstringNo
OrdinalformintNo
WarningMessageformstringNo
RunAsUICommandformboolNo
ParametersformHashtableNo
WorkflowVisualType Enum:
Button
Link
Label
WcfChange Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NextVersionNumberformintNo
PrevVersionNumberformintNo
ItemIdformGuidNo
VersionNumberformintNo
VersionformstringNo
OwnerformGuidNo
CommentformstringNo
LabelformstringNo
ChangeTypeformstringNo
IsPublishedVersionformboolNo
IsLastPublishedVersionformboolNo
ChangeDescriptionformstringNo
LastModifiedformDateTimeNo
DateCreatedformDateTimeNo
CreatedByUserNameformstringNo
PreviousIdformstringNo
NextIdformstringNo
MetadataformstringNo
AdditionalInfoformstringNo
CultureformstringNo
AvailableLanguagesformIList<string>No
WcfApprovalTrackingRecord Parameters:
NameParameterData TypeRequiredDescription
DateCreatedformDateTimeNo
NoteformstringNo
StatusformstringNo
UIStatusformstringNo
UserNameformstringNo

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

HTTP + OTHER

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

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

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