Jump to

• Request
• Response
• Examples

Get Configuration v2

post

/jderest/v2/defaultconfig

Get AIS Server configuration information and available capabilities.

Request

Query Parameters

• all(optional): string
  Return all capibilities for all versions, not just since this version
• bypassJASTest(optional): string
  Do not validate connection to JAS server
• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Execution

Body ()

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.

{
    "type":"object",
    "properties":{
        "jasHost":{
            "type":"string",
            "description":"The default EnterpriseOne HTML (JAS) Server host configured for this AIS Server."
        },
        "jasPort":{
            "type":"string",
            "description":"The default EnterpriseOne HTML (JAS) Server port configured for this AIS Server."
        },
        "jasProtocol":{
            "type":"string",
            "description":"The default EnterpriseOne HTML (JAS) Server protocol configured for this AIS Server."
        },
        "defaultEnvironment":{
            "type":"string",
            "description":"The default EnterpriseOne environment configured for this AIS Server."
        },
        "defaultRole":{
            "type":"string",
            "description":"The default EnterpriseOne role configured for this AIS Server."
        },
        "displayEnvironment":{
            "type":"boolean",
            "description":"Primarily used for mobile, indicates if environment should be displayed on client login screen."
        },
        "displayRole":{
            "type":"boolean",
            "description":"Primarily used for mobile, indicates if role should be displayed on client login screen."
        },
        "displayJasServer":{
            "type":"boolean",
            "description":"Primarily used for mobile, indicates if HTML (JAS) Server should be displayed on client login screen."
        },
        "defaultJasServer":{
            "type":"string",
            "description":"The default EnterpriseOne HTML (JAS) Server configured for this AIS Server."
        },
        "ssoAllowed":{
            "type":"boolean",
            "description":"Primarily used for mobile, indicates if mobile apps allow SSO."
        },
        "sessionTimeout":{
            "type":"string",
            "description":"The value configured for session timeout for this AIS Server."
        },
        "timeToLive":{
            "type":"string",
            "description":"The value configured for session time to live for this AIS Server."
        },
        "aisVersion":{
            "type":"string",
            "description":"The version (release level) of this AIS Server."
        },
        "capabilityList":{
            "type":"array",
            "description":"The list of capabilities of this AIS Server.",
            "items":{
                "$ref":"#/definitions/Capability"
            }
        },
        "requiredCapabilityMissing":{
            "type":"boolean",
            "description":"If you included a required capability list in your request this indicates if that capability is available on this AIS Server."
        },
        "keepJasSessionOpen":{
            "type":"boolean",
            "description":"The value configured for Keep HTML (JAS) Server Sessions open for this AIS Server."
        },
        "disconnectedTimeout":{
            "type":"string",
            "description":"Primarily for mobile, the value configured for disconnected timeout for this AIS Server."
        },
        "isRunningInWLS":{
            "type":"boolean",
            "description":"Will be true if the AIS Server is deployed to Oracle WebLogic Server."
        },
        "readCachTTL":{
            "type":"integer",
            "format":"int64",
            "description":"Time in milliseconds, configured for read cache entries to live.  Value of zero means read cachine is off."
        },
        "defaultCachingOn":{
            "type":"boolean",
            "description":"When the value is true this AIS Server is currently configured to always cache read requests for FormService and DataService calls."
        },
        "enableMonitoring":{
            "type":"boolean",
            "description":"When the value is true this AIS Server is currently configured to enable monitoring of requests."
        },
        "schedulerServer":{
            "type":"boolean",
            "description":"When the value is true this AIS Server is currently configured to be a scheduler server, the Quartz Scheduler is automatically started."
        },
        "externalJASURL":{
            "type":"string",
            "description":"External HTML Server url if different from the JAS url configured for AIS communications."
        },
        "groovyAvailable":{
            "type":"boolean",
            "description":"Indicates if Groovy properly configured with libraries available and engine initialized."
        },
        "jythonAvailable":{
            "type":"boolean",
            "description":"Indicates if Jython properly configured with libraries available and engine initialized."
        },
        "internalUseEnabled":{
            "type":"boolean",
            "description":"Indicates if internal use is enabled."
        },
        "jrubyAvailable":{
            "type":"boolean",
            "description":"Indicates if JRuby properly configured with libraries available and engine initialized."
        }
    },
    "description":"Response Object for Default Config Service."
}

Nested Schema : capabilityList

Type: array

The list of capabilities of this AIS Server.

Show Source

• Array of: object Capability
  Information about an individual capability.

{
    "type":"array",
    "description":"The list of capabilities of this AIS Server.",
    "items":{
        "$ref":"#/definitions/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.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the capability."
        },
        "shortDescription":{
            "type":"string",
            "description":"A short description of the capability."
        },
        "longDescription":{
            "type":"string",
            "description":"A long description of the capability"
        },
        "asOfRelease":{
            "type":"string",
            "description":"The release in which the capability was first made available."
        },
        "sinceVersion":{
            "type":"string",
            "description":"The Service Version in which the capability was first made available."
        }
    },
    "description":"Information about an individual capability."
}

415 Response

Invalid Content-Type Header - Must use application/json

500 Response

Server Failed to Process Request

Body ()

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.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

Back to Top

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/v2/defaultconfig/

Example Response

The following example shows the contents of the response body.

{
    "jasHost": "aishot",
    "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": "version2services",
            "shortDescription": "Version 2 Service URL",
            "longDescription": "New capabilities available with V2 Services",
            "asOfRelease": "9.2.1.2",
            "sinceVersion": "v2"
        },
        {
            "name": "nextPage",
            "shortDescription": "Next Page for App Stack and Data Request",
            "longDescription": "Ability to request next data set for Application Stack and Data Request",
            "asOfRelease": "9.2.1.2",
            "sinceVersion": "v2"
        },
        {
            "name": "simpleGetServices",
            "shortDescription": "Simple GET Data Requests",
            "longDescription": "Ability to perform Data Requests with GET operation",
            "asOfRelease": "9.2.1.2",
            "sinceVersion": "v2"
        },
        {
            "name": "formServiceOrderBy",
            "shortDescription": "Order By in Form Service",
            "longDescription": "Ability to order by columns in a grid with form service",
            "asOfRelease": "9.2.1.2",
            "sinceVersion": "v2"
        },
        {
            "name": "messageService",
            "shortDescription": "Send Message Service",
            "longDescription": "Ability to send E-mail or Work Center messages",
            "asOfRelease": "9.2.1.2",
            "sinceVersion": "v2"
        },
        {
            "name": "reportService",
            "shortDescription": "Report Service",
            "longDescription": "Ability to launch an determine the status of an EntepriseOne Report",
            "asOfRelease": "9.2.2.4",
            "sinceVersion": "v2"
        }
    ],
    "requiredCapabilityMissing": false,
    "keepJasSessionOpen": true,
    "disconnectedTimeout": "12",
    "isRunningInWLS": true,
    "readCachTTL": 60000,
    "defaultCachingOn": true
}

Back to Top