Execute a Form v2
/jderest/v2/formservice
Request
- application/json
-
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" ]
object
-
aggregation(optional):
object AggregationInfo
Provide information about the requested aggregation.
-
aliasNaming(optional):
boolean
Specify whether alias names should be used for field names. A value of true prevents Data Dictionary overrides from changing the field names.
-
allowCache(optional):
boolean
Specify whether cache should be used if available for the transaction.
-
batchDataRequest(optional):
boolean
A flag to indicate if this is a batch data request (used for data requests only).
-
bypassFormServiceEREvent(optional):
boolean
A flag allowing the caller to indicate if the form service event in FDA ER should execute.
-
cacheTime(optional):
integer(int32)
Override the default server Cache Time To Live in milliseconds.
-
dataSetVariableName(optional):
string
Used to allow orchestrator to process all rows of a result set
-
deviceName(optional):
string
An identifier for the device making the service call. If not provided, the requesting IP address is used.
-
enableAsyncEvents(optional):
boolean
Usually business functions called in event rules for form services are executed synchronously. Pass a value of true in this field to execute those asynchronously. (Tools Release 9.2.2.4 +)
-
enableNextPageProcessing(optional):
boolean
For Data Service requests only. A flag to indicate if a next page link will be returned.
-
environment(optional):
string
Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
-
excludeSummaryRow(optional):
boolean
A flag indicating the service should not return summary rows in grids indicated by a sigma character in the row header.
-
findOnEntry(optional):
string
Allowed Values:
[ "true", "false" ]
Indicates that the Find button should be pressed. -
forceUpdate(optional):
boolean
If cache is enabled, this tells the request to ignore the cache and execute the request.
-
formActions(optional):
array formActions
An array of actions to be performed in a specified order on a particular form.
-
formDSData(optional):
string
The form data structure values (for example |6001|M30|00007|).
-
formDSTmpl(optional):
string
The form data structure template (for example |1|2|3|).
-
formInputs(optional):
array formInputs
An array of FIStructure (id,value) pairs for values that should be passed into the form interconnect data structure.
-
formName:
string
The name of the EnterpriseOne application and form with an underscore between (for example P01012_W01012B).
-
formServiceAction(optional):
string
A character value of C (Create), R (Read), U (Update) or D (Delete), which can be accessed in FDA Event Rules when the form executes.
-
formServiceDemo(optional):
string
Allowed Values:
[ "true", "false" ]
Request only a demo version of the form to view all the fields without actual data. -
ignoreFDAFindOnEntry(optional):
string
Allowed Values:
[ "true", "false" ]
A flag allowing the caller to indicate if the application should not use the FDA setting for find on entry. -
includeTimings(optional):
boolean
Specify whether timing information should be included in the response. The timing information shows how long the formservice/dataservice ran and the total processing time.
-
jasserver(optional):
string
The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
-
loadBaseFormOnly(optional):
string
Allowed Values:
[ "true", "false" ]
When requesting formServiceDemo (Demo Mode) to prevent event rules execution send a value of true in this field. -
maxPageSize(optional):
string
The maximum number of records that should be returned. The default value is 100. A value of 'No Max' will return all records. This value does not apply to aggregation requests.
-
nextPageTimeInterval(optional):
string
For Data Service requests only. A number in milliseconds for how often records are fetched in the background before the next request is received.
-
outputType(optional):
string
Allowed Values:
[ "<blank>", "VERSION1", "GRID_DATA", "VERSION2", "ORACLE", "XML", "XMLSIMPLE" ]
The format of the output. GRID_DATA is the default value. -
password(optional):
string
The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
-
psToken(optional):
string
Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
-
query(optional):
object Query
The query portion of a data service or form service request.
-
queryObjectName(optional):
string
The object name of a saved query to be executed on the form.
-
returnControlIDs(optional):
string
The returnControlIDs string is bar delimited, without a starting or ending bar. Form fields are just a single value. Grid fields are indicated with a grid id, followed by a bracketed list of grid columns. Subform fields are indicated with subform id underscore field id. For example: 33|34|17[24,26,28]|50_45|50_53|50_9[35,39,41]
-
role(optional):
string
The role to use for login. If not specified, the default role configured for the AIS Server will be used.
-
setDirtyOnly(optional):
boolean
Specify whether to delete the data currently stored in the cache for the request. This does not execute the request. This forces the next execution to fetch from the database.
-
showActionControls(optional):
boolean
Specify whether action controls such as buttons, row, and form exits should be included in the response.
-
stopOnWarning(optional):
string
Allowed Values:
[ "true", "false" ]
A flag allowing the caller to indicate if warnings should be ignored or not. -
token(optional):
string
The AIS token, which is required if other authentication methods are not being used.
-
turboMode(optional):
string
A flag indicating the service should run in Turbo Mode, which reduces processing time by not processing unrequested grid columns and associated descriptions in the grid.
-
username(optional):
string
JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
-
userPreferenceDateTimeFormat(optional):
boolean
A flag to indicate if UTIME values should be returned in the user preference format and time zone. Only available with GRID_DATA output type.
-
variableNames(optional):
string
A list of variable names to correspond to the returnControlIDs. Used by Orchestrator only.
-
version(optional):
string
The version of the application to execute. If not provided, the default (ZJDE0001) version runs.
object
-
aggregations:
array aggregations
The list of aggregations requested.
-
currency(optional):
object CurrencyProcessing
Details for instructing the service to format the results for currency (currency decimals).
-
groupBy(optional):
array groupBy
The list of fields to group the results by.
-
orderBy(optional):
array orderBy
The list fields to order the results by.
array
-
Array of:
object FSREvent
An individual action to perform on a form.
array
-
Array of:
object FIStructure
A form interconnect value to send into a form request.
object
-
autoClear(optional):
boolean
Specify whether the system should clear any filter field or QBE values before executing the query.
-
autoFind(optional):
boolean
Specify whether the system should automatically find records matching the query.
-
complexQuery(optional):
array complexQuery
The array of complex query fragments if this is a compex query.
-
condition(optional):
array condition
The array of complex query fragments if this is a complex query.
-
matchType(optional):
string
Allowed Values:
[ "MATCH_ALL", "MATCH_ANY" ]
The match type for the query.
array
-
Array of:
object AggregationItem
Information provided for the aggregation of a specific column.
object
-
asIfCurrency(optional):
string
If you would like different currencies in the table to be converted to a single currency, indicate it here. You must have conversion rates in the currency conversion table for the currencies involved.
-
asIfDate(optional):
string
Specify the date to be used for the currency conversion. If not provided, today's date will be used.
-
currencyCode(optional):
string
If not using a specific type of processing, specify a specific currency code to use for formatting.
-
currencyCols(optional):
array currencyCols
Specify the columns to be formatted. You only need to add a column here once, even if you have several aggregations over that column. Identify each distinct column to which the currency processing should apply. If you do not identify currency columns here, then currency processing will be applied to all columns identified as currency columns in the data dictionary. A currency column is defined in the data dictionary with class CURRENCY.
-
keyCols(optional):
array keyCols
Specify the columns to be used as the key based on the type of processing. (For example for COMPANY processing, which field in the table will have the company value.)
-
roundingMode(optional):
integer(int32)
Rounding Mode override.
-
type(optional):
string
Allowed Values:
[ "CO", "CRCD", "MCU", "AID", "LT_CO_CRCD", "LT_CRCD", "STATIC" ]
The type of currency processing to use.
array
-
Array of:
object AggregationItem
Information provided for the aggregation of a specific column.
array
-
Array of:
object AggregationItem
Information provided for the aggregation of a specific column.
object
-
aggregation(optional):
string
Allowed Values:
[ "SUM", "MIN", "MAX", "AVG", "COUNT", "COUNT_DISTINCT", "AVG_DISTINCT", "SUM_DISTINCT" ]
The aggregation to perform. -
column:
string
The column to perform the aggregation over.
-
description(optional):
boolean
If this is set the associated description will be returned as part of the group by results.
-
direction(optional):
string
Allowed Values:
[ "ASC", "DESC" ]
If this is a group by, indicate the order. -
specialHandling(optional):
string
Allowed Values:
[ "USER", "CALQTR", "<SimpleDateFormatString>" ]
If this is a group by for a date field, indicate the simple date format for the dates. The result will be grouped and formated based on the input. 'USER': Uses the EnterpriseOne user's preferred date format. 'CALQTR': Uses the four digit year and one digit quarter format, for example 2020-1. SimpleDateFormat: Uses the simple date format that you supply, such as yyyy-MM-dd.
array
array
object
-
command(optional):
string
Allowed Values:
[ "SetQBEValue", "SetControlValue", "SetRadioButton", "SetComboValue", "DoAction", "SetCheckboxValue", "SelectRow", "UnSelectRow", "UnSelectAllRows", "SelectAllRows", "ClickGridCell", "ClickGridColumnAggregate", "NextGrid" ]
The command or action to perform. -
controlID(optional):
string
The control to perform the action on. This a form level object. It is not applicable to individual grid rows.
-
gridAction(optional):
object GridAction
Holds actions to perform on grid rows.
-
value(optional):
string
The value to use, if the action is to set a value.
object
-
gridID(optional):
string
The id of the grid (for example 1). This field is REQUIRED when using Grid Actions.
-
gridRowInsertEvents(optional):
array gridRowInsertEvents
The list of events for adding grid rows.
-
gridRowUpdateEvents(optional):
array gridRowUpdateEvents
The list of events for updating grid rows.
array
-
Array of:
object GridRowInsertEvent
Contains actions to apply to a newly added grid row.
array
-
Array of:
object GridRowUpdateEvent
The actions to apply to an existing grid row.
object
-
gridColumnEvents(optional):
array gridColumnEvents
The actions to apply to the new grid row.
array
-
Array of:
object GridColumnEvent
Action to be applied to a grid cell.
object
-
columnID:
string
The control id for the grid column. Pass only the column id here, a single number without separators. The grid must already be identified by including the gridID field at the root of GridAction.
-
command:
string
Allowed Values:
[ "SetGridCellValue", "SetGridComboValue", "ClickGridCell" ]
The operation to perform on the grid cell. -
value:
string
The value to use in the operation.
object
-
gridColumnEvents(optional):
array gridColumnEvents
The actions to perform on the existing grid row.
-
rowNumber(optional):
integer(int32)
The index of the existing grid row (zero based).
array
-
Array of:
object GridColumnEvent
Action to be applied to a grid cell.
object
-
id:
string
The id of the form data structure member.
-
value:
string
The value to send to the associated form interconnect structure member.
array
-
Array of:
object ComplexQueryFragment
The class used to join multiple queries into a complex query.
array
-
Array of:
object Condition
A condition within a query.
object
-
andOr(optional):
string
Allowed Values:
[ "AND", "OR" ]
The operation to append this query with. -
query(optional):
object Query
The query portion of a data service or form service request.
object
-
controlId:
string
The control or column the condition applies to.
-
dataType(optional):
string
-
operator:
string
Allowed Values:
[ "EQUAL", "NOT_EQUAL", "STR_START_WITH", "STR_END_WITH", "STR_CONTAIN", "LESS", "LESS_EQUAL", "GREATER", "GREATER_EQUAL", "STR_BLANK", "STR_NOT_BLANK", "BETWEEN", "LIST" ]
The operator for the condition. Operations supported are based on the data type. -
operatorString(optional):
string
-
value:
array value
The value(s) used for data comparison based on the operation.
array
-
Array of:
object QueryValue
The value used in a query comparison.
object
-
content(optional):
string
The value to be compared if it's a literal, or the value to be used in conjunction with the special value operation.
-
specialValueId(optional):
string
Allowed Values:
[ "LITERAL", "LOGIN_USER", "TODAY", "TODAY_PLUS_DAY", "TODAY_MINUS_DAY", "TODAY_PLUS_MONTH", "TODAY_MINUS_MONTH", "TODAY_PLUS_YEAR", "TODAY_MINUS_YEAR" ]
The special value id (see allowed values). Specify LITERAL if using the constant value only. -
specialValueString(optional):
string
Response
- application/json
- application/xml
200 Response
400 Response
403 Response
415 Response
500 Response
object
-
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 VERSION2 Output
The following shows an example of a form service request with VERSION2 defined as the output type. The token value is from a prior call to the tokenrequest service to establish a session.
curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/formservice -d { "token" : "0448VcFZoKlRKVMfEe46bM/5ZOgazi1LkZCgIpfV7lYV1w=MDIwMDA2LTMyMjg4Nzc0NTA3MDA1OTg1MjBubGphdmExNDYzMTUyNzI2NjY0", "deviceName" : "MyDevice", "formName" : "P0801CMP_W0801CMPA", "outputType" : "VERSION2", "formServiceAction" : "R", "bypassFormServiceEREvent" : true, "returnControlIDs" : "1[33,67,37,46]", "query" : { "condition" : [ { "value" : [ { "content" : "9", "specialValueId" : "LITERAL" }, { "content" : "1", "specialValueId" : "LITERAL" } ], "controlId" : "1[37]", "operator" : "LIST" }, { "value" : [ { "content" : "57000", "specialValueId" : "LITERAL" } ], "controlId" : "1[46]", "operator" : "GREATER" } ], "autoFind" : true, "matchType" : "MATCH_ALL", "autoClear" : true } }
Example Response VERSION2 Output
The following example shows the contents of the response body.
{ "fs_P0801CMP_W0801CMPA" : { "title" : "Work With Basic Compensation", "data" : { "gridData" : { "id" : 1, "titles" : { "col_33" : "Employee No", "col_67" : "Alpha Name", "col_37" : "Home Business Unit", "col_46" : "Annual Salary" }, "columnInfo" : { "z_AN8_33" : { "id" : 33, "title" : "Employee No", "dataType" : 9, "visible" : true, "bsvw" : true, "longName" : "mnEmployeeNo_33", "hyperlink" : true, "qbeEnabled" : true }, "z_ALPH_67" : { "id" : 67, "title" : "Alpha Name", "dataType" : 2, "visible" : true, "bsvw" : true, "longName" : "sAlphaName_67", "qbeEnabled" : true }, "z_HMCU_37" : { "id" : 37, "title" : "Home Business Unit", "dataType" : 2, "visible" : true, "bsvw" : true, "longName" : "sHomeBusinessUnit_37", "qbeEnabled" : true }, "z_SAL_46" : { "id" : 46, "title" : "Annual Salary", "dataType" : 9, "visible" : true, "bsvw" : true, "longName" : "mnAnnualSalary_46", "qbeEnabled" : true, "dispDec" : 2 } }, "rowset" : [ { "rowIndex" : 0, "MOExist" : false, "z_AN8_33" : { "internalValue" : 6001, "value" : "6001" }, "z_ALPH_67" : { "internalValue" : "AIS APP Stack TEST stack1", "value" : "AIS APP Stack TEST stack1" }, "z_HMCU_37" : { "internalValue" : " 9", "value" : "9" }, "z_SAL_46" : { "internalValue" : 75000.0, "value" : "75,000.00" } }, { "rowIndex" : 1, "MOExist" : false, "z_AN8_33" : { "internalValue" : 6044, "value" : "6044" }, "z_ALPH_67" : { "internalValue" : "Abrams, Brooke", "value" : "Abrams, Brooke" }, "z_HMCU_37" : { "internalValue" : " 9", "value" : "9" }, "z_SAL_46" : { "internalValue" : 60000.0, "value" : "60,000.00" } }, { "rowIndex" : 2, "MOExist" : false, "z_AN8_33" : { "internalValue" : 5651, "value" : "5651" }, "z_ALPH_67" : { "internalValue" : "Rothchild, Abigal E.", "value" : "Rothchild, Abigal E." }, "z_HMCU_37" : { "internalValue" : " 9", "value" : "9" }, "z_SAL_46" : { "internalValue" : 58000.0, "value" : "58,000.00" } } ], "summary" : { "records" : 3, "moreRecords" : false } } }, "errors" : [ ], "warnings" : [ ] }, "stackId" : 1, "stateId" : 1, "rid" : "42bf2b624426b677", "currentApp" : "P0801CMP_W0801CMPA_ZJDE0001", "timeStamp" : "2016-05-13:15.08.25", "sysErrors" : [ ] }
Example Request GRID_DATA Output
The following shows an example of a form service request with GRID_DATA defined as the output type. The token used is from a prior call to the tokenrequest service. For v2 services, by default the aliasNaming input field is set to "true" and the outputType input field is set to "GRID_DATA" when they are not included in the request message.
curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/formservice -d { "token" : "044HGIVWHbPmZdpW7UmJVFxGMhy+8hG+3jGo9EqwgttyEY=MDE5MDA2MTY0ODU0NzcwNjUyODM3NzE1M25samF2YTE0NzgxMTU1NDQ5ODg=", "deviceName" : "nljava", "formName" : "P0801CMP_W0801CMPA", "formServiceAction" : "R", "bypassFormServiceEREvent" : true, "returnControlIDs" : "1[33,67,37,46]", "query" : { "autoFind" : true, "autoClear" : true, "condition" : [ { "value" : [ { "content" : "9", "specialValueId" : "LITERAL" }, { "content" : "1", "specialValueId" : "LITERAL" } ], "controlId" : "1[37]", "operator" : "LIST" }, { "value" : [ { "content" : "57000", "specialValueId" : "LITERAL" } ], "controlId" : "1[46]", "operator" : "GREATER" } ] } } }
Example Response GRID_DATA Output
The following example shows the contents of the response body.
{ "fs_P0801CMP_W0801CMPA" : { "title" : "Work With Basic Compensation", "data" : { "gridData" : { "columns" : { "z_AN8_33" : "Employee No", "z_ALPH_67" : "Alpha Name", "z_HMCU_37" : "Home Business Unit", "z_SAL_46" : "Annual Salary" }, "rowset" : [ { "z_AN8_33" : 6044, "z_ALPH_67" : "Abrams, Brooke", "z_SAL_46" : 60000.0, "z_HMCU_37" : " 9" }, { "z_AN8_33" : 6001, "z_ALPH_67" : "Allen, Ray", "z_SAL_46" : 75000.0, "z_HMCU_37" : " 9" }, { "z_AN8_33" : 5651, "z_ALPH_67" : "Rothchild, Abigal E.", "z_SAL_46" : 58000.0, "z_HMCU_37" : " 9" } ], "summary" : { "records" : 3, "moreRecords" : false } } }, "errors" : [ ], "warnings" : [ ] }, "stackId" : 1, "stateId" : 1, "rid" : "caec04e04f0003d5", "currentApp" : "P0801CMP_W0801CMPA_ZJDE0001", "timeStamp" : "2016-11-02:19.39.08", "sysErrors" : [ ] }
Example Request Using Form Interconnect Variable
The following shows an example of a form service request with GRID_DATA defined as the output type and using the form interconnect variable. The token used is from a prior call to the token request service.
curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/formservice -d { "token" : "044Ai/G4n8qFDswPN3d6Pd0fMzDvCf+pUHMBeLy3p/w9ec=MDE5MDA4NzcxMDU4NDEyNTkzMzUyMTcwNE15RGV2aWNlMTQ4MjI1NDg4Mzc3Mg==", "deviceName" : "MyDevice", "ssoEnabled" : false, "showActionControls" : false, "outputType" : "VERSION2", "includeTimings" : false, "allowCache" : true, "forceUpdate" : false, "setDirtyOnly" : false, "findOnEntry" : "TRUE", "maxPageSize" : "3", "returnControlIDs" : "1[19]", "formName" : "P01012_W01012B", "formInputs" : [ { "id" : "2", "value" : "O" } ], "formServiceAction" : "R", "bypassFormServiceEREvent" : true } }
Example Response GRID_DATA Output
The following example shows the contents of the response body.
{ "fs_P01012_W01012B" : { "title" : "Work With Addresses", "data" : { "gridData" : { "id" : 1, "titles" : { "col_19" : "Address Number" }, "rowset" : [ { "rowIndex" : 0, "MOExist" : false, "z_AN8_19" : { "id" : 19, "internalValue" : 1, "dataType" : 9, "bsvw" : true, "title" : "Address Number", "visible" : true, "longName" : "mnAddressNumber_19", "editable" : false, "value" : "1" } }, { "rowIndex" : 1, "MOExist" : true, "z_AN8_19" : { "id" : 19, "internalValue" : 9, "dataType" : 9, "bsvw" : true, "title" : "Address Number", "visible" : true, "longName" : "mnAddressNumber_19", "editable" : false, "value" : "9" } }, { "rowIndex" : 2, "MOExist" : true, "z_AN8_19" : { "id" : 19, "internalValue" : 20, "dataType" : 9, "bsvw" : true, "title" : "Address Number", "visible" : true, "longName" : "mnAddressNumber_19", "editable" : false, "value" : "20" } } ], "summary" : { "records" : 3, "moreRecords" : true } } }, "errors" : [ ], "warnings" : [ ] }, "stackId" : 1, "stateId" : 1, "rid" : "299bb8d38b4d041d", "currentApp" : "P01012_W01012B_ZJDE0001", "timeStamp" : "2016-12-20:09.28.07", "sysErrors" : [ ] }