| Wiki Markup |
|---|
(!) WIP
h2. RAFT Service
{include:Interface Style}
{table:id=serviceMetaTable}
{tr}
{th:class=h}Name
{th}
{td:id=serviceName|colspan=2}RAFT Service
{td}
{tr}
{tr}
{th:class=h}Version
{th}
{td:id=serviceVersion}Dev ([0.1|Search Service 0.1])
{td}
{td:id=serviceVersionHistory}[Release Notes|Search Service Release Notes#current]
{td}
{tr}
{table}
| [#References] | [#Operations] | [#Capabilities] |
h3. Description
The RAFT Service is focused on providing a consistent interface for:
* Searching for Cost Objects and Cost Object Collections
* Viewing Budget, Actual, Commitments, and Forecast information for Cost Object Collections
* Creating What If scenarios as collections of speculations
* Viewing the projected impacts of those speculations
* Generating and viewing reports on this information
h3. References
see RAFT Requirements Documentation (RAFT-*)
h3. Operations
{include:Method Table Style Page}
{panel:title=Setup|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
*Domain Operations*
[#getModelTypes]
{panel}
{panel:title=Search|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
searchbyParm(&parm)
searchCollectionbyParm(&collection,&parm)
Listinfo about user sets
getSearchLists
listSupervisor(#count)
listAddressee(#count)
listSponsor(#count)
listPrimeSponsor(#count)
listId(#count)
listWorksets(#count)
listFlaggedCostObjects(#count)
{panel}
{panel:title=Maintenance|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
addComment
deleteComment
updateComment
getComment
getCommentsforObject
addWorksetAuthorizations
dropWorksetAuthorizations
viewAuthorizationsforUser
viewAuthorizationsforObject
List info about cost objects
listBudgets(CO,withchildren)
listWorksetScenarios(Workset,withchildren)
listCOScenarios(CO, withchildren)
listProjectPeriods
updateProjectPeriods
addProjectPeriod
dropProjectPeriod
validateProjectPeriods
listReport
executeReport
listDomain
buildDomainReport
executeDomainReport
Summary
BvAQueryDay
RvEQueryDay
BvAQueryMonth
RvEQueryMonth
Query
queryActualsSumm
queryActualsPODetail
queryActualsPEDetail
queryBudgetDay
queryCommitmentsSumm
queryCommitmentsPODetail
queryCommitmentsPEDetail
queryForecastSumm
queryForecastPODetail
queryForecastPEDetail
workset Management
createWorkset
deleteWorkset
archiveWorkset
listWorksets
showWorkset
addWorksetObj
delWorksetObj
addWorksetRule
deleteWorksetRule
updateWorksetfromRules
showWorksetChanges
showAccessChanges
showBalanceExceptions
showworksetCOSummary
showworksetApptSummary
scenario Management
showCOAttributes
showApptAttributes
showScenarioOverview
showScenaroFinImpact
showScenarioPersonImpact
showScenarioDetail
showCOExpenseDetail
showCOPersonDetail
showCODetail
showApptDetail
createScenario
deleteScenario
addCOtoScenario
addAppttoScenario
dropCOfromScenario
dropApptfromScenario
copyScenario
archiveScenario
addAssumption
dropAssumption
updateAssumption
addExpenseAllocSpec
addApptAllocSpec
updateExpenseAllocSpec
updateApptAllocSpec
dropExpenseAllocSpec
dropApptAllocSpec
addTBACOSpec
addTBHApptSpec
dropTBACOSpec
dropTBHApptSpec
updateCOSpec
updateApptSpec
addAdjSpec
dropAdjSpec
addCORateSpec
dropCORateSpec
updateFTESpec
updateVacationSpec
createExpenseAllocSpecfromCOEUS
createExpenseAllocSpecfromSAP
createPersonAllocSpecfromCOEUS
recalcApptDetail
recalcExpenseDetail
buildScenarioSummary
buildWorksetSummary
updateUserPrefGL
updateUserPrefBudget
checkSystemStatus
setScenarioVisibility
setWorksetVisibility
checkProjectedBalance
checkGLBudget
checkMonthlyBurn
checkPersonAlloc
checkRemainingGLBalance
checkRemainingBalance
addProjectTerm
dropProjectTerm
checkProjectTerms
showGlsInCategory
showGLHierarchy
showRatesonObj
showVarianceonScenario
showlineItemsonGL
{panel}
h4. {color:#000066}{_}Search{_}{color}
{anchor:getModelTypessearchByParm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}searchByParm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Searches the cost collector set and returns matches based on the passed in parameters
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coResultType|coResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns cost object details for all of the matching cost objects.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No cost objects found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NOMAX_MATCH1COUNT
{td}
{td:class=methodErrorDesc}NoNumber costof objects returned >250 found
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3} See RAFT-Search
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypessearchCollectionbyParm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypessearchCollectionByParm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesPerforms a collection search based off the identified parameters. listCollection ofsearches modelcannot typesbe knownused byto thisdefine servicesets
{td}
{tr}
{tr}
{th:class=h|rowspan=12}Parameters
{th}
{td:class=methodParamType}NoneString
{td}
{td:class=methodParamName}NoneCollection
{td}
{td:class=methodParamDesc}No parametersWhich collection will be searched, one of supervisor, sponsor, fund_center, profit_center, workset
{td}
{tr}
{tr}
{thtd:class=hmethodParamType}ReturnArray
{thtd}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]methodParamName}Parm
{td}
{td:class=methodReturnDesc}list of model types
{td}
{trmethodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{th:class=h|rowspan=1}ErrorsReturn
{th}
{td:class=methodErrorTypemethodReturnType|colspan=2}OPERATION_FAILED[collectionResultType|collectionResultTypeInfo Structure]
{td}
{td:class=methodErrorDesc}unable to complete requestmethodReturnDesc}Returns cost object details for all of the matching cost objects wrapped in a metadata header for the collection.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}CapabilitiesErrors
{th}
{td:class=capabilityDescmethodErrorType|colspan=3}=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No cost objects found
{td}
{tr}
{tr}
{thtd:class=h}methodErrorType|colspan=2}MAX_COUNT
{td}
{td:class=methodErrorDesc}Count of returned objects (including the collection header) exceeds 250 and cannot be displayed.
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypesgetSearchLists}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypesgetSearchLists
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesReturns the default listcollection of model types known by this serviceselection items for each of the search lists.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneArray
{td}
{td:class=methodParamName}NoneParm
{td}
{td:class=methodParamDesc}NoAn associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfolistSetResultType|cluResultTypeInfolistSetResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Master structure for list data of model typesthat includes supervisor, addressee, sponsor, prime_sponsor, workset. The set always returns a max of 150 entries. To extend beyond that requires the user to use the autocomplete methods.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {coloranchor:#000066listSupervisor}{_}Setup{_}{color}
{anchor:getModelTypes}
{
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypeslistSupervisor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesReturns the list of modelsupervisors typesaccessible knownby bythe thisrequesting serviceuser.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneInteger
{td}
{td:class=methodParamName}NoneCount
{td}
{td:class=methodParamDesc}No parametersThe number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfolistResultType|cluResultTypeInfolistResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, modelvalue typespairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypeslistAddressee}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypeslistAddressee
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesReturns the list of modeladressees typesaccessible knownby bythe thisrequesting serviceuser.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneInteger
{td}
{td:class=methodParamName}NoneCount
{td}
{td:class=methodParamDesc}No parameters
{tdThe number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfolistResultType|cluResultTypeInfolistResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of model typeskey, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypeslistSponsor}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypeslistSponsor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesReturns the list of modelsponsors typesaccessible knownby bythe thisrequesting serviceuser.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneInteger
{td}
{td:class=methodParamName}NoneCount
{td}
{td:class=methodParamDesc}No parametersThe number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfolistResultType|cluResultTypeInfolistResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, modelvalue typespairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{{anchor:listPrimeSponsor}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypeslistPrimeSponsor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesReturns the list of modelprime typessponsors knownaccessible by this servicethe requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneInteger
{td}
{td:class=methodParamName}NoneCount
{td}
{td:class=methodParamDesc}No parametersThe number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfolistResultType|cluResultTypeInfolistResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of model typeskey, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypeslistWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypeslistWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesReturns the list of modelworksets typesaccessible knownby bythe thisrequesting serviceuser.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneInteger
{td}
{td:class=methodParamName}NoneCount
{td}
{td:class=methodParamDesc}No parametersThe number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfolistResultType|cluResultTypeInfolistResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of model typeskey, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypeslistId}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypeslistId
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesReturns the list of model types known by this service cost object ids and titles accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneInteger
{td}
{td:class=methodParamName}NoneCount
{td}
{td:class=methodParamDesc}No parametersThe number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfolistResultType|cluResultTypeInfolistResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, modelvalue typespairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {coloranchor:#000066listFlaggedCostObjects}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypeslistFlaggedCostObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesReturns the list of flagged modelcost typesobjects knownflagged by the thisrequesting serviceuser.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneInteger
{td}
{td:class=methodParamName}NoneCount
{td}
{td:class=methodParamDesc}No parametersThe number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfocoResultType|cluResultTypeInfocoResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list Returns cost object details for all of model typesthe matching cost objects
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}SetupComment{_}{color}
{anchor:getModelTypesaddComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypesaddComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesAdds thea listcomment ofto modelthe types known by this serviceidentified object
{td}
{tr}
{tr}
{th:class=h|rowspan=14}Parameters
{th}
{td:class=methodParamType}NoneComment_Type
{td}
{td:class=methodParamName}NoneString
{td}
{td:class=methodParamDesc}No parametersDenotes whether a particular comment is public or private.
{td}
{tr}
{tr}
{thtd:class=hmethodParamType}ReturnRef_Type
{thtd}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]methodParamName}String
{td}
{td:class=methodReturnDesc}listmethodParamDesc}Identifies what sort of model types speculation the reference is on (EXPENSE_RULE, APPT_RULE, APPT, CO, SCENARIO, WORKSET)
{td}
{tr}
{tr}
{thtd:class=h|rowspan=1}ErrorsmethodParamType}REF_ID
{thtd}
{td:class=methodErrorType|colspan=2}OPERATION_FAILEDmethodParamName}String
{td}
{td:class=methodErrorDesc}unable to complete requestmethodParamDesc}The object id for the associated item (cost_collector_key, etc.)
{td}
{tr}
{tr}
{thtd:class=hmethodParamType}Capabilities
{thtd}
{td:class=capabilityDesc|colspan=3methodParamName}Parm
{td}
{tr}
{tr}
{th:class=h}Use Cases
{thtd:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{td:class=usecaseDesc|colspan=3methodParamType}
{td}
{tr}
{tr}
{thtd:class=hmethodParamName}Comments/FeedbackParm
{thtd}
{td:class=commentsDesc|colspan=3}methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this servicetr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns status information and object id for the action (in this case, the comment)
{td}
{tr}
{tr}
{th:class=h|rowspan=1}ParametersErrors
{th}
{td:class=methodErrorType|colspan=methodParamType2}NoneEXISTS
{td}
{td:class=methodParamName}NonemethodErrorDesc}Object already exists
{td}
{td:class=methodParamDesc}No parameterstr}
{tdtr}
{tr}td:class=methodErrorType|colspan=2}NO_MATCH
{trtd}
{thtd:class=h}Return
{thmethodErrorDesc}Object identified by REF_ID does not exist
{td}
{tr}
{td:class=methodReturnTypemethodErrorType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]EMPTY
{td}
{td:class=methodReturnDescmethodErrorDesc}listComment ofbody modelis typesempty
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATIONNO_FAILEDAUTH
{td}
{td:class=methodErrorDesc}unable to complete requestUser does not have comment authorizations here.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypesdeleteComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypesdeleteComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesSets the status for the identified comment list of model types known by this serviceto 'D', effectively removing the comment from display.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneArray
{td}
{td:class=methodParamName}NoneParm
{td}
{td:class=methodParamDesc}No{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfoconfirmResultType|cluResultTypeInfoconfirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model typesReturns the result status and objectId for the action.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILEDNO_MATCH
{td}
{td:class=methodErrorDesc}No comment match found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}unableUser cannot todelete completethis requestauthorization.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{tr}
{table}
[Back to Operations|#Operations]
{anchor:getComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypesgetComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}RetrievesRequests the listComment offrom model types known by this servicethe system.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}NoneString
{td}
{td:class=methodParamName}NoneComment_Id
{td}
{td:class=methodParamDesc}No parametersThe specific comment to retreive
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfocommentResultType|cluResultTypeInfocommentResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}listObject containing ofthe modelassociated typescomments
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILEDNO_MATCH
{td}
{td:class=methodErrorDesc}No comment found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}unableUser does not have access to completethis requestcomment
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
{anchor:getCommentsforObject}
h4. {color:#000066}{_}Setup{_}{color}
{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getCommentsforObject
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns all comments associated with the identified object
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodName|colspan=3}getModelTypesmethodParamDesc}The type of object to look up comments for
{td}
{tr}
{tr}
{thtd:class=hmethodParamType}DescriptionString
{thtd}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this servicemethodParamName}REF_ID
{td}
{td:class=methodParamDesc}The Id for the object to look up comments for (cost_collector_key, personell_key, etc.)
{td}
{tr}
{tr}
{th:class=h|rowspan=1}ParametersReturn
{th}
{td:class=methodParamType}NonemethodReturnType|colspan=2}[commentResultType|commentResultTypeInfo Structure]
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parametersmethodReturnDesc}Object containing the associated comments. If there is no match than an empty structure is returned.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}ReturnErrors
{th}
{td:class=methodReturnTypemethodErrorType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]NO_MATCH
{td}
{td:class=methodReturnDescmethodErrorDesc}listNo ofobject model typesfound
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATIONNO_FAILEDAUTH
{td}
{td:class=methodErrorDesc}unableUser does not have access to complete request look at comments on this object.
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]
h4. {color:#000066}{_}RAFT Authorizations{_}{color}
|
Page History
Overview
Content Tools
Activity