Overview

The Relay API provides a unified way to submit and manage different types of objects for validation and storage. Some of the supported use cases include document integrity checks, reviewer matching and author verification, with the flexibility to support additional workflows as needed.

Clients interact with the API through a POST request containing a JSON payload with the relevant details. Each request is validated against predefined constraints before the data is stored and made available for future retrieval.

Recommended Integration Workflow

The preferred pattern for a Relay-based integration is event-driven rather than polling-based. Rather than continuously querying ScholarOne Manuscripts for new documents, an integrator should subscribe to the relevant notification service event (for example, a new submission or a revision event) and wait for ScholarOne Manuscripts to push a notification when that event occurs. The notification payload includes, at minimum, the site_name and documentId for the affected submission, which together uniquely identify the document across the ScholarOne Manuscripts instance.

Upon receiving the notification, the integrator should use these two values to call the appropriate ScholarOne Manuscripts API to retrieve the metadata it needs, for example, getSubmissionInfoFull is by far the most commonly used call for this purpose, though other endpoints may apply depending on the use case. With this metadata in hand, the integrator runs its check or report generation process on its own infrastructure, outside of ScholarOne Manuscripts.

Once the results are ready, the integrator posts its findings back to ScholarOne Manuscripts by submitting a Relay API request to /api/s1m/v2/system/addJSONData, using the same documentId to associate the report with the correct submission. This notification-triggered, metadata-pull, report-push cycle keeps integrator systems synchronized with S1M in near real time while minimizing unnecessary API traffic, and is the recommended approach for any new Relay integration.

Method: POST

Resource

• /api/s1m/v2/system/addJSONData

Request Parameters

Request Body Elements

• The request body must be in JSON format.

Request Body Elements for Integrity Check example

{
    "data": {
        "type": 2,
        "payload": {
            "documentId": 12345,
            "content": "<p>Sample content</p>",
            "checkType": 1111,
            "url": "https://example.com",
            "effectiveDate": "2025-03-17",
            "score": 45,
            "alert": "false"
        }
    }
}

Request Body Elements Description