Get Configuration v1
post
/jderest/defaultconfig
Get AIS Server configuration information and available capabilities.
Request
Query Parameters
-
requiredCapabilities(optional): string
Specify the AIS capabilities your client requires. These capabilities must be available on the AIS Server.
-
settings(optional): string
Return the instance settings excluding the capibilities
Response
Supported Media Types
- application/json
200 Response
Successful Execution
Root Schema : DefaultConfig
Type:
object
Response Object for Default Config Service.
Show Source
-
aisVersion(optional):
string
The version (release level) of this AIS Server.
-
capabilityList(optional):
array capabilityList
The list of capabilities of this AIS Server.
-
defaultCachingOn(optional):
boolean
When the value is true this AIS Server is currently configured to always cache read requests for FormService and DataService calls.
-
defaultEnvironment(optional):
string
The default EnterpriseOne environment configured for this AIS Server.
-
defaultJasServer(optional):
string
The default EnterpriseOne HTML (JAS) Server configured for this AIS Server.
-
defaultRole(optional):
string
The default EnterpriseOne role configured for this AIS Server.
-
disconnectedTimeout(optional):
string
Primarily for mobile, the value configured for disconnected timeout for this AIS Server.
-
displayEnvironment(optional):
boolean
Primarily used for mobile, indicates if environment should be displayed on client login screen.
-
displayJasServer(optional):
boolean
Primarily used for mobile, indicates if HTML (JAS) Server should be displayed on client login screen.
-
displayRole(optional):
boolean
Primarily used for mobile, indicates if role should be displayed on client login screen.
-
enableMonitoring(optional):
boolean
When the value is true this AIS Server is currently configured to enable monitoring of requests.
-
externalJASURL(optional):
string
External HTML Server url if different from the JAS url configured for AIS communications.
-
groovyAvailable(optional):
boolean
Indicates if Groovy properly configured with libraries available and engine initialized.
-
internalUseEnabled(optional):
boolean
Indicates if internal use is enabled.
-
isRunningInWLS(optional):
boolean
Will be true if the AIS Server is deployed to Oracle WebLogic Server.
-
jasHost(optional):
string
The default EnterpriseOne HTML (JAS) Server host configured for this AIS Server.
-
jasPort(optional):
string
The default EnterpriseOne HTML (JAS) Server port configured for this AIS Server.
-
jasProtocol(optional):
string
The default EnterpriseOne HTML (JAS) Server protocol configured for this AIS Server.
-
jrubyAvailable(optional):
boolean
Indicates if JRuby properly configured with libraries available and engine initialized.
-
jythonAvailable(optional):
boolean
Indicates if Jython properly configured with libraries available and engine initialized.
-
keepJasSessionOpen(optional):
boolean
The value configured for Keep HTML (JAS) Server Sessions open for this AIS Server.
-
readCachTTL(optional):
integer(int64)
Time in milliseconds, configured for read cache entries to live. Value of zero means read cachine is off.
-
requiredCapabilityMissing(optional):
boolean
If you included a required capability list in your request this indicates if that capability is available on this AIS Server.
-
schedulerServer(optional):
boolean
When the value is true this AIS Server is currently configured to be a scheduler server, the Quartz Scheduler is automatically started.
-
sessionTimeout(optional):
string
The value configured for session timeout for this AIS Server.
-
ssoAllowed(optional):
boolean
Primarily used for mobile, indicates if mobile apps allow SSO.
-
timeToLive(optional):
string
The value configured for session time to live for this AIS Server.
Nested Schema : capabilityList
Type:
array
The list of capabilities of this AIS Server.
Show Source
-
Array of:
object Capability
Information about an individual capability.
Nested Schema : Capability
Type:
object
Information about an individual capability.
Show Source
-
asOfRelease(optional):
string
The release in which the capability was first made available.
-
longDescription(optional):
string
A long description of the capability
-
name(optional):
string
The name of the capability.
-
shortDescription(optional):
string
A short description of the capability.
-
sinceVersion(optional):
string
The Service Version in which the capability was first made available.
415 Response
Invalid Content-Type Header - Must use application/json
500 Response
Server Failed to Process Request
Root Schema : ServiceErrorResponse
Type:
object
Error Response
Show Source
-
errorText(optional):
string
-
exception(optional):
string
The class of the exception if an exception was thrown.
-
exceptionId(optional):
string
ExceptionId, only if an exception record was written to the F980060
-
message(optional):
string
Details about the error.
-
status(optional):
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp(optional):
string
The timestamp indicating the time the error message was returned.
-
type(optional):
string
Optional type of error
-
userDefinedErrorText(optional):
string
Optional error text added to an orchestration step.
Examples
Example Request
The following shows an example of a default config request. The default configurations currently on the AIS Server are returned in the response.
curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/defaultconfig/
Example Response
The following example shows the contents of the response body.
{ "jasHost": "aishost", "jasPort": "7552", "jasProtocol": "http", "defaultEnvironment": "JDV920", "defaultRole": "*ALL", "displayEnvironment": true, "displayRole": true, "displayJasServer": true, "defaultJasServer": "http://jashost:7552", "ssoAllowed": true, "sessionTimeout": "20", "timeToLive": "720", "aisVersion": "EnterpriseOne 9.2.2.4", "capabilityList": [ { "name": "grid", "shortDescription": "Grid Actions", "longDescription": "Ability to update, insert and delete grid records.", "asOfRelease": "9.1.4.4", "sinceVersion": null }, { "name": "editable", "shortDescription": "Enabled/Disabled", "longDescription": "Ability to indicate if form field or grid cell is editable (enabled) or not (disabled).", "asOfRelease": "9.1.4.4", "sinceVersion": null }, { "name": "log", "shortDescription": "Logging", "longDescription": "Endpoint exposed for logging to AIS Server log from client", "asOfRelease": "9.1.4.6", "sinceVersion": null }, { "name": "processingOption", "shortDescription": "Processing Options", "longDescription": "Processing Option Service exposed for fetching PO values from E1", "asOfRelease": "9.1.4.6", "sinceVersion": null }, { "name": "ignoreFDAFindOnEntry", "shortDescription": "Ignore FDA Find On Entry", "longDescription": "Ability to use the IgnoreFDAFindOnEntry flag", "asOfRelease": "9.1.4.6", "sinceVersion": null }, { "name": "selectAllGridRows", "shortDescription": "Select or Unselect All Grid Rows", "longDescription": "Ability to use select and unselect all grid rows, or unselect a single row in an action event", "asOfRelease": "9.1.5", "sinceVersion": null }, { "name": "applicationStack", "shortDescription": "Operations on a Stack of E1 Applications", "longDescription": "Ability to maintain a stack of open E1 applications and operate forms that are called", "asOfRelease": "9.1.5", "sinceVersion": null }, { "name": "thumbnailSize", "shortDescription": "Specify desired thumbnail size for MO List", "longDescription": "Ability to request a specific sized thumbnail images in a Media Object List Request", "asOfRelease": "9.1.5", "sinceVersion": null }, { "name": "gridCellClick", "shortDescription": "Click Grid Cell Hyperlink", "longDescription": "Ability to use GridCellClick event, to execute hyperlink in grid", "asOfRelease": "9.1.5.2", "sinceVersion": null }, { "name": "query", "shortDescription": "Query", "longDescription": "Ability to use Query on forms that support it", "asOfRelease": "9.1.5.2", "sinceVersion": null }, { "name": "taskAuthorization", "shortDescription": "Task Authorization", "longDescription": "Ability to Receive a list of authorized tasks based on either a task view id or the task id and parent id with in a task view.", "asOfRelease": "9.1.5.2", "sinceVersion": null }, { "name": "urlMediaObjects", "shortDescription": "URL Media Objects", "longDescription": "Ability to view, add or delete URL type media objects", "asOfRelease": "9.1.5.2", "sinceVersion": null }, { "name": "jargon", "shortDescription": "Data Item Jargon Service", "longDescription": "Ability to request data item descriptions based on users language and jargon (system) code", "asOfRelease": "9.1.5.3", "sinceVersion": null }, { "name": "aliasNaming", "shortDescription": "Alias Naming", "longDescription": "Ability receive form service responses with fields named by Data Dictionary alias", "asOfRelease": "9.1.5.3", "sinceVersion": null }, { "name": "orchestrator", "shortDescription": "Orchestrator", "longDescription": "Ability process multiple service requests, rules, cross references in a single call based on defined orchestration metadata", "asOfRelease": "9.1.5.5", "sinceVersion": null }, { "name": "basicAuth", "shortDescription": "Basic Authorization", "longDescription": "Ability receive basic authorization credentials for the token request service", "asOfRelease": "9.1.5.5", "sinceVersion": null }, { "name": "oAuth", "shortDescription": "OAM OAuth 2-Legged", "longDescription": "Ability support 2-Legged OAM oAuth flow and validate OAM Access Tokens supplied by a client", "asOfRelease": "9.1.5.5", "sinceVersion": null }, { "name": "dataservice", "shortDescription": "Data Service", "longDescription": "Ability to execute queries directly against tables and views", "asOfRelease": "9.1.5.5", "sinceVersion": null }, { "name": "actionControls", "shortDescription": "Show Action Controls", "longDescription": "Ability to request that action controls are returned in the form service response", "asOfRelease": "9.2.0.2", "sinceVersion": null }, { "name": "aggColumnClick", "shortDescription": "Click Grid Column Aggregate", "longDescription": "Ability to send an event to click the aggregation icon on a grid column", "asOfRelease": "9.2.0.2", "sinceVersion": null }, { "name": "dataServiceAggregation", "shortDescription": "Data Service Aggregation", "longDescription": "Ability to request aggregation of the data in a data service call", "asOfRelease": "9.2.0.2", "sinceVersion": null }, { "name": "outputType", "shortDescription": "Output Type", "longDescription": "Ability to request different output format for form service or data service responses", "asOfRelease": "9.2.0.2", "sinceVersion": null }, { "name": "preferenceService", "shortDescription": "Preference Service", "longDescription": "Ability to save and retrieve preference values by user", "asOfRelease": "9.2.0.2", "sinceVersion": null }, { "name": "orchestrationDiscovery", "shortDescription": "Orchestration Discovery", "longDescription": "Ability to discover available orchestrations", "asOfRelease": "9.2.0.2", "sinceVersion": null }, { "name": "queryObjectName", "shortDescription": "Query Object Name", "longDescription": "Ability to request an existing query to be used for a FormService or DataService request", "asOfRelease": "9.2.0.2", "sinceVersion": null }, { "name": "watchlist", "shortDescription": "Watchlist", "longDescription": "Ability to request an existing Watchlist value", "asOfRelease": "9.2.0.3", "sinceVersion": null }, { "name": "aggregationCurrencyDecimals", "shortDescription": "Aggregation Currency Decimals", "longDescription": "Ability to request aggregation of currency columns and apply currency processing for decimals on aggregated data", "asOfRelease": "9.2.0.3", "sinceVersion": null }, { "name": "dataServiceOrderBy", "shortDescription": "Data Service Browse Order By", "longDescription": "Ability to request columns to order by for browse type data service requests", "asOfRelease": "9.2.0.5", "sinceVersion": null }, { "name": "availableQueries", "shortDescription": "List Available Saved Queries", "longDescription": "Ability to request the list of available saved queries for an form, table or view", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "complexQuery", "shortDescription": "Complex Query", "longDescription": "Ability to specify a complex ad hoc query, several combined queries", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "dateGroupSpecialHandling", "shortDescription": "Date Group By Special Handling", "longDescription": "Ability to specify the date format returned for aggregations grouped by date columns", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "asIfCurrency", "shortDescription": "As If Currency", "longDescription": "Ability to specify a single currency for all values returned in an aggregation with currency decimal processing", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "queryDetails", "shortDescription": "User Defined Query Details", "longDescription": "Ability to get the details of an individual user defined query", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "applicationQueryInDataService", "shortDescription": "Application Query in Data Service", "longDescription": "Ability to request an existing query defined for a form, to be used in a data service request over the same view as the form", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "queryCombining", "shortDescription": "Combine Saved and Ad Hoc Query", "longDescription": "Ability to request both a saved query and an ad hoc query be combined with an AND to filter data for a form service or data service request", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "queryAggegration", "shortDescription": "Use Saved Query in Aggregation", "longDescription": "Ability to request filtering of data with a saved query for an aggregation data request", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "turboMode", "shortDescription": "Turbo Mode", "longDescription": "Ability to request optimized grid processing in form service request, where only the requested columns are processed", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "timings", "shortDescription": "Request Timing Information", "longDescription": "Ability to request timing information for form service and data service processing times", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "availableWatchlists", "shortDescription": "List Available Watchlists", "longDescription": "Ability to request the list of available watchlists for a user", "asOfRelease": "9.2.1.0", "sinceVersion": null }, { "name": "readCaching", "shortDescription": "Cache Read Responses", "longDescription": "Ability to cache responses of Data Requests and Read Form Service Requests", "asOfRelease": "9.2.1.1", "sinceVersion": null } ], "requiredCapabilityMissing": false, "keepJasSessionOpen": true, "disconnectedTimeout": "12", "isRunningInWLS": true, "readCachTTL": 60000, "defaultCachingOn": true, "deprecated": true }