Resource request from Windows applications
improve this page | report issueOverview
MobileFirst Operations Console applications can access resources using the WorklightResourceRequest
REST API.
The REST API works with all adapters and external resources.
Prerequisites:
- Ensure you have added the Mobile Foundation SDK to your Native Windows 8.1 Universal or Windows 10 UWP.
- Learn how to create adapters.
WLResourceRequest
The WorklightResourceRequest
class handles resource requests to adapters or external resources.
Create a WorklightResourceRequest
object and specify the path to the resource and the HTTP method.
Available methods are: GET
, POST
, PUT
and DELETE
.
URI adapterPath = new URI("/adapters/JavaAdapter/users",UriKind.Relative);
WorklightResourceRequest request = WorklightClient.ResourceRequest(adapterPath,"GET");
- For JavaScript adapters, use
/adapters/{AdapterName}/{procedureName}
- For Java adapters, use
/adapters/{AdapterName}/{path}
. Thepath
depends on how you defined your@Path
annotations in your Java code. This would also include any@PathParam
you used. - To access resources outside of the project, use the full URL as per the requirements of the external server.
- timeout: Optional, request timeout in milliseconds
- scope: Optional, if you know which scope is protecting the resource - specifying this scope could make the request more efficient.
Sending the request
Request the resource by using the .send()
method.
WorklightResponse response = await request.send();
Use the WorklightResponse response
object to get the data that is retrieved from the adapter.
The response
object contains the response data and you can use its methods and properties to retrieve the required information. Commonly used properties are ResponseText
, ResponseJSON
(if the response is in JSON) , Success
(if the invoke was successful or failure) and HTTPStatus
(the HTTP status of the response).
Parameters
Before sending your request, you may want to add parameters as needed.
Path parameters
As explained above, path parameters (/path/value1/value2
) are set during the creation of the WorklightResourceRequest
object:
Uri adapterPath = new Uri("/adapters/JavaAdapter/users/value1/value2",UriKind.Relative);
WorklightResourceRequest request = WorklightClient.createInstance(adapterPath,"GET");
Query parameters
To send query parameters (/path?param1=value1...
) use the SetQueryParameter
method for each parameter:
request.SetQueryParameter("param1","value1");
request.SetQueryParameter("param2","value2");
JavaScript adapters
JavaScript adapters use ordered nameless parameters. To pass parameters to a Javascript adapter, set an array of parameters with the name params
:
request.SetQueryParameter("params","['value1', 'value2']");
This should be used with GET
.
Form parameters
To send form parameters in the body, use .Send(Dictionary<string, string> formParameters)
instead of .Send()
:
Dictionary<string,string> formParams = new Dictionary<string,string>();
formParams.Add("height", height.getText().toString());
request.Send(formParams);
JavaScript adapters
JavaScript adapters use ordered nameless parameters. To pass parameters to a Javascript adapter, set an array of parameters with the name params
:
formParams.Add("params","['value1', 'value2']");
This should be used with POST
.
Header parameters
To send a parameter as an HTTP header use .SetHeader()
API:
request.SetHeader(KeyValuePair<string,string> header);
Other custom body parameters
.Send(requestBody)
allows you to set an arbitrary String in the body..Send(JObject json)
allows you to set an arbitrary dictionary in the body..Send(byte[] data)
allows you to set an arbitrary byte array in the body.
The response
The WorklightResponse
object contains the response data and you can use its methods and properties to retrieve the required information. Commonly used properties are ResponseText
(String), ResponseJSON
(JSONObject) (if the response is in JSON) and success
(boolean) (success status of the response).
In case of request failure, the response object also contains a error
property.
For more information
For more information about WLResourceRequest, refer to the API Reference.https://public.dhe.ibm.com/software/products/en/MobileFirstPlatform/docs/v800/mfpf_csharp_win8_native_client_api.pdf
Sample application
The ResourceRequestWin8 and ResourceRequestWin10 projects contain a native Windows 8 Universal/Windows 10 UWP application that makes a resource request using a Java adapter.
The adapter Maven project contains the Java adapter used during the resource request call.
Click to download the Windows 8.1 Universal project.
Click to download the Windows 10 UWP project.
Click to download the adapter Maven project.
Sample usage
Follow the sample’s README.md file for instructions.
▲Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.