A REST configuration is an XML file with a
.RCM extension (short for REST Connection Manager) that describes a Web API. It stores all settings related to authentication, resources, endpoints, data sending and processing for consuming an API in SSIS context.
The main elements of a RCM configuration include:
- Service - specify the base service URL (i.e. base address for API endpoints) and configure general error handling settings.
- Authentications - describe any authentication methods that the service supports. You can use "User" parameters - they are specified when configuring the authentication in the REST Connection Manager, "Token" - builtin functionality of REST engine that process and store OAuth token information.
- Resources - describe templates and resources. Templates fields are fields that can be referenced by multiple resources. Template resources enable specifying common settings for multiple resources. A resource contains all fields that any of its related endpoint returns or accepts. There can be multiple endpoints that return particular resource data and also there can be zero or one endpoint corresponding to the different ways resource data can be modified (i.e. creating, updating, upserting and deleting).
An XML Schema is available for documenting and validating the RCM format.
Ready to give it a try?
COZYROC SSIS+ Components Suite is free for testing in your development environment.