getUADMetadata

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: 1 (United States English) 2 (Simplified Chinese, Pinyin ordering) 3 (French)
_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. `<status>SUCCESS</status>`	String	State of a given request call
callID `<callId>63631fe1-7378-4cc1-ab18-87c06c2eff58</callId>`	String	The CALL_ID is the unique identifier for a given Web Services call. Generated by the ScholarOne Web Services application.
profileCallId `<profileCallId>111111</profileCallId>`	String	An id value that is set by the client for call tracking. Set by the request’s external_id element.

documentId `<documentId>62694048</documentId>`	Integer	Unique identifier for the document.

documentScores Complex Child of Parent Root Includes the following response elements: documentScore	Complex	Container element holding all document score records for this document.

documentScore Complex Child of documentScores Includes the following response elements: datetimeReportCreated, score, clearedBy, clearedByFirstName, clearedByLastName, clearedComment, datetimeCleared	Complex	Represents the overall UAD scoring summary for the document.
datetimeReportCreated `<datetimeReportCreated>2025-11-21 11:52:23</datetimeReportCreated>`	DateTime	Timestamp when the UAD report was created (format: YYYY-MM-DD HH:MM:SS)
score `<score>58</score>`	Integer	Cumulative UAD score for the document (sum of all triggered UAD item scores)
clearedBy `<clearedBy>1329444</clearedBy>`	Integer	Person ID of the user who cleared the alert.
clearedByFirstName `<clearedByFirstName>John</clearedByFirstName>`	String	First name of the user who cleared the alert.
clearedByLastName `<clearedByLastName>Grammaticus</clearedByLastName>`	String	Last name of the user who cleared the alert.
clearedComment `<clearedComment>the reviewers are known to the editors</clearedComment>`	String	Comment provided by the user when clearing the alert.
datetimeCleared `<datetimeCleared>2021-01-19 08:01:15</datetimeCleared>`	DateTime	Timestamp when the alert was cleared by journal staff (format: YYYY-MM-DD HH:MM:SS)

uadItems Complex Child of Parent Root Includes the following response elements: uadItem	Complex	Container element holding all UAD detection items for this document.

uadItem Complex Child of uadItems Includes the following response elements: UADScoreItemType, datetimeChecked, personId1, firstName1, lastName1, ipAddress1, deviceId1, personId2, firstName2, lastName2, ipAddress2, deviceId2	Complex	Represents a specific instance of unusual activity detected on the document.
datetimeChecked `<datetimeChecked>2025-11-21 11:37:33</datetimeChecked>`	DateTime	Timestamp when the activity was detected.
deviceId1 `<deviceId1>25d4888f-e4b8-4ccb-a556-67b0121862cd</deviceId1>`	String	Device ID (UUID) of the first individual.
deviceId2 `<deviceId2>25d4888f-e4b8-4ccb-a556-67b0121862cd</deviceId2>`	String	Device ID (UUID) of the second individual (if applicable)
firstName1 `<firstName1>John</firstName1>`	String	First name of the first individual.
firstName2 `<firstName2>Ryan</firstName2>`	String	First name of the second individual (if applicable)
lastName1 `<lastName1>Smith</lastName1>`	String	Last name of the first individual.
lastName2 `<lastName2>Ros</lastName2>`	String	Last name of the second individual (if applicable)
ipAddress1 `<ipAddress1>76.123.18.67</ipAddress1>`	String	IP address of the first individual.
ipAddress2 `<ipAddress2>76.123.18.67</ipAddress2>`	String	IP address of the second individual (if applicable)
personId1 `<personId1>141313629</personId1>`	Integer	Person ID of the first individual involved.
personId2 `<personId2>135863054</personId2>`	Integer	Person ID of the second individual (if applicable)
UADScoreItemType `<UADScoreItemType>UAD_AU_REV_CK_CHECK</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.