Introduction

The PROLIN Power Server REST-based Web API is a service that exposes PROLIN Smart Suite resources and relationships through the Open Data Protocol (OData).

This service can be accessed using programming languages such as C# or Java, or scripting languages like JavaScript.

Interaction with the service is performed through standard HTTP requests:

By default, the data is returned in JSON format.

In the remainder of this document, the term REST-based Web API will be referred to as REST API.

Change History

Rev # Date Summary
0.1 June 2015 Initial revision
1.0 Mar 2016 Finalized revision
1.1 Aug 2016 Added support for $select clause
1.2 Oct 2016 Added support for $expand clause
1.3 Jan 2017 Added queries on individual entities
2.0 Feb 2020 - Added support for $select and $expand on individual properties
- Added support for navigation properties
- Added support for OAuth authentication
- Added support for attachments, history lines and custom fields
- Added OpenAPI explorer endpoint
- Added TLS support
- Added support for POST, PATCH, DELETE operations
- Added support for creating and removing references
- Exposed some basic OData annotations in $metadata
- Added $ping
2.1 Jun 2020 - Date/Time values are always UTC
- POST now accepts @odata.bind to add references on creation
- $filter=Code/Value eq <id> now supported
- Added support for history line attachments
- Added support for @odata.bind on PATCH operations
2.2 Mar 2021 - Added support for Custom Entity Reference update/delete/assign
- Added support for Custom Code properties (Patch, Post)
- Added support for nested complex object navigation (e.g., Assignment)
2.3 Jun 2024 - Added Codes function endpoint
- Added support for Templates
2.4 Sept 2025 - Added /Me Endpoint

Intended Audience

Due to the high level of technical details, this document is intended for the following audience:

  • Software Architects
  • Software Engineers
  • Support Engineers
  • Technical Consultants
Back to top