1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Query
  4. Query Management
  5. Get query details by query created date range

v1.0

get

/ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queryDetails/dateRange

Retrieves query management records for the requested study and site by query created date range using forward-only cursor pagination. The caller must have ViewAllQueries permission for the requested study. startDate and endDate are inclusive. 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
  • Minimum Length: 24
    Maximum Length: 24
    Inclusive date-range end in dd-MMM-yyyy HH:mm:ss.SSS format. 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
  • Minimum Length: 24
    Maximum Length: 24
    Required inclusive query created start timestamp in dd-MMM-yyyy HH:mm:ss.SSS format.
    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
Nested Schema : comments
Type: array
Query comment history.
Show Source
Nested Schema : ExistingStudyRoles
Type: array
Existing study role assignments for query comments grouped per interaction.
Show Source
Nested Schema : studyRoles
Type: array
Study role assignments returned after update.
Show Source
Nested Schema : CommentDetailsDTOV2
Type: object
Show Source
Nested Schema : DisplayUserDto
Type: object
User details including name, username, and email address.
Show Source
Nested Schema : items
Type: array
Existing study role assignments for query comments grouped per interaction.
Show Source
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