apiUtility

mura.client.api.json.v1

Class apiUtility

WEB-INF.cftags.component
    mura.cfobject
      mura.client.api.json.v1.apiUtility

This provides JSON/REST API functionality

Class Attributes:

None

Constructor Summary
init([any siteid])

Method Summary
`any`	AllowAccess([any bean], [any $], [any throwError='true'])
`any`	AllowAction([any bean], [any $])
`any`	applyPropertyFormat([any prop])
`any`	applyRemoteFormat([any str])
`any`	checkForChangesetRequest([any entityName], [any siteid])
`any`	checkSchema([any entityname])
`any`	declareEntity([any entityConfig])
`any`	delete([any entityName], [any id], [any siteid])
`any`	expandEntity([any entity], [any itemStuct], [any siteid], [any expand=''])
`any`	findAll([any siteid], [any entityName], [any params], [any expand=''])
`any`	findCalendarItems([any calendarid], [any siteid], [any start], [any end], [any categoryid], [any tag], [any format=''])
`any`	findCrumbArray([any entityName], [any id], [any siteid], [any iterator], [any expand=''], [any expanded='false'])
`any`	findCurrentUser([any entityName], [any id], [any siteid], [any render='false'], [any variation='false'], [any expand=''])
`any`	findMany([any entityName], [any ids], [any siteid], [any params], [any expand=''], [any expanded='false'])
`any`	findNew([any entityName], [any siteid], [any expand=''])
`any`	findOne([any entityName], [any id], [any siteid], [any render='false'], [any variation='false'], [any expand=''], [any method='findOne'], [any expanded='false'])
`any`	findProperties([any entityname], [any properties=''])
`any`	findQuery([any entityName], [any siteid], [any params], [any queryString='[runtime expression]'], [any expand=''], [any expanded='false'])
`any`	findRelatedContent([any id], [any siteid], [any params], [any arguments], [any expand=''], [any expanded='false'])
`any`	findVersionHistory([any id], [any siteid], [any expand=''], [any expanded='false'])
`any`	formatArray([any _array])
`any`	generateCSRFTokens([any siteid], [any context])
`any`	getApiVersion()
`any`	getConfig()
`any`	getEndPoint([any mode='json'], [any useProtocol='true'])
`any`	getEntityConfig([any entityName])
`any`	getFilteredValues([any entity], [any expanded='false'], [any entityConfigName], [any siteid], [any expandLinks=''], [any pk=''])
`any`	getLinks([any entity])
`any`	getParamsWithOutMethod([any params])
`any`	getPrimaryEntityStruct([any entity], [any $])
`any`	getRelationship([any from], [any to])
`any`	getSerializer()
`any`	getSwaggerEntityParams([any entity], [any _in='query'], [any idInPath='false'], [any method='get'], [any mode=''], [any csrf='true'])
`any`	getSwaggerEntityProps([any entity])
`any`	getSwaggerPropertyDataType([any datatype])
`any`	getURLForImage([any fileid], [any size='small'], [any height='auto'], [any width='auto'], [any siteid], [any complete='true'], [any secure='false'], [any useProtocol='false'])
`any`	isAggregateQuery()
`any`	isValidRequest()
`any`	iteratorToArray([any iterator], [any siteid], [any expand=''], [any $], [any expanded='false'])
`any`	login([any username], [any password], [any siteid], [any lockdownCheck='false'], [any lockdownExpires=''])
`any`	logout()
`any`	packageIteratorArray([any iterator], [any itArray], [any method], [any expanded='false'])
`any`	parseParamsFromPath([any pathInfo], [any params], [any start])
`any`	processAsyncObject([any siteid])
`any`	processRequest([any path='[runtime expression]'])
`any`	registerDisplayObject([any displayObjectName], [any config])
`any`	registerEntity([any entityName], [any config='[runtime expression]'], [any beanInstance=''])
`any`	registerLinkMethod([any method])
`any`	registerMethod([any methodName], [any method])
`any`	save([any siteid], [any entityname], [any id='new'], [any expand=''])
`any`	serializeResponse([any response], [any statusCode='200'])
`any`	setConfig([any conifg])
`any`	setFeedProps([any feed], [any params])
`any`	setImageURLs([any entity])
`any`	setIteratorProps([any iterator], [any params])
`any`	swagger([any siteid], [any params])
`any`	undeclareEntity([any entityname], [any deleteSchema='false'])
`any`	validate([any data='{}'], [any validations='{}'])
`any`	validateEmail()

Methods inherited from class `mura.cfobject`
commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEntity, getEventManager, getFeed, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, invokeMethod, mixin, parseDateArg, removeValue, set, setValue, valueExists

Methods inherited from class mura.cfobject

commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEntity, getEventManager, getFeed, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, invokeMethod, mixin, parseDateArg, removeValue, set, setValue, valueExists

Methods inherited from class `WEB-INF.cftags.component`
None

Constructor Detail

init

public init([any siteid])

Parameters:: siteid

Method Detail

AllowAccess

public any AllowAccess([any bean], [any $], [any throwError='true'])

Parameters:: bean; $; throwError

AllowAction

public any AllowAction([any bean], [any $])

Parameters:: bean; $

applyPropertyFormat

public any applyPropertyFormat([any prop])

Parameters:: prop

applyRemoteFormat

public any applyRemoteFormat([any str])

Parameters:: str

checkForChangesetRequest

public any checkForChangesetRequest([any entityName], [any siteid])

Parameters:: entityName; siteid

checkSchema

public any checkSchema([any entityname])

Parameters:: entityname

declareEntity

public any declareEntity([any entityConfig])

Parameters:: entityConfig

delete

public any delete([any entityName], [any id], [any siteid])

Parameters:: entityName; id; siteid

expandEntity

public any expandEntity([any entity], [any itemStuct], [any siteid], [any expand=''])

Parameters:: entity; itemStuct; siteid; expand

findAll

public any findAll([any siteid], [any entityName], [any params], [any expand=''])

Parameters:: siteid; entityName; params; expand

findCalendarItems

public any findCalendarItems([any calendarid], [any siteid], [any start], [any end], [any categoryid], [any tag], [any format=''])

Parameters:: calendarid; siteid; start; end; categoryid; tag; format

findCrumbArray

public any findCrumbArray([any entityName], [any id], [any siteid], [any iterator], [any expand=''], [any expanded='false'])

Parameters:: entityName; id; siteid; iterator; expand; expanded

findCurrentUser

public any findCurrentUser([any entityName], [any id], [any siteid], [any render='false'], [any variation='false'], [any expand=''])

Parameters:: entityName; id; siteid; render; variation; expand

findMany

public any findMany([any entityName], [any ids], [any siteid], [any params], [any expand=''], [any expanded='false'])

Parameters:: entityName; ids; siteid; params; expand; expanded

findNew

public any findNew([any entityName], [any siteid], [any expand=''])

Parameters:: entityName; siteid; expand

findOne

public any findOne([any entityName], [any id], [any siteid], [any render='false'], [any variation='false'], [any expand=''], [any method='findOne'], [any expanded='false'])

Parameters:: entityName; id; siteid; render; variation; expand; method; expanded

findProperties

public any findProperties([any entityname], [any properties=''])

Parameters:: entityname; properties

findQuery

public any findQuery([any entityName], [any siteid], [any params], [any queryString='[runtime expression]'], [any expand=''], [any expanded='false'])

Parameters:: entityName; siteid; params; queryString; expand; expanded

findRelatedContent

public any findRelatedContent([any id], [any siteid], [any params], [any arguments], [any expand=''], [any expanded='false'])

Parameters:: id; siteid; params; arguments; expand; expanded

findVersionHistory

public any findVersionHistory([any id], [any siteid], [any expand=''], [any expanded='false'])

Parameters:: id; siteid; expand; expanded

formatArray

public any formatArray([any _array])

Parameters:: _array

generateCSRFTokens

public any generateCSRFTokens([any siteid], [any context])

Parameters:: siteid; context

getApiVersion

public any getApiVersion()

getConfig

public any getConfig()

getEndPoint

public any getEndPoint([any mode='json'], [any useProtocol='true'])

Parameters:: mode; useProtocol

getEntityConfig

public any getEntityConfig([any entityName])

Parameters:: entityName

getFilteredValues

public any getFilteredValues([any entity], [any expanded='false'], [any entityConfigName], [any siteid], [any expandLinks=''], [any pk=''])

Parameters:: entity; expanded; entityConfigName; siteid; expandLinks; pk

getLinks

public any getLinks([any entity])

Parameters:: entity

getParamsWithOutMethod

public any getParamsWithOutMethod([any params])

Parameters:: params

getPrimaryEntityStruct

public any getPrimaryEntityStruct([any entity], [any $])

Parameters:: entity; $

getRelationship

public any getRelationship([any from], [any to])

Parameters:: from; to

getSerializer

public any getSerializer()

getSwaggerEntityParams

public any getSwaggerEntityParams([any entity], [any _in='query'], [any idInPath='false'], [any method='get'], [any mode=''], [any csrf='true'])

Parameters:: entity; _in; idInPath; method; mode; csrf

getSwaggerEntityProps

public any getSwaggerEntityProps([any entity])

Parameters:: entity

getSwaggerPropertyDataType

public any getSwaggerPropertyDataType([any datatype])

Parameters:: datatype

getURLForImage

public any getURLForImage([any fileid], [any size='small'], [any height='auto'], [any width='auto'], [any siteid], [any complete='true'], [any secure='false'], [any useProtocol='false'])

Parameters:: fileid; size; height; width; siteid; complete; secure; useProtocol

isAggregateQuery

public any isAggregateQuery()

isValidRequest

public any isValidRequest()

iteratorToArray

public any iteratorToArray([any iterator], [any siteid], [any expand=''], [any $], [any expanded='false'])

Parameters:: iterator; siteid; expand; $; expanded

login

public any login([any username], [any password], [any siteid], [any lockdownCheck='false'], [any lockdownExpires=''])

Parameters:: username; password; siteid; lockdownCheck; lockdownExpires

logout

public any logout()

packageIteratorArray

public any packageIteratorArray([any iterator], [any itArray], [any method], [any expanded='false'])

Parameters:: iterator; itArray; method; expanded

parseParamsFromPath

public any parseParamsFromPath([any pathInfo], [any params], [any start])

Parameters:: pathInfo; params; start

processAsyncObject

public any processAsyncObject([any siteid])

Parameters:: siteid

processRequest

public any processRequest([any path='[runtime expression]'])

Parameters:: path

registerDisplayObject

public any registerDisplayObject([any displayObjectName], [any config])

Parameters:: displayObjectName; config

registerEntity

public any registerEntity([any entityName], [any config='[runtime expression]'], [any beanInstance=''])

Parameters:: entityName; config; beanInstance

registerLinkMethod

public any registerLinkMethod([any method])

Parameters:: method

registerMethod

public any registerMethod([any methodName], [any method])

Parameters:: methodName; method

save

public any save([any siteid], [any entityname], [any id='new'], [any expand=''])

Parameters:: siteid; entityname; id; expand

serializeResponse

public any serializeResponse([any response], [any statusCode='200'])

Parameters:: response; statusCode

setConfig

public any setConfig([any conifg])

Parameters:: conifg

setFeedProps

public any setFeedProps([any feed], [any params])

Parameters:: feed; params

setImageURLs

public any setImageURLs([any entity])

Parameters:: entity

setIteratorProps

public any setIteratorProps([any iterator], [any params])

Parameters:: iterator; params

swagger

public any swagger([any siteid], [any params])

Parameters:: siteid; params

undeclareEntity

public any undeclareEntity([any entityname], [any deleteSchema='false'])

Parameters:: entityname; deleteSchema

validate

public any validate([any data='{}'], [any validations='{}'])

Parameters:: data; validations

validateEmail

public any validateEmail()