1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Query
  4. Reporting
  5. Generate Subject Queries report

[Deprecated]: v1.0
post

/ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Deprecated: Use latest version instead. Compared to pre-REST report generation flows, this v1.0 endpoint generates subject query reports through a standardized API payload and callback model. This benefits users by reducing manual report orchestration and improving integration traceability.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : SearchSpecs
Type: object
Title: SearchSpecs
Request body passing search specs like limit, offset and list of fields
Show Source
  • fieldSpecsList
    Field Specification List. Each element describes a single filter applied to the report.
  • Minimum Value: 1
    Maximum Value: 5000
    Maximum number of records to display per page. Provide a value between 1 and 5000 inclusive. Negative numbers are not accepted.
    Example: 50
  • Minimum Value: 0
    Maximum Value: 2147483647
    An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Provide a zero or positive value.
    Example: 5
Nested Schema : fieldSpecsList
Type: array
Field Specification List. Each element describes a single filter applied to the report.
Show Source
  • Field
    Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.
Example:
[
    {
        "fieldName":"ruleState",
        "fieldType":"list",
        "fieldSequence":1,
        "fieldValueList":[
            "approved"
        ]
    }
]
Nested Schema : Field
Type: object
Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.
    Example: ruleState
  • Minimum Value: 0
    Maximum Value: 2147483647
    Sequence/order of the field. Provide a non-negative integer.
    Example: 1
  • Minimum Length: 4
    Maximum Length: 16
    Allowed Values: [ "list", "date", "date-time", "number", "string", "boolean" ]
    Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.
    Example: list
  • fieldValueList
    List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.
Example:
{
    "fieldName":"ruleState",
    "fieldType":"list",
    "fieldSequence":1,
    "fieldValueList":[
        "approved"
    ]
}
Nested Schema : fieldValueList
Type: array
List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
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
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

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

Back to Top