Simple Form Service Query v2

get

/jderest/v2/formservice/{application}/{form}

Execute simple queries over EnterpriseOne forms.

Request

Path Parameters
Query Parameters
  • Allow the response to be cached for faster subsequent fetches.
  • EnterpriseOne environment, if not using a default environment.
  • Collection Format: multi
    A list of fields to be returned in the response (for example F0101.AN8).
  • Collection Format: multi
    A list of filters to be applied to fields, format is field name operator value (for example F0101.AN8 EQ 6001),allowed values list contains possible operators.
    • Allowed Values: [ "EQ", "NE", "STARTSWITH", "ENDSWITH", "CONTAINS", "LT", "LE", "GT", "GE" ]
  • Filter type, MATCH_ALL or MATCH_ANY of the filters passed in.
    Allowed Values: [ "MATCH_ALL", "MATCH_ANY" ]
  • Maximium number of records to return.
  • Output Format Type for Data Services.
    Allowed Values: [ "GRID_DATA", "ORACLE", "XML", "XMLSIMPLE" ]
  • EnterpriseOne password, if not using an established session.
  • EnterpriseOne role, if not using a default role.
  • Collection Format: multi
    List of sort orders for each field, - is descending, + is ascending (for example -F0101.AN8 or +F0101.AN8).
  • The AIS token, use if you have already established a session.
  • EnterpriseOne userid, if not using an established session.
Header Parameters
Back to Top

Response

Supported Media Types

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
Body ()
Root Schema : ServiceErrorResponse
Type: object
Error Response
Show Source
Back to Top

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
}
Back to Top