v3.0

post

/ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/querymgmt/openQueryList

Retrieves non-candidate query-management records for dashboard and To-Do workflows. Supports Opened, Answered and Closed; Candidate and Deleted are rejected. Requires the QueryGetNonCandidate;ViewAllQueries access expression and the assigned-query-enhancements feature.

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
  • Defaults to false. true selects all-site processing in the simple site-only path and bypasses supplied site filters there; it does not grant caller authorization.
    Example:
    false
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Filters and pagination for query-management POST requests. At least one non-empty subjectIdList or siteIdList is required.
Show Source
  • Study-role UUID for a current query assignment. Distinct from creator/closing role filters. Omit if not filtering assignment.
    Example: 68C35A92894A4ABCB2E2F6008E4402DB
  • Study-role UUID associated with a historical closing interaction; distinct from current assignment.
    Example: 68C35A92894A4ABCB2E2F6008E4402DB
  • Study-role UUID associated with query creation; distinct from the assignedRoleId filter.
    Example: 68C35A92894A4ABCB2E2F6008E4402DB
  • 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.
    Example: 1
  • Allowed Values: [ "CANDIDATE", "OPENED", "CLOSED", "ANSWERED", "REOPENED", "UPDATED" ]
    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.
    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
  • formIdList
    Designed form UUIDs; any listed form may match. Omitted or empty list applies no form-list filter.
  • Defaults to false. true applies caller-role assignment and actionable-query rules, using caller rights, query state and automated-query eligibility.
    Example: true
  • Matches the calendar date of the current query record update, not an updated-since boundary. Format dd-MMM-yyyy; interpreted using service/database calendar-date handling. Omit for no date-equality filter.
    Example: 11-Dec-2025
  • PaginationParamDTO
    Pagination options for the query collection. GET details bind oldest/limit/offset in the URL; management lists send this object in the JSON body.
  • Whole days since initial creation: -7 selects age < 7 days; 7 selects age > 7 days. 0 or omission applies no age filter. Boundaries are strict; negative values do not mean future-dated queries.
    Example: -7
  • Query UUID. In v3 its presence selects detail-style processing; other supplied filters still apply.
    Example: AE33A9096BF548BBB29A96E399E9FBBB
  • User UUID associated with a historical closing interaction, not a username. Omit if unused; do not send an empty string.
    Example: 00000000000000000000000000000003
  • Original creator user UUID, not a username such as autocalc. Omit unused filters rather than sending an empty string.
    Example: 00000000000000000000000000000003
  • In v3 this supplied value is ignored: grid processing is selected when queryByID is absent, and detail-style processing when queryByID is present. Earlier versions can use this flag.
    Example: true
  • queryState
    Case-sensitive lifecycle states. queryList applies no explicit state filter when omitted/empty. openQueryList defaults to Opened, Answered, Closed and rejects Candidate and Deleted.
  • Auto selects rule-generated queries; Manual selects user-created queries, case-insensitively. All, omission or unrecognized values select all types.
    Example: Auto
  • 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
  • Case-insensitive contains search on the initial query comment; does not search subject/item names. SQL LIKE % and _ are wildcards; backslash escapes wildcard characters.
    Example: missing value
  • siteIdList
    Site UUIDs; any listed site may match. At least one of siteIdList or subjectIdList must be non-empty. v3 allSitesUser=true bypasses this filter in the simple site-only retrieval path.
  • 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.
    Example: 2026-01-01T00:00:00.000Z
  • subjectIdList
    Subject UUIDs; any listed subject may match. At least one of subjectIdList or siteIdList must be non-empty. Other supplied filters narrow the result.
  • visitIdList
    Designed visit/event UUIDs; any listed visit may match. Omitted or empty list applies no visit-list filter.
Example:
{
    "paginationParam":{
        "offset":0,
        "limit":25,
        "orderasc":false
    },
    "subjectIdList":[
        "762744769B0E4E40B6A74691179BC578"
    ],
    "queryState":[
        "Opened",
        "Answered"
    ],
    "currentRecord":"1"
}
Nested Schema : formIdList
Type: array
Designed form UUIDs; any listed form may match. Omitted or empty list applies no form-list filter.
Show Source
  • Designed form UUIDs; any listed form may match. Omitted or empty list applies no form-list filter.
    Example: ["680E0FB01F1B4CCB990C333563FAEE80"]
Example:
[
    "680E0FB01F1B4CCB990C333563FAEE80"
]
Nested Schema : PaginationParamDTO
Type: object
Pagination options for the query collection. GET details bind oldest/limit/offset in the URL; management lists send this object in the JSON body.
Show Source
Example:
{
    "orderasc":false,
    "limit":25,
    "offset":0
}
Nested Schema : queryState
Type: array
Case-sensitive lifecycle states. queryList applies no explicit state filter when omitted/empty. openQueryList defaults to Opened, Answered, Closed and rejects Candidate and Deleted.
Show Source
  • Case-sensitive lifecycle states. queryList applies no explicit state filter when omitted/empty. openQueryList defaults to Opened, Answered, Closed and rejects Candidate and Deleted.
    Example: ["Opened","Answered"]
Example:
[
    "Opened",
    "Answered"
]
Nested Schema : siteIdList
Type: array
Site UUIDs; any listed site may match. At least one of siteIdList or subjectIdList must be non-empty. v3 allSitesUser=true bypasses this filter in the simple site-only retrieval path.
Show Source
  • Site UUIDs; any listed site may match. At least one of siteIdList or subjectIdList must be non-empty. v3 allSitesUser=true bypasses this filter in the simple site-only retrieval path.
    Example: ["CB9BBB0767114F599FE75616223D6665"]
Example:
[
    "CB9BBB0767114F599FE75616223D6665"
]
Nested Schema : subjectIdList
Type: array
Subject UUIDs; any listed subject may match. At least one of subjectIdList or siteIdList must be non-empty. Other supplied filters narrow the result.
Show Source
  • Subject UUIDs; any listed subject may match. At least one of subjectIdList or siteIdList must be non-empty. Other supplied filters narrow the result.
    Example: ["762744769B0E4E40B6A74691179BC578"]
Example:
[
    "762744769B0E4E40B6A74691179BC578"
]
Nested Schema : visitIdList
Type: array
Designed visit/event UUIDs; any listed visit may match. Omitted or empty list applies no visit-list filter.
Show Source
  • Designed visit/event UUIDs; any listed visit may match. Omitted or empty list applies no visit-list filter.
    Example: ["3B95322B15144E4397B30305EB33E871"]
Example:
[
    "3B95322B15144E4397B30305EB33E871"
]
Examples

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