REST API for Clinical One Cloud Service

v10.0

put

/ec-query-svc/rest/v10.0/studies/{studyId}/{mode}/queries/{queryId}/close

Compared to v9.0, this v10 endpoint validates study role context before closing the query and returns the expanded QueryV9Response payload including user display name metadata.

Request

Path Parameters

mode(required): string
Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).
Example:
```
test
```
queryId(required): string
ID of the query to close.
Example:
```
AE33A9096BF548BBB29A96E399E9FBBB
```
studyId(required): string
Clinical One study identifier formatted as a 32 to 36 character GUID.
Example:
```
A1B23C45D67E89F123456789ABCDEF12
```

Supported Media Types

application/json

Root Schema : QueryDTO Version 9

Type: object

Title: QueryDTO Version 9

Information for creating/editing query

Show Source

dataElementId: string (uuid)

Data element unique GUID.
discrepancyId: integer (int64)

Discrepancy identifier sourced from Data Capture. Negative values are rejected.

Example: 123456789
eventId: string (uuid)

Event unique GUID.
eventInstanceNumber: number (int64)

Sequence number (0, 1, 2, ...) of the repeating event. Negative values are rejected.

Example: 0
formId: string (uuid)

Form unique GUID.
formInstanceNumber: number (int64)

Sequence number (0, 1, 2, ...) of the repeating form. Negative values are rejected.

Example: 0
id: string (uuid)

Query unique identifier. Value must be a 32 to 36 character hexadecimal GUID.
itemId: string (uuid)

Item unique GUID.
objectVersionNumber: number (int64)

Sequence number (0, 1, 2, ...) of object version. Negative values are rejected.

Example: 0
propertyName: string

Property name associated with the query when Data Capture properties are involved. Example: visit.

Example: visit
propertyType: string

Allowed Values: [ "visit", "visitStartDate" ]

Property type classification. Allowed values: visit (query anchored to visit details), visitStartDate (query anchored to the visit start date).

Example: visit
queryComment: string

Minimum Length: 1

Maximum Length: 2048

Query comments captured during open, candidate, or close operations.

Example: Query comment example here..
repeatFormNumber: integer (int64)

Repeat form sequence number. Negative values are rejected.

Example: 1
siteId: string (uuid)

Site unique GUID.
studyRoles: array studyRoles

List of study role identifiers assigned to the query.
studyVersionStart: string (date-time)

Data element version start timestamp in ISO-8601 format.

Example: 2026-01-15T10:05:30Z
subjectId: string (uuid)

Subject unique GUID.
userDisplayName: string

First and last name of the query creator or last modifier.

Example: John Doe

{
    "title":"QueryDTO Version 9",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Query unique identifier. Value must be a 32 to 36 character hexadecimal GUID.",
            "format":"uuid"
        },
        "queryComment":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Query comments captured during open, candidate, or close operations.",
            "example":"Query comment example here.."
        },
        "subjectId":{
            "type":"string",
            "description":"Subject unique GUID.",
            "format":"uuid"
        },
        "dataElementId":{
            "type":"string",
            "description":"Data element unique GUID.",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Data element version start timestamp in ISO-8601 format.",
            "format":"date-time",
            "example":"2026-01-15T10:05:30Z"
        },
        "formId":{
            "type":"string",
            "description":"Form unique GUID.",
            "format":"uuid"
        },
        "formInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of the repeating form. Negative values are rejected.",
            "format":"int64",
            "example":0
        },
        "siteId":{
            "type":"string",
            "description":"Site unique GUID.",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "description":"Event unique GUID.",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of the repeating event. Negative values are rejected.",
            "format":"int64",
            "example":0
        },
        "studyRoles":{
            "type":"array",
            "description":"List of study role identifiers assigned to the query.",
            "example":[
                "6AF54DB79B764662B685D68C52AB0B84",
                "6AF54DB79B764662B685D68C52AB0B84"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "discrepancyId":{
            "type":"integer",
            "description":"Discrepancy identifier sourced from Data Capture. Negative values are rejected.",
            "format":"int64",
            "example":123456789
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Repeat form sequence number. Negative values are rejected.",
            "format":"int64",
            "example":1
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of object version. Negative values are rejected.",
            "format":"int64",
            "example":0
        },
        "itemId":{
            "type":"string",
            "description":"Item unique GUID.",
            "format":"uuid"
        },
        "propertyName":{
            "type":"string",
            "description":"Property name associated with the query when Data Capture properties are involved. Example: visit.",
            "example":"visit"
        },
        "propertyType":{
            "type":"string",
            "description":"Property type classification. Allowed values: visit (query anchored to visit details), visitStartDate (query anchored to the visit start date).",
            "example":"visit",
            "enum":[
                "visit",
                "visitStartDate"
            ]
        },
        "userDisplayName":{
            "type":"string",
            "description":"First and last name of the query creator or last modifier.",
            "example":"John Doe"
        }
    },
    "description":"Information for creating/editing query",
    "example":"{\\n  \\\"queryComment\\\": \\\"Visit date clarification required.\\\",\\n  \\\"subjectId\\\": \\\"762744769B0E4E40B6A74691179BC578\\\",\\n  \\\"dataElementId\\\": \\\"583A45DD0A1C46F88D7842D76CAF9A59\\\",\\n  \\\"formId\\\": \\\"680E0FB01F1B4CCB990C333563FAEE80\\\",\\n  \\\"siteId\\\": \\\"CB9BBB0767114F599FE75616223D6665\\\",\\n  \\\"eventId\\\": \\\"3B95322B15144E4397B30305EB33E871\\\",\\n  \\\"eventInstanceNumber\\\": 0,\\n  \\\"formInstanceNumber\\\": 0,\\n  \\\"itemId\\\": \\\"42738D18833E45C29D9CDEABBB2247FE\\\",\\n  \\\"studyRoles\\\": [\\\"6AF54DB79B764662B685D68C52AB0B84\\\"],\\n  \\\"discrepancyId\\\": 123456789,\\n  \\\"propertyName\\\": \\\"visit\\\",\\n  \\\"propertyType\\\": \\\"visitStartDate\\\",\\n  \\\"userDisplayName\\\": \\\"Jane QueryAuthor\\\"\\n}"
}

Example:

{\n  \"queryComment\": \"Visit date clarification required.\",\n  \"subjectId\": \"762744769B0E4E40B6A74691179BC578\",\n  \"dataElementId\": \"583A45DD0A1C46F88D7842D76CAF9A59\",\n  \"formId\": \"680E0FB01F1B4CCB990C333563FAEE80\",\n  \"siteId\": \"CB9BBB0767114F599FE75616223D6665\",\n  \"eventId\": \"3B95322B15144E4397B30305EB33E871\",\n  \"eventInstanceNumber\": 0,\n  \"formInstanceNumber\": 0,\n  \"itemId\": \"42738D18833E45C29D9CDEABBB2247FE\",\n  \"studyRoles\": [\"6AF54DB79B764662B685D68C52AB0B84\"],\n  \"discrepancyId\": 123456789,\n  \"propertyName\": \"visit\",\n  \"propertyType\": \"visitStartDate\",\n  \"userDisplayName\": \"Jane QueryAuthor\"\n}

Nested Schema : studyRoles

Type: array

List of study role identifiers assigned to the query.

Show Source

Array of: string(uuid)

{
    "type":"array",
    "description":"List of study role identifiers assigned to the query.",
    "example":[
        "6AF54DB79B764662B685D68C52AB0B84",
        "6AF54DB79B764662B685D68C52AB0B84"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "6AF54DB79B764662B685D68C52AB0B84",
    "6AF54DB79B764662B685D68C52AB0B84"
]

Examples

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : QueryDTO Version 9

Type: object

Title: QueryDTO Version 9

Information returned from updating/inserting query

Show Source

dataElementId: string (uuid)

Data element unique GUID.
discrepancyId: integer (int64)

Discrepancy identifier sourced from Data Capture. Negative values are rejected.

Example: 123456789
eventId: string (uuid)

Event unique GUID.
eventInstanceNumber: number (int64)

Sequence number (0, 1, 2, ...) of the repeating event. Negative values are rejected.

Example: 0
formId: string (uuid)

Form unique GUID.
formInstanceNumber: number (int64)

Sequence number (0, 1, 2, ...) of the repeating form. Negative values are rejected.

Example: 0
id: string (uuid)

Query unique identifier. Value must be a 32 to 36 character hexadecimal GUID.
isQueryCreator: boolean

Indicates if the authenticated user created the query (true or false).

Example: true
itemId: string (uuid)

Item unique GUID.
objectVersionNumber: number (int64)

Sequence number (0, 1, 2, ...) of object version. Negative values are rejected.

Example: 0
propertyName: string

Property name associated with the query when Data Capture properties are involved. Example: visit.

Example: visit
propertyType: string

Allowed Values: [ "visit", "visitStartDate" ]

Property type classification. Allowed values: visit (query anchored to visit details), visitStartDate (query anchored to the visit start date).

Example: visit
queryComment: string

Minimum Length: 1

Maximum Length: 2048

Query comments captured during open, candidate, or close operations.

Example: Query comment example here..
repeatFormNumber: integer (int64)

Repeat form sequence number. Negative values are rejected.

Example: 1
ruleId: string (uuid)

Rule unique GUID for queries created by rule.
siteId: string (uuid)

Site unique GUID.
state: string

Allowed Values: [ "Candidate", "Opened", "Answered", "Closed", "Deleted" ]

Query state. Allowed values: Candidate (new discrepancy awaiting triage), Opened (active discrepancy requiring action), Answered (site responded awaiting review), Closed (resolved discrepancy), Deleted (removed during workflow).

Example: Opened
studyRoles: array studyRoles

Study role assignments returned after update.
studyVersionStart: string (date-time)

Data element version start timestamp in ISO-8601 format.

Example: 2026-01-15T10:05:30Z
subjectId: string (uuid)

Subject unique GUID.

{
    "title":"QueryDTO Version 9",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Query unique identifier. Value must be a 32 to 36 character hexadecimal GUID.",
            "format":"uuid"
        },
        "queryComment":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Query comments captured during open, candidate, or close operations.",
            "example":"Query comment example here.."
        },
        "state":{
            "type":"string",
            "description":"Query state. Allowed values: Candidate (new discrepancy awaiting triage), Opened (active discrepancy requiring action), Answered (site responded awaiting review), Closed (resolved discrepancy), Deleted (removed during workflow).",
            "example":"Opened",
            "enum":[
                "Candidate",
                "Opened",
                "Answered",
                "Closed",
                "Deleted"
            ]
        },
        "subjectId":{
            "type":"string",
            "description":"Subject unique GUID.",
            "format":"uuid"
        },
        "dataElementId":{
            "type":"string",
            "description":"Data element unique GUID.",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Data element version start timestamp in ISO-8601 format.",
            "format":"date-time",
            "example":"2026-01-15T10:05:30Z"
        },
        "formId":{
            "type":"string",
            "description":"Form unique GUID.",
            "format":"uuid"
        },
        "formInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of the repeating form. Negative values are rejected.",
            "format":"int64",
            "example":0
        },
        "siteId":{
            "type":"string",
            "description":"Site unique GUID.",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "description":"Event unique GUID.",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of the repeating event. Negative values are rejected.",
            "format":"int64",
            "example":0
        },
        "studyRoles":{
            "type":"array",
            "description":"Study role assignments returned after update.",
            "items":{
                "$ref":"#/components/schemas/QueryStudyRoleDTOv6"
            }
        },
        "discrepancyId":{
            "type":"integer",
            "description":"Discrepancy identifier sourced from Data Capture. Negative values are rejected.",
            "format":"int64",
            "example":123456789
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Repeat form sequence number. Negative values are rejected.",
            "format":"int64",
            "example":1
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of object version. Negative values are rejected.",
            "format":"int64",
            "example":0
        },
        "itemId":{
            "type":"string",
            "description":"Item unique GUID.",
            "format":"uuid"
        },
        "propertyName":{
            "type":"string",
            "description":"Property name associated with the query when Data Capture properties are involved. Example: visit.",
            "example":"visit"
        },
        "propertyType":{
            "type":"string",
            "description":"Property type classification. Allowed values: visit (query anchored to visit details), visitStartDate (query anchored to the visit start date).",
            "example":"visit",
            "enum":[
                "visit",
                "visitStartDate"
            ]
        },
        "ruleId":{
            "type":"string",
            "description":"Rule unique GUID for queries created by rule.",
            "format":"uuid"
        },
        "isQueryCreator":{
            "type":"boolean",
            "description":"Indicates if the authenticated user created the query (true or false).",
            "example":true
        }
    },
    "description":"Information returned from updating/inserting query",
    "example":"{\\n  \\\"id\\\": \\\"AE33A9096BF548BBB29A96E399E9FBBB\\\",\\n  \\\"queryComment\\\": \\\"Visit date clarification required.\\\",\\n  \\\"state\\\": \\\"Opened\\\",\\n  \\\"subjectId\\\": \\\"762744769B0E4E40B6A74691179BC578\\\",\\n  \\\"dataElementId\\\": \\\"583A45DD0A1C46F88D7842D76CAF9A59\\\",\\n  \\\"dataElementVersionStart\\\": \\\"2026-01-15T10:05:30Z\\\",\\n  \\\"formId\\\": \\\"680E0FB01F1B4CCB990C333563FAEE80\\\",\\n  \\\"siteId\\\": \\\"CB9BBB0767114F599FE75616223D6665\\\",\\n  \\\"eventId\\\": \\\"3B95322B15144E4397B30305EB33E871\\\",\\n  \\\"eventInstanceNumber\\\": 0,\\n  \\\"formInstanceNumber\\\": 0,\\n  \\\"objectVersionNumber\\\": 6,\\n  \\\"itemId\\\": \\\"42738D18833E45C29D9CDEABBB2247FE\\\",\\n  \\\"discrepancyId\\\": 123456789,\\n  \\\"repeatFormNumber\\\": 1,\\n  \\\"propertyName\\\": \\\"visit\\\",\\n  \\\"propertyType\\\": \\\"visitStartDate\\\",\\n  \\\"ruleId\\\": \\\"0E1F4EDBB97943F0B2DE8C6C5AA31234\\\",\\n  \\\"isQueryCreator\\\": true,\\n  \\\"studyRoles\\\": [{\\\"studyRoleId\\\": \\\"6AF54DB79B764662B685D68C52AB0B84\\\", \\\"studyRoleName\\\": \\\"CRA\\\"}]\\n}"
}

Example:

{\n  \"id\": \"AE33A9096BF548BBB29A96E399E9FBBB\",\n  \"queryComment\": \"Visit date clarification required.\",\n  \"state\": \"Opened\",\n  \"subjectId\": \"762744769B0E4E40B6A74691179BC578\",\n  \"dataElementId\": \"583A45DD0A1C46F88D7842D76CAF9A59\",\n  \"dataElementVersionStart\": \"2026-01-15T10:05:30Z\",\n  \"formId\": \"680E0FB01F1B4CCB990C333563FAEE80\",\n  \"siteId\": \"CB9BBB0767114F599FE75616223D6665\",\n  \"eventId\": \"3B95322B15144E4397B30305EB33E871\",\n  \"eventInstanceNumber\": 0,\n  \"formInstanceNumber\": 0,\n  \"objectVersionNumber\": 6,\n  \"itemId\": \"42738D18833E45C29D9CDEABBB2247FE\",\n  \"discrepancyId\": 123456789,\n  \"repeatFormNumber\": 1,\n  \"propertyName\": \"visit\",\n  \"propertyType\": \"visitStartDate\",\n  \"ruleId\": \"0E1F4EDBB97943F0B2DE8C6C5AA31234\",\n  \"isQueryCreator\": true,\n  \"studyRoles\": [{\"studyRoleId\": \"6AF54DB79B764662B685D68C52AB0B84\", \"studyRoleName\": \"CRA\"}]\n}

Nested Schema : studyRoles

Type: array

Study role assignments returned after update.

Show Source

Array of: object QueryStudyRoleDTOv6

{
    "type":"array",
    "description":"Study role assignments returned after update.",
    "items":{
        "$ref":"#/components/schemas/QueryStudyRoleDTOv6"
    }
}

Nested Schema : QueryStudyRoleDTOv6

Type: object

Show Source

studyRoleId: string (uuid)

Study role of the user performing the query operation
studyRoleName: string

Study role name of the user performing the query operation

Example: CRA

{
    "type":"object",
    "properties":{
        "studyRoleId":{
            "type":"string",
            "description":"Study role of the user performing the query operation",
            "format":"uuid"
        },
        "studyRoleName":{
            "type":"string",
            "description":"Study role name of the user performing the query operation",
            "example":"CRA"
        }
    }
}

Examples

400 Response

Request validation failed due to missing, invalid, or inconsistent request data.

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

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: true

Allowed 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: true

Semantic version of the response envelope.

Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Overall execution status. Value is success when result is populated and failed when errorData is returned.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result payload returned when status equals success.",
            "example":{
                "opened":3,
                "answered":1,
                "closed":2
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Semantic version of the response envelope.",
            "readOnly":true,
            "example":"1"
        }
    },
    "description":"Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.",
    "example":"{\\n  \\\"status\\\": \\\"success\\\",\\n  \\\"result\\\": {\\n    \\\"id\\\": \\\"AE33A9096BF548BBB29A96E399E9FBBB\\\",\\n    \\\"state\\\": \\\"Answered\\\"\\n  },\\n  \\\"errorData\\\": null,\\n  \\\"version\\\": \\\"1\\\"\\n}"
}

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

details: object QueryRestErrorDetail

Read Only: true

Context object returned when additional error metadata is available.
errorCode: string

Read Only: true

Machine-readable error code that identifies the failure.

Example: QRY-5000
errorMessage: string

Read Only: true

Human-readable explanation describing why the request failed.

Example: Unexpected server error.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Machine-readable error code that identifies the failure.",
            "readOnly":true,
            "example":"QRY-5000"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable explanation describing why the request failed.",
            "readOnly":true,
            "example":"Unexpected server error."
        },
        "details":{
            "$ref":"#/components/schemas/QueryRestErrorDetail"
        }
    },
    "description":"Standard structure used to describe errors returned by Query APIs.",
    "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."
        }
    }
}

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

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

{
    "type":"object",
    "properties":{
        "requestId":{
            "type":"string",
            "description":"Unique identifier that can be supplied to Oracle Support when troubleshooting.",
            "example":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a"
        },
        "supportCode":{
            "type":"string",
            "description":"Support or incident code associated with the error source.",
            "example":"QRY-5000"
        },
        "hint":{
            "type":"string",
            "description":"Client-facing guidance that clarifies how to resolve or retry the request.",
            "example":"Retry request after verifying the study mode."
        }
    },
    "description":"Context object returned when additional error metadata is available.",
    "readOnly":true,
    "example":{
        "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
        "supportCode":"QRY-5000",
        "hint":"Retry request"
    }
}

Example:

{
    "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
    "supportCode":"QRY-5000",
    "hint":"Retry request"
}

Examples

404 Response

The query could not be found.

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

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: true

Allowed 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: true

Semantic version of the response envelope.

Example: 1

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Overall execution status. Value is success when result is populated and failed when errorData is returned.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result payload returned when status equals success.",
            "example":{
                "opened":3,
                "answered":1,
                "closed":2
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/Error details DTO"
        },
        "version":{
            "type":"string",
            "description":"Semantic version of the response envelope.",
            "readOnly":true,
            "example":"1"
        }
    },
    "description":"Base envelope returned by Query APIs. Use the status field to determine whether result or errorData is populated.",
    "example":"{\\n  \\\"status\\\": \\\"success\\\",\\n  \\\"result\\\": {\\n    \\\"id\\\": \\\"AE33A9096BF548BBB29A96E399E9FBBB\\\",\\n    \\\"state\\\": \\\"Answered\\\"\\n  },\\n  \\\"errorData\\\": null,\\n  \\\"version\\\": \\\"1\\\"\\n}"
}

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

details: object QueryRestErrorDetail

Read Only: true

Context object returned when additional error metadata is available.
errorCode: string

Read Only: true

Machine-readable error code that identifies the failure.

Example: QRY-5000
errorMessage: string

Read Only: true

Human-readable explanation describing why the request failed.

Example: Unexpected server error.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Machine-readable error code that identifies the failure.",
            "readOnly":true,
            "example":"QRY-5000"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable explanation describing why the request failed.",
            "readOnly":true,
            "example":"Unexpected server error."
        },
        "details":{
            "$ref":"#/components/schemas/QueryRestErrorDetail"
        }
    },
    "description":"Standard structure used to describe errors returned by Query APIs.",
    "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."
        }
    }
}

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

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

{
    "type":"object",
    "properties":{
        "requestId":{
            "type":"string",
            "description":"Unique identifier that can be supplied to Oracle Support when troubleshooting.",
            "example":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a"
        },
        "supportCode":{
            "type":"string",
            "description":"Support or incident code associated with the error source.",
            "example":"QRY-5000"
        },
        "hint":{
            "type":"string",
            "description":"Client-facing guidance that clarifies how to resolve or retry the request.",
            "example":"Retry request after verifying the study mode."
        }
    },
    "description":"Context object returned when additional error metadata is available.",
    "readOnly":true,
    "example":{
        "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
        "supportCode":"QRY-5000",
        "hint":"Retry request"
    }
}

Example:

{
    "requestId":"3b3b8f31-87a3-4dd2-8b9d-21d0c93ef27a",
    "supportCode":"QRY-5000",
    "hint":"Retry request"
}

Examples