[Deprecated]: v6.0
get
/ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queryDetails
Deprecated: Use latest version instead. Compared to v5.0, this v6.0 endpoint preserves query-details filtering while introducing versioned DTO alignment for upgraded query workflows. This benefits users by keeping query-details integrations stable during version transitions.
Request
Path Parameters
-
mode(required): string
Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).
-
studyId(required): string(uuid)
Clinical One study identifier formatted as a 32-character UUID without dashes.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Nested Schema : QueryDetailsDTOV6Resp
Type:
Show Source
object-
comments: array
comments
-
eventInstanceNumber: integer
(int32)
-
formId: string
(uuid)
-
formInstanceNumber: integer
(int32)
-
formName: string
-
id: string
(uuid)
-
itemId: string
(uuid)
-
itemName: string
-
queryModAllowedByUser: boolean
-
ruleId: string
(uuid)
-
studyRoles: array
studyRoles
-
studyVersion: string
-
subjectId: string
(uuid)
-
subjectName: string
-
userCanCloseQuery: boolean
-
visitId: string
(uuid)
-
visitName: string
Nested Schema : comments
Type:
Show Source
array-
Array of:
object CommentDetailsDTO
A list of comments associated with the query
Nested Schema : CommentDetailsDTO
Type:
objectA list of comments associated with the query
Show Source
-
queryComment: string
Text recorded for this query interaction or state transition.Example:
Please verify the value. -
state: string
Allowed Values:
[ "Candidate", "Opened", "Answered", "Closed", "Deleted" ]Lifecycle state at this interaction, not necessarily the current query state. Candidate is awaiting triage; Opened awaits a response; Answered awaits review; Closed is resolved; Deleted is removed.Example:Opened -
userInfo: object
DisplayUserDto
User details including name, username, and email address.
-
value: string
Captured value associated with this interaction; can contain a JSON-encoded value/label array or be null.Example:
[{"value":"4","label":"Caucasian"}] -
versionStart: string
(date-time)
Effective timestamp of this history interaction, in ISO-8601 format.Example:
2026-01-01T10:00:00Z
Nested Schema : DisplayUserDto
Type:
objectUser details including name, username, and email address.
Show Source
-
emailAddress: string
User's email address.Example:
alice.brown@email.com -
firstName: string
User's first name.Example:
Alice -
id: string
Unique identifier for the user.Example:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
lastName: string
User's last name.Example:
Brown -
userName: string
User's login name.Example:
alicebrown
Example:
{
"id":"00000000000000000000000000000003",
"userName":"autocalc"
}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