Index Changes

Difference between version and version     

Back to Sun Data Mashup Engine REST Support, or Sun Data Mashup Engine REST Support Info


At line 1 changed 26 lines.
!!Sun Data Mashup Engine REST Support
This topic provides information about REST support.
* Resources
** Identified Resources
*** Tables, views, federated views, data mashups of relational/rss feed
*** Reaching to particular page, row and column
** Supported Parameters
*** Page: Supports pagination of large result sets
*** Row: Reaches a particular row irrespective of the page
*** Column: Reaches a particular column
*** Extra parameters: depends upon the application configuration
* Constructing Resource URIs in encoding mode\\Data Mashup Engine support of REST.
** To get all the records, the URL is:{{page=0&row=0&column=0}}
** To reach a particular page, such as the 2nd page, the URL is: {{page=2&row=0&column=0}}\\If you attempt to reach an invalid page, such as {{‐1}}, the URL returns all the pages.
** To reach a particular row, such as the 10th row, the URL is: {{page=2&row=10&column=0}}\\The page value is ignored and only 10th row is displayed. If you attempt to reach a row with an invalid row, all the pages and all the rows are returned.
** To get all the records of a particular attribute, such as {{CUSTOMER_ID}}, the URL is: {{page=0&row=0&column=CUSTOMER_ID}}\\This lists all the records of attribute {{CUSTOMER_ID}}.
** To get only values of the {{CUSTOMER_ID}} in 2nd page, the URL is: {{page=2&row=0&column=CUSTOMER_ID}}
** To drill down to the 2nd row of the {{CUSTOMER_ID}} value , the URL is: {{page=2&row=2&column=CUSTOMER_ID}}\\In this instance, the page attribute value is ignored.\\__Note – __Currently the Data Mashup Engine does not support a POST request.
* Runtime-Input Arguments
** Runtime-input arguments can be added at Design time
** Runtime arguments for flat files and tab delimited files are added automatically
* Using Runtime arguments with REST Query
** The default way to Reach{{ page=0&row=0&column=0&FILE_LOC_STUDENTINFO=0}}\\{{FILE_LOC_STUDENTINFO}} is the runtime argument. Once the runtime argument is defined at design time, it is mandatory to mention this argument while accessing URL.\\{{FILE_LOC_STUDENTINFO=0}} is the runtime argument that you are accessing with default values. You can overwrite this value by specifying a file name, such as {{page=0&row=0&column=0&FILE_LOC_STUDENTINFO=test.xls}}.\\__Note – __{{test.xls}} is the file name that you overwrite; this must be configured in GlassFish as part of application configuration.
! Related Topics
* [Sun Data Mashup Engine Overview|SunDataMashupEngineOverview]
* [Configuring and Starting the Sun GlassFish Enterprise Server|ConfiguringAndStartingTheSunGlassFishEnterpriseServer]
!!Using the Enterprise Data Mashup Service Engine\\
\\
__Contents__
* [Using the Enterprise Data Mashup Service Engine|UsingTheSunDataMashupEngine]
* [Enterprise Data Mashup Service Engine Overview|SunDataMashupEngineOverview]
* [Starting the GlassFish Server and Data Mashup Service Engine|ConfiguringAndStartingTheSunGlassFishEnterpriseServer]
At line 29 changed 5 lines.
* [Creating and Deploying a Composite Application to Complete a Data Mashup Project|CreatingAndDeployingACompositeApplicationToCompleteADataMashup Project]
* [Testing the Deployment of a JBI Composite Application|TestingTheDeploymentOfAJBICompositeApplication]
* [Sun Data Mashup Engine Application Configuration|SunDataMashupEngineApplicationConfiguration]
* [Viewing the Data|ViewingTheData]
* [Known Data Mashup Issues|KnownDataMashupIssues]
* [Creating and Deploying a Composite Application for a Data Mashup Project|CreatingAndDeployingACompositeApplicationToCompleteADataMashupProject]
* [Testing the Deployment of a Composite Application|TestingTheDeploymentOfAJBICompositeApplication]
* [Configuring and Viewing the Data|ViewingTheData]
* [Data Mashup Service Engine Application Configurations|SunDataMashupEngineApplicationConfiguration]
* __Data Mashup Service Engine REST Support__
* [Known Data Mashup Issues|KnownDataMashupIssues]\\
\\
At line 35 changed 1 line.
[Previous|SunDataMashupEngineApplicationConfiguration] [Next|KnownDataMashupIssues]
!!!Data Mashup Service Engine REST Support
This topic provides information about REST support.
* Resources\\
** Identified Resources\\
* Tables, views, federated views, data mashups of relational or RSS feeds\\
* Reaching to particular page, row, and column\\
** Supported Parameters\\
* __Page__ – Supports pagination of large result sets\\
* __Row__ – Reaches a particular row irrespective of the page\\
* __Column__ – Reaches a particular column\\
* Extra parameters depend upon the application configuration\\
* Constructing Resource URIs in encoding mode\\
Data Mashup Service Engine support of REST.\\
** To get all the records, the URL is {{page=0&row=0&column=0}}.\\
** To reach a particular page, such as the 2nd page, the URL is: {{page=2&row=0&column=0}}.\\
If you attempt to reach an invalid page, such as {{‐1}}, the URL returns all the pages.\\
** To reach a particular row, such as the 10th row, the URL is {{page=2&row=10&column=0}}.\\
The page value is ignored and only 10th row is displayed. If you attempt to reach a row with an invalid row, all the pages and all the rows are returned.\\
** To get all the records of a particular attribute, such as {{CUSTOMER_ID}}, the URL is {{page=0&row=0&column=CUSTOMER_ID}}.\\
This lists all the records of attribute {{CUSTOMER_ID}}.\\
** To get only values of the {{CUSTOMER_ID}} in 2nd page, the URL is {{page=2&row=0&column=CUSTOMER_ID}}.\\
** To drill down to the 2nd row of the {{CUSTOMER_ID}} value , the URL is {{page=2&row=2&column=CUSTOMER_ID}}.\\
In this instance, the page attribute value is ignored.\\__Note -__ Currently the Data Mashup Service Engine does not support a POST request. \\
* Runtime input arguments\\
** Runtime-input arguments can be added in the EDM collaboration at design-time.\\
** Runtime arguments for flat files and tab delimited files are added automatically.\\
* Using runtime arguments with REST queries.\\
** To reach {{page=0&row=0&column=0&FILE_LOC_STUDENTINFO=0}}:\\
{{FILE_LOC_STUDENTINFO}} is the runtime argument. Once the runtime argument is defined in the collaboration, it is mandatory to mention this argument while accessing URL.\\
{{FILE_LOC_STUDENTINFO=0}} is the runtime argument that you are accessing with default values. You can overwrite this value by specifying a file name, such as {{page=0&row=0&column=0&FILE_LOC_STUDENTINFO=test.xls}}.\\ __Note -__ {{test.xls}} is the file name that you overwrite; this must be configured in GlassFish as part of application configuration. \\
\\
[Previous|SunDataMashupEngineApplicationConfiguration] [Next|KnownDataMashupIssues]
------
[Return to GlassFish ESB Documentation Home|GlassFishESBDocs]

JSPWiki v2.4.100
[RSS]
« Home Index Changes Prefs
This page (revision-10) was last changed on 16-Jun-09 16:29 PM, -0700 by CarolT