Get UDO Details v1
/jderest/udomanager/{operation}
Request
- application/json
-
operation: string
The UDO operation to perform, either get a single object or get all objects of that type.Allowed Values:
[ "getallobjects", "getobjectbykey" ]
-
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
-
deviceName(optional):
string
An identifier for the device making the service call. If not provided, the requesting IP address is used.
-
environment(optional):
string
Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
-
formName(optional):
string
The form associated with the UDO, which is required for form based UDOs like queries.
-
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.
-
omwObjectName(optional):
string
The object name of the UDO, if requesting an individual UDO.
-
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.
-
role(optional):
string
The role to use for login. If not specified, the default role configured for the AIS Server will be used.
-
token(optional):
string
The AIS token, which is required if other authentication methods are not being used.
-
udoType:
string
The type of UDO for this request, either WATCHLIST or QUERY.
-
username(optional):
string
JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
Response
- application/json
200 Response
400 Response
403 Response
415 Response
444 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.
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 Watchlist Request
The following shows an example of request to get Watchlist details. The token passed in this example was received from a separate token request.
curl POST -H "Content-Type:application/json" http://ais_server_url/jderest/udomanager/getobjectbykey/ -d { "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=", "udoType": "WATCHLIST", "omwObjectName": "OVW07210A_1608230001CUST" }
Example Response
The following example shows the contents of the response body with Watchlist details.
{"activeObject": { "name": "ClearShowAll", "omwObjectName": "OVW07210A_1608230001CUST", "user": "JDE", "description": "PayCycle All", "prodCode": null, "tokenProjectName": null, "metaData": { "queryObjectName": "QRY07210A_1608230001CUST", "warningThreshold": 2, "criticalThreshold": 10, "maxRecords": 200, "formOID": "P07210_W07210A_ZJDE0001", "refreshInterval": 60 } }}
Example Query Request
The following shows an example of request to get Query details. The token passed in this example was received from a separate token request.
curl POST -H "Content-Type:application/json" http://ais_server_url/jderest/udomanager/getobjectbykey/ -d { "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=", "udoType": "QUERY", "omwObjectName": "QRY0801A_1608110001CUST" }
Example Response
The following example shows the contents of the response body with Query details.
{"activeObject": { "name": "CO1", "omwObjectName": "QRY0801A_1608110001CUST", "user": "*PUBLIC", "description": "CO1", "tokenProjectName": null, "metaData": { "bsvw": "V060116B", "andQuery": true, "autoClear": false, "autoFind": true, "conditions": [ { "leftServerId": "qbe0_1.24", "leftId": "qbe0_1.4", "ddAlias": "HMCO", "table": "F060116", "dataType": 1, "display": "Home Company (QBE)", "rightWidth": 97, "maxLength": 5, "operatorId": 0, "rightOperand": [ { "value": "00001", "svId": 0 }] }] } }}
Example All Objects Request
The following shows an example of a request to get all Watchlists. The token passed in this example was received from a separate token request.
curl POST -H "Content-Type:application/json" http://ais_server_url/jderest/udomanager/getallobjects/ -d { "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=", "udoType": "WATCHLIST" }
Example Response
The following example shows the contents of the response body for get all WATCHLIST objects.
{ "managerTitle": "Watchlist Manager", "messages": { "primary": null, "secondary": null }, "activeObject": {}, "type": "udos", "error": null, "udoObjects": [ { "group": "Personal", "items": [ { "name": "Company1", "description": " ", "omwObjectName": "OVW0801A_1912200001CUST", "user": "JDE", "prodCode": null }, { "name": "Employees on Leave", "description": " ", "omwObjectName": "OVW01012B_2003050001CUST", "user": "JDE", "prodCode": null } ] }, { "group": "Pending Approval", "items": [] }, { "group": "Rework", "items": [] }, { "group": "Reserved", "items": [] }, { "group": "Shared", "items": [ { "name": "1095-Cs For Reporting Year", "description": "1095-Cs For Reporting Year", "omwObjectName": "OVW08119A_1609010002JDE", "user": "*PUBLIC", "prodCode": null }, { "name": "ACA Eligibility TBD", "description": "ACA Eligibility TBD", "omwObjectName": "OVW081161A_1608170028JDE", "user": "*PUBLIC", "prodCode": null }, { "name": "ACA Eligible YTD", "description": " ", "omwObjectName": "OVW081161A_1608170029JDE", "user": "*PUBLIC", "prodCode": null } ] } ] }