v11.0

get

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

Retrieves query details and comment history for candidate-inclusive review in the supplied study and mode. Requires the QueryGetAll;ViewAllQueries access expression. Results remain subject to caller visibility. The visit-date-query feature must be enabled.

Request

Path Parameters
  • Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).
    Example:
    test
  • Study UUID: 32 hexadecimal characters or standard 36-character hyphenated UUID.
    Example:
    A1B23C45D67E89F123456789ABCDEF12
Query Parameters
  • Use 1 for current records only; 2 uses the historical retrieval path, which can include current and earlier interactions. Omission becomes 0 and also uses historical retrieval.
    Allowed Values: [ "1", "2" ]
    Example:
    1
  • Data-element UUID associated with the question. Requires itemId, which requires subjectId. Cannot be combined with visit-property filtering.
    Example:
    6178E2B4CFC74C7F8ED8F9E81B7A72BF
  • History event evaluated within startDate/endDate: OPENED is first opening; ANSWERED is latest answer; CLOSED is latest Closed/Deleted interaction; REOPENED is latest reopening; UPDATED is latest interaction. Runtime also accepts CANDIDATE for first candidate interaction. Omission matches any history interaction in the range. No effect without a date boundary or when the MCP query-workflow feature is disabled.
    Allowed Values: [ "OPENED", "CLOSED", "ANSWERED", "REOPENED", "UPDATED" ]
    Example:
    UPDATED
  • Inclusive upper boundary for query-history date filtering. Use ISO-8601 with a timezone offset. Omit for no upper boundary. Requires the MCP query-workflow feature; otherwise ignored.
    Example:
    2026-01-31T23:59:59.999Z
  • Visit/event UUID. Alias of visitId; ignored in favor of visitId when both are supplied.
    Example:
    3B95322B15144E4397B30305EB33E871
  • Occurrence number of the visit/event, distinct from the designed visit UUID. Use the number from the captured visit context; omit to include all occurrences. Negative values are rejected.
    Example:
    1
  • Designed form UUID, not a form-instance number. Cannot be combined with visit-property filtering.
    Example:
    680E0FB01F1B4CCB990C333563FAEE80
  • Occurrence number of the form within the visit, distinct from repeatFormNumber. Use the captured form context; omit to include all occurrences. Negative values are rejected.
    Example:
    1
  • Defaults to 0. Use 1 for sidebar historical retrieval with hidden-item filtering. Current-only retrieval already filters hidden items.
    Allowed Values: [ "0", "1" ]
    Example:
    1
  • Designed question/item UUID, distinct from its associated dataElementId. Requires subjectId. Cannot be combined with visit-property filtering.
    Example:
    6178E2B4CFC74C7F8ED8F9E81B7A72BF
  • Maximum records per page. Omission is 0 (unbounded); positive values limit page size.
    Example:
    25
  • Zero-based number of query records to skip. Defaults to 0.
    Example:
    0
  • Defaults to true. Sorts query groups by latest matching versionStart (ascending for true, descending for false), then query UUID; comments follow that timestamp direction.
    Example:
    false
  • Property name within propertyType. For visit start date use visitStartDate with propertyType=visit.
    Example:
    visitStartDate
  • Property category. For the supported visit start-date pair use propertyType=visit and propertyName=visitStartDate. Cannot be combined with formId, itemId or dataElementId.
    Allowed Values: [ "visit", "visitStartDate" ]
    Example:
    visit
  • Repeating-form sequence number; omit to avoid narrowing by this sequence. Distinct from formInstanceNumber. Use the number returned with the captured form context.
    Example:
    1
  • Numeric rule-query type identifier (the response typeId), not a rule UUID. Use the type associated with the query. Omit to include all types. The resource parses an integer.
    Example:
    3
  • Study site UUID. Filters queries by the subject/site context; caller site-access restrictions still apply.
    Example:
    CB9BBB0767114F599FE75616223D6665
  • Inclusive lower boundary for query-history date filtering. Use ISO-8601 with a timezone offset. Omit for no lower boundary. Requires the MCP query-workflow feature; otherwise ignored. At least one ordinary scope/state/property filter is still required for GET details.
    Example:
    2026-01-01T00:00:00.000Z
  • Case-sensitive Candidate, Opened, Answered, Closed or Deleted. Omission applies no explicit state filter. Repeat state for multiple values, e.g. state=Candidate&state=Opened.
    • Allowed Values: [ "Candidate", "Opened", "Answered", "Closed", "Deleted" ]
    Example:
    Opened
  • Study subject UUID, not the subject display name. Filters queries for that subject; required when itemId is supplied.
    Example:
    762744769B0E4E40B6A74691179BC578
  • Designed visit UUID. Alias of eventId; visitId takes precedence if both are supplied.
    Example:
    3B95322B15144E4397B30305EB33E871

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : Response DTO
Type: object
Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
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
Result payload returned when status equals success.
Example:
{
    "opened":3,
    "answered":1,
    "closed":2
}
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

400 Response

Request validation failed due to missing, invalid, or inconsistent request data.
Body ()
Root Schema : Response DTO
Type: object
Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
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
Result payload returned when status equals success.
Example:
{
    "opened":3,
    "answered":1,
    "closed":2
}
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

404 Response

The query could not be found.
Body ()
Root Schema : Response DTO
Type: object
Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
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
Result payload returned when status equals success.
Example:
{
    "opened":3,
    "answered":1,
    "closed":2
}
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