v10.0
put
/ec-query-svc/rest/v10.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
Assigns or updates the study roles responsible for an eligible query, allowing clients to route follow-up work and optionally record an audit comment. Compared to v9.0, this v10 endpoint supports multiple study role assignments in one call and applies enhanced assignment validation.
Request
Path Parameters
-
mode(required): string
Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).Example:
test -
queryId(required): string
Query ID.Example:
AE33A9096BF548BBB29A96E399E9FBBB -
studyId(required): string
Clinical One study identifier formatted as a 32-character UUID without dashes.Example:
A1B23C45D67E89F123456789ABCDEF12
Query Parameters
-
discrepancyId: integer(int64)
Minimum Value:
0Unique discrepancy identifier. Negative values are rejected.Example:123456789 -
objectVersionNumber: number(int64)
Minimum Value:
0Current object version number. Negative values are rejected.Example:2
Supported Media Types
- application/json
Root Schema : schema
Type:
objectRequest payload for query assign update v10 API.
Show Source
-
comment: string
Review comment recorded during assignment.Example:
Reassigning to CRA for follow-up. -
studyRoles(required): array
studyRoles
List of study role identifiers to assign.
Nested Schema : studyRoles
Type:
arrayList of study role identifiers to assign.
Show Source
Example:
[
"6AF54DB79B764662B685D68C52AB0B84"
]Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : QueryDTO Version 9
Type:
objectTitle:
QueryDTO Version 9Information returned from updating/inserting query
Show Source
-
dataElementId: string
(uuid)
Data element unique GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
discrepancyId: integer
(int64)
Discrepancy identifier sourced from Data Capture. Negative values are rejected.Example:
123456789 -
eventId: string
(uuid)
Event unique GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
eventInstanceNumber: number
(int64)
Sequence number (0, 1, 2, ...) of the repeating event. Negative values are rejected.Example:
0 -
formId: string
(uuid)
Form unique GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
formInstanceNumber: number
(int64)
Sequence number (0, 1, 2, ...) of the repeating form. Negative values are rejected.Example:
0 -
id: string
(uuid)
Query unique identifier. Value must be a 32 to 36 character hexadecimal GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
isQueryCreator: boolean
Indicates if the authenticated user created the query (true or false).Example:
true -
itemId: string
(uuid)
Item unique GUID.Example:
b2b8327a-faa6-4122-8710-6192ab5984ef -
objectVersionNumber: number
(int64)
Sequence number (0, 1, 2, ...) of object version. Negative values are rejected.Example:
0 -
propertyName: string
Property name associated with the query when Data Capture properties are involved. Example: visit.Example:
visit -
propertyType: string
Allowed Values:
[ "visit", "visitStartDate" ]Property type classification. Allowed values: visit (query anchored to visit details), visitStartDate (query anchored to the visit start date).Example:visit -
queryComment: string
Minimum Length:
1Maximum Length:2048Query comments captured during open, candidate, or close operations.Example:Query comment example here.. -
repeatFormNumber: integer
(int64)
Repeat form sequence number. Negative values are rejected.Example:
1 -
ruleId: string
(uuid)
Rule unique GUID for queries created by rule.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
siteId: string
(uuid)
Site unique GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
state: string
Allowed Values:
[ "Candidate", "Opened", "Answered", "Closed", "Deleted" ]Query state. Allowed values: Candidate (new discrepancy awaiting triage), Opened (active discrepancy requiring action), Answered (site responded awaiting review), Closed (resolved discrepancy), Deleted (removed during workflow).Example:Opened -
studyRoles: array
studyRoles
Study-role assignments associated with the query. Each entry supplies the role UUID and display name.
-
studyVersionStart: string
(date-time)
Data element version start timestamp in ISO-8601 format.Example:
2026-01-15T10:05:30Z -
subjectId: string
(uuid)
Subject unique GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef
Nested Schema : studyRoles
Type:
arrayStudy-role assignments associated with the query. Each entry supplies the role UUID and display name.
Show Source
Example:
[
{
"studyRoleId":"68C35A92894A4ABCB2E2F6008E4402DB",
"studyRoleName":"CRA"
}
]Nested Schema : QueryStudyRoleDTOv6
Type:
Show Source
object-
studyRoleId: string
(uuid)
Study-role UUID represented by this assignment/history entry.Example:
68c35a92-894a-4abc-b2e2-f6008e4402db -
studyRoleName: string
Display name of the corresponding study role.Example:
CRA
Examples
400 Response
Request validation failed due to missing, invalid, or inconsistent request data.
Root Schema : Response DTO
Type:
objectBase envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
Result payload returned when status equals success.
-
status: string
Read Only:
trueAllowed Values:[ "success", "failed" ]Overall execution status. Value is success when result is populated and failed when errorData is returned.Example:success -
version: string
Read Only:
trueSemantic version of the response envelope.Example:1
Nested Schema : Error details DTO
Type:
objectStandard structure used to describe errors returned by Query APIs.
Show Source
-
details: object
QueryRestErrorDetail
Read Only:
trueContext object returned when additional error metadata is available. -
errorCode: string
Read Only:
trueMachine-readable error code that identifies the failure.Example:QRY-5000 -
errorMessage: string
Read Only:
trueHuman-readable explanation describing why the request failed.Example:Unexpected server error.
Example:
{
"errorCode":"QRY-5000",
"errorMessage":"Unexpected server error.",
"details":{
"requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
"supportCode":"QRY-5000",
"hint":"Retry request after verifying the study mode."
}
}Nested Schema : result
Type:
objectResult payload returned when status equals success.
Example:
{
"opened":3,
"answered":1,
"closed":2
}Nested Schema : QueryRestErrorDetail
Type:
objectRead Only:
trueContext object returned when additional error metadata is available.
Show Source
-
hint: string
Client-facing guidance that clarifies how to resolve or retry the request.Example:
Retry request after verifying the study mode. -
requestId: string
Unique identifier that can be supplied to Oracle Support when troubleshooting.Example:
3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a -
supportCode: string
Support or incident code associated with the error source.Example:
QRY-5000
Example:
{
"requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
"supportCode":"QRY-5000",
"hint":"Retry request"
}Examples
404 Response
The query could not be found.
Root Schema : Response DTO
Type:
objectBase envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
Result payload returned when status equals success.
-
status: string
Read Only:
trueAllowed Values:[ "success", "failed" ]Overall execution status. Value is success when result is populated and failed when errorData is returned.Example:success -
version: string
Read Only:
trueSemantic version of the response envelope.Example:1
Nested Schema : Error details DTO
Type:
objectStandard structure used to describe errors returned by Query APIs.
Show Source
-
details: object
QueryRestErrorDetail
Read Only:
trueContext object returned when additional error metadata is available. -
errorCode: string
Read Only:
trueMachine-readable error code that identifies the failure.Example:QRY-5000 -
errorMessage: string
Read Only:
trueHuman-readable explanation describing why the request failed.Example:Unexpected server error.
Example:
{
"errorCode":"QRY-5000",
"errorMessage":"Unexpected server error.",
"details":{
"requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
"supportCode":"QRY-5000",
"hint":"Retry request after verifying the study mode."
}
}Nested Schema : result
Type:
objectResult payload returned when status equals success.
Example:
{
"opened":3,
"answered":1,
"closed":2
}Nested Schema : QueryRestErrorDetail
Type:
objectRead Only:
trueContext object returned when additional error metadata is available.
Show Source
-
hint: string
Client-facing guidance that clarifies how to resolve or retry the request.Example:
Retry request after verifying the study mode. -
requestId: string
Unique identifier that can be supplied to Oracle Support when troubleshooting.Example:
3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a -
supportCode: string
Support or incident code associated with the error source.Example:
QRY-5000
Example:
{
"requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
"supportCode":"QRY-5000",
"hint":"Retry request"
}Examples