[Deprecated]: v1.0
post
/ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/querymgmt/openQueryList
Deprecated: Use latest version instead. Compared to the previous manual dashboards, this v1.0 endpoint supplies open query management results filtered by state so external clients can build To-Do lists without custom SQL. This improves user integration reliability.
Request
Path Parameters
-
mode(required): string
Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).
-
studyId(required): string(uuid)
Clinical One study identifier formatted as a 32-character UUID without dashes.
Supported Media Types
- application/json
Root Schema : schema
Type:
objectFilters and pagination for query-management POST requests. At least one non-empty subjectIdList or siteIdList is required.
Show Source
-
assignedRoleId: string
Study-role UUID for a current query assignment. Distinct from creator/closing role filters. Omit if not filtering assignment.Example:
68C35A92894A4ABCB2E2F6008E4402DB -
closedStudyRoleId: string
Study-role UUID associated with a historical closing interaction; distinct from current assignment.Example:
68C35A92894A4ABCB2E2F6008E4402DB -
creatorStudyRoleId: string
Study-role UUID associated with query creation; distinct from the assignedRoleId filter.Example:
68C35A92894A4ABCB2E2F6008E4402DB -
currentRecord: string
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 -
dateEventType: string
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 -
endDate: string
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: array
formIdList
Designed form UUIDs; any listed form may match. Omitted or empty list applies no form-list filter.
-
isToDo: boolean
Defaults to false. true applies caller-role assignment and actionable-query rules, using caller rights, query state and automated-query eligibility.Example:
true -
lastUpdated: string
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 -
paginationParam: object
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.
-
queryByAge: string
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 -
queryByID: string
Query UUID. In v3 its presence selects detail-style processing; other supplied filters still apply.Example:
AE33A9096BF548BBB29A96E399E9FBBB -
queryClosedBy: string
User UUID associated with a historical closing interaction, not a username. Omit if unused; do not send an empty string.Example:
00000000000000000000000000000003 -
queryCreatedBy: string
Original creator user UUID, not a username such as autocalc. Omit unused filters rather than sending an empty string.Example:
00000000000000000000000000000003 -
queryGridView: string
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: array
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.
-
queryType: string
Auto selects rule-generated queries; Manual selects user-created queries, case-insensitively. All, omission or unrecognized values select all types.Example:
Auto -
ruleTypeId: string
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 -
searchStr: string
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: array
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.
-
startDate: string
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: array
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: array
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:
arrayDesigned form UUIDs; any listed form may match. Omitted or empty list applies no form-list filter.
Show Source
-
Array of:
string
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:
objectPagination 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:
arrayCase-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
-
Array of:
string
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:
arraySite 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
-
Array of:
string
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:
arraySubject 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
-
Array of:
string
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:
arrayDesigned visit/event UUIDs; any listed visit may match. Omitted or empty list applies no visit-list filter.
Show Source
-
Array of:
string
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
- application/json
200 Response
Open query management results returned successfully.
Root Schema : Response DTO
Type:
objectBase envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
Result payload returned when status equals success.
-
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 : result
Type:
objectResult payload returned when status equals success.
Example:
{
"opened":3,
"answered":1,
"closed":2
}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
400 Response
Request validation failed due to missing, invalid, or inconsistent request data.
Root Schema : Response DTO
Type:
objectBase envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
Result payload returned when status equals success.
-
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 : result
Type:
objectResult payload returned when status equals success.
Example:
{
"opened":3,
"answered":1,
"closed":2
}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
404 Response
Returned when no open queries match the provided filters.
Root Schema : Response DTO
Type:
objectBase envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
Result payload returned when status equals success.
-
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 : result
Type:
objectResult payload returned when status equals success.
Example:
{
"opened":3,
"answered":1,
"closed":2
}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 occurs while retrieving open query data.
Root Schema : Response DTO
Type:
objectBase envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.
Show Source
-
errorData: object
Error details DTO
Standard structure used to describe errors returned by Query APIs.
-
result: object
result
Result payload returned when status equals success.
-
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 : result
Type:
objectResult payload returned when status equals success.
Example:
{
"opened":3,
"answered":1,
"closed":2
}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