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
  • Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).
    Example:
    test
  • Clinical One study identifier formatted as a 32-character UUID without dashes.
    Example:
    A1B23C45D67E89F123456789ABCDEF12
Query Parameters
  • 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
  • Minimum Value: 1
    Maximum Value: 10000
    Required maximum number of query records to return. Accepted values are positive integers from 1 through 10000; negative values are not accepted.
    Example:
    25
  • Minimum Length: 1
    Maximum Length: 2048
    Optional 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
  • Minimum Length: 32
    Maximum Length: 36
    Pattern: ^[0-9A-Fa-f-]{32,36}$
    Required single site identifier used to filter query records for the requested study.
    Example:
    F65008AC5A7E44E88B0B5C065E4D19A4
  • 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 Top

Response

Supported Media Types

200 Response

Query details returned successfully. If no query records match the requested filters, results is returned as an empty array.
Body ()
Root Schema : QueryListByDateRangeRespDTO
Type: object
Query Service response envelope for query details returned by created date range.
Show Source
Nested Schema : Error details DTO
Type: object
Standard structure used to describe errors returned by Query APIs.
Show Source
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: object
Cursor-paginated query details payload returned in the Query Service response envelope.
Show Source
Nested Schema : QueryRestErrorDetail
Type: object
Read Only: true
Context object returned when additional error metadata is available.
Show Source
  • Client-facing guidance that clarifies how to resolve or retry the request.
    Example: Retry request after verifying the study mode.
  • Unique identifier that can be supplied to Oracle Support when troubleshooting.
    Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
  • 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: array
Query records returned for the current page.
Show Source
Nested Schema : QueryDetailsDTOv12Resp
Type: object
Query management response entry with study role metadata.
Show Source
  • 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.
  • Discrepancy identifier sourced from Data Capture. Negative values are rejected.
    Example: 123456789
  • Sequence number (0, 1, 2, ...) of the repeating event. Negative values are rejected.
    Example: 0
  • 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.
  • Form unique GUID.
    Example: b1b8327a-faa6-4122-8710-6192ab5984ef
  • Sequence number (0, 1, 2, ...) of the repeating form. Negative values are rejected.
    Example: 0
  • Form display label from the study design.
    Example: Screening Form
  • Query unique identifier. Value must be a 32 to 36 character hexadecimal GUID.
    Example: b1b8327a-faa6-4122-8710-6192ab5984ef
  • Whether the query belongs to a cyclic visit in the study design, not whether the query has been reopened.
    Example: false
  • Indicates if the authenticated user created the query (true or false).
    Example: true
  • Item unique GUID.
    Example: b2b8327a-faa6-4122-8710-6192ab5984ef
  • Question display label; may be absent for visit-property queries.
    Example: Race
  • Sequence number (0, 1, 2, ...) of object version. Negative values are rejected.
    Example: 0
  • Property within propertyType; visitStartDate is the visit start-date property. May be null for item queries.
    Example: visitStartDate
  • Property category; visit identifies a visit-property query. May be null for item queries.
    Example: visit
  • 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
  • Whether the authenticated caller may modify this query under its current state and assignment rules.
    Example: false
  • Repeat form sequence number. Negative values are rejected.
    Example: 1
  • Designer rule UUID for a rule-generated query; may be null for manual queries.
    Example: ae33a909-6bf5-48bb-b29a-96e399e9fbbb
  • Site unique GUID.
    Example: b1b8327a-faa6-4122-8710-6192ab5984ef
  • studyRoles
    Study-role assignments associated with the query. Each entry supplies the role UUID and display name.
  • Study design version associated with the query, not the API/envelope version.
    Example: 15.0.0.75
  • Subject unique GUID.
    Example: b1b8327a-faa6-4122-8710-6192ab5984ef
  • Subject display label; subjectId carries its UUID.
    Example: Subject 001
  • Numeric rule-query type identifier. Corresponds to ruleTypeId filtering; distinct from the designer rule UUID.
    Example: 3
  • Whether the authenticated caller may answer this query under its current state, rights and assignment rules.
    Example: true
  • Whether the authenticated caller may close this query under its current state, rights and assignment rules.
    Example: true
  • Designed visit/event UUID; instance numbers identify its captured occurrence.
    Example: 3b95322b-1514-4e43-97b3-0305eb33e871
  • Visit display label from the study design.
    Example: Screening Visit
Nested Schema : comments
Type: array
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.
Show Source
Example:
[
    {
        "state":"Opened",
        "queryComment":"Please verify the value.",
        "versionStart":"2026-01-01T10:00:00Z"
    }
]
Nested Schema : ExistingStudyRoles
Type: array
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.
Show Source
  • 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: array
Study-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: object
Show Source
  • Text recorded for this query interaction or state transition.
    Example: Please verify the value.
  • 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
  • Display name of the user/system that recorded this interaction.
    Example: Auto Calculation
  • DisplayUserDto
    User details including name, username, and email address.
  • Study-role UUID associated with the interaction; may be null for system users.
    Example: 68C35A92894A4ABCB2E2F6008E4402DB
  • Display name of the interaction study role; may be null when not available.
    Example: CRA
  • Captured value associated with this interaction; can contain a JSON-encoded value/label array or be null.
    Example: [{"value":"4","label":"Caucasian"}]
  • Effective timestamp of this history interaction, in ISO-8601 format.
    Example: 2026-01-01T10:00:00Z
Nested Schema : DisplayUserDto
Type: object
User details including name, username, and email address.
Show Source
Example:
{
    "id":"00000000000000000000000000000003",
    "userName":"autocalc"
}
Nested Schema : items
Type: array
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.
Show Source
Example:
[
    [
        {
            "studyRoleId":"68C35A92894A4ABCB2E2F6008E4402DB",
            "studyRoleName":"CRA"
        }
    ]
]
Nested Schema : QueryStudyRoleDTOv6
Type: object
Show Source
Examples

400 Response

Returned when the request cannot be parsed before endpoint validation is performed.
Body ()
Root Schema : QueryListByDateRangeErrorRespDTO
Type: object
Query Service error response envelope for query details returned by created date range.
Show Source
Nested Schema : Error details DTO
Type: object
Standard structure used to describe errors returned by Query APIs.
Show Source
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: object
No result payload is returned when status equals failed.
Nested Schema : QueryRestErrorDetail
Type: object
Read Only: true
Context object returned when additional error metadata is available.
Show Source
  • Client-facing guidance that clarifies how to resolve or retry the request.
    Example: Retry request after verifying the study mode.
  • Unique identifier that can be supplied to Oracle Support when troubleshooting.
    Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
  • 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.
Body ()
Root Schema : QueryListByDateRangeErrorRespDTO
Type: object
Query Service error response envelope for query details returned by created date range.
Show Source
Nested Schema : Error details DTO
Type: object
Standard structure used to describe errors returned by Query APIs.
Show Source
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: object
No result payload is returned when status equals failed.
Nested Schema : QueryRestErrorDetail
Type: object
Read Only: true
Context object returned when additional error metadata is available.
Show Source
  • Client-facing guidance that clarifies how to resolve or retry the request.
    Example: Retry request after verifying the study mode.
  • Unique identifier that can be supplied to Oracle Support when troubleshooting.
    Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
  • 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.
Body ()
Root Schema : QueryListByDateRangeErrorRespDTO
Type: object
Query Service error response envelope for query details returned by created date range.
Show Source
Nested Schema : Error details DTO
Type: object
Standard structure used to describe errors returned by Query APIs.
Show Source
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: object
No result payload is returned when status equals failed.
Nested Schema : QueryRestErrorDetail
Type: object
Read Only: true
Context object returned when additional error metadata is available.
Show Source
  • Client-facing guidance that clarifies how to resolve or retry the request.
    Example: Retry request after verifying the study mode.
  • Unique identifier that can be supplied to Oracle Support when troubleshooting.
    Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
  • 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.
Body ()
Root Schema : QueryListByDateRangeErrorRespDTO
Type: object
Query Service error response envelope for query details returned by created date range.
Show Source
Nested Schema : Error details DTO
Type: object
Standard structure used to describe errors returned by Query APIs.
Show Source
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: object
No result payload is returned when status equals failed.
Nested Schema : QueryRestErrorDetail
Type: object
Read Only: true
Context object returned when additional error metadata is available.
Show Source
  • Client-facing guidance that clarifies how to resolve or retry the request.
    Example: Retry request after verifying the study mode.
  • Unique identifier that can be supplied to Oracle Support when troubleshooting.
    Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
  • 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.
Body ()
Root Schema : QueryListByDateRangeErrorRespDTO
Type: object
Query Service error response envelope for query details returned by created date range.
Show Source
Nested Schema : Error details DTO
Type: object
Standard structure used to describe errors returned by Query APIs.
Show Source
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: object
No result payload is returned when status equals failed.
Nested Schema : QueryRestErrorDetail
Type: object
Read Only: true
Context object returned when additional error metadata is available.
Show Source
  • Client-facing guidance that clarifies how to resolve or retry the request.
    Example: Retry request after verifying the study mode.
  • Unique identifier that can be supplied to Oracle Support when troubleshooting.
    Example: 3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a
  • 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

Back to Top