Simple Table Query v2
get
/jderest/v2/dataservice/table/{tableName}
Execute simple queries over EnterpriseOne tables.
Request
Path Parameters
-
tableName: string
The name/id of the table in EnterpriseOne (for example F0101)
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:
multiA list of fields to be returned in the response (for example F0101.AN8). -
$filter(optional): array[string]
Collection Format:
multiA list of filters to be applied to fields. The format or syntax includes the field name, operator, and value (for example F0101.AN8 EQ 6001). Click Items to view a list of allowed values for the operators.-
Allowed Values:
[ "EQ", "NE", "STARTSWITH", "ENDSWITH", "CONTAINS", "LT", "LE", "GT", "GE" ]
-
-
$filterType(optional): string
Apply MATCH_ALL or MATCH_ANY filter type to the list of filters.Allowed Values:
[ "MATCH_ALL", "MATCH_ANY" ] -
$limit(optional): string
Maximum number of records to return.
-
$outputType(optional): string
The output format type for data services.Allowed Values:
[ "GRID_DATA", "ORACLE", "XML", "XMLSIMPLE" ] -
$password(optional): string
The EnterpriseOne user password, which is required if not using an established session.
-
$role(optional): string
The EnterpriseOne role, if not using a default role.
-
$sort(optional): array[string]
Collection Format:
multiList of sort orders for each field: - for descending, + for 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 user ID, which is required 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:
objectError 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 Output
Example Simple Get 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 the request parameters, or you can pass Basic Auth or JWT Auth headers for authorization. For caching, you must use a token. Example Response Simple Get Output - The following shows an example of a simple Get data request with a descending "$sort". Pass the username and password or token in the 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/table/F0101?$filter=F0101.AN8%20EQ%206001"
Example Response Simple Get Output
The following example shows the contents of the response body.
{
"fs_DATABROWSE_F0101":{
"title":"Data Browser - F0101 [Address Book Master]",
"data":{
"gridData":{
"id":146,
"fullGridId":"146",
"columns":{
"F0101_AN8":"Address Number",
"F0101_ALKY":"Long Address",
"F0101_TAX":"Tax ID",
"F0101_ALPH":"Alpha Name",
"F0101_DC":"Description Compressed",
"F0101_MCU":"Business Unit",
"F0101_SIC":"Industry Class",
"F0101_LNGP":"L ",
"F0101_AT1":"Sch Typ",
"F0101_CM":"C M",
"F0101_TAXC":"Per/ Corp",
"F0101_AT2":"N I",
"F0101_AT3":"HRM Records",
"F0101_AT4":"T 4",
"F0101_AT5":"T 5",
"F0101_ATP":"P T",
"F0101_ATR":"C T",
"F0101_ATPR":"C 5",
"F0101_AB3":"Code 3",
"F0101_ATE":"E M",
"F0101_SBLI":"Subledger Inactive",
"F0101_EFTB":"Begin Date",
"F0101_AN81":"Address Number",
"F0101_AN82":"Address Number",
"F0101_AN83":"Address Number",
"F0101_AN84":"Address Number",
"F0101_AN86":"Address Number",
"F0101_AN85":"Special Payee",
"F0101_AC01":"Cat Code 1",
"F0101_AC02":"Act Rep",
"F0101_AC03":"Cat Code 3",
"F0101_AC04":"Geo Reg",
"F0101_AC05":"Cat Code 5",
"F0101_AC06":"Cat Code 6",
"F0101_AC07":"Tax Rpt",
"F0101_AC08":"Cat Code 8",
"F0101_AC09":"Cat Code 9",
"F0101_AC10":"Cat Code 10",
"F0101_AC11":"Sal Reg",
"F0101_AC12":"Cat Code 12",
"F0101_AC13":"Lin Bus",
"F0101_AC14":"Sls Vol",
"F0101_AC15":"Cat Code 15",
"F0101_AC16":"Cat Code 16",
"F0101_AC17":"Cat Code 17",
"F0101_AC18":"Cat Code 18",
"F0101_AC19":"Cat Code 19",
"F0101_AC20":"Cat Code 20",
"F0101_AC21":"CC 21",
"F0101_AC22":"CC 22",
"F0101_AC23":"CC 23",
"F0101_AC24":"CC 24",
"F0101_AC25":"CC 25",
"F0101_AC26":"Conti nent",
"F0101_AC27":"CC 27",
"F0101_AC28":"CC 28",
"F0101_AC29":"CC 29",
"F0101_AC30":"CC 30",
"F0101_GLBA":"Bank Acct-G/L",
"F0101_PTI":"Time In",
"F0101_PDI":"Date In",
"F0101_MSGA":"A C",
"F0101_RMK":"Remark ",
"F0101_TXCT":" Certificate",
"F0101_TX2":"Individual Tax ID",
"F0101_ALP1":"Alternate Char Set Name",
"F0101_URCD":"User Code",
"F0101_URDT":"User Date",
"F0101_URAT":"User Amount",
"F0101_URAB":"User Number",
"F0101_URRF":"User Reference",
"F0101_USER":"User ID",
"F0101_PID":"Program ID",
"F0101_UPMJ":"Date Updated",
"F0101_JOBN":"Work Stn ID",
"F0101_UPMT":"Time Updated",
"F0101_PRGF":"P F",
"F0101_SCCLTP":"Shortcut Client Type",
"F0101_TICKER":"Ticker ",
"F0101_EXCHG":"Stock Exchange ",
"F0101_DUNS":"DUNS Number",
"F0101_CLASS01":"Classification Code 01",
"F0101_CLASS02":"Classification Code 02",
"F0101_CLASS03":"Classification Code 03",
"F0101_CLASS04":"Classification Code 04",
"F0101_CLASS05":"Classification Code 05",
"F0101_NOE":"Number Of Employee ",
"F0101_GROWTHR":"Growth Rate ",
"F0101_YEARSTAR":"Year Started ",
"F0101_AEMPGP":"Employee Group Approvals",
"F0101_ACTIN":"Future Indicator",
"F0101_REVRNG":"Revenue ",
"F0101_SYNCS":"Synchronization Status",
"F0101_PERRS":"Previous Error Status",
"F0101_CAAD":"Server Status"
},
"rowset":[
{
"F0101_DC":"AISAPPSTACKTESTSTACK1",
"F0101_ATP":"Y",
"F0101_EFTB":null,
"F0101_JOBN":"denaa000.u",
"F0101_AC19":" ",
"F0101_AC18":" ",
"F0101_ALP1":"ALLENRAY",
"F0101_USER":"CB8789894",
"F0101_MCU":" 1",
"F0101_ATR":"N",
"F0101_AC20":" ",
"F0101_TAX":"798525841",
"F0101_GLBA":" ",
"F0101_PRGF":" ",
"F0101_GROWTHR":0,
"F0101_ALKY":" ",
"F0101_CM":" ",
"F0101_AN81":6001,
"F0101_AC26":" ",
"F0101_AC25":" ",
"F0101_AN83":6001,
"F0101_AC28":" ",
"F0101_AN82":6001,
"F0101_AC27":" ",
"F0101_AC22":" ",
"F0101_AC21":" ",
"F0101_AC24":" ",
"F0101_YEARSTAR":" ",
"F0101_ALPH":"AIS APP Stack TEST stack1",
"F0101_AC23":" ",
"F0101_CLASS02":" ",
"F0101_CLASS01":" ",
"F0101_ACTIN":" ",
"F0101_AC08":" ",
"F0101_AC07":" ",
"F0101_CLASS05":" ",
"F0101_CLASS04":" ",
"F0101_AC09":" ",
"F0101_CLASS03":" ",
"F0101_SYNCS":0,
"F0101_NOE":0,
"F0101_TX2":" ",
"F0101_SIC":" ",
"F0101_AN8":6001,
"F0101_AC15":" ",
"F0101_AC14":" ",
"F0101_AC17":" ",
"F0101_EXCHG":" ",
"F0101_AEMPGP":" ",
"F0101_AC16":" ",
"F0101_URCD":" ",
"F0101_AB3":" ",
"F0101_AC11":" ",
"F0101_AC10":" ",
"F0101_AC13":" ",
"F0101_AC12":" ",
"F0101_TAXC":" ",
"F0101_URRF":" ",
"F0101_PTI":0,
"F0101_URAT":0.00,
"F0101_DUNS":" ",
"F0101_SBLI":" ",
"F0101_PERRS":0,
"F0101_AC04":"430",
"F0101_AC03":"310",
"F0101_PDI":null,
"F0101_AC06":" ",
"F0101_AC05":" ",
"F0101_AC02":" ",
"F0101_AC01":"115",
"F0101_SCCLTP":" ",
"F0101_AT1":"E",
"F0101_UPMJ":"20170209",
"F0101_TXCT":" ",
"F0101_AN85":6001,
"F0101_AN84":6001,
"F0101_AC29":" ",
"F0101_AN86":6001,
"F0101_LNGP":" ",
"F0101_ATPR":"N",
"F0101_URDT":null,
"F0101_AT5":"N",
"F0101_AT4":"N",
"F0101_AT3":"Y",
"F0101_AT2":"N",
"F0101_AC30":" ",
"F0101_PID":"EP01012",
"F0101_UPMT":95912,
"F0101_URAB":0,
"F0101_ATE":"Y",
"F0101_TICKER":" ",
"F0101_REVRNG":" ",
"F0101_MSGA":" ",
"F0101_RMK":" ",
"F0101_CAAD":0
}
],
"summary":{
"records":1,
"moreRecords":false
}
}
},
"errors":[
],
"warnings":[
]
},
"stackId":1,
"stateId":1,
"rid":"7850abf3381f461d",
"currentApp":"DATABROWSE_F0101",
"timeStamp":"2017-02-09:14.20.26",
"sysErrors":[
],
"totalMS":152,
"renderMS":2
}
Example Request - Multiple Filters and Fields
The following shows an example of a simple Get data request with multiple "$field" values and multiple "$filter" values. Filter values will be combined with AND condition when the filter is applied.
curl -X GET -H "Authorization: Basic SkRFOkpERQ==" "http://ais_server_url/jderest/v2/dataservice/table/F0101?$field=F0101.AN8&%24field=F0101.UPMJ&%24filter=F0101.UPMJ%20GT%2004032019&%24filter=F0101.AN8%20EQ%206001"
Example Response - Multiple Filters and Fields
The following example shows the contents of the response body for multiple "$field" values and multiple "$filter" values.
{
"fs_DATABROWSE_F0101": {
"title": "Data Browser - F0101 [Address Book Master]",
"data": {
"gridData": {
"id": 53,
"fullGridId": "53",
"columns": {
"F0101_AN8": "Address Number",
"F0101_UPMJ": "Date Updated"
},
"rowset": [
{
"F0101_UPMJ": "20200225",
"F0101_AN8": 6001
}
],
"summary": {
"records": 1,
"moreRecords": false
}
}
},
"errors": [],
"warnings": []
},
"stackId": 1,
"stateId": 1,
"rid": "6432a38992ce0e35",
"currentApp": "DATABROWSE_F0101",
"timeStamp": "2020-06-24:08.19.31",
"sysErrors": [],
"totalMS": 39,
"renderMS": 0
}
Example Request Filter and Limit
The following shows an example of a simple Get data request with a "$field" and "$limit" defined. pass username, 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/table/F0101?$filter=F0101.AN8%20GE%206000&%24limit=5&%24field=ALPH"
Example Response Filter and Limit Output
The following example shows the contents of the response body for "$field" and "$limit" output.
{
"fs_DATABROWSE_F0101":{
"title":"Data Browser - F0101 [Address Book Master]",
"data":{
"gridData":{
"id":52,
"fullGridId":"52",
"columns":{
"F0101_ALPH":"Alpha Name"
},
"rowset":[
{
"F0101_ALPH":"AIS APP Stack TEST stack1"
},
{
"F0101_ALPH":"Abbott, Dominique"
},
{
"F0101_ALPH":"Western Distribution Center"
},
{
"F0101_ALPH":"Hunter, Monica"
},
{
"F0101_ALPH":"Northern Distribution Center"
}
],
"summary":{
"records":5,
"moreRecords":true
}
}
},
"errors":[
],
"warnings":[
]
},
"stackId":1,
"stateId":1,
"rid":"ace26dd33c74f418",
"currentApp":"DATABROWSE_F0101",
"timeStamp":"2017-02-09:14.26.19",
"sysErrors":[
],
"totalMS":42,
"renderMS":2
}
Example Request - Sort
The following shows an example of a simple Get data request with a descending "$sort". pass username, 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//table/F060116?%24filter=F060116.AN8%20GE%206000&%24sort=%2BF060116.HMCU&%24sort=-F060116.AN8&%24limit=5&%24field=F060116.HMCU&%24field=F060116.AN8"
Example Response - Sort
The following example shows the contents of the response body for a sort request.
{
"fs_DATABROWSE_F060116":{
"title":"Data Browser - F060116 [Employee Master Information]",
"data":{
"gridData":{
"id":53,
"fullGridId":"53",
"columns":{
"F060116_AN8":"Address Number",
"F060116_HMCU":"Home Business Unit"
},
"rowset":[
{
"F060116_HMCU":" 3",
"F060116_AN8":6033
},
{
"F060116_HMCU":" 9",
"F060116_AN8":211101
},
{
"F060116_HMCU":" 9",
"F060116_AN8":201115
},
{
"F060116_HMCU":" 9",
"F060116_AN8":201114
},
{
"F060116_HMCU":" 9",
"F060116_AN8":201113
}
],
"summary":{
"records":5,
"moreRecords":true
}
}
},
"errors":[
],
"warnings":[
]
},
"stackId":1,
"stateId":1,
"rid":"a229250893f6b342",
"currentApp":"DATABROWSE_F060116",
"timeStamp":"2017-02-09:15.10.50",
"sysErrors":[
],
"totalMS":199,
"renderMS":4
}