...
ODATA URL format:
ODATA v2: https://odata-<environment>.<customer>.moventus.com/odata/api2
ODATA v4: https://odata-<environment>.<customer>.moventus.com/odata/api4
ADVANCED Endpoint for custom queries created in Rego OData Extension object: https://odata-<environment>.<customer>.moventus.com/odata/ppmapi
For example, if your organization name is “biggreenit”, the endpoints for the DEV non-production environment will be as below:
ODATA v2: https://odata-dev.biggreenit.moventus.com/odata/api2
ODATA v4: https://odata-dev.biggreenit.moventus.com/odata/api4
ADVANCED Endpoint for custom queries created in Rego OData Extension object: https://odata-dev.biggreenit.moventus.com/odata/ppmapi
For example, if your organization name is “biggreenit”, the endpoints for the PRODUCTION environment will be as below. Production URLs will not have the environment name:
ADVANCED Endpoint for custom queries created in Rego OData Extension object: https://odata.biggreenit.moventus.com/odata/ppmapi
CREDENTIALS:
ODATA does not use Single Sign On, or any other custom authentication. Basic authentication is used. The Clarity username and password will be used to connect to ODATA.
...
ODATA Query Code | Provide the unique identifier for the feed in “ODATA Query Code”. The code should start with an alphabetic letter, can contain only alphanumeric digits with no spaces or other special characters except underscore. |
Short Description | Description of the feed details |
SQL Query | a SELECT query to execute for the feed. If all fields of a table are required, use “SELECT * from <table_name>” |
Query Primary Keys Alias | Each OData feed entry must have a primary key. It can be combination of multiple keys. In such case, use a comma to separate the key aliases |
Query Status | Can have a status as New, Valid, Invalid. Only Valid queries will be available for the ODATA feed IMPORTANT NOTE: If the query takes more than 15 seconds to execute, then status is set to invalid. Such queries hit the hard threshold limits of AWS architecture and will adversely impact the main Clarity transactional database. |
Error | If the query or the primary key details provided are invalid, then Query Status will be set to invalid, and the respective error reason will be displayed in this field. |
Active | When inactive, the fields: short description, SQL Query, Query Primary Keys Alias will be editable and can be changed. To validate the query, Check the Active field and save the changes. This will auto trigger the process “Rego Validate OData Extension” which will perform all the validations. If validations are successful, the status is set to valid. Otherwise, the status is marked as invalid, and reasons are mentioned under the Error field |
Activated and validated entries will be locked to avoid for further editing. To edit, user must first deactivate the entry. Then perform the required changes, activate, and save the form. This will trigger the process that will revalidate the changes.
...
All the validated ODATA extension object entries should now be accessible in the ODATA endpoint.
...