|
Parameter
|
Description
|
|
*Base URI*
|
Specify the URI that depends on your region and environment, which helps you establish connection with the *Open Connecters* service.
> ### Example:
> `https://api.openconnectors.ext.int.sap.hana.ondemand.com/elements/api-v2`
|
|
*Credential Name*
|
Provide the alias value for identifying the connector credentials. This helps the adapter authenticate and communicate with the connector. You can select the relevant **OpenConnector** security artifact from the list. Choose *Select* to see and add the relevant **OpenConnector** security artifact from the list.
See: [Deploying a User Credentials Artifact](deploying-a-user-credentials-artifact-6912d63.md)
|
|
*Resource*
|
Specify the resource name of an instance that you want to access. Resources belonging to specific instances and its operations are listed by Open Connectors. Choose *Select* to see the list of resources available for this specific instance.
> ### Note:
> - Do not use `$` character while defining query parameters.
>
> - Make sure you provide the*Base URI* before selecting the resources.
|
|
*Method*
|
Specify the HTTP method to retrieve the data from the connector. Find suitable HTTP method for the action performed by API:
- `POST`
- `GET`
- `PATCH`
- `PUT`
- `DELETE`
> ### Note:
> For *XML* request format, the HTTP methods are read from the source.
|
|
*Request Format*
|
Specify the content format of the incoming message. You can select one of the following request formats:
- XML
- JSON
> ### Note:
> You must include ``as the root element for every XML request as shown in the sample code below.
>
> > ### Sample Code:
> > ```
> >
> >
> >
> >
> > /elements/api-v2
> >
> > ..............
> >
> >
> >
> >
> >
> > ...........
> >
> >
> >
> >
> >
> > .......
> >
> >
> >
> >
> >
> > ............
> >
> > ..........
> >
> > ..........
> >
> > ............
> >
> > ............
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> >
> > ```
|
|
*Response Format*
|
Specify the content format for the outgoing message. For example, if you select XML format, then the response is converted to XML and dispatched.
> ### Note:
> Do not use either *JSON to XML* or *XML to JSON* converters in the integration flow for transforming a response message.
|
|
*Query Parameters for Resource*
|
Define the value of a variable you want to modify. For example, you have defined a variable `/name/{varname1}{varname2}` in the resource field. Now use the *Query Parameters for Resource* field to define the value for `{varname1}{varname2}` variables. Use commas to separate more than variable such as `varname1=hello world, varname2= hello SAP`.
You can now include queries to the URI to filter for specific resources from the response. For example, define the query parameters with the query data in the format as follows`${header.querydata1};${header.querydata2}`, and use `;` to sperate two distinct queries.
|
|
*Page Size*
|
Specify the maximum number of records to be fetched in one page.
|
|
*Process in Pages*
|
The message is processed in pages of size defined in the *Page Size* field.
> ### Note:
> Enable this option only if you are using the receiver adapter in a *Local Integration Process* invoked by a *Looping Process Call*.
|
|
*Timeout \(in ms\)*
|
Specify the maximum amount of time the system waits for a response before terminating the connection.
|
### Related Links
SAP Blog [How to create a sample integration scenario using Open Connectors Adapter](https://blogs.sap.com/2019/03/13/cloud-integration-how-to-create-a-sample-integration-scenario-using-open-connectors-adapter/).
[SAP Open Connectors](https://help.openconnectors.ext.hana.ondemand.com/home)