# OL Connect REST client

This package implements the REST calls to the OL Connect server. The OL Connect REST API reference can be found in [the cookbook](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference.html "OL Connect REST API cookbook")

## Public API methods
Within the root directory of the package there is a README.md file for each of the public API endpoints used by the OL Connect nodes. These can be accessed by viewing the package source using the Code tab on this NPM page. Alternatively the links below point to the online API cookbook where full details of the request and response objects as well as API endpoints can be found.

* [All in One](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/All-In-One_Service/Process_All-In-One_(JSON).html)
* [File Store Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/File_Store_Service/Download_Managed_File_or_Directory.html)
* [Data Mapping Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Data_Mapping_Service/Process_Data_Mapping_(JSON).html)
* [Output Creation Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Output_Creation_Service/Process_Output_Creation_(By_Job_Set)_(JSON).html
* [Content Item Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Content_Item_Entity_Service/Get_Data_Record_for_Content_Item.html)
* [Content Set Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Content_Set_Entity_Service/Get_All_Content_Sets.html)
* [Data Record Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Data_Record_Entity_Service/Add_Data_Records.html)
* [Data Set Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Data_Set_Entity_Service/Get_All_Data_Sets.html)
* [Document Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Document_Entity_Service/Get_Document_Metadata_Properties.html)
* [Document Set Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Document_Set_Entity_Service/Get_Documents_for_Document_Set.html)
* [Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Entity_Service/Find_Data_Entity.html)
* [Job Creation Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Job_Creation_Service/Get_Result_of_Operation.html)
* [Job Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Job_Entity_Service/Get_Content_Items_for_Job.html)
* [Job Segment Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Job_Segment_Entity_Service/Get_Document_Sets_for_Job_Segment.html)
* [Job Set Entity Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Job_Set_Entity_Service/Get_All_Job_Sets.html)
* [Creation Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Content_Creation_Service/Create_Preview_PDF_(By_Data)_(JSON).html)
* [Content Creation (Email) Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Content_Creation_(Email)_Service/Process_Content_Creation_(By_Data_Record)_(JSON).html)
* [Content Creation (HTML) Service](https://help.uplandsoftware.com/objectiflune/en/olconnect-api/2025.2/Cookbook/REST_API_Reference/Content_Creation_(HTML)_Service/Process_Content_Creation_(By_Data)_(JSON).html)

## Support
OL Connect Automate is supported through the [OL Care program](https://uplandsoftware.com/objectiflune/customer-support-and-resources/). Feel free to visit the [OL Connect Automate forum](https://olforum.uplandsoftware.com/c/olcnrs/38) to post questions, comments and suggestions.

## License
Copyright 2025 Upland Software Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software
and associated documentation files (the "Software"), to deal in the Software without restriction, 
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial 
portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.