Execute a Form v2

post

/jderest/v2/formservice

Request to execute an EnterpriseOne form. Optionally, perform actions on the form and receive data from the form in the response.

Request

Supported Media Types
Header Parameters
Body ()
The FormRequest class is the expected input class to the jderest/formservice AIS service.
Root Schema : FormRequest
Type: object
The FormRequest class is the expected input class to the jderest/formservice AIS service.
Show Source
Nested Schema : AggregationInfo
Type: object
Provide information about the requested aggregation.
Show Source
Nested Schema : formActions
Type: array
An array of actions to be performed in a specified order on a particular form.
Show Source
Nested Schema : formInputs
Type: array
An array of FIStructure (id,value) pairs for values that should be passed into the form interconnect data structure.
Show Source
Nested Schema : Query
Type: object
The query portion of a data service or form service request.
Show Source
Nested Schema : aggregations
Type: array
The list of aggregations requested.
Show Source
Nested Schema : CurrencyProcessing
Type: object
Details for instructing the service to format the results for currency (currency decimals).
Show Source
  • 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.
  • Specify the date to be used for the currency conversion. If not provided, today's date will be used.
  • If not using a specific type of processing, specify a specific currency code to use for formatting.
  • 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
    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.)
  • Rounding Mode override.
  • Allowed Values: [ "CO", "CRCD", "MCU", "AID", "LT_CO_CRCD", "LT_CRCD", "STATIC" ]
    The type of currency processing to use.
Nested Schema : groupBy
Type: array
The list of fields to group the results by.
Show Source
Nested Schema : orderBy
Type: array
The list fields to order the results by.
Show Source
Nested Schema : AggregationItem
Type: object
Information provided for the aggregation of a specific column.
Show Source
  • Allowed Values: [ "SUM", "MIN", "MAX", "AVG", "COUNT", "COUNT_DISTINCT", "AVG_DISTINCT", "SUM_DISTINCT" ]
    The aggregation to perform.
  • The column to perform the aggregation over.
  • If this is set the associated description will be returned as part of the group by results.
  • Allowed Values: [ "ASC", "DESC" ]
    If this is a group by, indicate the order.
  • 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.
Nested Schema : currencyCols
Type: array
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.
Show Source
Nested Schema : keyCols
Type: array
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.)
Show Source
Nested Schema : FSREvent
Type: object
An individual action to perform on a form.
Show Source
  • Allowed Values: [ "SetQBEValue", "SetControlValue", "SetRadioButton", "SetComboValue", "DoAction", "SetCheckboxValue", "SelectRow", "UnSelectRow", "UnSelectAllRows", "SelectAllRows", "ClickGridCell", "ClickGridColumnAggregate", "NextGrid" ]
    The command or action to perform.
  • The control to perform the action on. This a form level object. It is not applicable to individual grid rows.
  • GridAction
    Holds actions to perform on grid rows.
  • The value to use, if the action is to set a value.
Nested Schema : GridAction
Type: object
Holds actions to perform on grid rows.
Show Source
Nested Schema : gridRowInsertEvents
Type: array
The list of events for adding grid rows.
Show Source
Nested Schema : gridRowUpdateEvents
Type: array
The list of events for updating grid rows.
Show Source
Nested Schema : GridRowInsertEvent
Type: object
Contains actions to apply to a newly added grid row.
Show Source
Nested Schema : gridColumnEvents
Type: array
The actions to apply to the new grid row.
Show Source
Nested Schema : GridColumnEvent
Type: object
Action to be applied to a grid cell.
Show Source
  • 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.
  • Allowed Values: [ "SetGridCellValue", "SetGridComboValue" ]
    The operation to perform on the grid cell.
  • The value to use in the operation.
Nested Schema : GridRowUpdateEvent
Type: object
The actions to apply to an existing grid row.
Show Source
Nested Schema : gridColumnEvents
Type: array
The actions to perform on the existing grid row.
Show Source
Nested Schema : FIStructure
Type: object
A form interconnect value to send into a form request.
Show Source
  • The id of the form data structure member.
  • The value to send to the associated form interconnect structure member.
Nested Schema : complexQuery
Type: array
The array of complex query fragments if this is a compex query.
Show Source
Nested Schema : condition
Type: array
The array of complex query fragments if this is a complex query.
Show Source
Nested Schema : ComplexQueryFragment
Type: object
The class used to join multiple queries into a complex query.
Show Source
Nested Schema : Condition
Type: object
A condition within a query.
Show Source
Nested Schema : value
Type: array
The value(s) used for data comparison based on the operation.
Show Source
Nested Schema : QueryValue
Type: object
The value used in a query comparison.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful Execution of Set Dirty Only
Body ()
Root Schema : StatusResponse
Type: object
Returns the status of read cache set dirty only operation.
Show Source

400 Response

Bad Request - Invalid JSON Input

403 Response

Authorization Failure

415 Response

Invalid Content-Type Header - Must use application/json

444 Response

Invalid Token
Body ()
Root Schema : ServiceErrorResponse
Type: object
Error Response
Show Source

500 Response

Server Failed to Process Request
Body ()
Root Schema : ServiceErrorResponse
Type: object
Error Response
Show Source
Back to Top

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" : [ ]
}

Back to Top