Swagger UI

 1.0.2 

[ Base URL: app.modelshop.com/modelshop/api ]
../api/swagger.json

Main account and security management APIs

POST​/account​/user​/{userId}​/login
Log in the current user. The given user ID must correspond with the currently authenticated user.
POST​/account​/user​/{userId}​/logout
Log out the current user. The given user ID must correspond with the currently authenticated user.
POST​/account​/logFile
Retrieve the server log file - must be administrator
GET​/account​/user​/isadmin
Check if a current logged in user is an administrator.
GET​/account​/user​/public​/oauth2​/code​/{oauth2Code}
Determine whether or not the requested user ID is valid and available. If not, then provide a list of suggested alternatives.
GET​/account​/user​/public​/suggest​/{userId}
Determine whether or not the requested user ID is valid and available. If not, then provide a list of suggested alternatives.
POST​/account​/user​/public​/requestRemindUserids
Request a list of user ids for the provided email address be sent to the email
POST​/account​/user​/public​/requestPasswordReset
Request a password reset for the user identified.
POST​/account​/user​/{userId}​/resetUserPassword
Enable an administrator to reset a user's password.
POST​/account​/user​/public​/resetUserPassword
Reset the user's password using a one-time code.
POST​/account​/user​/public
Create a new user from the publicly accessible portal. The client process does not have to be logged in as it does in createUserIdentity. However, a secure token is required.
POST​/account​/user​/public​/confirm
Confirms that the user has identified him or herself by clicking on the encoded hyperlink in an email message
POST​/account​/user​/public​/requestNewVerification
Request a new user verification message to be sent.
GET​/account​/user​/isaccounts
Check if a current logged in user is an administrator.
POST​/account​/user​/password
Change the current logged in user's password. The given user ID must correspond with the currently authenticated user.
POST​/account​/user​/{userId}​/password
Change the given user's password.
GET​/account​/userNames
Provide a complete list of modelshop users.
GET​/account​/user
Provide a complete list of modelshop users.
POST​/account​/user
Create a user with the given authorities and the information provided.
GET​/account​/user​/{userId}
Provide information about the given user.
PUT​/account​/user​/{userId}
Save information about the given user.
GET​/account​/user​/currentuser
Provide information about the current user. The given user ID must correspond with the currently authenticated user.
PUT​/account​/refreshUser​/{userId}
Remove the given user from the user identity cache.
PUT​/account​/resetLogin​/{userId}
Reset the number of login attempts and the last login attempt for the specified user.
PUT​/account​/agreeToTerms​/{userId}
Update the user with agreement to terms and conditions
GET​/account​/group
Provide information about all of the groups in the user database.
GET​/account​/group​/suggest​/{groupId}
Provide a list of suggested group ID's that resemble the requested group ID.
GET​/account​/group​/{groupId}
Provide information about a specific group.
POST​/account​/group​/{groupId}
Create a new group.
PUT​/account​/group​/{groupId}
Save information about a specific group.
DELETE​/account​/group​/{groupId}
Delete a specific group.
GET​/account​/accounts
Provide information about the specified account.
GET​/account​/account​/{accountId}
Provide information about the specified account.
POST​/account​/account​/{accountId}
Create the specified account.
PUT​/account​/account​/{accountId}
Save information about the specified account.
DELETE​/account​/account​/{accountId}
Delete the specified account.
GET​/account​/organizations
Provide information about the available organizations
GET​/account​/registrationOpen
Provide an indicator of whether or not new registrations are currently accepted.
GET​/account​/sso
Return a list of single sign-on options
GET​/account​/encrypt​/{text}
Encrypt the given text
POST​/account​/admin​/startServer
Instruct modelshop to begin or resume accepting requests for service
POST​/account​/admin​/stopServer
Instruct modelshop to stop accepting requests for service
GET​/account​/admin​/serverStatus
Provide an indicator of whether or not modelshop is currently accepting requests for service.
POST​/account​/admin​/public​/usageInfo
Post usage info from another instance to be tracked by this instance.
GET​/account​/clipboard
Retrieve text from the user's clipboard
POST​/account​/clipboard
ut some text on the user's clipboard
POST​/account​/{userId}​/{modelPath}​/keytab​/{file}
Provides the ability to securely upload a security key file (e.g. kerberos keytab)
GET​/account​/guideEvent
Provide the entry from the modelshop guide identified by the key
POST​/account​/refreshGuide
Updates the guide map
POST​/account​/guideHistory
Records information about a guide event, such as whether or not the user selected an action, played media, or indicated that guidance about a particular feature is to be hidden.
POST​/account​/unHideGuide
Request to unhide all of the events in the guide.
GET​/account​/public​/property​/{propertyName}
Return a public Modelshop server property

ADMINISTRATOR

GET​/account​/admin​/usageInfo
Return usage info for this instance.
GET​/account​/admin​/instancePerformance
Return instance performance statistics

REST APIs for interacting with analytics (connected to H20 or Python)

GET​/analytics​/{userId}​/{modelPath}​/{analytic}​/errors
Retrieve any errors associated with the specified analytic.
PUT​/analytics​/{userId}​/{modelPath}​/config​/{analytic}
putAnalyticConfig updates the configuration of an analytic that is already in the model.
POST​/analytics​/{userId}​/{modelPath}​/{analytic}​/dataset
prepareDataset provides information to the user about the dataset, and accepts additional specifications in an iterative fashion
PUT​/analytics​/{userId}​/{modelPath}​/{analytic}​/dataset
commitDataset stores the dataset in the analytic server, and provides attributes that describe the dataset
GET​/analytics​/{userId}​/{modelPath}​/{analytic}​/typeOptions
Retrieves the current analytic type options from an analytic
POST​/analytics​/{userId}​/{modelPath}​/{analytic}​/train
rain an analytic
GET​/analytics​/{userId}​/{modelPath}​/{analytic}​/metrics
Retrieve the metrics from a training session with the specified analytic.
GET​/analytics​/metrics​/{metricUUID}
Gets a metric by metric uuid
POST​/analytics​/{userId}​/{modelPath}​/{analytic}​/deploy
eployRuntimeModel exports the file that encapsulates the model after training, and stores it in the model repository.
POST​/analytics​/{userId}​/{modelPath}​/{analytic}​/{command}
Posts an updated analytic config with a specific command and returns a structure with the latest model results
POST​/analytics​/{userId}​/{modelPath}​/{analytic}​/script
Posts an updated analytic config with a specific command and returns a structure with the latest model results
GET​/analytics​/{userId}​/algorithms​/{analyticType}
Gets a list of analytic algorithms available given an analytic type and analytic server name
GET​/analytics​/{userId}​/{modelPath}​/{analytic}​/describe
Posts an updated analytic config with a specific action and returns a structure with the latest model results
POST​/analytics​/{userId}​/{modelPath}​/{analytic}​/process​/{actionType}
Posts an updated analytic config with a specific action and returns a structure with the latest model results
POST​/analytics​/{userId}​/{modelPath}​/{analytic}​/download​/{file}
downloadScoringObject exports the scoring object for the selected analytic. It streams data from a file stored within the model's folder hierarchy. The client process specifies the name of a file in the URL.
POST​/analytics​/{userId}​/{modelPath}​/{analytic}​/upload​/{file}
Posts an updated analytic config with a specific command and returns a structure with the latest model results
GET​/analytics​/{userId}​/{modelPath}​/{analytic}​/options
Retrieves the current analytic options from an analytic, will return defaults if not set
PUT​/analytics​/{userId}​/{modelPath}​/{analytic}​/options
Posts an updated analytic options to an analytic
GET​/analytics​/{userId}​/{modelPath}​/{analytic}​/data
Main REST API for retrieving model records from Modelshop.
GET​/analytics​/{userId}​/{modelPath}​/{analytic}​/scores
Retrieve analytic scores for a given entity id
GET​/analytics​/public​/{userId}​/{modelPath}​/{analytic}​/file​/{token}
Downloads selected records from a view in an external format such as CSV (more to be added)

REST APIs for interacting with data connectors

GET​/connector​/{userId}​/{modelPath}​/config
Provides a list of configurations for all of the connectors associated with the given entity.
POST​/connector​/{userId}​/{modelPath}​/config
Creates a connector and stores its configuration.
GET​/connector​/{userId}​/{modelPath}​/config​/{connector}
Provides the configuration for a particular connector.
PUT​/connector​/{userId}​/{modelPath}​/config​/{connector}
Updates the configuration of an existing connnector.
GET​/connector​/{userId}​/{modelPath}​/createConfig
Synthesizes the configuration for a new connector.
POST​/connector​/{userId}​/{modelPath}​/rename​/{fromName}​/{toName}
Renames a connector, and adjusts its storage location accordingly.
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/execute
Executes a custom command on a connector
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/upload​/{file}
Imports data into a connector from a FileInputStream, storing it within the model's folder hierarchy.
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/temporaryData​/{file}
Transfers data from the client site to a temporary location within the model's folder hierarchy.
POST​/connector​/{userId}​/{modelPath}​/{connectorName}​/download​/{file}
Performs a reverse import. It streams data from a file stored within the model's folder hierarchy.
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/detectConnectorStructure​/{file}
Determines the connector's configuration and provides a copy of the model config with updates based on the contents of the given data source.
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/detectStructure​/{file}
Determines the connector's configuration and provides a copy of the model config with updates based on the contents of the given data source.
POST​/connector​/{userId}​/{modelPath}​/{connectorName}​/reload
Loads the data from the data source specified in the connector's configuration into the associated entity, which is usually a datalist.
GET​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/dataSources
Provides a list of data source names associated with the connector, along with information such as whether or not the data source is currently active, and date last loaded.
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/getDataSources
Provides a list of data source names associated with the connector
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/addDataSourceRef​/{file}
Adds the specified data source to the connector's data source references
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/deleteDataSource​/{file}
Deletes the specified data source.
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/dataSourceComponents​/{file}
Provides a list of components in the data source utilized by the connector.
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/createConnectors​/{file}
Performs all of the operations required to import and store data from a variety of data sources
POST​/connector​/{userId}​/{modelPath}​/{connectorName}​/dataPreview​/{file}
Provides a sample of the data source structured either according to the connector configuration, or according to its own format.
POST​/connector​/{userId}​/{modelPath}​/{connectorName}​/statistics​/{file}
Provides statistics about the data source.
POST​/connector​/public​/{userId}​/{modelPath}​/{connectorName}​/httppost
Provides an HTTP POST endpoint for connectors (post XML, respond XML or POST Json, respond Json which is usually a datalist.
POST​/connector​/{userId}​/{modelPath}​/{connectorName}​/httppost
Provides an HTTP POST endpoint for connectors (post XML, respond XML or POST Json, respond Json which is usually a datalist.
POST​/connector​/{userId}​/{modelPath}​/{entityName}​/{connectorName}​/testConnection
Test a connector connection, for example a database connection

REST APIs for interacting with dashboards

GET​/dashboard​/{userId}​/{modelPath}​/widget​/{dashboard}​/{widget}​/entities
Return a list of entities to select from for a selection widget
GET​/dashboard​/{userId}​/{modelPath}​/config
Return a list of dashboard configurations
POST​/dashboard​/{userId}​/{modelPath}​/config
Create a new dashboard configuration
GET​/dashboard​/{userId}​/{modelPath}​/config​/{Dashboard}
Return a specific dashboard configuration
POST​/dashboard​/{userId}​/{modelPath}​/rename​/{fromName}​/{toName}
Rename a dashboard
GET​/dashboard​/{userId}​/{modelPath}​/group
Retrieve a list of dashboard groups
POST​/dashboard​/{userId}​/{modelPath}​/group
Create a new dashboard group
POST​/dashboard​/{userId}​/{modelPath}​/renamegroup​/{fromName}​/{toName}
Rename a dashboard group
POST​/dashboard​/{userId}​/{modelPath}​/{fileName}​/upload​/{file}
Upload a dashboard image
POST​/dashboard​/{userId}​/{modelPath}​/widget​/{dashboard}​/{widget}​/newentity
Create a new entity for a widget
GET​/dashboard​/{userId}​/{modelPath}​/widget​/{dashboard}​/{widget}​/html
Returned smart HTML data with any ${expression} results evaluated
GET​/dashboard​/{userId}​/{modelPath}​/html​/{dashboard}
Return an HTML representation of a dashboard
POST​/dashboard​/{userId}​/{modelPath}​/pdf​/{dashboard}
Download a PDF representation of a dashboard

Data handler APIs provide access to datalists, including fields and calculations

GET​/data​/{userId}​/{modelPath}​/{view}​/{fieldName}​/values
Gets a list of possible values for a field - used when a field refers to some external list of values (e.g. a reference to another list by some link field)
GET​/data​/{userId}​/{modelPath}​/{view}
Main REST API for retrieving dataset records.
POST​/data​/{userId}​/{modelPath}​/{view}
POST creates new model records (note, currently same behavior as PUT)
PUT​/data​/{userId}​/{modelPath}​/{view}
Creates or updates records in the model on the indicated view.
DELETE​/data​/{userId}​/{modelPath}​/{view}
Delete all records or records based on a filter
PATCH​/data​/{userId}​/{modelPath}​/{view}
Updates records in the model on the indicated view.
GET​/data​/{userId}​/{modelPath}​/{view}​/summary
Return a summary data record that aggregates totals across selected records based on the view definition
GET​/data​/public​/{userId}​/{modelPath}​/{view}​/file​/{token}
Downloads selected records from a view in an external format such as CSV (more to be added)
GET​/data​/{userId}​/{modelPath}​/{view}​/agData
An internal API that returns data to a client side grid
GET​/data​/{userId}​/{modelPath}​/{view}​/{id}
Retrieve a single data record by entity ID
PUT​/data​/{userId}​/{modelPath}​/{view}​/{id}
Similar to @putData but for a single record based on entity ID
DELETE​/data​/{userId}​/{modelPath}​/{view}​/{id}
Similar to deleteData but for a single record
PATCH​/data​/{userId}​/{modelPath}​/{view}​/{id}
Similar to @patchData but for a single record
GET​/data​/{userId}​/{modelPath}​/{view}​/{field}​/{value}
Return a data record or records by selecting on a single field
PUT​/data​/{userId}​/{modelPath}​/{view}​/putGet​/{returnView}
The putGet service performs a putData operation, waits for the aggregators to complete, gets the data from the same view, and then returns it to the client.
POST​/data​/public​/{userId}​/{modelPath}​/{view}​/webhook​/{keyName}​/{keyValue}​/{fieldName}​/{fieldValue}
Webhook endpoint for setting a field on an entity
DELETE​/data​/{userId}​/{modelPath}​/{view}​/viewList
Similar to deleteData but for a single record
GET​/data​/{userId}​/{modelPath}​/{view}​/{columnName}​/url
Returns the hyperlink for a given view/column/row to link to another part of the model
POST​/data​/{userId}​/{modelPath}​/{view}​/release
Releases a query result set to free resources. Should be called when the client is finished using a paging query and no longer is subscribed to changes
GET​/data​/{userId}​/{modelPath}​/{view}​/changes
Subscribe to any record changes for a given query - will only return changes for fields already retrieved by the query (not all records in the query result set)
GET​/data​/{userId}​/{modelPath}​/{view}​/info
Return metadata about a recently executed view results, including the filters transformed into an expression clause
POST​/data​/{userId}​/{modelPath}​/{view}​/changes​/unsubscribe
End subscription to any changes for a view - will terminate any pending COMET asynchronous callbacks
GET​/data​/{userId}​/{modelPath}​/{view}​/keys
Gets a list of id and key names for a datalist
GET​/data​/{userId}​/{modelPath}​/{view}​/{fieldName}​/list
Gets a list of possible values for a field - used when a field refers to some external list of values (e.g. a reference to another list by some link field)
POST​/data​/{userId}​/{modelPath}​/multiDownload
Downloads selected views to an excel file (more to be added)
GET​/data​/{userId}​/{modelPath}​/{view}​/download
Downloads selected records from a view in an external format such as CSV (more to be added)
POST​/data​/{userId}​/{modelPath}​/{view}​/download
Downloads selected records from a view in an external format such as CSV (more to be added)
POST​/data​/{userId}​/{modelPath}​/{view}​/download​/{downloadId}
Downloads selected records from a view in an external format such as CSV (more to be added)
POST​/data​/{userId}​/{modelPath}​/{view}​/export
Exports selected records from a view to a file in an external format such as CSV, JSON, XML, etc.
POST​/data​/{userId}​/{modelPath}​/{view}​/getExport
Streams report data from a file stored within the model's folder hierarchy.
POST​/data​/{userId}​/{modelPath}​/multiExport
Downloads selected views to an excel file (more to be added)
GET​/data​/{userId}​/{modelPath}​/console
Sends a command to a model similar to a console command in the UI (does not require a UI).
GET​/data​/{userId}​/{modelPath}​/{view}​/{id}​/detail
REST API for retrieving detailed model records by a list of ids. This DetailData version will return a detailed data tree
POST​/data​/{userId}​/{modelPath}​/{view}​/{id}​/detail
POST creates new detailed model records (note, currently same behavior as PUT). @see putData
GET​/data​/{userId}​/{modelPath}​/{view}​/details
REST API for retrieving detailed model records based on a view. This DetailData version will return a detailed data tree
GET​/data​/{userId}​/{modelPath}​/{view}​/detaillist
Main REST API for retrieving detailed model records. This DetailData version will return a detailed data tree
GET​/data​/{userId}​/{modelPath}​/{datalist}​/normalize
Normalize the filter, sort, and group specifications, turn them into json strings, and return them to the client. Also return an ExpressionClause that matches the filters
GET​/data​/{userId}​/{modelPath}​/{viewName}​/{id}​/{field}​/document
Return an image from a field in a specific dataitem
POST​/data​/{userId}​/{modelPath}​/{viewName}​/{id}​/{field}​/document
Put an image into a field in a specific dataitem

REST APIs for interacting with datalists (primarily design time)

POST​/datalist​/{userId}​/{modelPath}​/{datalistName}​/reload
Reload the data from the connector into the associated data list.
GET​/datalist​/{userId}​/{modelPath}​/list
Retrieve a list of entries in a datalist by key
GET​/datalist​/{userId}​/{modelPath}​/fields
Retrieve a list of fields in a datalist
POST​/datalist​/{userId}​/{modelPath}​/{datalist}​/field​/{fieldName}
Add a field to a datalist
GET​/datalist​/{userId}​/{modelPath}​/{datalist}​/localExpression​/{fieldName}​/{id}
Return the source expression for a field that has a localized calculation
GET​/datalist​/{userId}​/{modelPath}
Get a list of datasets in the model
POST​/datalist​/{userId}​/{modelPath}
Create a new datalist
GET​/datalist​/{userId}​/{modelPath}​/{datalist}
Retrieve a datalist configuration for a specified datalist
POST​/datalist​/{userId}​/{modelPath}​/{fromName}​/rename​/{toName}
Rename a datalist
POST​/datalist​/{userId}​/{modelPath}​/{datalistName}​/recalculate
Initiate a recalculation for a datalist (optionally forced)

Primary REST APIs for working with models

POST​/models​/{userId}​/{modelPath}​/methodInfo
Provides the information the client process needs to display detailed information about methods and their arguments.
POST​/models​/{userId}​/{modelPath}​/item​/delete
Deletes a particular component of the model.
GET​/models​/{userId}​/categories
Provides a list of model categories
GET​/models​/{userId}​/{modelPath}
Get model configuration - provides the model's configuration (config)
PUT​/models​/{userId}​/{modelPath}
Update the model configuration. Any components of the model that have changed will be updated.
GET​/models​/public​/{userId}​/{modelPath}​/access
A public access point to retrieve models that are shared publicly
GET​/models​/{userId}​/{modelPath}​/config
Retrieve the configuration for a model
PUT​/models​/{userId}​/{modelPath}​/config
Save the configuration for a model - without opening the model
GET​/models​/{userId}
Retrieve a list of models the user has access to, optionally including shared models
POST​/models​/{userId}
Create a new model with a model configuration
POST​/models​/{userId}​/{folderPath}​/folder
Create a datalist folder inside a model
DELETE​/models​/{userId}​/{folderPath}​/folder
Delete a model folder (aka workspace)
POST​/models​/{userId}​/{fromFolderPath}​/renameFolder
Rename a model folder (called workspaces in the UI)
POST​/models​/{userId}​/{fromModelName}​/rename
Rename a model
POST​/models​/{userId}​/{fromModelName}​/saveAs
Copy or duplicate a model as a new name
POST​/models​/{userId}​/{fromModelName}​/copyShares
Copies the shares from one model to another model.
POST​/models​/{userId}​/{modelPath}​/deploy​/{toServerUrl}​/{toUserId}​/{toModelPath}
Copy or duplicate a model as a new name
POST​/models​/{userId}​/import
Copies a model configuration from the designated path to the user's repository, and establishes a new model.
POST​/models​/{userId}​/{modelPath}​/importModel​/{file}
Copies a model configuration from the file input stream, or from the designated URL into an existing model, without disturbing the data, and rebuild the model.
POST​/models​/{userId}​/{modelPath}​/importContent
Import all or part of another live model into this model.
GET​/models​/{userId}​/{modelPath}​/copy
Copy Model Content. Extract a component of a model (datalist, connector, view, etc) as Json
POST​/models​/{userId}​/{modelPath}​/paste
Paste Model Content. Send a Json formatted copy of a model item (datalist, connector, view, etc) to add to this model
POST​/models​/{userId}​/{modelPath}​/open
Retrieves the model from the repository in order to ensure it is available.
GET​/models​/{userId}​/{modelPath}​/errors
Provides a list of current model errors
POST​/models​/{userId}​/{modelPath}​/errors​/clear
Clear all error from the specified model (they may return on recalculation)
GET​/models​/{userId}​/folders
Return a list of folders inside a model
GET​/models​/{userId}​/plugins
Provides a list of accessible model plug-ins in the repository.
GET​/models​/{userId}​/templates
Provides a list of accessible model templates in the repository.
GET​/models​/tree​/{userId}
Provides a list of the accessible models in the repository, organized as a model info tree
GET​/models​/tree​/{userId}​/{infoTreeType1}​/{infoTreeType2}
Provides a list of the accessible models in the repository, organized as a model info tree.
POST​/models​/{userId}​/{modelPath}​/build
Instructs the server to rebuild the model.
POST​/models​/{userId}​/{modelPath}​/refresh
Refresh all calculations on the model, optionally forcing recalculation of cached items
POST​/models​/{userId}​/{modelPath}​/saveData
Flushes the model contents to the external data cache without waiting for the next scheduled cycle
POST​/models​/{userId}​/{modelPath}​/close
Terminates all jobs, flushes the in memory caches, and releases all dynamic memory associated with the model.
POST​/models​/{userId}​/{modelPath}​/download
Streams the model file to the client process as a .zip file. For saving locally.
GET​/models​/{userId}​/{modelPath}​/download​/{exportLocation}
Streams the model file to the client process as a .zip file. For saving locally.
POST​/models​/{userId}​/{modelPath}​/downloadConfigVersion​/{version}
Streams the specified version of the model config file to the client.
POST​/models​/{userId}​/{modelPath}​/export
Writes the model config file to a location on the server. Location is a server local path, e.g. file://home/username/archive
GET​/models​/{userId}​/{modelPath}​/treecopy​/{mode}
Provides an account of the hierarchy of model components for the purpose of performing a selective copy operation.
GET​/models​/{userId}​/{modelPath}​/tree​/{mode}
Provides an account of the model's components, organized in a hierarchy of relationships.
GET​/models​/{userId}​/{modelPath}​/item
Provides information about a particular component of the model.
POST​/models​/{userId}​/{modelPath}​/item
Creates a model component based on the configuration provided.
POST​/models​/{userId}​/{modelPath}​/item​/rename
Renames a particular model component, including its data cache.
GET​/models​/{userId}​/{modelPath}​/attributes
Provides the configuration for the specified model component, along with the configurations
PUT​/models​/{userId}​/{modelPath}​/attributes
Updates the configurations of the model components represented in the given attributes hierarchy.
GET​/models​/{userId}​/thumbs
Provides a list of model information, including name, icon, category, url, and user.
POST​/models​/{userId}​/{modelPath}​/hints
Provides the information the client process needs to display hints in the modelshop console.
GET​/models​/{userId}​/{modelPath}​/formatHelp
Provides the information the client process needs to display detailed information about methods and their arguments.
POST​/models​/{userId}​/{modelPath}​/search
Provides a list of search results for the given text.
GET​/models​/share​/{userId}​/{sharePath}
Provides a list of invitations extended to other users to share a model.
POST​/models​/share​/{userId}​/{sharePath}
Shares a model
POST​/models​/share​/accept​/{inviteKey}
Accepts a shared model
DELETE​/models​/share​/{userId}​/{sharePath}​/{inviteKey}
Revokes a previously extended invitation to share a model.
POST​/models​/{userId}​/{modelPath}​/loading
Toggles a model loading flag which avoids missing link errors when loading a model in multiple steps
POST​/models​/{userId}​/{modelPath}​/pauseRecalculate
Toggles the calculation engine from calculating in real-time
POST​/models​/{userId}​/{modelPath}​/productionMode
Toggles production mode for the model - non critical data will not be loaded
POST​/models​/{userId}​/{modelPath}​/setup​/extractdimension
Creates a new datalist that represents a dimension of an existing datalist
POST​/models​/{userId}​/{modelPath}​/setup​/projection
Creates a projection datalist

REST APIs for additional utility methods for model management

POST​/modelutil​/backup
Perform server backup to a timestamp checkpoint
POST​/modelutil​/runScript​/{file}
Uploads a file to the server scripts directory and and executes it if a .sh file
POST​/modelutil​/messagetoxml​/{userId}​/{modelPath}
Convert a message body to XML
POST​/modelutil​/xmltomessage​/{userId}​/{modelPath}
Convert XML to a message
GET​/modelutil​/profiles​/{userId}​/{modelPath}
Retrieve performance profiles for model calculations
POST​/modelutil​/profiles​/{userId}​/{modelPath}​/clear
Resets performance profiles
GET​/modelutil​/dependencies​/{userId}​/{modelPath}
Retrieve a string dump dependencies between calculations and fields
GET​/modelutil​/{userId}​/{modelPath}​/jobStatus​/{jobid}
Return detailed job status information for an identified job
GET​/modelutil​/{userId}​/{modelPath}​/version​/{modelVersion}
Provide the model config for a particular version of the model.
GET​/modelutil​/{userId}​/modelshopVersion
Provide information about modelshop, such as version, build number, release date, model config version, and license information.
POST​/modelutil​/closeAllModels
Terminates all jobs, flushes the in memory caches, and releases all dynamic memory associated with the opened models.
GET​/modelutil​/modelGraph​/{userId}​/{modelPath}
Retrieve a directed graph of items in a model and their relationships
GET​/modelutil​/dependencyGraph​/{userId}​/{modelPath}
Retrieve a directed graph of all calculations and fields in the model along with relationships
GET​/modelutil​/{userId}​/{modelPath}​/history
Provide a list of all available versions of the model, along with copies of their respective ModelInfo objects.
GET​/modelutil​/{userId}​/{modelPath}​/uuid
Return a unique identifier representing the current state of the model configuration
GET​/modelutil​/openModels
Retrieve a list of all open models including model statistics
GET​/modelutil​/memoryusage
Compute and return the percentage of memory usage out of the total available memory.
POST​/modelutil​/{userId}​/{modelPath}​/{configId}​/version
Compare the current version of the model with a copy or a different version of the model.
POST​/modelutil​/{userId}​/{modelPath}​/compare
Compare the current version of the model with a copy or a different version of the model.
POST​/modelutil​/{userId}​/{modelPath}​/compareVersions
Compare two versions of the same model. Provide a compareID that the client process may subsequently utilize to obtain deltas.
GET​/modelutil​/{userId}​/{modelPath}​/compare​/{compareId}
Provide a list of all attributes that are different in a pair of models, and describe how they differ. Based on a compare results id
POST​/modelutil​/{userId}​/{modelPath}​/compare​/{compareId}
Update the model according to the selected changes identified in the node list message.
POST​/modelutil​/{userId}​/{modelPath}​/revert​/{modelVersion}
Revert the model to the specified version. Save a backup copy of the current version. If the model is open, close it.
GET​/modelutil​/supportedCM
Check configuration management support
POST​/modelutil​/pullCM
Pull repository from configuration management
POST​/modelutil​/pushCM
Push repository to configuration management
POST​/modelutil​/deploy​/{file}
Deploy a new WAR file to the server, can be modelshop.war or another application to be deployed to the tomcat server
POST​/modelutil​/runScriptName​/{scriptName}
Runs an existing script file on the server, requires admin rights
GET​/modelutil​/{userId}​/{modelPath}​/{view}​/{field}​/fieldStats
Provide statistics and other information about the data stored in the specified field in the specified view.
GET​/modelutil​/{userId}​/{modelPath}​/runningJobs
Provide a list of all attributes that are different in a pair of models, and describe how they differ.
POST​/modelutil​/{userId}​/{modelPath}​/cancelJob​/{jobid}
Cancel a running or scheduled job
POST​/modelutil​/{userId}​/{modelPath}​/cancelJobs
Cancel all running jobs, optionally forcing

Handles ping requests for health monitoring

GET​/ping​/pingbounce​/{remoteAddress}
Used to bounce a ping off another server, used to see if server is accessible from the internet
GET​/ping​/ping
Ping the server to see if it's responsive, does not require authorization
GET​/ping​/authorizedPing
Ping the server to see if it's responsive with authorization

REST API for handling model resources such as documents and images

GET​/resource​/theme​/image​/{extjs}
Retrieves a theme image for whitelabeling purposes
GET​/resource​/theme​/file​/{extjs}
Retrieves a theme text file for whitelabeling purposes
PUT​/resource​/{userId}​/{modelPath}​/html​/{extjs}
Store an HTML document in the model, local path starts after /html/
GET​/resource​/{userId}​/{modelPath}​/{file}
Retrieve a file from a model at a local path
POST​/resource​/{userId}​/{modelPath}​/{file}
Upload a file to the model at a given local path
POST​/resource​/upload​/{fileType}​/{location}​/{file}
Upload a file to the server (non model files)
GET​/resource​/image​/{fileType}​/{location}​/{file}
Retrieve a general image from the server
GET​/resource​/file​/{fileType}​/{location}​/{file}
Retrieve a general file from the server

REST APIs for managing rulebases

GET​/rulebase​/{userId}​/{modelPath}​/results​/{entityName}
Retrieve rule results for a named rulebase
GET​/rulebase​/{userId}​/{modelPath}​/{rulebase}​/{field}​/{value}
Return a subset of rule results for a named rulebase using a field level filter
GET​/rulebase​/{userId}​/{modelPath}​/config
Return the list of rulebase configurations for an entity type
POST​/rulebase​/{userId}​/{modelPath}​/config
Create a new rulebase configuration
GET​/rulebase​/{userId}​/{modelPath}​/config​/{rulebase}
Return a rulebase config for a named rulebase
PUT​/rulebase​/{userId}​/{modelPath}​/config​/{rulebase}
Update an existing rulebase configuration
POST​/rulebase​/{userId}​/{modelPath}​/rename​/{fromName}​/{toName}
Rename a rulebase
POST​/script​/{userId}​/{modelPath}
Create a new script. Just stores configuration, will not modify any related job run information
POST​/script​/{userId}​/{modelPath}​/{scriptPath}​/run
Manually trigger running a script

Models

ServiceError
UserContact
UserIdentity
UserInformation
UserInformationMessage
DefaultMessage
SuggestUserIdentityMessage
UserProfileMessage
CategoryListMessage
CategoryValue
UserInformationListMessage
GroupIdentity
GroupIdentityListMessage
SuggestGroupIdentityMessage
GroupIdentityMessage
AccountInfo
AccountInfoMessage
EntityUsage
IPUsage
ModelUsage
UsageInfo
UsageInfoMessage
UserUsage
InstancePerformanceMessage
GuideEvent
GuideEventMessage
AnalyticConfig
AnalyticConfigMessage
AnalyticDatasetConfig
AnalyticDatasetField
AnalyticOption
Expression
ModelshopAlgorithmConfig
ScorecardConfig
ScorecardWeightConfig
ServerWorkspaceConfig
Share
WebFunctionCommandConfig
JobStatus
JobStatusMessage
AnalyticDatasetMessage
AnalyticMetrics
AnalyticMetricsChart
AnalyticMetricsMessage
AnalyticMetricsTable
AnalyticMetricsText
AxisConfig
ChartColumnFilter
ChartConfig
ChartTableColumn
ChartTableConfig
GanttConfig
GeneratorError
GeoLocation
GeoMapConfig
GraphEdgeConfig
GraphNodeConfig
GridConfig
LabelConfig
MarkerConfig
OverlayConfig
PivotConfig
PivotGroup
PivotValue
SeriesConfig
AnalyticOutput
AnalyticsMessage
ConsoleMessage
AnalyticAlgorithm
AnalyticsAlgorithmsMessage
AnalyticsOptionsMessage
FieldStats
InfoStat
RuleResult
SummaryKey
SummaryStats
ViewListMessage
AnalyticScoresMessage
ChartConfigsMessage
ChartConfigMessage
ChartDataMessage
ChartField
ChartLayout
ConnectorAuth
ConnectorConfig
ConnectorField
ConnectorsMessage
DataSourceConfig
DatabaseConnectionConfig
DatabaseMediaConfig
DatabaseSourceConfig
ExcelMediaConfig
FileSourceConfig
JsonMediaConfig
MediaComponent
MediaConfig
ParseHint
RawMediaConfig
TextMediaConfig
WebServiceParameter
WebServiceSourceConfig
XmlMediaConfig
ConnectorMapField
ConnectorMessage
ConnectorDataSourceComponentsMessage
Alias
Amortization
Argument
ArgumentValue
BinConfig
ButtonConfig
ButtonPanelConfig
Calculation
ClauseField
ClauseLiteral
ColorRange
ColorStep
ColumnGroup
CubeConfig
DashboardConfig
DashboardGroupConfig
DashboardWidgetConfig
DataField
DataImportConfig
DataImportItem
DataItemConfig
DataLinkConfig
DateRange
DecisionConditionLogic
DecisionFlowConfig
DecisionStepAction
DecisionStepConfig
DecisionStepLayout
DecisionTransition
DimensionConfig
ExpressionClause
ExtraConfig
ExtractionConfig
FactConfig
Field
FieldControl
FieldMap
Filter
FolderInfo
FormWidgetConfig
Format
GaugeInfo
GitManagerConfig
InfoCurrency
InfoDataItem
InfoDate
InfoDecision
InfoNumber
InfoRaw
InfoText
LookupMap
ModelAccess
ModelConfig
ModelInfo
ModelMessage
ModelPluginConfig
ModelStatistics
PinValue
ProjectionConfig
Reference
ReferenceSelector
RuleAction
RuleActionArgumentResult
RuleActionResult
RuleConfig
RulebaseConfig
ScriptConfig
SecuritySpec
Select
Series
Sort
SummaryField
SummaryType
TableCell
TableColumn
TableRow
TableWidgetConfig
TransformConfig
ViewConfig
ViewExportSpecification
ViewExportTemplate
ViewMatrix
ViewWidgetConfig
WebServiceCall
WidgetController
ConnectorModelMessage
ConnectorModelConfig
ConnectorDataSourceInfoMessage
DataSourceInfo
DataPreviewMessage
ConnectorMapping
ConnectorStatsMessage
CubeMessage
CubePivotMarker
CubeConfigsMessage
CubeConfigMessage
FieldValue
ViewFieldListMessage
DashboardConfigsMessage
DashboardConfigMessage
DashboardGroupConfigsMessage
DashboardGroupConfigMessage
DashboardData
DashboardDataMessage
DashboardValue
ListMessage
Message
ViewInfoMessage
UnsubscribeMessage
JobStatusListMessage
ViewExportSpecMessage
DataDetail
ViewDetailMessage
NormalizeFilterSortGroupMessage
DatalistsMessage
DatalistMessage
DecisionFlowConfigsMessage
DecisionFlowConfigMessage
DecisionFlowControl
Hint
HintParameter
MethodHintListMessage
ModelCopyTree
ModelCopyTreeMessage
ImportModelMessage
FolderListMessage
ModelListMessage
ModelInfoTree
ModelInfoTreeMessage
ModelItemTree
ModelItemTreeMessage
SearchOption
Component
Config
ItemMessage
AttributesMessage
ModelAttributes
ModelThumb
ModelThumbsMessage
SyntaxError
VisualExpression
VisualExpressionMessage
HintContext
FormatHelpMessage
SearchInfo
SearchInfoMessage
SearchResults
ShareListMessage
ShareMessage
ExtractDimensionMessage
ProjectionMessage
ModelshopVersionMessage
ConfigGraphEdge
ConfigGraphMessage
ConfigGraphNode
HistoryMessage
ModelHistory
ModelStatisticsMessage
NodeListMessage
DataItemReference
DataItemReferenceMessage
DataItemFieldStatsMessage
FieldDataStats
HistogramPoint
RuleResultMessage
RulebaseConfigsMessage
RulebaseConfigMessage
ScriptInfo
ScriptInfoMessage
ScriptRunInfo
ScriptInfoTree
ScriptInfoTreeMessage
ViewMessage
ViewsMessage
Online validator badge