ThingWorx Model Definition in Composer > Modeling > Integration Connectors > Exposing Services on the Integration Connectors
Exposing Services on the Integration Connectors
After creating an Integration Connector, use the following steps to expose services on the Integration Connector.
1. Edit the connector Thing and select Services from the drop-down list at the top of the page.
2. Click Add.
3. From the drop-down list, select Route.
4. Enter information in each of the sections as described in the table below.
Service Info
Enter information in the necessary fields. Help buttons are available next to each field for additional information.
Route Info
a. Endpoint: Select an option from the drop-down list. Endpoints are retrieved from the back-end system you set up on the Configuration page.
b. Mapping ID: Select an existing map or create a New API Map. For more information, see Creating a New API Map for the Service. Note the following:
No API map is needed for a JSON response.
PTC recommends that services are created using maps generated for the same endpoint as the one for which the service is being created. Not all maps are interchangeable or reusable across all endpoints. The reusability is governed by the response schemas of each endpoint. If the response schemas are similar for a given set of endpoints, the map created for one can be used as the map for the service created for its counterpart.
c. Base Type
Inputs populate after you have selected the endpoint to connect to.
For services, the following input query parameters are available if you want to filter the results:
$expand: OData parameter that can be used if an entity has a Navigate property.
For more information on the query parameters, see Using ODataConnector or SAPODataConnector.
$orderby: Returns an entity set information in ascending or descending order. Default is ascending order.
The $orderby logic in ThingWorx follows the $orderby logic defined in Windchill or OData specifications.
This parameter is available only for returnType as Collection.
Odata official website mentions that entitySet always returns a collection. Therefore, when endpoints refer to an entitySet, $orderby parameter is displayed even though it does not have a returnType.
For Windchill, the parameter $orderby does not work for actions and functions.
$orderby parameter is available for SAPOdata and Odata Connectors only.
orderBy parameter is not visible when the connectors are imported. To see the orderBy parameter, edit the service after import.
They must be constructed using specific expressions defined in back-end applications.
5. Click Done.
Click Done before saving the Thing; otherwise, the new service is lost.
6. Save the Thing.
Now you have a service that can be consumed by a mashup.
Was this helpful?