v1.0
get
/ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queryDetails/dateRange
Retrieves query management records for the requested study and site when any query lifecycle record has a VersionStart within the requested date range, using forward-only cursor pagination ordered by query creation date and query ID. The caller must have ViewAllQueries permission for the requested study. startDate and endDate are inclusive. Date-only values are supported: a date-only startDate is interpreted as 00:00:00.000 UTC and a date-only endDate as 23:59:59.999 UTC. The end date must be later than the start date. Continuation requests must reuse the same studyId, mode, siteId, startDate, endDate, and limit values with the returned nextPageToken. nextPageToken is null on the last page.
Request
Path Parameters
-
mode(required): string
Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).Example:
test -
studyId(required): string(uuid)
Clinical One study identifier formatted as a 32-character UUID without dashes.Example:
A1B23C45D67E89F123456789ABCDEF12
Query Parameters
-
endDate(required): string
Inclusive date-range end in dd-MMM-yyyy HH:mm:ss.SSS format, or a date-only value in dd-MMM-yyyy or yyyy-MM-dd format. A date-only end value is interpreted as 23:59:59.999 UTC. The end date must be later than the start date.Example:
09-Jun-2026 00:00:00.000 -
limit(required): integer(int32)
Minimum Value:
1Maximum Value:10000Required maximum number of query records to return. Accepted values are positive integers from 1 through 10000; negative values are not accepted.Example:25 -
pageToken: string
Minimum Length:
1Maximum Length:2048Optional opaque URL-safe Base64 cursor token. Omit this value on the first request; on successive calls, set pageToken to the nextPageToken value from the previous response.Example:eyJ2ZXJzaW9uIjoxLCJzdHVkeUlkIjoiQTFCMjNDNDVENjdFODlGMTIzNDU2Nzg5QUJDREVGMTIifQ -
siteId(required): string(uuid)
Minimum Length:
32Maximum Length:36Pattern:^[0-9A-Fa-f-]{32,36}$Required single site identifier used to filter query records for the requested study.Example:F65008AC5A7E44E88B0B5C065E4D19A4 -
startDate(required): string
Required inclusive query lifecycle activity start timestamp in dd-MMM-yyyy HH:mm:ss.SSS format, or a date-only value in dd-MMM-yyyy or yyyy-MM-dd format. A date-only start value is interpreted as 00:00:00.000 UTC.Example:
01-Mar-2026 00:00:00.000
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Query details returned successfully. If no query records match the requested filters, results is returned as an empty array.
Root Schema : QueryListByDateRangeRespDTO
Type:
objectQuery Service response envelope for query details returned by created date range.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
QueryListByDateRangeResultDTO
Cursor-paginated query details payload returned in the Query Service response envelope.
-
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 : QueryListByDateRangeResultDTO
Type:
objectCursor-paginated query details payload returned in the Query Service response envelope.
Show Source
-
hasMore: boolean
Indicates if there are more results beyond the current page.Example:
true -
limit: integer
(int32)
Minimum Value:
1Maximum Value:10000Maximum number of records returned per page.Example:25 -
nextPageToken: string
Opaque cursor token to request the next page. Null on the last page when hasMore is false.
-
results: array
results
Query records returned for the current page.
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"
}Nested Schema : results
Type:
arrayQuery records returned for the current page.
Show Source
-
Array of:
object QueryDetailsDTOv12Resp
Query management response entry with study role metadata.
Nested Schema : QueryDetailsDTOv12Resp
Type:
objectQuery management response entry with study role metadata.
Show Source
-
comments: array
comments
Query interaction history. Each entry has its own state and versionStart. Details follow requested history ordering; v3 lists return newest-first. Do not infer current state from an arbitrary entry.
-
discrepancyId: integer
(int64)
Discrepancy identifier sourced from Data Capture. Negative values are rejected.Example:
123456789 -
eventInstanceNumber: number
(int64)
Sequence number (0, 1, 2, ...) of the repeating event. Negative values are rejected.Example:
0 -
ExistingStudyRoles: array
ExistingStudyRoles
Role-assignment groups per query interaction, rather than a flat current-assignment list. Returned as ExistingStudyRoles; each inner list contains study-role UUID/name pairs.
-
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 -
formName: string
Form display label from the study design.Example:
Screening Form -
id: string
(uuid)
Query unique identifier. Value must be a 32 to 36 character hexadecimal GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
isCycle: boolean
Whether the query belongs to a cyclic visit in the study design, not whether the query has been reopened.Example:
false -
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 -
itemName: string
Question display label; may be absent for visit-property queries.Example:
Race -
objectVersionNumber: number
(int64)
Sequence number (0, 1, 2, ...) of object version. Negative values are rejected.Example:
0 -
propertyName: string
Property within propertyType; visitStartDate is the visit start-date property. May be null for item queries.Example:
visitStartDate -
propertyType: string
Property category; visit identifies a visit-property query. May be null for item queries.Example:
visit -
queryAge: string
Whole days from first opening to latest closure, or to the current UTC time if not closed. Candidate and Deleted queries have age 0. This response age differs from queryByAge filtering, which compares days since initial creation.Example:
3 -
queryModAllowedByUser: boolean
Whether the authenticated caller may modify this query under its current state and assignment rules.Example:
false -
repeatFormNumber: integer
(int64)
Repeat form sequence number. Negative values are rejected.Example:
1 -
ruleId: string
(uuid)
Designer rule UUID for a rule-generated query; may be null for manual queries.Example:
ae33a909-6bf5-48bb-b29a-96e399e9fbbb -
siteId: string
(uuid)
Site unique GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
studyRoles: array
studyRoles
Study-role assignments associated with the query. Each entry supplies the role UUID and display name.
-
studyVersion: string
Study design version associated with the query, not the API/envelope version.Example:
15.0.0.75 -
subjectId: string
(uuid)
Subject unique GUID.Example:
b1b8327a-faa6-4122-8710-6192ab5984ef -
subjectName: string
Subject display label; subjectId carries its UUID.Example:
Subject 001 -
typeId: integer
(int32)
Numeric rule-query type identifier. Corresponds to ruleTypeId filtering; distinct from the designer rule UUID.Example:
3 -
userCanAnswerQuery: boolean
Whether the authenticated caller may answer this query under its current state, rights and assignment rules.Example:
true -
userCanCloseQuery: boolean
Whether the authenticated caller may close this query under its current state, rights and assignment rules.Example:
true -
visitId: string
(uuid)
Designed visit/event UUID; instance numbers identify its captured occurrence.Example:
3b95322b-1514-4e43-97b3-0305eb33e871 -
visitName: string
Visit display label from the study design.Example:
Screening Visit
Nested Schema : comments
Type:
arrayQuery interaction history. Each entry has its own state and versionStart. Details follow requested history ordering; v3 lists return newest-first. Do not infer current state from an arbitrary entry.
Show Source
Example:
[
{
"state":"Opened",
"queryComment":"Please verify the value.",
"versionStart":"2026-01-01T10:00:00Z"
}
]Nested Schema : ExistingStudyRoles
Type:
arrayRole-assignment groups per query interaction, rather than a flat current-assignment list. Returned as ExistingStudyRoles; each inner list contains study-role UUID/name pairs.
Show Source
-
Array of:
array items
Role-assignment groups per query interaction, rather than a flat current-assignment list. Returned as ExistingStudyRoles; each inner list contains study-role UUID/name pairs.
Example:
[
[
{
"studyRoleId":"68C35A92894A4ABCB2E2F6008E4402DB",
"studyRoleName":"CRA"
}
]
]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 : CommentDetailsDTOV2
Type:
Show Source
object-
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 -
userDisplayName: string
Display name of the user/system that recorded this interaction.Example:
Auto Calculation -
userInfo: object
DisplayUserDto
User details including name, username, and email address.
-
userStudyRoleId: string
Study-role UUID associated with the interaction; may be null for system users.Example:
68C35A92894A4ABCB2E2F6008E4402DB -
userStudyRoleName: string
Display name of the interaction study role; may be null when not available.Example:
CRA -
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 : items
Type:
arrayRole-assignment groups per query interaction, rather than a flat current-assignment list. Returned as ExistingStudyRoles; each inner list contains study-role UUID/name pairs.
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
Returned when the request cannot be parsed before endpoint validation is performed.
Root Schema : QueryListByDateRangeErrorRespDTO
Type:
objectQuery Service error response envelope for query details returned by created date range.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
No result payload is returned when status equals failed.
-
status: string
Allowed Values:
[ "failed" ]Overall execution status. Value is failed when errorData is returned.Example:failed -
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:
objectNo result payload is returned when status equals failed.
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
401 Response
Returned when authentication is missing, invalid, or expired. Provide a valid Authorization header.
Root Schema : QueryListByDateRangeErrorRespDTO
Type:
objectQuery Service error response envelope for query details returned by created date range.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
No result payload is returned when status equals failed.
-
status: string
Allowed Values:
[ "failed" ]Overall execution status. Value is failed when errorData is returned.Example:failed -
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:
objectNo result payload is returned when status equals failed.
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
403 Response
Returned when the authenticated user does not have ViewAllQueries permission for the requested study. Assign this permission through study role administration before calling the API.
Root Schema : QueryListByDateRangeErrorRespDTO
Type:
objectQuery Service error response envelope for query details returned by created date range.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
No result payload is returned when status equals failed.
-
status: string
Allowed Values:
[ "failed" ]Overall execution status. Value is failed when errorData is returned.Example:failed -
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:
objectNo result payload is returned when status equals failed.
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
422 Response
Returned when required filters are missing or invalid, including missing siteId, multiple siteId values, invalid date-time values, endDate earlier than startDate, limit outside 1 through 10000, an invalid pageToken, or a pageToken whose filters do not match the current request.
Root Schema : QueryListByDateRangeErrorRespDTO
Type:
objectQuery Service error response envelope for query details returned by created date range.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
No result payload is returned when status equals failed.
-
status: string
Allowed Values:
[ "failed" ]Overall execution status. Value is failed when errorData is returned.Example:failed -
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:
objectNo result payload is returned when status equals failed.
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
500 Response
Returned when an unexpected server error prevents query list retrieval.
Root Schema : QueryListByDateRangeErrorRespDTO
Type:
objectQuery Service error response envelope for query details returned by created date range.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
No result payload is returned when status equals failed.
-
status: string
Allowed Values:
[ "failed" ]Overall execution status. Value is failed when errorData is returned.Example:failed -
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:
objectNo result payload is returned when status equals failed.
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