Alokai

SapccApiSiteMessagesRequest

Request parameters for siteMessages operation in SapccApi. SapccApiSiteMessagesRequest

interface SapccApiSiteMessagesRequest {
	readonly baseSiteId: string;
	readonly currentPage?: string;
	readonly needsTotal?: SiteMessagesNeedsTotalEnum;
	readonly pageSize?: string;
	readonly sort?: string;
	readonly userId: string;
}

Properties

NameRequiredTypeDescription
baseSiteIdRequiredstringBase site identifier. {string} SapccApiSiteMessages
currentPageOptionalstringThe current result page requested. {string} SapccApiSiteMessages
needsTotalOptionalSiteMessagesNeedsTotalEnumThe flag for indicating if total number of results is needed or not. {'true' | 'false'} SapccApiSiteMessages
pageSizeOptionalstringThe number of results returned per page. {string} SapccApiSiteMessages
sortOptionalstringThe sorting method applied to the return results. {string} SapccApiSiteMessages
userIdRequiredstringUser identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user. {string} SapccApiSiteMessages

Referenced Types

On this page