setCustomFlagsList

setCustomFlagsList This API endpoint allows users to set or clear custom flags on singe or multiple documents. Custom flags are user-defined markers that help categorize or prioritize documents within the system. This API call supports applying or removing custom flags on specific documents, identified by their unique documentId.

Method: POST

Resource

/api/s1m/v2/submissions/full/setCustomFlagsList

Request Parameters

Element	Type	Description	Required	Example or Default Value
setCustomFlagsList	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
site_name	String	Site short name. The short name is the abbreviated or truncated name of the journal, society, publisher, or family.	Yes	web_svcs
url	String	The Web Service URL, which identifies the specific service to handle the request.	Yes	v2/submissions/full/setCustomFlagsList
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

Request Body Elements

The request body must be in JSON format.

{
  "input": {
    "customFlagsList": [
      {
        "documentId": 1001644,
        "customFlagId": 1234,
        "setFl": 0
      },
      {
        "documentId": 4374354,
        "customFlagName": "Starfleet Member",
        "setFl": 1
      }
    ]
  }
}

Request Body Elements Description

Request Body Element	Type	Description	Required	Example or Default Value
Input	Object	This is the root object containing all the data required for setting custom flags on manuscripts.	Yes
customFlagsList	Array	An array of objects, where each object represents an operation to set or clear a custom flag on a specific manuscript. Multiple documents can be processed in a single request.	Yes
documentId	Integer	The unique identifier of the manuscript on which the flag is to be set or cleared.	Yes	"documentId": 54104923
customFlagId	Integer	The unique identifier of the custom flag to be applied or removed. This field is required if customFlagName is not provided. This ID must correspond to a predefined custom flag in the system.	Yes, if customFlagName is not provided	"customFlagId": 1234
customFlagName	String	The name of the custom flag to be applied or removed. This field is required if customFlagId is not provided. The name must match a predefined custom flag in the system.	Yes, if customFlagId is not provided	"customFlagName": "Starfleet Member"
setFl	Integer	Indicates whether the flag should be set or cleared: 1: Set the flag on the document. 0: Clear the flag from the document.	Yes	"setFl": 1