Migration to RDEA 2.0 APIs FAQs

SafetyChain is transitioning from the Record Data Extract APIs (RDEA) 1.0 to RDEA 2.0. This update will also include the discontinuation of the RDEA 1.0 Report Page, as well as the API Admin and Helper Pages available at LINK. The deadline for clients to be migrated off of Logi/RDEA 1.0 APIS and into the new RDEA 2.0 API platform is 07/01/2025.

Benefits clients will experience include:

Enhanced Security: APIs are now protected with Bearer JWT Authorization.

Simplified Access: Clients can manage API access through Roles and Permissions, eliminating the need for SafetyChain involvement.

Streamlined Filtering: Request filtering is managed within the request body, offering a more consistent and user-friendly experience.

Improved Error Messaging: Error messages are now more detailed and explanatory, facilitating easier issue identification and resolution.

Robust Backend Platform: Supported by Azure Function Applications, ensuring reliable and consistent performance.

Standardized Output: Data is formatted with appropriate Parent and Child structures where applicable.

Introduction of Power BI Connector: A new Power BI Connector simplifies integration for users of Power BI.

For clients currently using the RDEA 1.0 Report Page, the new Power BI Connector can be used to generate and convert data into .csv files.

FAQS

Will I be able to access the old APIs right now?

Yes, the old APIs will remain available until the specified deadline.

Will I need new security tokens for the new APIs?

No, new security tokens are not required. Access to the RDEA 2.0 APIs is managed by updating the necessary permissions for roles. For more details, please visit our Developers Hub.

Are the new responses the same as the old responses?

The new responses are largely similar to the old ones, but there are a few key differences:**

  1. List Formatting Changes:

    • Old Responses: Lists were presented as a single string.
    • New Responses: Lists are now organized as child objects within their respective parent entities. For example:
      • ImageList
      • FieldImageList
      • VerificationList
  2. Changes to GetRecordFields API:

    • Old Version: Data was presented in a flat table format.
    • New Version: The GetRecordFields API call now provides data in a Parent (Record) / Child (RecordFields) format. This change means paging now applies to records instead of individual record fields.
  3. Static Output of APIs:

    • Old Responses: Users had to use variables to determine the output.
    • New Responses: The output is now static, providing all data directly without requiring additional variable usage.
  4. Status Object Table:

    • Old Responses: Had no status information.
    • New Responses: All responses now include a Status Object with the following details:
      • RequestId: The ID of the request.
      • ResponseStatus: The status of the request (e.g., Complete, Incomplete, Error).
      • RecordCount: The number of records returned.
      • Comments: Any additional comments, including error descriptions if applicable.

What are the time limits for the new API calls?

The new API call duration has time limits ranging from 100 to 240 seconds maximum.

What should I do if I encounter an error related to the API call duration?

If you encounter an error, it is advised to filter your query further to fit within the allotted time restrictions. This adjustment should help ensure your query completes within the permitted duration.

Will any APIs be discontinued?

Yes, the GetRecordResults API will be deprecated. Its information has been integrated into the GetRecordFields API call.

Are the RDEA 2.0 APIs available to begin development and testing?

Yes, the RDEA 2.0 APIs are available for development and testing in both the Train and Live environments.

I use the Report Page to query and download my data. Will this still be available?

No, the Report Page will be deprecated after the deadline. However, SafetyChain has developed a Power BI Connector to offer similar functionality for our clients.