1. REST API for JD Edwards EnterpriseOne AIS Server
  2. Tasks
  3. Report Service

Execute a Report v2

post

/jderest/v2/report/execute

Execute the specified report.

Request

Supported Media Types
Header Parameters
Body ()
The input to the report service.
Root Schema : LaunchUBERequest
Type: object
The input to the report service.
Show Source
Nested Schema : biReportDeliveryTypes
Type: array
A list of delivery methods to use for an embedded BI Publisher report.
Show Source
Nested Schema : biReportLanguages
Type: array
A list of languages to produce for an embedded BI Publisher report. You can use EnterpriseOne supported language codes or special values listed in the allowed values list.
Show Source
Nested Schema : biReportOutputTypes
Type: array
A list of outputs to produce for an embedded BI Publisher report.
Show Source
Nested Schema : DataSelection
Type: object
Populate this input object to override data selection for this execution of the report.
Show Source
Nested Schema : DataSequence
Type: object
Populate this input object to override data sequence for this execution of the report.
Show Source
Nested Schema : poValues
Type: array
A set of processing option IDs and their values to use during report execution. You may either supply report interconnect values or processing option values, not both.
Show Source
Nested Schema : PrintOptions
Type: object
Used to override the print options for a report.
Show Source
Nested Schema : riValues
Type: array
The report interconnect values to be used during report execution. You may either supply report interconnect values or processing option values, not both. Dates must be in yyyyMMdd format. Utime Fields must be in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.
Show Source
Nested Schema : criteria
Type: array
The data selection criteria.
Show Source
Nested Schema : Criterion
Type: object
A criterion for data selection of a report.
Show Source
  • Allowed Values: [ "EQUAL", "NOT_EQUAL", "LESS_THAN", "GREATER_THAN", "LESS_EQUAL", "GREATER_EQUAL", "VALUE_IN_LIST", "NOT_VALUE_IN_LIST", "WITHIN_A_RANGE", "NOT_WITHIN_A_RANGE", "EQUAL_OR_EMPTY" ]
    The method used to compare the subject and predicate in this criterion.
  • Allowed Values: [ "OR", "AND" ]
    The operator to use in conjuntion with other criterion in the criteria set (if there are other critrion).
  • SelectionValue
    The field or value to use as the subject or predicate in a data selection criterion.
  • SelectionValue
    The field or value to use as the subject or predicate in a data selection criterion.
Nested Schema : SelectionValue
Type: object
The field or value to use as the subject or predicate in a data selection criterion.
Show Source
Nested Schema : values
Type: array
The single, list, or range or literal values
Show Source
Nested Schema : orderByColumns
Type: array
The data sequence columns and order direction
Show Source
Nested Schema : OrderByColumn
Type: object
A column to include in data secquence along with it's sequencing properties.
Show Source
  • Allowed Values: [ "ASC", "DESC" ]
    The data dictionary alias of the column to sort by.
  • The direction to sort the data in this column.
  • Indicate true if a level break is desired when the value of this column changes.
  • Indicate true if a page break is desired when the value of this column changes. Setting this value to true will also set the level break value to true, level break is required for a page break.
  • The proiority of the column in the sequence. Lower numbers will be sequenced before higher numbers.
  • The table of the column to sort by.
Nested Schema : POValue
Type: object
A processing option value to use for this execution of the report.
Show Source
  • The ID of the processing option value to set, defined in the processing option template. For date values the date must be in yyyyMMdd format, for example 20190512.
  • The value to use for the processing option with the associated id.
Back to Top

Response

Supported Media Types

200 Response

Successful Execution
Body ()
Root Schema : UBEProcessingResponse
Type: object
Details of the status of the report.
Show Source
Nested Schema : xmlpOutputDefinitions
Type: array
A list of all outputs from an XMLP job.
Show Source
Nested Schema : XmlpOutputDefinition
Type: object
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 - Basic

The following shows an example of a report service request to run an existing version using the version defined data selection and sequencing. The token value is from a prior call to the tokenrequest service to establish a session. 

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/report/execute -d
{
	"token": "0449pMVIJy1icXVEfVGFSoFqgOevhbVx5Cam4mSeoim6x8=MDE5MDEzNzMyMzA2NjE5NDYyMjc5OTEyMzEwLjEzOS4xMTAuMzgxNTA5NjM1MjE3NzUy",
	"reportName": "R064011",
	"reportVersion": "XJDE0001"
}

Example Response

The following example shows the contents of the response body. This response example applies to all report service requests with the fireAndForget property set to true for the report to run asynchronously.

{
   "reportName": "R064011",
   "reportVersion": "XJDE0001",
   "jobNumber": 1128,
   "executionServer": "myEntServer"
}

Example Request - Wait For Completion

The following shows an example of a report service request to run an existing version using the version defined data selection and sequencing. The fireAndForget paramter is false, requesting that the service wait until the report is complete to return. The token value is from a prior call to the tokenrequest service to establish a session.

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/report/execute -d
{ 
    "token": "0449pMVIJy1icXVEfVGFSoFqgOevhbVx5Cam4mSeoim6x8=MDE5MDEzNzMyMzA2NjE5NDYyMjc5OTEyMzEwLjEzOS4xMTAuMzgxNTA5NjM1MjE3NzUy",
    "reportName": "R064011",
    "reportVersion": "XJDE0001",
    "fireAndForget":false
}

Example Response - Wait for Completion

The following example shows the contents of the response body, which contains details about the status of the report completion.

{
   "reportName": "R064011",
   "reportVersion": "XJDE0001",
   "jobNumber": 1130,
   "executionServer": "myEntServer",
   "jobStatus": "D",
   "objectType": "UBE",
   "user": "JDE",
   "environment": "JDV920",
   "submitDate": "20171102",
   "lastDate": "20171102",
   "submitTime": 152509,
   "lastTime": 152511,
   "oid": "R064011_XJDE0001",
   "queueName": "QBATCH"
}

Example Request - Data Selection

The following shows an example of a report service request to run an existing version and override the defined data selection. Be aware that the security configuration may prevent the ability to override data selection. The token value is from a prior call to the tokenrequest service to establish a session.

This requests the data selection for Start Date (DST) to be equal to the date 02/01/2010.

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/report/execute -d
{
	"token": "044frDm3po61n7sVRJSW3743TxkPkdG7qGcWPs9u8rL0fI=MDE5MDEzNzAxMjczNDMzMTg0NDIzMjkxNDEwLjEzOS4xMTAuMzgxNTA5NjM2MTI4NzMy",
	"reportName": "R064011",
	"reportVersion": "NLVERS",
	"dataSelection": {
		"criteria": [{
			"subject": {
				"view": "V060116Z",
				"dictItem": "DST",
				"table": "F060116"
			},
			"predicate": {
				"literalType": "SINGLE",
				"values": ["02/01/2010"]
			},
			"comparisonType": "EQUAL"
		}]
	}
}

Example Request - Data Sequencing and Processing Options

The following shows an example of a report service request to run an existing version and override the defined data sequencing and processing options. Be aware that the security configuration may prevent the ability to override processing options. The token value is from a prior call to the tokenrequest service to establish a session. 

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/report/execute -d
{
	"token": "044frDm3po61n7sVRJSW3743TxkPkdG7qGcWPs9u8rL0fI=MDE5MDEzNzAxMjczNDMzMTg0NDIzMjkxNDEwLjEzOS4xMTAuMzgxNTA5NjM2MTI4NzMy",
	"reportName": "R064011",
	"reportVersion": "NLVERS",
	"dataSequence": {
		"orderByColumns": [{
			"direction": "ASC",
			"pageBreak": true,
			"levelBreak": true,
			"seq": 1,
			"table": "F060116",
			"dictItem": "HMCO"
		},
		{
			"levelBreak": true,
			"direction": "ASC",
			"seq": 2,
			"table": "F060116",
			"dictItem": "HMCU"
		},
		{
			"levelBreak": true,
			"direction": "ASC",
			"seq": 4,
			"table": "F060116",
			"dictItem": "AN8"
		},
		{
			"levelBreak": true,
			"direction": "ASC",
			"seq": 3,
			"table": "F060116",
			"dictItem": "ALPH"
		}]
	},
	"poValues": [{
		"id": 1,
		"value": ""
	},
	{
		"id": 2,
		"value": "1"
	},
	{
		"id": 3,
		"value": "HOM"
	}]
}

Example Request - Print Options

The following shows an example of a report service request including print options and queue name. The token value is from a prior call to the tokenrequest service to establish a session. 

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/report/execute -d
{
	"token": "044frDm3po61n7sVRJSW3743TxkPkdG7qGcWPs9u8rL0fI=MDE5MDEzNzAxMjczNDMzMTg0NDIzMjkxNDEwLjEzOS4xMTAuMzgxNTA5NjM2MTI4NzMy",
    "reportName": "R064011",
    "reportVersion": "XJDE0001",
    "printOptions": {
		"numberCopies": 2,
		"orientation": 1,
		"paperType": "LETTER",
		"printImmediate": true,
		"printStyleSDT": 2,
		"printerName": "PRINTER1",
		"saveCSVFile": true,
		"savePDLFile": true
    },
    "queueName":"QBATCH2"
}
Back to Top