Simple Form Service Query v2
get
/v2/formservice/{application}/{form}
Execute simple queries over EnterpriseOne forms.
Request
Path Parameters
-
application(required): string
The name of the application in EnterpriseOne (for example P01012).
-
form(required): string
The name of the form in the application (for example W01012B).
Query Parameters
-
$allowCache: string
Allow the response to be cached for faster subsequent fetches.
-
$environment: string
EnterpriseOne environment, if not using a default environment.
-
$field: array[string]
Collection Format:
multi
A list of fields to be returned in the response (for example F0101.AN8). -
$filter: array[string]
Collection Format:
multi
A list of filters to be applied to fields. The format of each filter is: field name[space]operator[space]value (for example, 1[14] EQ 6001 -- this would return the record with Address Number equal to 6001).
Release 9.2.8.3 and later, to use a special date value in the filter the format is: field name[space]operator[space]value[space]special date value (for example, 1[409] EQ 5 TODAY_MINUS_DAY -- this would return records with date values for five days ago).
Allowed operators: EQ, NE, STARTSWITH, ENDSWITH, CONTAINS, LT, LE, GT, GE.
Allowed special date values: TODAY, TODAY_PLUS_DAY, TODAY_MINUS_DAY, TODAY_PLUS_MONTH, TODAY_MINUS_MONTH, TODAY_PLUS_YEAR, TODAY_MINUS_YEAR -
$filterType: string
Filter type, MATCH_ALL or MATCH_ANY of the filters passed in.Allowed Values:
[ "MATCH_ALL", "MATCH_ANY" ]
-
$limit: string
Maximium number of records to return.
-
$outputType: string
Output Format Type for Data Services.Allowed Values:
[ "GRID_DATA", "ORACLE", "XML", "XMLSIMPLE" ]
-
$password: string
EnterpriseOne password, if not using an established session.
-
$role: string
EnterpriseOne role, if not using a default role.
-
$sort: array[string]
Collection Format:
multi
List of sort orders for each field, - is descending, + is ascending (for example -F0101.AN8 or +F0101.AN8). -
$token: string
The AIS token, use if you have already established a session.
-
$username: string
EnterpriseOne userid, if not using an established session.
Header Parameters
-
jde-AIS-Auth: string
Token
-
jde-AIS-Auth-Device: string
Device Name
-
jde-AIS-MonitorOnStart: boolean
Monitor on Start
-
jde-AIS-MonitorRequest: 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:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
string
Optional error text added to an orchestration step.
Examples
Example Simple Get Form Output
The following shows an example of a simple Get form request that runs the default application version. This allows you to quickly get data if there is no special logic required. 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/formservice/P0801/W0801A?$filter=1%5B14%5D%20GE%206001&%24sort=-1%5B14%5D&%24limit=5&%24field=1%5B15%5D"
Example Response Simple Get Output
The following example shows the contents of the response body.
{ "fs_P0801_W0801A":{ "title":"Work With Employee Information", "data":{ "gridData":{ "id":1, "fullGridId":"1", "columns":{ "z_ALPH_15":"Alpha Name" }, "rowset":[ { "z_ALPH_15":"Ryan, Harris" }, { "z_ALPH_15":"Peter, Siddle" }, { "z_ALPH_15":"Watson, Shane" }, { "z_ALPH_15":"Warne, Shane" }, { "z_ALPH_15":"Mcgrath, Glen" } ], "summary":{ "records":5, "moreRecords":true } } }, "errors":[ ], "warnings":[ ] }, "stackId":1, "stateId":1, "rid":"c36103b8f0ada86a", "currentApp":"P0801_W0801A", "timeStamp":"2017-02-10:12.36.35", "sysErrors":[ ], "totalMS":336, "renderMS":2 }