REST API for Clinical One Cloud Service

~~[Deprecated]: v5.0~~

put

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

Deprecated: Use latest version instead. Compared to v4.0, this v5.0 endpoint returns QueryDTOv5 payloads with property metadata and study role assignments so visit property automation can reconcile closed queries. This improves user integration reliability.

Request

Path Parameters

mode(required): string

Study mode. Allowed values: test (testing sandbox), training (training environment), and active (production).
queryId(required): string(uuid)

ID of the query to close.
studyId(required): string(uuid)

Clinical One study identifier formatted as a 32 to 36 character GUID.

Supported Media Types

application/json

Root Schema : QueryDTO Version 5

Type: object

Title: QueryDTO Version 5

Information for creating or updating a manual query in v5.0. Compared to v4.0, this schema preserves propertyType/propertyName metadata produced by validation rules.

Show Source

dataElementId(required): string (uuid)

Data element unique identifier.
dataElementVersionStart: string (date-time)

Timestamp when the referenced data element version started (ISO-8601).

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

Event unique identifier for the visit.
eventInstanceNumber: number (int64)

Repeat sequence number (0, 1, 2, ...) of the visit. Negative values are rejected.

Example: 0
formId(required): string (uuid)

Form unique identifier.
formInstanceNumber: number (int64)

Repeat sequence number (0, 1, 2, ...) of the form. Negative values are rejected.

Example: 0
id: string (uuid)

Query unique identifier generated by the service.
itemId: string (uuid)

Item unique identifier referenced by the query.
objectVersionNumber: number (int64)

Optimistic locking number (0, 1, 2, ...) maintained by the service. Negative values are rejected.

Example: 2
propertyName: string

Specific property name derived from the propertyType. visitStartDate = captured visit start date discrepancy.

Example: visitStartDate
propertyType: string

Allowed Values: [ "visit" ]

Property classification associated with the query. visit = visit-level property metadata returned by validation rules.

Example: visit
queryComment: string

Query comment captured when creating or updating the query.

Example: Query reopened after visit start date correction.
siteId: string (uuid)

Site unique identifier that owns the subject.
state: string

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

Query state. Candidate = query created but not yet opened; Opened = active action required; Answered = site responded; Closed = sponsor closed; Deleted = removed from workflow.

Example: Opened
subjectId(required): string (uuid)

Subject unique identifier associated with the query.

{
    "title":"QueryDTO Version 5",
    "required":[
        "dataElementId",
        "eventId",
        "formId",
        "subjectId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Query unique identifier generated by the service.",
            "format":"uuid"
        },
        "queryComment":{
            "type":"string",
            "description":"Query comment captured when creating or updating the query.",
            "example":"Query reopened after visit start date correction."
        },
        "state":{
            "type":"string",
            "description":"Query state. Candidate = query created but not yet opened; Opened = active action required; Answered = site responded; Closed = sponsor closed; Deleted = removed from workflow.",
            "example":"Opened",
            "enum":[
                "Candidate",
                "Opened",
                "Answered",
                "Closed",
                "Deleted"
            ]
        },
        "subjectId":{
            "type":"string",
            "description":"Subject unique identifier associated with the query.",
            "format":"uuid"
        },
        "dataElementId":{
            "type":"string",
            "description":"Data element unique identifier.",
            "format":"uuid"
        },
        "dataElementVersionStart":{
            "type":"string",
            "description":"Timestamp when the referenced data element version started (ISO-8601).",
            "format":"date-time",
            "example":"2026-01-15T10:05:30Z"
        },
        "formId":{
            "type":"string",
            "description":"Form unique identifier.",
            "format":"uuid"
        },
        "formInstanceNumber":{
            "type":"number",
            "description":"Repeat sequence number (0, 1, 2, ...) of the form. Negative values are rejected.",
            "format":"int64",
            "example":0
        },
        "siteId":{
            "type":"string",
            "description":"Site unique identifier that owns the subject.",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "description":"Event unique identifier for the visit.",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "type":"number",
            "description":"Repeat sequence number (0, 1, 2, ...) of the visit. Negative values are rejected.",
            "format":"int64",
            "example":0
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Optimistic locking number (0, 1, 2, ...) maintained by the service. Negative values are rejected.",
            "format":"int64",
            "example":2
        },
        "itemId":{
            "type":"string",
            "description":"Item unique identifier referenced by the query.",
            "format":"uuid"
        },
        "propertyType":{
            "type":"string",
            "description":"Property classification associated with the query. visit = visit-level property metadata returned by validation rules.",
            "example":"visit",
            "enum":[
                "visit"
            ]
        },
        "propertyName":{
            "type":"string",
            "description":"Specific property name derived from the propertyType. visitStartDate = captured visit start date discrepancy.",
            "example":"visitStartDate"
        }
    },
    "description":"Information for creating or updating a manual query in v5.0. Compared to v4.0, this schema preserves propertyType/propertyName metadata produced by validation rules.",
    "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\\\": 2,\\n  \\\"itemId\\\": \\\"42738D18833E45C29D9CDEABBB2247FE\\\",\\n  \\\"propertyType\\\": \\\"visit\\\",\\n  \\\"propertyName\\\": \\\"visitStartDate\\\"\\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\": 2,\n  \"itemId\": \"42738D18833E45C29D9CDEABBB2247FE\",\n  \"propertyType\": \"visit\",\n  \"propertyName\": \"visitStartDate\"\n}

Examples

Response

Supported Media Types

application/json

200 Response

Query closed successfully.

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

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

Returned when the target query cannot be found for the supplied study, mode, and queryId.

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

500 Response

Returned when an unexpected error occurs while closing the query.

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