Simple View Query v2
get
/jderest/v2/dataservice/view/{viewName}
Execute simple queries over EnterpriseOne business views.
Request
Path Parameters
-
viewName: string
The name/id of the view in EnterpriseOne (for example V0101A)
Query Parameters
-
$allowCache(optional): string
Allow the response to be cached for faster subsequent fetches.
-
$environment(optional): string
EnterpriseOne environment, if not using a default environment
-
$field(optional): array[string]
Collection Format:
multi
A list of fields to be returned in the response (for example F0101.AN8) -
$filter(optional): array[string]
Collection Format:
multi
A list of filters to be applied to fields, format is field nameoperator value (for example F0101.AN8 EQ 6001),allowed values list contains possible operators. -
Allowed Values:
[ "EQ", "NE", "STARTSWITH", "ENDSWITH", "CONTAINS", "LT", "LE", "GT", "GE" ]
-
-
$filterType(optional): string
Filter type, MATCH_ALL or MATCH_ANY of the filters passed in.
-
$limit(optional): string
Maximum number of records to return.
-
$outputType(optional): string
Output Format Type for Data Services.Allowed Values:
[ "GRID_DATA", "ORACLE", "XML", "XMLSIMPLE" ]
-
$password(optional): string
EnterpriseOne password, if not using an established session
-
$role(optional): string
EnterpriseOne role, if not using a default role
-
$sort(optional): array[string]
Collection Format:
multi
List of sort orders for each field, - is descending, + is ascending (for example -F0101.AN8 or +F0101.AN8). -
$token(optional): string
The AIS token, use if you have already established a session.
-
$username(optional): string
EnterpriseOne userid, if not using an established session
Header Parameters
-
jde-AIS-Auth(optional): string
Token
-
jde-AIS-Auth-Device(optional): string
Device Name
-
jde-AIS-MonitorOnStart(optional): boolean
Monitor on Start
-
jde-AIS-MonitorRequest(optional): string
Monitor RequestAllowed Values:
[ "monitorRequest", "monitorRequestIO" ]
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successful Execution
400 Response
Bad Request - Invalid JSON Input
403 Response
Authorization Failure
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 Simple Get View Output
The following shows an example of a simple Get data request that enables you to quickly get data when no special logic is required. Pass the username and password or token in request parameters, or you can pass Basic Auth or JWT Auth headers for authorization. For caching, you must use a token.
curl -X GET -H "Authorization: Basic SkRFOkpERQ==" "http://ais_server_url/jderest/v2/dataservice/view/V0101E?$sort=F0101.AT1&$sort=-F0101.AN8&$filter=F0101.AN8 GE 6001&$limit=5&$field=F0101.ALPH&$field=F0101.AN8"
Example Response Simple Get Output
The following example shows the contents of the response body.
{ "fs_DATABROWSE_V0101E": { "title": "Data Browser - V0101E [Address Book Update]", "data": { "gridData": { "id": 54, "fullGridId": "54", "columns": { "F0101_AN8": "Address Number", "F0101_ALPH": "Alpha Name", "F0101_AT1": "Sch Typ" }, "rowset": [ { "F0101_AT1": "A", "F0101_AN8": 10114, "F0101_ALPH": "Hilsenbeck, Darrin" }, { "F0101_AT1": "A", "F0101_AN8": 10113, "F0101_ALPH": "Shipley, Terri" }, { "F0101_AT1": "A", "F0101_AN8": 10112, "F0101_ALPH": "Harris, Eric" }, { "F0101_AT1": "A", "F0101_AN8": 10111, "F0101_ALPH": "Smith, Robert" }, { "F0101_AT1": "A", "F0101_AN8": 10110, "F0101_ALPH": "Stover, Kendra" } ], "summary": { "records": 5, "moreRecords": true } } }, "errors": [], "warnings": [] }, "stackId": 1, "stateId": 1, "rid": "6fd21fb264f9d965", "currentApp": "DATABROWSE_V0101E", "timeStamp": "2017-02-09:20.36.02", "sysErrors": [], "totalMS": 633, "renderMS": 5 }