1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Query
  4. Query Management
  5. Get number of queries in a study

v2.0

post

/ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queryCount

Deprecated: Use latest version instead. Compared to v1.0, this v2.0 endpoint normalizes UUID casing, returns query counts in a consistent wrapper, and validates subject and state filters more rigorously. This improves user integration reliability.

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 to 36 character GUID.
    Example:
    A1B23C45D67E89F123456789ABCDEF12
Supported Media Types
Request Body - application/json ()
Root Schema : QueryCountPostDTO v2.0
Type: object
Title: QueryCountPostDTO v2.0
Query count request payload.
Show Source
Nested Schema : states
Type: array
Unique Items Required: true
List of query states to include in the count. Allowed values: Candidate, Opened, Answered, Deleted, Closed.
Show Source
  • List of query states to include in the count. Allowed values: Candidate, Opened, Answered, Deleted, Closed.
    Example: ["Opened","Answered","Candidate"]
Example:
[
    "Opened",
    "Answered",
    "Candidate"
]
Nested Schema : subjects
Type: array
List of subject identifiers to evaluate.
Show Source
Example:
[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Query counts returned successfully.
Body ()
Root Schema : QueryCountResults v2.0
Type: object
Title: QueryCountResults v2.0
Query Count result payload
Show Source
Example:
{
    "status":"success",
    "version":"2",
    "errorData":null,
    "result":[
        {
            "subjectName":"TestSite1184",
            "subjectId":"762744769B0E4E40B6A74691179BC578",
            "eventId":"3B95322B15144E4397B30305EB33E871",
            "eventInstanceNumber":null,
            "candidate":0,
            "opened":1,
            "answered":0,
            "deleted":0,
            "closed":0,
            "totalQueries":1
        }
    ]
}
Nested Schema : result
Type: array
Query count detail rows
Show Source
Nested Schema : QueryCountResults Entry v2.0
Type: object
Title: QueryCountResults Entry v2.0
Query Count result payload entry
Show Source
Example:
{
    "subjectName":"TestSite1184",
    "subjectId":"762744769B0E4E40B6A74691179BC578",
    "eventId":"3B95322B15144E4397B30305EB33E871",
    "eventInstanceNumber":null,
    "candidate":0,
    "opened":1,
    "answered":0,
    "deleted":0,
    "closed":0,
    "totalQueries":1
}
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
Example:
{\n  \"status\": \"success\",\n  \"result\": {\n    \"id\": \"AE33A9096BF548BBB29A96E399E9FBBB\",\n    \"state\": \"Answered\"\n  },\n  \"errorData\": null,\n  \"version\": \"1\"\n}
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

Returned when no counts are available for the supplied filters.
Body ()
Root Schema : QueryCountResults v2.0
Type: object
Title: QueryCountResults v2.0
Query Count result payload
Show Source
Example:
{
    "status":"success",
    "version":"2",
    "errorData":null,
    "result":[
        {
            "subjectName":"TestSite1184",
            "subjectId":"762744769B0E4E40B6A74691179BC578",
            "eventId":"3B95322B15144E4397B30305EB33E871",
            "eventInstanceNumber":null,
            "candidate":0,
            "opened":1,
            "answered":0,
            "deleted":0,
            "closed":0,
            "totalQueries":1
        }
    ]
}
Nested Schema : result
Type: array
Query count detail rows
Show Source
Nested Schema : QueryCountResults Entry v2.0
Type: object
Title: QueryCountResults Entry v2.0
Query Count result payload entry
Show Source
Example:
{
    "subjectName":"TestSite1184",
    "subjectId":"762744769B0E4E40B6A74691179BC578",
    "eventId":"3B95322B15144E4397B30305EB33E871",
    "eventInstanceNumber":null,
    "candidate":0,
    "opened":1,
    "answered":0,
    "deleted":0,
    "closed":0,
    "totalQueries":1
}
Examples

500 Response

Returned when an unexpected error occurs while retrieving query counts.
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
Example:
{\n  \"status\": \"success\",\n  \"result\": {\n    \"id\": \"AE33A9096BF548BBB29A96E399E9FBBB\",\n    \"state\": \"Answered\"\n  },\n  \"errorData\": null,\n  \"version\": \"1\"\n}
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