getUADMetadata
The Unusual Activity Detection (UAD) Metadata API retrieves detailed information about unusual activity detected on manuscripts during submission and review processes. This API returns comprehensive UAD scoring data, including detected activity types, involved persons, device information, and timestamps.
Required Parameters
- Document ID(s) - up to 25
- Site Short Name
Optional Parameters
- Locale ID
- _type
- External ID
Resource
/api/s1m/v2/document/full/uadmetadata/documentids
Request Parameters
| Element | Type | Description | Required | Example or Default Value |
|---|---|---|---|---|
| getUADMetadata | Root | Yes | ||
| username | String | Profile User Name. This is the user name used by the API, not a ScholarOne Manuscripts user. This is from the Caller’s profile. | Yes | sample_user |
| password | String | The API Key. Encrypted value uniquely identifying and authenticating Caller | Yes | SRU4DQ5WOJ2PX8CA |
| ids† | Integer or Integer Array | Document Id or Ids. Unique identifier for each Manuscript Revision in the ScholarOne Manuscripts system. Internally to ScholarOne, this is a numeric value. Each entry must be surrounded by single or double quotes and comma separated when more than one entry is specified. | Yes, if submission IDs are not used. | ’88026’ Or if a list is being requested: '88026','88087','89328' |
| site_name | String | Site short name. The short name is the abbreviated or truncated name of the journal, society, publisher, or family. | Yes | salesdemoplus |
| url | String | The Web Service URL, which identifies the specific service to handle the request. | Yes | v2/document/full/uadmetadata/documentids |
| external_id | String | An id value that can be set by the client for call tracking. Caller supplied Text string to be stored with Audit History information. | No | 123456 |
| locale_id | Integer | The unique identifier for a specific language. The value of the locale_id must match to the specific language as defined in the Caller’s profile. | No | Options are:
|
| _type | String | The data type requested from the Service <xml> or <json>. This defaults to <xml>. | No | xml (default if omitted), or json |
Response Elements
| Response Element /Example or Default Value | Type | Description |
|---|---|---|
Status Can be one of SUCCESS, FAILURE, or MAINTENANCE. | String | State of a given request call |
callID
| String | The CALL_ID is the unique identifier for a given Web Services call. Generated by the ScholarOne Web Services application. |
profileCallId
| String | An id value that is set by the client for call tracking. Set by the request’s external_id element. |
documentId
| Integer | Unique identifier for the document. |
documentScores Complex Child of Parent Root | Complex | Container element holding all document score records for this document. |
documentScore Complex Child of documentScores | Complex | Represents the overall UAD scoring summary for the document. |
datetimeReportCreated
| DateTime | Timestamp when the UAD report was created (format: YYYY-MM-DD HH:MM:SS) |
score
| Integer | Cumulative UAD score for the document (sum of all triggered UAD item scores) |
clearedBy
| Integer | Person ID of the user who cleared the alert. |
clearedByFirstName
| String | First name of the user who cleared the alert. |
clearedByLastName
| String | Last name of the user who cleared the alert. |
clearedComment
| String | Comment provided by the user when clearing the alert. |
datetimeCleared
| DateTime | Timestamp when the alert was cleared by journal staff (format: YYYY-MM-DD HH:MM:SS) |
uadItems Complex Child of Parent Root | Complex | Container element holding all UAD detection items for this document. |
uadItem Complex Child of uadItems | Complex | Represents a specific instance of unusual activity detected on the document. |
datetimeChecked
| DateTime | Timestamp when the activity was detected. |
deviceId1
| String | Device ID (UUID) of the first individual. |
deviceId2
| String | Device ID (UUID) of the second individual (if applicable) |
firstName1
| String | First name of the first individual. |
firstName2
| String | First name of the second individual (if applicable) |
lastName1
| String | Last name of the first individual. |
lastName2
| String | Last name of the second individual (if applicable) |
ipAddress1
| String | IP address of the first individual. |
ipAddress2
| String | IP address of the second individual (if applicable) |
personId1
| Integer | Person ID of the first individual involved. |
personId2
| Integer | Person ID of the second individual (if applicable) |
UADScoreItemType
| String | Type of unusual activity detected (see UAD Score Item Types below) |
UAD Score Item Types
The UAD system detects 29 distinct types of unusual activity patterns. Each type has an associated default score value that contributes to the overall document UAD score.
For more detailed information about UAD Score item types, please contact ScholarOne Manuscripts Support.
Updated 7 months ago