REST API for Clinical One Cloud Service

~~[Deprecated]: v2.0~~

put

/ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queries/{queryId}/answer

Deprecated: Use latest version instead. Compared to v1.0, this v2.0 endpoint validates answer payloads against the expanded v2 schema and emits discrepancy metadata required by downstream audit pipelines. 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)

Query ID.
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 2

Type: object

Title: QueryDTO Version 2

Information for creating/editing query

Show Source

dataElementId(required): string (uuid)

Data element unique GUID.
eventId: string (uuid)

Event unique GUID.
eventInstanceNumber: number (bigdecimal)

Minimum Value: 0

Minimum Value: > false

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

Example: 0
formId: string (uuid)

Form unique GUID.
id: string (uuid)

Query unique GUID generated by the service.
queryComment(required): string

Minimum Length: 1

Maximum Length: 2048

Query comments.

Example: Comment
siteId: string (uuid)

Site unique GUID.
state: string

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

Query state. Candidate = query created but not yet opened; Opened = action required; Answered = awaiting review; Deleted = removed from workflow; Closed = finalised.

Example: Opened
studyVersionStart: string (date-time)

Data element version start timestamp.

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

Subject unique GUID.

{
    "title":"QueryDTO Version 2",
    "required":[
        "dataElementId",
        "queryComment",
        "subjectId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Query unique GUID generated by the service.",
            "format":"uuid"
        },
        "queryComment":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Query comments.",
            "example":"Comment"
        },
        "state":{
            "type":"string",
            "description":"Query state. Candidate = query created but not yet opened; Opened = action required; Answered = awaiting review; Deleted = removed from workflow; Closed = finalised.",
            "example":"Opened",
            "enum":[
                "Candidate",
                "Opened",
                "Answered",
                "Deleted",
                "Closed"
            ]
        },
        "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.",
            "format":"date-time",
            "example":"2026-01-15T10:05:30Z"
        },
        "formId":{
            "type":"string",
            "description":"Form unique GUID.",
            "format":"uuid"
        },
        "siteId":{
            "type":"string",
            "description":"Site unique GUID.",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "description":"Event unique GUID.",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "minimum":0,
            "exclusiveMinimum":false,
            "type":"number",
            "description":"Sequence number (0, 1, 2, ...) of the repeating event. Negative values are rejected.",
            "format":"bigdecimal",
            "example":0
        }
    },
    "description":"Information for creating/editing 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}"
}

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}

Examples

Response

Supported Media Types

application/json

200 Response

Query answered successfully and audit metadata persisted.

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 specified query identifier does not exist in the study and mode provided.

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 recording the answer.

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